/api/public/v1/billing/cancelEnd a plan now, or when the paid period runs out.
Before you call
x-auth-user (their pagename or your own external_id) alongside your API key.Idempotency-Key header (1–255 characters, new for every new cancellation) to retry safely: the same key and request returns the first result with Idempotent-Replayed: true and cancels nothing twice; the same key with a different request returns 422; a repeat while the first is still running returns 409.When the plan ends
at_period_end: true: access continues until the current paid period ends.effective_from: ends at that date/time; now or past = immediate, future = access until then.effective_from can't be later than the current subscription's end time — anything later is set to that end time.at_period_end defaults to false.effective_from or at_period_end: true, never both (400).at_period_endbooleanoptionalDefault: false (ends now or at effective_from). true = access continues until the current paid period ends. Do not combine with effective_from.
effective_fromstring (ISO 8601)optionalDate/time the plan ends. Optional — defaults to now. Now or past = immediate; future = access until then. Cannot be later than the current subscription's end time; a later value is set to that end time. Do not combine with at_period_end: true.
referencestringoptionalYour own reference number.
| Field | Type | Description |
|---|---|---|
| at_period_endopt | boolean | Default: false (ends now or at effective_from). true = access continues until the current paid period ends. Do not combine with effective_from. |
| effective_fromopt | string (ISO 8601) | Date/time the plan ends. Optional — defaults to now. Now or past = immediate; future = access until then. Cannot be later than the current subscription's end time; a later value is set to that end time. Do not combine with at_period_end: true. |
| referenceopt | string | Your own reference number. |
{ "success": false, "error": "Send either effective_from or at_period_end, not both." }{ "success": true, "pagename": "johndoe", "status": "canceled", "endsAt": "2026-02-05T10:00:00.000Z" }{ "success": false, "error": "The company owner's plan cannot be canceled via the API; manage it from the company billing settings." }/api/public/v1/billing/cancelDefault: false (ends now or at effective_from). true = access continues until the current paid period ends. Do not combine with effective_from.
Date/time the plan ends. Optional — defaults to now. Now or past = immediate; future = access until then. Cannot be later than the current subscription's end time; a later value is set to that end time. Do not combine with at_period_end: true.
Your own reference number.