Skip to main content
Um customer representa a pessoa física ou jurídica que compra de você. Ele reúne identidade e dados de cobrança — nome, e-mail, telefone, CPF/CNPJ, nome de cobrança e endereço. O identificador do cadastro é o id; o e-mail é obrigatório, mas pode aparecer em mais de um customer da mesma organização. É a ele que se prendem pagamentos, assinaturas, invoices e métodos de pagamento salvos. Na API, cada criação gera um customer novo, exceto quando o documento informado já pertence a outro cadastro ativo. No checkout hospedado, a Chargefy mantém o customer fixado na sessão ou resolve um cadastro existente por CPF/CNPJ e, depois, por e-mail antes de criar outro.

​
Data Object

Este é o formato completo retornado em create, get, update, itens de list e em data.object dos webhooks customer.*.
​
string
Identificador do customer. Usa o prefixo cus_*.
​
string
Sempre "customer".
​
object | null
Endereço de cobrança. Vem null quando não foi informado.
​
string | null
Nome ou razão social usada em cobrança. Vem null quando não foi informado.
​
string
Data de criação em ISO 8601.
​
string | null
CPF ou CNPJ do cliente, apenas dígitos. Vem null quando não foi informado.
​
string | null
Tipo do documento do cliente. Vem null quando não foi informado.
​
string
Email do cliente. É obrigatório, mas não é único dentro da organização atuante.
​
boolean
true em produção; false em ambiente de teste.
​
object
Objeto livre para correlacionar o customer com o seu sistema. Quando vazio, retorna {}.
​
string | null
Nome do cliente. Vem null quando não foi informado.
​
string | null
Telefone do cliente. Vem null quando não foi informado.
​
string | null
Data da última atualização em ISO 8601. Vem null enquanto o customer nunca foi atualizado.

​
Operações

​
Eventos

Mudanças nesse objeto disparam os seguintes eventos: O payload sempre carrega o objeto customer completo em data.object; eventos de update também incluem data.previous_attributes com os valores anteriores dos campos alterados.