Skip to main content
POST
Create a checkout session

Authorizations

Authorization
string
header
required

Paste your secret key as the bearer token: sk_test_… (test) or sk_live_… (live). That is all a normal API call needs. OAuth access tokens from POST /v1/oauth/token also work, but a client id/secret is only for platforms acting on another tenant's behalf, not for your own integration.

Body

application/json
planId
string

Either planId or amount is required.

amount
integer
currency
string
default:NGN
customerEmail
string<email>
customerPhone
string
successUrl
string<uri>
metadata
object

Response

201 - application/json

Created

id
string
token
string
url
string
status
string
kind
enum<string>
Available options:
subscription,
one_time,
topup
amount
integer
currency
string
planId
string | null
createdAt
string