Subscriptions

Check available Subscription APIs on left-hand navigation bar.

Resources

Field

Data Type

Read-only

Context

subscription_id

string

Unique immutable identifier for subscription

external_subscription_id

string

Equivalent of subscription_id. Returned in GET call

account_id

string

Unique immutable identifier for account

external_account_id

string

Equivalent of account_id. Returned in GET call

status_id

integer

status

string

Active, Cancelled, Future, Suspended, {custom_value}

status_csb

string

Active, Cancelled, Future, Suspended

amount

float

mrr

float

Monthly recurring revenue

cancelled_mrr

float

Cancelled Monthly recurring revenue for "Cancelled" subscriptions

billing_period

integer

Number of terms i.e. 1, 3,12

billing_period_unit

string

month, year, quarter

product_name

float

product_code

string

Unique product code

plan_name

string

plan_code

date

Unique plan code

plan_quantity

integer

plan_unit_price

string

currency

string

ISO-4217

created_on

date

YYYY-MM-DD

updated_on

date

YYYY-MM-DD

activated_on

date

YYYY-MM-DD

next_billing_on

date

YYYY-MM-DD

cancelled_on

date

YYYY-MM-DD

subscription_start_on

date

YYYY-MM-DD

subscription_ends_on

date

YYYY-MM-DD

trial_start_on

date

YYYY-MM-DD

trial_ends_on

date

YYYY-MM-DD

created_at

timestamp

YYYY-MM-DD HH:MM:SS

updated_at

timestamp

YYYY-MM-DD HH:MM:SS