Cancel Subscription
This API is used to cancel an ACTIVE or PAUSED subscription. Canceling a subscription works differently for the Prepaid and Postpaid billing cycles. If cancelAtEnd is used, the subscription will remain in ACTIVE state until the end of the billing cycle. At the end of the billing cycle, the subscription will be auto-canceled, and no new invoice will be raised. If cancelNow is used, it will change the status from ACTIVE to CANCELLED then only.
For Prepaid, cancelNow will not revert the amount paid at the start of the cycle but will issue adjustment credits for that customer, which can be used in the future for any subscription payments. Therefore, it is recommended to use cancelAtEnd to cancel a ACTIVE subscription.
For Postpaid, cancelNow and cancelAtEnd can be used. If cancelNow is used, it will raise a pro-rate-based invoice and will try to debit the amount using the auto-debit mandate if available.
In the subscription analytics, this is considered as if the user has requested to drop out of the subscription.
Authorizations
Merchant API Key
Generated request signature
Body
- Option 1
- Option 2
Subscription Id of the subscription for which update is needed.
Subscriptions will be canceled at the end of the cycle. If cancelAtEnd is used to cancel a subscription. In response to this API, the subscription remains in the ACTIVE state and cancelAtEnd the parameter is changed to true.Mandatory if cancelNow is not passed
Subscriptions will be canceled immediately.Manadatory if cancelAtEnd is not passed