Documentation menu

Request paid plan change

POSThttps://api.instacloud.com/orgs/{orgId}/billing/plan-change

Token scope: account · org — read-only tokens refused (not a GET).

Free → paid takes effect once paid; Pro → Team next UTC day after payment; downgrade at the current paid period end (owner/admin)

Parameters

NameInTypeRequiredDescription
orgIdpathstringyes

Request body

application/json

FieldTypeRequiredDescription
tier"free" | "pro" | "team"yes
idempotencyKeystringyes
expectedFeeCentsintegernoRequired for Pro/Team: amount due now accepted from the options response, excluding tax; zero for a scheduled downgrade. Omit for Free.

Responses

200

Default Response

FieldTypeRequiredDescription
idstringyes
fromTierstringyes
toTierstringyes
status"awaiting_payment" | "scheduled" | "applied" | "failed" | "cancelled"yes
effectiveAtstringyes
includedUsdnumberyes
changeKind"upgrade" | "downgrade"no
renewalAtstringno
cancellablebooleanno
paymentUrlstring | nullno

400

Default Response

FieldTypeRequiredDescription
errorstringyes

403

Default Response

FieldTypeRequiredDescription
errorstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

409

Default Response

FieldTypeRequiredDescription
errorstringyes

503

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown