Leave the paid plan (at period end, or now)
POST/api/billing/cancel
Admin only.
mode=period_end- the plan stays active untilcurrent_period_end, then the workspace drops to Free. No renewal invoice is issued, so there is no dunning. Undo withPOST /api/billing/resume. This is the same switch asauto_renew=false. A period that has already ended (overdue) drops to Free immediately and its unpaid renewal is voided.mode=now- Free immediately. The unused remainder of the current paid period is NOT refunded to the card; it is credited to the wallet (meta.credit_cents), remaining time x the price actually paid.
Request
Responses
- 200
- 401
- 403
- 422
The refreshed billing summary.
Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).
Authenticated but not allowed.
Not on a paid plan, or an invalid mode.