Cancel Subscription

POST

/subscriptions/cancel

Cancels a subscription immediately.

Provide either subscriptionId or domain — at least one is required.

By subscription ID

{ "subscriptionId": "sub_V2M9KP3XAQZL" }

By domain name

{ "domain": "acmecorp.com" }

Note: Cancellation takes effect immediately. Data is retained until the period end date.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Subscription cancelled successfully

Bodyapplication/json

🟠401Unauthorized

🟠400Bad Request

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/subscriptions/cancel' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "subscriptionId": "sub_V2M9KP3XAQZL",
    "domain": "acmecorp.com"
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Subscription cancelled successfully",
    "data": null,
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

Modified at 2026-08-06 06:20:56

Renew Subscriptions

Toggle Auto-Renewal

Cancel Subscription

By subscription ID#

By domain name#

Request

Responses

By subscription ID

By domain name