Start a plan change checkout
Billing
Start a plan change checkout
Applies a plan change or starts hosted checkout. Monthly-to-annual switches apply immediately; annual-to-monthly at renewal. Redirect the customer to paymentUrl when non-null; null means the change applied without a payment step. Rejected while billing is past due; requires the organization owner.
POST
Start a plan change checkout
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Body
application/json
Available options:
pro Available options:
monthly, annual Minimum string length:
1Available options:
1000, 2000, 4000, 8000, 12000, 20000, 30000, 40000, 50000, 75000, 100000 Minimum string length:
1Minimum string length:
1Response
Checkout result for the plan change.
Hosted checkout URL to redirect the customer to. null when the change was applied directly without a payment step.