Subscriptions States and Descriptions
During its life cycle, a Subscription can go through the following states:Created
A Subscription attains thecreated state once it is created.
Authenticated
A Subscription goes to theauthenticated state when the customer completes the authentication transaction.
Subscriptions with an Immediate Start Date
The Subscription with an immediate start date remains in the created state till the first charge is made and moves to the active state after the first charge.
Subscriptions with a Trial Period
- The Subscription with an add-on amount remains in the
createdstate and moves to theauthenticatedstate after the add-on amount is processed. - The Subscription without an add-on amount moves to the
authenticatedstate when the customer completes the authentication transaction.
Active
A Subscription goes to theactive state when the billing cycle for the Subscription starts.
Action on Razorpay
When a Subscription moves to theactive state from the authenticated state, we attempt to charge the authorized card against the invoice amount.
Pending
- A Subscription goes to the
pendingstate when an auto-charge on a payment is unsuccessful. We continue to retry the payment while it is in this state. In the meanwhile, you can ask the customer to authenticate another card, if required. - After all the retry attempts have been exhausted, the Subscription moves to the
haltedstate.
- When the Subscription moves to the
haltedstate from thependingstate, invoices continue to be generated as per the billing cycles. However, no auto-charge is attempted. It is important to note that once the Subscription moves back to theactivestate, the previous charges will not be re-attempted. Only future billing cycles are charged automatically. - When the Subscription moves to the
pendingstate from theactivestate, you are notified about the failed attempt via our webhooks. For Subscriptions authenticated via cards, we continue to automatically process a retry without you having to take any action. We also send the customer an email notifying them about the failure. This email has a call-to-action from the customer to change the card that is associated with the Subscription.
active state from the pending state, the customer needs to authenticate another card. This enables us to successfully perform a charge on it. You or the customer can also manually attempt a charge on the same card by attempting to charge any of the older unpaid invoices. If they go through successfully, the Subscription moves back to the active state.
Halted
The Subscription goes to thehalted state when the last auto-charge is unsuccessful and all retries are exhausted.
Handy TipsIt is possible for the Subscription to continue to remain in the
halted state for more than one billing cycle. In such scenarios:- Invoices are generated for all billing cycles, but no auto-charge is attempted.
-
The customer needs to authenticate another card or you or the customer needs to manually attempt a charge on an older unpaid invoice. If the older invoice is successfully charged, the Subscription will automatically move to the
activestate. The Subscription moves to theactivestate once the customer changes their card details and we are able to successfully perform a charge on it. It can also move to theactivestate if a charge on an older invoice is attempted and it goes through successfully.
Cancelled
- When you cancel a Subscription, it moves to the
cancelledstate. Once cancelled, a Subscription cannot be restarted. - A Subscription can be cancelled using the Cancel API or from the Dashboard.
Paused
- Only Subscriptions in the
activestate can be paused. - You can pause a Subscription.
- From the Dashboard.
- Using API.
Expired
If thestart_at time for the Subscription has been set and the authentication transaction has not been done by the start_at time, the Subscription moves to the expired state and cannot be used again.
Completed
A Subscription moves to thecompleted state when it reaches the end of its life cycle as per the end_date set for the Subscription.