Skip to content

Create a checkout session (client token)

POST
/checkout/create_client_session
billing.funnelfox.com

Start a new checkout session and obtain a client token for payment.

org_id
required
string

Organization ID

Media typeapplication/json
CheckoutClientSessionIn
object
region
required
Region

Payment service provider region (useful when merchant has multiple payment provider accounts)

string
≤ 64 characters · /^[a-z]{1,20}$/
integration_type
required
IntegrationEnum
string
one of fakeintegration primer stripe
pp_ident
required
price point ident

Unique identifier of the price point

string
≤ 256 characters · /^[-A-Za-z_0-9]{1,256}$/
external_id
required
Customer Id

Your unique identifier for the user

string
≤ 256 characters
email_address
required
Email Address
string
≤ 1024 characters
country_code
string
nullable
client_metadata
object
Client Metadata

Custom metadata from your client application

Show 1 propertyHide property
key
additional properties
any

200 Client token and order ID

Section titled “200”
Media typeapplication/json
CheckoutClientSessionOut
object
client_token
required
Client Token
string
order_id
required
Order Id
string format: uuid