Skip to main content
DELETE
Esta rota remove um cliente da sua base. O contrato da API classifica a operação como exclusão lógica (soft delete). Use quando o cliente pede para encerrar o cadastro ou quando você precisa limpar registros duplicados.

Quando usar

Antes de chamar

  • Tenha uma chave secreta (sk_) válida, do mesmo ambiente em que o cliente foi criado (Credenciais e ambientes).
  • Tenha o id do cliente.
  • Se o cliente tem assinaturas ativas ou cartões salvos, decida antes o que fazer com eles: cancele as assinaturas em Cancelar assinatura e remova os cartões em Excluir cartão, se for o caso.
A documentação da API não descreve o que acontece com cartões salvos, assinaturas e cobranças de um cliente excluído. Trate esses vínculos de forma explícita, com as rotas próprias de cada recurso, antes de excluir o cliente.

Parâmetros de caminho

string
required
Identificador único do cliente. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.
Esta rota não tem corpo de requisição nem parâmetros de consulta.

Respostas

A resposta de sucesso é 204 sem corpo.
Para o desenvolvedor: não tente ler JSON da resposta 204, o corpo vem vazio. Em Node.js, verifique response.status === 204 (ou response.ok) antes de qualquer response.json().

Erros comuns

Veja também

Guia de clientes

Criação, manutenção e remoção de clientes.

Excluir cartão

Revogar um cartão salvo no cofre.

Ciclo de vida da assinatura

Cancelamento e estorno de assinaturas.

Listar clientes

Encontrar cadastros duplicados.