Skip to main content
POST
Start a plan change checkout

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Body

application/json
plan
enum<string>
required
Available options:
pro
interval
enum<string>
required
Available options:
monthly,
annual
organizationId
string
required
Minimum string length: 1
aiCreditTier
enum<number>
Available options:
1000,
2000,
4000,
8000,
12000,
20000,
30000,
40000,
50000,
75000,
100000
successUrl
string
Minimum string length: 1
idempotencyKey
string
Minimum string length: 1

Response

Checkout result for the plan change.

paymentUrl
string | null
required

Hosted checkout URL to redirect the customer to. null when the change was applied directly without a payment step.