Skip to main content
POST

Authorizations

Authorization
string
header
required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Body

application/json

Customer creation data

email
string<email>
required
metadata
object
required
description
string
Maximum string length: 1000
Pattern: ^[\p{L}\p{N}\s.,'"&\/()+:%;?!@#_[\]\-]*$
externalRef
string
Maximum string length: 50
name
string
Maximum string length: 100
Pattern: ^[\p{L}\p{N} .,'"&\/()+:\-]*$
telephone
Pattern: ^\+[1-9]\d{6,14}$

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