GET /api/v1/customers/:id

Retorna os detalhes de um cliente específico pelo ID

Recupera as informações completas de um cliente, incluindo metadados e dados da organização.

​

Autenticação

Requer Organization Access Token (OAT) via header Authorization: Bearer. Escopos necessários: web:read, web:write, customers:read ou customers:write.

​

Parâmetros de Caminho

id · string · required

ID único do cliente

​

Resposta

id · string

ID único interno do cliente no Chargefy.

email · string

Email do cliente.

name · string

Nome do cliente.

external_id · string

ID externo associado ao cliente (se informado).

user_metadata · object

Metadados personalizados associados ao cliente.

organization_id · string

ID da organização à qual o cliente pertence.

organization · object

Objeto com dados da organização (id, name, slug, avatar_url).

created_at · string

Data e hora de criação no formato ISO 8601.

updated_at · string

Data e hora da última atualização no formato ISO 8601.

​

Exemplo

cURL

curl -X GET https://api.chargefy.io/api/v1/customers/cus_def456 \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "id": "cus_def456",
  "email": "[e-mail]",
  "name": "João Santos",
  "user_metadata": {
    "source": "api",
    "plan": "pro"
  },
  "organization_id": "org_xyz",
  "organization": {
    "id": "org_xyz",
    "name": "Minha Empresa",
    "slug": "minha-empresa",
    "avatar_url": null
  },
  "created_at": "2026-03-12T10:00:00Z",
  "updated_at": "2026-03-12T10:00:00Z"
}