Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

API key for /api/v1/* endpoints

Body

application/json
email
string
Example:

"john@example.com"

phone
string
Example:

"+2348012345678"

first_name
string
Example:

"John"

last_name
string
Example:

"Doe"

metadata
object

Arbitrary key-value data to attach to the customer

Example:

Response

Customer created successfully.

id
string
required
business_id
string
required
mode
object
required
email
string
required
phone
string
required
first_name
string
required
last_name
string
required
status
enum<string>
required
Available options:
active,
inactive
cc_customer_id
string | null
required
metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
business
object
required