Skip to main content
POST
Create a new customer (v2)

Body

application/json
firstName
string
required

Customer's first name

Example:

"John"

email
string<email>
required

Customer's email address

Example:

"john.doe@example.com"

lastName
string

Customer's last name

Example:

"Doe"

phoneNumber
string

Customer's phone number

Example:

"+1234567890"

displayName
string

Display name for the customer

Example:

"Johnny"

accountName
string

Account name associated with the customer

Example:

"John Doe's Account"

notes
string

Free-form notes about the customer

Example:

"VIP customer"

notificationOptions
object

Customer notification preferences

taxId
string | null

Customer tax identifier (e.g. RFC)

Maximum string length: 50
Example:

"VTH981105F90"

billingAddress
object | null

Billing address managed through the customer endpoints (no standalone address CRUD).

Response

Customer created successfully

id
string<uuid>

Unique customer identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

merchantId
string<uuid> | null

Merchant that owns this customer

Example:

"123e4567-e89b-12d3-a456-426614174111"

sourceId
string<uuid> | null

Legacy copy-on-write source customer id (always null for new customers)

Example:

null

firstName
string

Customer's first name

Example:

"John"

lastName
string

Customer's last name

Example:

"Doe"

email
string<email>

Customer's email address

Example:

"john.doe@example.com"

phoneNumber
string

Customer's phone number

Example:

"+1234567890"

displayName
string | null

Display name for the customer

Example:

"Johnny"

accountName
string | null

Account name associated with the customer

Example:

"John Doe's Account"

notes
string | null

Free-form notes about the customer

Example:

"VIP customer"

active
boolean

Whether the customer is active

Example:

true

notificationOptions
object

Customer notification preferences

createdAt
string<date-time>

Customer creation timestamp

Example:

"2025-01-15T10:00:00.000Z"

updatedAt
string<date-time>

Customer last update timestamp

Example:

"2025-01-15T10:00:00.000Z"

taxId
string | null

Customer tax identifier (e.g. RFC)

Maximum string length: 50
Example:

"VTH981105F90"

billingAddress
object | null

Billing address managed through the customer endpoints (no standalone address CRUD).