Change the plan

Apply a plan upgrade or schedule a downgrade. Requires a user credential with billing:manage.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organizationId?string

Organization to operate on. Auto-filled from CLI and SDK context when omitted. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).

Length1 <= length

planSlug*string

Length1 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/billing/plan-change" \  -H "Content-Type: application/json" \  -d '{    "planSlug": "string"  }'

{  "billingSubscriptionChangeId": "string",  "billingSubscriptionId": "string",  "status": "string",  "type": "string",  "effectiveAt": "2019-08-24T14:15:22Z",  "invoiceId": "string",  "creditDeficitAmount": "string",  "creditDeficitChargeAmount": "string",  "creditTopUpAmount": "string",  "immediateChargeAmount": "string",  "subscriptionChargeAmount": "string",  "proratedCreditGrantAmount": "string"}

Request Body

Response Body

200application/json

`application/json`