Subscription Object


Subscription Life Cycle

StatusDescription
wait_for_paymentWhen the subscription has been created but payment is not done
activeThe subscription is active and ready to use
expiredThe subscription is expired

Subscription Entity

FieldDescription
idstring The unique identifier of Subscription
namestring The name of Subscription
billing_periodstring The billing_period for subscription can be monthly/weekly/annually/daily, default value is monthly
billing_period_countinteger The billing_period_count for subscription.For example, If billing_period is set for Monthly and billing_period_count is set as 2, then charge will be made every 2 months, default value is 1
grace_periodstring The grace_period for subscription can be terminate/ignore/monthly/hourly/weekly/daily. default value is 24 hours . terminate if the subscription was not paid after the due date, the subscription will end immediately And ignore if the subscription was not paid after the due date, the subscription will continue and status remain active.Grace Period should be less than Billing period
grace_period_countinteger The grace_period for subscription has to be zero for grace_period terminate/ignore & non zero in case of grace_period as monthly/hourly/weekly/daily.for example, if grace_period is set for Monthly and grace_period_count is set as 2, then charge will be made every 2 months
pricestring The price for a single subscription plan
qtystring The quantity of subscription plan, total amount will be price * qty
amountstring The amount for which the Order was created
subscription_ref_idstring The subscription_ref_id is upstream id from merchant
customer_objectjson object Indicates the customer information
statusstring The status of subscription
started_atstring The started_at associated with start date for subscription plan which should be current date or greater
next_due_atstring Indicates the next due date for subscription
charge_typestring The charge_type can be manual or automatic (only available for credit card)
linkstring Subscription link