Cancel subscription
Schedules cancellation at the end of the billing period, or undoes a scheduled cancellation. Either releases a queued downgrade first; cancelAtPeriodEnd false keeps the current plan renewing.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
identity*string
Length
1 <= length <= 200Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/subscriptions/string/cancel" \ -H "Content-Type: application/json" \ -d '{ "cancelAtPeriodEnd": true, "idempotencyKey": "string" }'{ "id": "string", "identity": "string", "planKey": "string", "status": "string", "periodStart": 0, "periodEnd": 0, "cancelAtPeriodEnd": true, "scheduledChange": { "planKey": "string", "effectiveAt": 0 }, "paymentHold": true, "creditGrants": [], "topupsEnabled": true, "featureMultipliers": [], "pendingChange": { "planKey": "string", "expiresAt": 0, "paymentUrl": "string" }, "featureLimits": [ { "featureKey": "string", "limit": 0, "period": "month", "overage": "block" } ]}