Skip to main content
POST
Request paid plan change

Authorizations

Authorization
string
header
required

Session access JWT or an API token (insta_<prefix>_<secret>).

Path Parameters

orgId
string<uuid>
required

Body

application/json
tier
required
Available options:
free
idempotencyKey
string
required
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$
expectedFeeCents
integer

Required for Pro/Team: amount due now accepted from the options response, excluding tax; zero for a scheduled downgrade. Omit for Free.

Required range: 0 <= x <= 9007199254740991

Response

Default Response

id
string<uuid>
required
fromTier
string
required
toTier
string
required
status
required
Available options:
awaiting_payment
effectiveAt
string<date-time>
required
includedUsd
number
required
changeKind
Available options:
upgrade
renewalAt
string<date-time>
cancellable
boolean
paymentUrl
string<uri> | null