Clientes

Remover Cliente

Remove um cliente da sua conta.

DELETE/v1/customers/:customerId

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

A exclusão é bloqueada quando o cliente possui assinaturas recorrentes vinculadas, retornando erro 400 (CUSTOMER_HAS_ACTIVE_SUBSCRIPTIONS). Cancele as assinaturas antes de excluir.

Case de uso:

Como plataforma, quero remover um cadastro criado por engano, garantindo que clientes com assinaturas ativas não sejam apagados por acidente.

Authorizations

bearer

Authorization

string obrigatório

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

customers/delete

Path Parameters

customerIdstringobrigatório

Customerid

← Anterior

Atualizar Cliente

Listar assinaturas

const url = 'https://sandbox.validapay.com.br/v1/customers/:customerId';

const options = {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200▾

JSON

{
  "success": true
}

400▾

JSON

{
    "error": {
        "message": "Cliente possui assinaturas vinculadas e não pode ser excluído",
        "code": "CUSTOMER_HAS_ACTIVE_SUBSCRIPTIONS",
        "details": null,
        "timestamp": "2026-07-14T21:39:36.322Z"
    }
}

← Anterior

Atualizar Cliente

Listar assinaturas