Clientes

Detalhar Cliente

Retorna os dados completos de um cliente, incluindo todos os endereços cadastrados e o histórico de assinaturas.

Cada assinatura vem acompanhada dos itens, dos ciclos de cobrança e das faturas e cobranças de cada ciclo. É a visão consolidada usada na tela de detalhe do cliente.

Case de uso:

Como atendente, quero ver tudo que um cliente possui — assinaturas, ciclos e faturas — em uma única consulta, para responder a um contato de suporte.

GET/v1/customers/:customerId

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

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

Authorizations

bearer

Authorization

string · header · required

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

Escopos requeridos

customers/read

Path Parameters

Name	Type	Required	Description
customerId	string	Required	Customerid

← Anterior

Buscar Cliente por Documento

Atualizar Cliente

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

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

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

Response Examples

200200

{
  "customer": {
    "customerId": "cus_xxx",
    "name": "Alexandre Souza",
    "document": "11144477735",
    "status": "ACTIVE"
  },
  "addresses": [
    {
      "zipCode": "01310100",
      "street": "Avenida Paulista",
      "number": "1000",
      "city": "São Paulo",
      "state": "SP",
      "isDefault": true
    }
  ],
  "subscriptions": []
}

404404

{
    "error": {
        "message": "Cliente não encontrado",
        "code": "CUSTOMER_NOT_FOUND",
        "details": null,
        "timestamp": "2026-07-14T21:39:36.322Z"
    }
}

← Anterior

Buscar Cliente por Documento

Atualizar Cliente