Skip to main content
POST
/
v1
/
sdk
/
customers
curl --request POST \
  --url https://api.example.com/v1/sdk/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "customer@example.com"
}
'
{
  "email": "customer@example.com",
  "externalRef": "auth_user_12345",
  "name": "John Doe",
  "reference": "cus_3c4d5e6f7g8h"
}

Body

application/json

Customer creation data

​
email
string
required

Customer email address (required)

Example:

"customer@example.com"

​
externalRef
string

External reference ID from your auth system to map this customer to an auth user (optional)

Example:

"auth_user_12345"

​
name
string

Customer full name (optional)

Example:

"John Doe"

Response

Customer created successfully

​
email
string
required

Customer email address

Example:

"customer@example.com"

​
name
string
required

Customer full name

Example:

"John Doe"

​
reference
string
required

Customer reference identifier

Example:

"cus_3c4d5e6f7g8h"

​
externalRef
string

External reference ID from your auth system (if set during creation or update)

Example:

"auth_user_12345"

​
purchases
object[]

Active purchases