Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
customers

Arquiva um cliente específico através do ID.

Esta operação irá mover o cliente para uma área especial da plataforma onde não poderá receber novas assinaturas ou sofrer alterações, porém seu histórico será mantido.

Todas as assinaturas e faturas pendentes serão canceladas automaticamente.

delete/v1/customers/{id}

Path parameters

idinteger required

ID do cliente que deverá ser arquivado.

Response

Cliente arquivado com sucesso.

idinteger required

ID do cliente

namestring required

Nome do cliente

emailstring

E-mail do cliente

registry_codestring

CPF ou CNPJ do cliente

codestring

Código opcional para referência via API

notesstring

Observações adicionais internas sobre o cliente

status'active' | 'inactive' | 'archived' required

Status do cliente

created_atstring required

Data e hora do cadastro do cliente

updated_atstring required

Data e hora da última atualização do cliente

metadataobject

Metadados do cliente