When subscriptions are cancelled, they may need to be restored. Apart from the intentional cancellation of a subscription, the subscription recurring payments can be cancelled due to subscription duration settings or failed payment attempts.
- Limited billing attempts
Some subscriptions have a predefined number of billing attempts, after which they automatically enter theredemptionstatus. In this scenario, customers may wish to continue using the subscription, prompting the merchant to either restore it or make another payment attempt. - Failed billing attempts
Additionally, subscriptions can enter thecancelledstate after unsuccessful billing attempts in theredemptionstatus. Merchants can restore these subscriptions based on customer requests.
You can restore the customer’s cancelled subscription to recover access to their product or service. Choose one of these options:
-
Without changes - pass
subscription_idand a desiredexpired_at, with none for discount data -
With a discount applied - pass
subscription_idandexpired_at, and value for eithercoupon_idorcoupon_codeto apply reduced pricing for future payments- If the subscription already has a discount, it is replaced with the new value.
- If the discount is invalid, the restore request fails with an error.
- If you pass both
coupon_idandcoupon_code, you get a400 Bad Requesterror.
Restoring a cancelled subscription ensures that customers can immediately recover access to your product or service.
When restoring a subscription, the system checks for active subscriptions associated with the given customer_account_id and product_id combination.
The restoration process fails if an existing subscription with these parameters is found or being processed at the moment of the check.
This step helps avoid duplicates and potential chargebacks from double charges.
Once you successfully restore a subscription, the subscription status changes from cancelled to active, and the billing period is updated based on the specified expiration date.
The customer gets billed again for continued access to their chosen product or service.
subscription_id, and may include a discount value and the new expiration date (expired_at) following the ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ pattern.
Via Hub
To restore a subscription
- Go to Billing.
- Find the subscription you need and click on it.
- In the top-right corner, click on Restore.
- In the pop-up window, click on Restore to activate the subscription.
Optionally, set the subscription expiration date.
If the provided subscription expiration date (expired_at) is in the past, the system automatically updates it to the current date to prevent unwanted charges.