Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

Secret API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Unique key that makes the request safe to retry. Keys expire after 24 hours.

Maximum string length: 255

Body

application/json
type
enum<string>
required
Available options:
individual,
business
external_id
string

Your own identifier for this customer. Must be unique within your account.

Example:

"user_10492"

name
object
email
string<email>
Example:

"alex.morgan@example.com"

phone
string

Phone number in E.164 format. Required for wallet provisioning and 3DS OTP delivery.

Example:

"+34600000000"

metadata
object

Up to 50 key-value pairs for your own reference. Values are strings up to 500 characters.

Example:

Response

Created.

An individual or business that cards are issued to.

id
string
required
read-only

Unique identifier, prefixed with cus_.

Example:

"cus_01JZ8M4X7K"

object
enum<string>
required
read-only

Object type.

Available options:
customer
type
enum<string>
required
Available options:
individual,
business
status
enum<string>
required
Available options:
active,
inactive
created_at
string<date-time>
required
read-only

Time the customer was created.

external_id
string

Your own identifier for this customer. Must be unique within your account.

Example:

"user_10492"

name
object
email
string<email>
Example:

"alex.morgan@example.com"

phone
string

Phone number in E.164 format. Required for wallet provisioning and 3DS OTP delivery.

Example:

"+34600000000"

metadata
object

Up to 50 key-value pairs for your own reference. Values are strings up to 500 characters.

Example:
updated_at
string<date-time>
read-only

Time the customer was last updated.