Subscriptions

Check available Subscription APIs on left-hand navigation bar.

Subscription Life Cycle

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

Trial, 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

string

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

Time at which the subscription moved from Trial state to Active state. Typically the purchase date.

next_billing_on

date

YYYY-MM-DD

The date on which the customer will be billed next.

cancelled_on

date

YYYY-MM-DD

The date on which the customer Cancelled Subscription.

Note:Subscription may remain Active till the end of contracted or paid term.

subscription_start_on

date

YYYY-MM-DD

Date on which the subscription started. aka Contract Start Date.

subscription_ends_on

date

YYYY-MM-DD

Date on which the subscription started. aka Contract End Date.

Eg: For a one year contact with quarterly billing, this will be subscription_start_on + 1 year.

current_term_start_on

date

YYYY-MM-DD

Date on which the current term of the subscription started.

current_term_end_on

date

YYYY-MM-DD, Date on which the current term of the subscription ends.

Eg: For a one year contact with quarterly billing, this will be current_term_start_on + 3 months.

trial_start_on

date

YYYY-MM-DD

Start of the trial period for the subscription.

trial_ends_on

date

YYYY-MM-DD

Start of the trial period for the subscription.

created_at

timestamp

YYYY-MM-DD HH:MM:SS

updated_at

timestamp

YYYY-MM-DD HH:MM:SS