Cancel subscription

Cancel a subscription. For currently active subscriptions, subscription will be scheduled to end at end of current billing period. For upcoming subscriptions, subscription will be deleted.

POST /external/subscriptions/{id}/cancel

Cancel subscription

cURL

curl --request POST \
  --url https://platform.runonatlas.com/external/subscriptions/{id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "externalCustomerId": "external-customer-id-123"
}
'

Authorizations

x-api-key · string · header · required

You can obtain this key from the Atlas dashboard. It must be of type secret

Path Parameters

id · string · required

The Atlas subscription ID

Minimum string length: 1

Example:

"atlas-internal-subscription-id-123"

Body

application/json

externalCustomerId · string · required

The external ID of the customer (e.g. the customer ID in your system)

Minimum string length: 1

Example:

"external-customer-id-123"

type · enum<string> · required

Available options: active, upcoming

Response

204

The subscription has been canceled.