Buscar Cliente por ID - Upag Documentation

Retorna as informações completas de um cliente específico pelo seu ID.

Endpoint

curl https://api.upag.io/v1/customers/cus_ahwDXrgYvur89iPs \
  -H "Authorization: Bearer {token}"

import { Upag } from 'upag';

const upag = new Upag('sk_test_your_api_key');

const customer = await upag.customers.retrieve('cus_ahwDXrgYvur89iPs');

Parâmetros

string

required

ID único do cliente, começando com cus_.

Resposta

Response

{
  "id": "cus_ahwDXrgYvur89iPs",
  "livemode": false,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+5511999999999",
  "taxId": "12345678900",
  "line1": "Rua Example, 123",
  "line2": "Apto 45",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "zipCode": "01234567",
  "createdAt": 1731622178441,
  "updatedAt": 1731622178441
}