Disable Subscription

Disable 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.

📘

Note

Disable subscription does not stop any pending retries on subscription. Pending retry is caused by failure on previous subscription payment. Any pending retries will still be executed after subscription is disabled for trying to resolve previous pending payments.

To disable subscription and stop all pending retries, you can use Cancel Subscription instead.



Disable Subscription Method

HTTP MethodEndpointDescription
POSTBASE_URL/v1/subscriptions/{subscription_id}/disableDisable 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!