Requests the cancellation of an ACTIVE or PENDING Subscription. The request has no body.
Cancellation is asynchronous: the Subscription immediately moves to CANCEL_PENDING and then to CANCELLED once the network confirms. Any other status is refused with 409 subscription_not_cancellable.
POST
/subscriptions/{subscriptionID}/cancel
curl \
--request POST 'https://zim.api.zimconnections.com/subscriptions/subs_BiPtvfzYKwcyNMNvTGmLO/cancel' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-App-Identifier: $API_KEY"
Response examples (201)
{
"message": "Plan cancellation requested"
}
Response examples (401)
{
"statusCode": 401,
"message": "Unauthorized"
}
Response examples (404)
{
"statusCode": 404,
"message": "Record not found",
"error": "Not Found"
}
Response examples (409)
{
"statusCode": 409,
"message": "subscription_not_cancellable",
"error": "Conflict"
}