Create customer

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

emailAddress · string<email> · required

The primary email address of the customer.

Example:

"[e-mail]"

firstName · string | null

The first name of the customer.

Example:

"John"

lastName · string | null

The last name of the customer.

Example:

"Doe"

phoneNumber · string<phone> | null

The phone number of the customer. Must include the country code.

Example:

"[phone]"

address · object

The address of the customer.

Show child attributes

Example:

{
  "street": "123 Main St",
  "city": "Springfield",
  "state": "IL",
  "postalCode": "62701",
  "country": "US"
}

shippingAddress · object

The shipping address of the customer.

Show child attributes

metadata · object

Additional metadata for the customer.

Show child attributes

Example:

{
  "order_id": "ord_1JYLo8KerLxWZaQtys6ZQ1xS"
}

locale · enum<string>

The locale preference of the customer.

Available options:

en_US,

fr_FR

Example:

"fr_FR"

clientReferenceId · string

Unique string of your choice to reconcile with your internal system.

Example:

"myclientid-1234"

Response

201 - application/json

Customer successfully created.

id · string · required

The id of the customer.

Example:

"cus_1234567890"

emailAddress · string<email> · required

The primary email address of the customer.

Example:

"[e-mail]"

firstName · string | null · required

The first name of the customer.

Example:

"John"

lastName · string | null · required

The last name of the customer.

Example:

"Doe"

phoneNumber · string<phone> | null · required

The phone number of the customer.

Example:

"[phone]"

livemode · boolean · required

Wether the customer is in live mode or test mode.

Example:

true

isBlocked · boolean · required

Wether the customer is blocked or not.

Example:

true

organizationId · string · required

The id of the organization.

Example:

"org_1234567890"

addressId · string | null · required

The id of the shippingAddress.

Example:

"adr_1234567890"

shippingAddressId · string | null · required

The id of the shippingAddress.

Example:

"adr_1234567890"

metadata · object | null · required

Additional metadata for the customer.

Show child attributes

Example:

{
  "my_system_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
}

createdAt · string<date-time> · required

Example:

"2021-07-22T00:00:00.000Z"

createdBy · string | null · required

The id of the user who created the customer.

Example:

"usr_1234567890"

updatedAt · string<date-time> · required

Example:

"2021-07-22T00:00:00.000Z"

blockedAt · string<date-time> | null · required

Example:

"2021-07-22T00:00:00.000Z"

blockedBy · string | null · required

The id of the user who blocked the customer.

Example:

"usr_1234567890"

updatedBy · string | null · required

The id of the user who last updated the customer.

Example:

"usr_1234567890"

deletedAt · string<date-time> | null · required

Example:

"2021-07-22T00:00:00.000Z"