Referencia APICustomers

Obtener un cliente

Obtén los detalles de un cliente. Puedes buscar por id del cliente (formato cus_xxx) o por user_id (formato usr_xxx) usando el query parameter.

Authentication

X-SECRET-KEYstring
Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Path parameters

idstringRequired

ID del cliente (formato cus_xxx)

Query parameters

user_idstringOptional

(Alternativa) Buscar por ID de usuario en lugar del ID de cliente

Response

Detalles del cliente
idstringOptional

ID único del cliente

user_idstringOptional
ID del usuario asociado
emailstringOptionalformat: "email"
Email del cliente
namestringOptional
Nombre del cliente
phonestring or nullOptional

Número de teléfono

addressstring or nullOptional

Dirección

nitstring or nullOptional

Número de identificación tributaria

metadatamap from strings to any or nullOptional
Metadata personalizada
test_clock_idstring or nullOptional
ID del test clock asignado al Customer. Solo puede usarse con una llave de un Sandbox nombrado.