Documentation menu

Get plan change options

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

Token scope: account · org — read-only tokens allowed.

Read paid-plan change availability, current subscription prices and an authorized pending retry

Parameters

NameInTypeRequiredDescription
orgIdpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
enabledbooleanyes
canManagebooleanyes
pendingobject | nullyes
pending.idstringyes
pending.fromTierstringyes
pending.toTierstringyes
pending.status"awaiting_payment" | "scheduled" | "applied" | "failed" | "cancelled"yes
pending.effectiveAtstringyes
pending.includedUsdnumberyes
pending.changeKind"upgrade" | "downgrade"no
pending.renewalAtstringno
pending.cancellablebooleanno
pending.paymentUrlstring | nullno
retryKeystring | nullyes
optionsobject[]yes
options.tier"free" | "pro" | "team"yes
options.feeCentsintegeryes
options.currency"usd"yes
options.includedUsdnumberyes
options.effectiveAtstringno
options.renewalAtstringno
options.renewalFeeCentsintegerno
options.changeKind"upgrade" | "downgrade"no

403

Default Response

FieldTypeRequiredDescription
errorstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

503

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown