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/billing/plan/checkout

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/billing/plan/checkout
  • Auth: HTTP bearer

Request body

plan'pro' required
interval'monthly' | 'annual' required
organizationIdstring required
aiCreditTier1000 | 2000 | 4000 | 8000 | 12000 | 20000 | 30000 | 40000 | 50000 | 75000 | 100000
successUrlstring
idempotencyKeystring

Response

Checkout result for the plan change.

paymentUrlstring nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.