Skip to main content
curl -X GET "https://api.chargefy.io/v1/customers/cus_123" \
  -H "Authorization: Bearer {{API_KEY}}"
{
  "id": "cus_123",
  "object": "customer",
  "billing_address": {
    "city": "São Paulo",
    "country": "BR",
    "line1": "Av. Paulista, 1000",
    "line2": null,
    "postal_code": "01310-100",
    "state": "SP"
  },
  "billing_name": null,
  "created_at": "2026-05-16T14:09:27Z",
  "document": "12345678901",
  "document_type": "cpf",
  "email": "nome@email.com",
  "livemode": true,
  "metadata": {
    "reference_id": "ref_456"
  },
  "name": "Cliente Exemplo",
  "phone": "+5511999990000",
  "updated_at": "2026-05-16T15:02:10Z"
}
Retorna um customer pelo ID. Para correlacionar com um ID do seu sistema, armazene o cus_* ao criar o cliente (ou guarde sua chave em metadata.reference_id e busque por email via GET /v1/customers).

Autenticação

A API key da própria organização atua diretamente. A API key de plataforma exige o header Organization: <organization_id> apontando para uma organização conectada ativa.

Parâmetros de caminho

id
string
required
ID do cliente (cus_*).
curl -X GET "https://api.chargefy.io/v1/customers/cus_123" \
  -H "Authorization: Bearer {{API_KEY}}"

Resposta

200 OK com o objeto customer completo. Mesmo shape de POST /v1/customers.
{
  "id": "cus_123",
  "object": "customer",
  "billing_address": {
    "city": "São Paulo",
    "country": "BR",
    "line1": "Av. Paulista, 1000",
    "line2": null,
    "postal_code": "01310-100",
    "state": "SP"
  },
  "billing_name": null,
  "created_at": "2026-05-16T14:09:27Z",
  "document": "12345678901",
  "document_type": "cpf",
  "email": "nome@email.com",
  "livemode": true,
  "metadata": {
    "reference_id": "ref_456"
  },
  "name": "Cliente Exemplo",
  "phone": "+5511999990000",
  "updated_at": "2026-05-16T15:02:10Z"
}

Erros comuns

StatuscodeQuando ocorre
404resource_missingCliente não existe nesta organização (ou foi removido)