Cancel Subscription

Cancel a customer's subscription account with a specific subscription_id so that the customer is not charged for the subscription in the future. Successful request returns status_message indicating that the subscription details are updated.

The difference between cancel subscription and disable subscription is that cancel subscription also stop any pending retries on subscription due to previous failure on charging customer (might be caused by timeout to payment provider or customer balance is insufficient).




Cancel Subscription Method

HTTP MethodEndpointDescription
POSTBASE_URL/v1/subscriptions/{subscription_id}/cancelCancel subscription



Disable Subscription Response

{
  "status_message": "Subscription is updated."
}
{
  "status_message": "Subscription doesn't exist."
}
{
  "status_message": "Sorry, our system is recovering from unexpected issues. Please retry."
}
JSON AttributeDescriptionType
status_messageMessage describing the status of the result of API request.String
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!