Skip to main content
DELETE
Excluir um cliente
Exclui o cadastro quando os vínculos existentes permitem. Esta operação não estorna pagamentos nem cancela assinaturas. Requer customers:write ou write. Veja campos, relacionamentos e eventos.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID público do cliente na conta.

Pattern: ^cus_[a-z0-9]{16}$

Response

Operação concluída

id
string
required

Identificador público estável. Use o valor retornado pela API nas consultas e relacionamentos; não derive IDs de nomes.

Pattern: ^cus_[a-z0-9]{16}$
city
string | null
required

Cidade do cliente; null quando ausente.

country
string | null
required

País informado no cadastro; null quando ausente.

created_at
string<date-time>
required

Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura.

currency
string | null
required

Moeda dos indicadores do cliente. Pode ser null. Somente leitura.

document
string | null
required

Documento do cliente como string, preservando zeros à esquerda; null quando ausente.

document_type
string | null
required

Tipo do documento informado, como cpf ou cnpj; null quando ausente.

email
string | null
required

Email do cliente. Obrigatório e não vazio na criação; convertido para minúsculas ao criar.

email_marketing_status
string | null
required

Situação de email marketing: subscribed, unsubscribed, archived, requires_verification, invalid_email ou bounced.

external_id
string | null
required

Identificador do cliente no seu sistema. Pode ser null. Não substitui o id da Hubfy.

first_name
string | null
required

Primeiro nome; null quando ausente.

last_name
string | null
required

Sobrenome; null quando ausente.

metadata
object
required

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

mrr_cents
integer
required

Receita recorrente mensal registrada para o cliente, em centavos. Somente leitura.

name
string | null
required

Nome do cliente. Obrigatório e não vazio na criação.

object
string
required

Tipo do objeto retornado. O valor é fixo para este recurso.

Allowed value: "customer"
phone
string | null
required

Telefone do cliente como string; null quando ausente.

region
string | null
required

Estado ou região do cliente; null quando ausente.

total_revenue_cents
integer
required

Receita acumulada registrada para o cliente, em centavos. Não deve ser enviada em criação ou atualização.

updated_at
string<date-time>
required

Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura.