Skip to main content

Leave the paid plan (at period end, or now)

POST 

/api/billing/cancel

Admin only.

  • mode=period_end - the plan stays active until current_period_end, then the workspace drops to Free. No renewal invoice is issued, so there is no dunning. Undo with POST /api/billing/resume. This is the same switch as auto_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​

The refreshed billing summary.