v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-billing

Update Subscription Endpoint

Update an org's subscription: upgrade/downgrade or cancel.

  • If plan_id is provided, changes the plan.
  • If cancel_now is true, cancels immediately.
  • If cancel_at_period_end is true, schedules cancel at period end.
post/v1/orgs/{org_id}/billing/subscriptions:update

Path parameters

org_idstring required

Request body

plan_idstring nullable
cancel_at_period_endboolean nullable
cancel_nowboolean nullable

Response

Successful Response

{"stackTrail":"paths:/v1/orgs/{org_id}/billing/subscriptions%3Aupdate:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}