When a subscription is cancelled, it might need to be restored. Beyond intentional cancellation, subscriptions can be cancelled due to duration settings or failed payment attempts.
- Limited billing attempts
Some subscriptions have a predefined number of billing attempts, applied through a retry mode. When the initial payment fails, the subscription enters theredemptionstatus and retries begin. Customers might wish to continue using the subscription, and a successful payment retry recovers it. - Failed billing attempts
Some subscriptions can enter thecancelledstate after all retry attempts fail in theredemptionstatus. Merchants can restore these subscriptions based on customer requests.
You can restore a cancelled subscription to recover the customer’s access to your product or service. Choose one of these options:
-
Without changes - include
subscription_idand preferredexpired_atin the request, with none for discount data. -
With a discount applied - include
subscription_idandexpired_at, and value for eithercoupon_idorcoupon_codeto apply reduced pricing.- 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 include both
coupon_idandcoupon_code, you get a400 Bad Requesterror.
Before restoring a subscription, the system checks for active subscriptions associated with the given customer_account_id and product_id combination.
If a matching subscription exists or is currently being processed, the restore request fails. This prevents duplicate subscriptions and potential 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 can 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.