Cancel a subscription

Cancel a subscription

delete

This endpoint allows cancellation of an existing subscription by ID.

Path parameters

subscription_idinteger · int64Required

Unique numeric identifier of the subscription to be cancelled. This is the subscription ID provided when the subscription was created.

Example: 123456789

Header parameters

Content-TypestringRequired

Media type of the body sent to the API.

Default: application/json

X-Datestring · date-timeRequired

ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ)

X-LoginstringRequired

Merchant X-Login API Key.

AuthorizationstringRequired

Authorization control hash.

X-Idempotency-KeystringOptional

Unique idempotency key for ensuring that the same request is not processed more than once.

Body

application/json

objectOptional

Responses

200

Subscription successfully cancelled

application/json

Responseobject

420

Subscription does not exist

application/json

421

Subscription was already cancelled

application/json

426

Subscription is terminated and cannot be cancelled

application/json

501

Generic Error

application/json

delete

/v3/subscriptions/{subscription_id}

HTTPcURLJavaScriptPython

DELETE /v3/subscriptions/{subscription_id} HTTP/1.1
Host: api-stg.onekeypayments.com
Content-Type: application/json
X-Date: 2025-12-06T01:33:05.711Z
X-Login: text
Authorization: text
Accept: */*
Content-Length: 2

{}

{}