Skip to main content
PATCH
Change subscription plan

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Headers

x-client-id
string
required

Client identifier for the company in the request.

Example:

"client_abc123"

Path Parameters

uuid
string<uuid>
required

Body

application/json
new_plan_uuid
string<uuid>
required

UUID of the plan to switch to.

Example:

"plan-uuid-..."

immediately
boolean | null

When true, the plan changes now. When false (default), it changes at the next billing date.

Example:

false

Response

Plan change scheduled or applied

data
object