Skip to main content
POST
Change plan

Authorizations

Authorization
string
header
required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Headers

Idempotency-Key
string
required

Identifies one logical mutation across retries.

Required string length: 1 - 255
Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

organizationId
string
required
projectId
string
required

The project being billed.

Body

application/json
category
string
required

Category slug, e.g. analytics or messaging.

Pattern: ^[a-z][a-z0-9_]{0,63}$
planCode
string
required

Plan to subscribe to, e.g. analytics_pro.

Required string length: 1 - 64

Response

The idempotency key resolved to an operation that is already terminal.

failure
null
required
kind
enum<string>
required
Available options:
change_plan,
adjust_fixed_charge_quantity
operationId
string
required

Stable handle for this provisioning action.

resolvedAt
string | null
required
result
object
required
status
string
required

Terminal. The result is authoritative.

Allowed value: "succeeded"
submittedAt
string | null
required