Atributos

id nullable string
Identificador único del Customer.

external_id string
Identificador único del Customer definido por la Organización.

government_id string
Identificador personal del Customer según su nacionalidad.

mail string
Correo que se utilizará para contactar al Customer.

name nullable string
Nombre por el cual nos referimos al Customer en los mensajes.

phone_number nullable string
Número de teléfono del Customer para contactarlo por SMS y Whatsapp.

pac_mandate_id nullable string
Identificador del mandato que se pondrá al inscribir el PAC asociado al Customer.

default_agent nullable string
Correo del agente que tendrá asignado por defecto el Customer en caso de que este responda alguno de los mensajes enviados a través de la plataforma.

send_mail nullable boolean
Flag que nos indica si quieres iniciar el envío automático de recordatorios de inscripción de medio de pago al crear el customer. Se le enviará con la secuencia "Mensajes automáticos para registro de medios de pago".

agent_phone_number nullable string
Teléfono del agente asignado.

silenced_until nullable date-time
Fecha hasta la cual será silenciado el Customer. No recibirá mensajes hasta después de la fecha seleccionada.

metadata nullable json
Valores adicionales específicos de cada Customer. Son tratados como valores de texto y que no pueden tener más de 256 caracteres cada uno. Debes agregarlos en la webapp de Toku antes de poder utilizarlos aquí.

secondary_emails nullable array
Lista de los emails secundarios a los que se va a reenviar la mensajería que se envíe al customer.

default_receipt_type 🧾 nullable string
Tipo de recibo a emitir por defecto para este Customer. Puede tomar los valores bill o invoice para hacer referencia a facturas o boletas respectivamente.

rfc 🇲🇽 🧾 nullable string
Registro Federal de Contribuyentes de México.

tax_zip_code 🇲🇽 🧾 nullable string
Código postal del domicilio para México.

fiscal_regime 🇲🇽 🧾 nullable string
Régimen fiscal del Customer.

Ejemplo


{
  "id": "cus_lq1wGjwgFyqQm4ACZx0QjE84qKm8fffa",
  "external_id": "18579878K",
  "government_id": "18579878K",
  "name": "Jon Snow",
  "mail": "Joh@snow.got",
  "phone_number": "+56987654321",
  "silenced_until": null,
  "default_agent": null,
  "agent_phone_number": null,
  "pac_mandate_id": null,
  "send_mail": false,
  "default_receipt_type": null,
  "rfc": null,
  "tax_zip_code": null,
  "fiscal_regime": null,
  "secondary_emails": [],
  "metadata":{
    "variable1": "valor",
  }
}

📘
Identificadores
Los campos external_id, government_id y mail pueden ser usados como identificador único de tus Customer. Por defecto se tomará el government_id como identificador único. Haznos saber si necesitas cambiarlo. Los campos que no sean identificador único pasan a ser opcionales.