Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

API key (sk_test_... or sk_live_...)

Body

application/json
external_reference
string
required

Your internal user ID

Example:

"user-123"

first_name
string
required
Example:

"John"

last_name
string
required
Example:

"Doe"

email
string<email>
required
phone_country_code
string
required

International dialing code, + followed by 1 to 4 digits

Pattern: ^\+\d{1,4}$
Example:

"+33"

phone
string
required

Phone number, without the dialing code

Example:

"612345678"

date_of_birth
string<date>
required
Example:

"1990-05-15"

address
string
required
Example:

"123 Main Street"

city
string
required
Example:

"Paris"

state
string
required
Example:

"IDF"

postal_code
string
required
Example:

"75001"

country
string
required

ISO 3166-1 alpha-3 country code

Pattern: ^[A-Z]{3}$
Example:

"FRA"

metadata
object | null

Arbitrary key-value data

Example:

Response

Customer created

success
boolean
Example:

true

data
object
meta
object