Cancel a subscription

Cancel a subscription.

You can cancel a subscription in any state except cancelled or finished. When you cancel a subscription, it will be marked as cancelled and no further billing cycles will be created. Any pending orders will be cancelled.

Request​

Path parameters

Path parameters

The ID of the subscription.

Header parameters

Header parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

Info

For more information, see: Authentication

Possible values: [2023-09-01, 2024-05-01, 2024-09-01, 2025-10-16]
Example: "2025-10-16"

The version of the Merchant API, specified in YYYY-MM-DD format.

If not specified, you will receive an error.

Info

For more information about API versioning, see: API versions.

Response​

Subscription cancelled successfully