Pular para o conteúdo principal
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<email> | null

E-mail do cliente.

phone
string | null
taxId
string | null

CPF ou CNPJ.

country
string | null

País do cliente, em código ISO de duas letras (BR, US). Hoje a venda é no Brasil; venda internacional está em breve.

Exemplo:

"BR"

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
obrigatório

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

Pattern: ^cus_[0-9A-Za-z]{22}$
Exemplo:

"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV"

externalId
string
obrigatório

O id deste cliente no seu sistema.

stage
enum<string>
obrigatório
Opções disponíveis:
lead,
converted
convertedAt
string<date-time> | null
obrigatório
conversionPaymentId
string | null
obrigatório
Pattern: ^pay_[0-9A-Za-z]{22}$
Exemplo:

"pay_585vbbvnwDyuyeA3MTOitd"

createdAt
string<date-time>
obrigatório
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.