SaaS APIsubscriptions

Change subscription tier

View as Markdown

Upgrade or downgrade tier. Owner/billing_admin only. Supports Idempotency-Key. Downgrade with active VKs > new limit returns 409 CONFLICT_VK_QUOTA.

Headers

AuthorizationstringRequired

Bearer {access_token}

X-Workspace-IdstringRequired
Workspace UUID
Idempotency-KeystringOptional
Client UUID for idempotent request

Request

tier (free|pro|team|enterprise|contact), billingPeriod (monthly|yearly)

billingPeriodenumRequired
Allowed values:
tierenumRequired
Allowed values:

Response

data: updated subscription

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error