true keeps access until the period ends. Defaults to false (immediate).
Your own reference number.
POST
/api/public/v1/billing/cancelRequires x-auth-token
Cancel a plan
End a plan now, or when the paid period runs out.
Identify the member with the `x-auth-user` header (their pagename or username) alongside your API key — this is whose subscription is canceled. The company owner's plan cannot be canceled via the API; manage it from the company billing settings.
Body fields
at_period_endbooleanoptionaltrue keeps access until the period ends. Defaults to false (immediate).
referencestringoptionalYour own reference number.
| Field | Type | Description |
|---|---|---|
| at_period_endopt | boolean | true keeps access until the period ends. Defaults to false (immediate). |
| referenceopt | string | Your own reference number. |
Responses
200OKThe cancellation is recorded.
{ "success": true, "pagename": "johndoe", "status": "canceled", "endsAt": "2026-02-05T10:00:00.000Z" }409Company ownerThe company owner's plan cannot be canceled via the API.
{ "success": false, "error": "The company owner's plan cannot be canceled via the API; manage it from the company billing settings." }POST
/api/public/v1/billing/cancelResponseNot sent yet