Skip to main content
POST
Create checkout session
For a paid monthly plan, requests a hosted checkout from an available provider using the registered billing country. Usage-based business plans can instead return activated: true without a hosted checkout; they can still incur usage charges. Staff must approve the billing country before paid plans or usage-based business tiers are enabled. An unapproved country returns HTTP 409 with code: BILLING_COUNTRY_REVIEW_REQUIRED. Complete country review in the signed-in billing page first. Send a provider from the account’s visible_providers. A URL parameter cannot change billing country. Existing paid personal subscriptions must be managed before starting another checkout. Flutterwave refuses monthly checkout if its recurring payment plan is missing. A checkout link is not proof of payment. Refresh the subscription after provider confirmation.

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_key
string
required
cancel_url
string

URL to redirect on checkout cancellation

email
string
provider
enum<string>
Available options:
stripe,
flutterwave
success_url
string

URL to redirect after successful checkout

Response

Checkout session

checkout_url
string
activated
boolean
plan_key
string
message
string