Skip to main content
POST
JavaScript

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
email
string
requerido
name
string
requerido
metadata
Metadata · object

Additional metadata for the customer

phone_number
string | null
preferred_locale
null | enum<string>

The language of the customer emails, a code from GET /locales. With no value, the emails are in English until a checkout or the customer portal sets a language.

Opciones disponibles:
ar,
ca,
zh,
nl,
en,
fr,
de,
he,
id,
it,
ja,
ka,
ko,
ms,
pl,
pt,
ro,
ru,
es,
sv,
th,
tr

Respuesta

business_id
string
requerido
created_at
string<date-time>
requerido
customer_id
string
requerido
email
string
requerido
name
string
requerido
blocked_at
string<date-time> | null

When the merchant blocked this customer. The dashboard shows the "Blocked" badge and the unblock action from it. The list route leaves it empty; only the single-customer route resolves it.

blocklist_entry_id
string | null

Blocklist entry behind blocked_at, so the dashboard can link to it.

metadata
Metadata · object

Additional metadata for the customer

phone_number
string | null
preferred_locale
null | enum<string>

The language of the customer emails. null gives English.

Opciones disponibles:
ar,
ca,
zh,
nl,
en,
fr,
de,
he,
id,
it,
ja,
ka,
ko,
ms,
pl,
pt,
ro,
ru,
es,
sv,
th,
tr
Última modificación el 1 de abril de 2026