REST API

Subscription Statuses

This diagram illustrates the statuses of a subscription from creation to completion.

Figure:

Subscription Flow
Diagram of the statuses of a subscription.
A subscription has one of these statuses:
Created
The subscription has been created but the first payment has not been processed.
Pending
The first payment is scheduled or the subscription is in transition to another state.
Active
The subscription is currently in use. It is set with a payment instrument and a payment is scheduled at a pre-determined frequency agreed upon with your customer.
Delinquent
A scheduled payment was declined.
The system automatically retries the payment for a number of times. If the payment succeeds, the system automatically moves the subscription back to
active
state. Otherwise, if the automated retry logic fails to obtain a successful payment, the system automatically moves the subscription to the
suspended
state.
Suspended
The automated retry logic failed to obtain successful payment, or you have explicitly suspended the subscription. In order to resume a suspended subscription for the next billing cycle, choose one of these options:
  • Collect a different payment method from your customer and then reactivate the subscription
  • Cancel the subscription and create a new subscription for your customer.
Cancelled
You have explicitly cancelled the subscription and it cannot be reactivated. You might cancel an active or pending subscription when you and the customer agree to end the subscription. You might choose to cancel a delinquent subscription rather than wait for the automatic retry logic to proceed. You might cancel a suspended subscription if the customer does not have an acceptable alternate payment method.
IMPORTANT
You cannot cancel a subscription within 10 minutes before or after a payment begins processing.
Completed
All scheduled payments were made. This is the state of a subscription that ends with all scheduled payments successfully completed. This state applies to subscriptions set up with a scheduled end date.
IMPORTANT
You cannot reactivate a completed subscription.