Skip to main content
POST
Criar cliente

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Corpo

application/json
externalId
string
obrigatório

O id deste cliente no seu sistema (por exemplo, o id do usuário no seu app). Obrigatório; repetir o mesmo valor devolve o mesmo cliente.

name
string | null

Nome do cliente.

email
string | null

E-mail do cliente.

taxId
string | null

CPF ou CNPJ.

pspRef
string | null

Referência do cliente no meio de pagamento, se você já tiver uma. Normalmente não é preciso enviar.

metadata
object

Dados livres seus, em JSON. Guardados na inscrição.

Resposta

Cliente criado ou já existente.

Quem paga, no nível da sua conta. O externalId é único na conta.

id
string<uuid>

Id do cliente. Não é o id da inscrição.

externalId
string

O id deste cliente no seu sistema.

name
string | null
email
string | null
taxId
string | null

CPF ou CNPJ.

phone
string | null

Telefone de contato, em formato internacional só com dígitos e sem + (por exemplo 5511999999999). Serve para contato e não identifica o cliente.

pspRef
string | null

Referência do cliente no meio de pagamento, quando existe.

createdAt
string<date-time>