Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

Use sk_test_ keys for sandbox. Use sk_live_ keys for production. Obtain your key from the dashboard.

Body

application/json
external_ref
string
required

Your internal user ID. Must be unique per tenant.

Maximum string length: 200
Example:

"user_12345"

name
string
required
Maximum string length: 200
Example:

"Acme Corp"

email
string<email>
required
Example:

"billing@acme.ng"

phone
string
Maximum string length: 20
Example:

"+2348012345678"

Response

Customer created

object
enum<string>
Available options:
customer
id
string
Example:

"cus_01JABC..."

external_ref
string

Your own system's user ID. Use this to look up customers by your ID.

Example:

"user_12345"

name
string
Example:

"Acme Corp"

created_at
string<date-time>