Skip to main content
POST
Preview Subscription Change

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null

Path Parameters

workspace_id
string<uuid>
required

Body

application/json
billing_interval
enum<string>
required
Available options:
month,
year
plan_key
enum<string>
required
Available options:
pro,
team
seat_quantity
integer
default:1
Required range: 1 <= x <= 10000

Response

Successful Response

immediate_transaction
Immediate Transaction · object | null
next_transaction
Next Transaction · object | null
recurring_transaction_details
Recurring Transaction Details · object | null