Skip to main content
POST
/
checkout
/
create_client_session
Create a checkout session (client token)
curl --request POST \
  --url https://billing.funnelfox.com/{org_id}/v1/checkout/create_client_session \
  --header 'Content-Type: application/json' \
  --data '
{
  "region": "<string>",
  "integration_type": "fakeintegration",
  "pp_ident": "<string>",
  "external_id": "<string>",
  "email_address": "<string>",
  "country_code": "<string>",
  "client_metadata": {}
}
'
{
  "client_token": "<string>",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Path Parameters

​
org_id
string
required

Organization ID

Body

application/json
​
region
string
required

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

Maximum string length: 64
Pattern: ^[a-z]{1,20}$
​
integration_type
enum<string>
required
Available options:
fakeintegration,
primer,
stripe
​
pp_ident
string
required

Unique identifier of the price point

Maximum string length: 256
Pattern: ^[-A-Za-z_0-9]{1,256}$
​
external_id
string
required

Your unique identifier for the user

Maximum string length: 256
​
email_address
string
required
Maximum string length: 1024
​
country_code
string | null
​
client_metadata
Client Metadata · object

Custom metadata from your client application

Response

200 - application/json

Client token and order ID

​
client_token
string
required
​
order_id
string<uuid>
required