Skip to main content
POST
Create checkout session
Creates a checkout session with the appropriate payment provider for your region. The response includes a URL where the user completes payment.

Request body

string
required
The plan to subscribe to: STARTER, BUSINESS, or ENTERPRISE.
string
Payment provider to use (stripe, paystack, or flutterwave). If omitted, the provider is selected automatically based on your region. See billing configuration to check your default provider.
string
required
URL to redirect the user to after successful payment.
string
required
URL to redirect the user to if they cancel the checkout.

Response

string
The hosted checkout page URL. Redirect the user to this URL to complete payment.

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
plan
string
required

Plan identifier to subscribe to

success_url
string

URL to redirect after successful checkout

cancel_url
string

URL to redirect on checkout cancellation

Response

Checkout session

checkout_url
string
session_id
string
expires_at
string