Skip to main content
POST /v1/customers  ·  Requer o escopo customers:write
Cria um cliente na sua conta. Vincule um a um checkout via customer_id para não reenviar os dados do comprador a cada vez.

Parâmetros do corpo

string
obrigatório
Nome completo do cliente ou razão social. De 1 a 160 caracteres.
string
obrigatório
E-mail válido, até 320 caracteres. Armazenado em minúsculas. Deve ser único na sua conta.
string
Telefone, de 1 a 32 caracteres. Recomenda-se o formato E.164 (+5511999999999).
string
CPF ou CNPJ, de 1 a 32 caracteres. Enviado como veio — só dígitos ou formatado.
object
Pares chave–valor livres para seu uso. Retornados em toda representação do cliente.
Campos desconhecidos causam 400 (invalid_request).

Requisição

cURL

Resposta

201 Created com o objeto de cliente.

Erros

Objeto de cliente

string
ID do cliente, com prefixo cus_.
string
Sempre "customer".
string
Nome completo ou razão social.
string
E-mail, em minúsculas.
string | null
Telefone, ou null.
string | null
CPF ou CNPJ, ou null.
string
active ou inactive. Novos clientes nascem active.
object
Seus metadados. {} se nada foi definido.
string
Data/hora de criação em ISO 8601.
string
Data/hora da última alteração em ISO 8601.