Consultar um cliente
GET
Os dados e o endereço de um cliente.
Permissão da chave: customers:read.
header
x-api-key<token>Sua chave de API, criada no painel em Desenvolvedores → Chaves de API.
id*stringO id do cliente (cus_…).
O cliente.
application/json- response
Um cliente, um por CPF ou CNPJ em cada modo.
id*stringname*string|nullemail*string|nullphone*string|nulldocumentType*stringValores aceitos
"CPF""CNPJ"document*stringSó dígitos.
address*|null quando nenhum campo do endereço foi informado.
livemode*booleancreatedAt*stringFormato
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Formato
date-timeupdatedAt*stringFormato
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Formato
date-timecurl -X GET "https://example.com/api/v1/customers/string"{ "id": "cus_01k6g8m2v4x7z9b3c5d7f9h0j2", "name": "Ana Souza", "email": "[email protected]", "phone": "11912345678", "documentType": "CPF", "document": "12345678909", "address": { "zipCode": "01310100", "street": "Avenida Paulista", "number": "1000", "complement": "string", "district": "Bela Vista", "city": "São Paulo", "state": "SP" }, "livemode": true, "createdAt": "2026-10-04T15:30:00.000Z", "updatedAt": "2026-10-04T15:30:00.000Z"}