Skip to main content

icon: calendar-x

Cancel Subscription

Use the Cancel Subscription API to cancel an existing subscription. This API allows merchants to cancel a subscription using its unique subscription ID. Once successfully cancelled, the subscription status is updated to revoked.

Endpoint

Authentication

Every API request must include the required authentication headers. See the Authentication Guide for details.

Path Parameters

Request Body

No request parameters are required in the body.

Example Request

Signature Generation

For this request, the payload is empty. Generate the HMAC-SHA256 signature using the JSON-encoded empty payload ([]) concatenated with the request timestamp. Refer to the Authentication Guide for signature generation details.

Successful Response

When the subscription is eligible for cancellation, the API returns the updated subscription details.

Error Responses

Subscription Cannot Be Cancelled

If the subscription is already cancelled (revoked), expired, or deleted, it cannot be cancelled again.

Subscription Not Found

If the requested subscription does not exist or does not belong to the authenticated merchant, the API returns:

Important Notes

  • The subscription ID must belong to the authenticated merchant.
  • Subscriptions that are already cancelled, expired, or deleted cannot be cancelled again.
  • On successful cancellation, the subscription status becomes revoked.
  • The API returns the updated subscription details in the data object.