A subscription is a resource used to periodically charge a customer. It is created using a transaction token specifically requested for subscription use. Subscriptions can only be created if your account is verified.
Subscriptions are charged periodically based on the time period specified on creation. They are cancellable at any time. If a charge fails on a subscription, it will be retried the following day. If a subscription has specific number of consecutive failed charges, it will automatically be cancelled.
A charge is created immediately upon creating a subscription.
It is recommended to use webhooks to be alerted of subscriptions events. The
SUBSCRIPTION_PAYMENT event will notify you when a successful payment has been made. The
SUBSCRIPTION_FAILED event will notify failed payments for a subscription. The
SUBSCRIPTION_CANCELED event will notify you when a subscription has been canceled.
It is possible to update the payment information for a subscription by updating it with a new transaction token. If you update an
unpaid subscription’s transaction token, it will immediately create another charge.
The subscription object
The unique identifier for the subscription
The unique identifier for the store the charge was made to.
The amount to charge.
The currency the charge will be in.
The amount that was requested to be charged formatted to include a decimal place if there is a minor currency unit.
The initial amount to charge
The initial amount that was requested to be charged formatted to include a decimal place if there is a minor currency unit.
The date in which all subsequent payments should start on, in
|schedule_settings.zone_id||string (IANA Timezone)|
The timezone the subscription will be charged at
The frequency of the subscription billed. One of
|cyclical_period||string (ISO-8601 Duration)|
The frequency of the subscription expressed as a ISO-8601 duration, with a minimum frequency of 1 day and a minimum interval of 1 day. If this field is populated,
Number of payments：3,5,6,10,12,15,18,20,24
The unique identifier of the scheduled payment
The date this payment will be executed based on the timezone declared in
|next_payment.zone_id||string (IANA Timezone)|
The timezone in which this payment will be executed at.
The amount to be charged
The currency to be charged in
The amount to be charged formatted to include a decimal place if there is a minor currency unit.
If the payment has been executed
If this is the last payment in the subscription, only applicable for installment type subscription.
The time the scheduled payment was created on
Number of payments left, if applicable.
The amount left, if applicable.
The amount left, if applicable, formatted to include a decimal place if there is a minor currency unit.
The status of the subscription. One of
Any user defined metadata associated with the refund.
The date the refund was created on.