HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Objeto Customer

El cliente: la persona o empresa a la que se le cobra.

Cliente de la organización: la persona o empresa a la que se le cobra.

Es el punto de partida de la integración: las Subscriptions y las Invoices se crean siempre asociadas a un Customer, y los medios de pago quedan guardados a su nombre.

Para referenciarlo sirve tanto el identificador que Toku devuelve al crearlo como el external_id con el que lo conoce la organización integrada.

Atributos


agent_phone_number string
Número de teléfono del agente por defecto.


default_agent string
Correo del agente por defecto que contactará al cliente cuando se abra un ticket.


default_receipt_type string
Tipo de documento tributario que se emitirá por defecto para el cliente.

Valores posibles: bill, invoice, no_receipt.


external_id string
Identificador externo del cliente definido por la organización. Por defecto, las organizaciones usan el government_id como identificador externo del cliente.


fiscal_regime string
Régimen fiscal del cliente, requerido para generar el recibo CFDI (México).


government_id string
Identificador tributario o personal del cliente según su país. Por ejemplo, el RUT de una persona en Chile: 18.579.787-K.


id string
Identificador público del cliente.


mail string
Correo electrónico del cliente.


metadata object
Campos adicionales definidos por cada organización para el cliente.


name string
Nombre del cliente.


pac_mandate_id string
Identificador del mandato PAC (Pago Automático de Cuentas) asociado al cliente.


phone_number string
Número de teléfono del cliente.


rfc string
RFC del cliente (México); si está presente, la deuda generará el documento tributario correspondiente.


secondary_emails array of string
Lista de correos electrónicos secundarios del cliente.


send_mail boolean
Determina si se debe emitir el webhook 'invoice.no_payment_method' al crear el cliente.


silenced_until string (date-time)
Fecha y hora en que expira el silenciamiento del cliente. Si es null, el cliente no está silenciado.


tax_zip_code string
Código postal tributario del cliente, requerido para generar el recibo CFDI (México).

Ejemplo

{
  "agent_phone_number": "+56990220640",
  "default_agent": "[email protected]",
  "default_receipt_type": "bill",
  "external_id": "18579878K",
  "fiscal_regime": "601",
  "government_id": "18579878K",
  "id": "cus_ejC08yLqOWoFhVx4Fx42E3IR9X50tNx2",
  "mail": "[email protected]",
  "metadata": {
    "car_brand": "Toyota",
    "car_model": "Yaris"
  },
  "name": "Jon Snow",
  "pac_mandate_id": "18547404k",
  "phone_number": "+56987654321",
  "rfc": "EKU9003173C9",
  "secondary_emails": [
    "[email protected]",
    "[email protected]"
  ],
  "send_mail": false,
  "silenced_until": "2026-01-20T00:00:00Z",
  "tax_zip_code": "78187"
}