Change Subscription Plan
Switches org_id's active subscription to plan_id. A pricier plan (by price_cents) applies immediately with a prorated token top-up; a cheaper plan is deferred to the next renewal so the org keeps this period's already-paid-for tokens. See spec Decision 3.
Authorization
OAuth2AuthorizationCodeBearer AuthorizationBearer <token>
In: header
Path Parameters
org_id*Org Id
Format
uuidQuery Parameters
verify_locally?Verify Locally
Default
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/organisations/497f6eca-6276-4993-bfeb-53cbbbba6f08/subscription/change-plan" \ -H "Content-Type: application/json" \ -d '{ "plan_id": "00713021-9aea-41da-9a88-87760c08fa72" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "plan_id": "00713021-9aea-41da-9a88-87760c08fa72", "pending_plan_id": "629d4fe1-0d1e-4644-a391-11a603324978", "status": "string", "current_period_start": "2019-08-24T14:15:22Z", "current_period_end": "2019-08-24T14:15:22Z", "cancel_at_period_end": false, "canceled_at": "2019-08-24T14:15:22Z"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}