Treli API
Docs
Soporte
  1. Clientes
  • Introducción
  • Autenticación
  • Errores
  • Suscripciones
    • Suscripción
    • Crear suscripción
      POST
    • Actualizar suscripción
      POST
    • Cancelar suscripción
      POST
    • Obtener suscripción
      GET
    • Eliminar descuento
      DELETE
    • Pausar suscripción
      POST
    • Reanudar suscripción
      POST
  • Items de suscripción
    • Obtener item de suscripción
      GET
    • Eliminar item de suscripción
      DELETE
    • Actualizar item de suscripción
      POST
    • Crear item de suscripción
      POST
  • Clientes
    • Cliente
    • Crear cliente
      POST
    • Actualizar cliente
      POST
    • Obtener cliente
      GET
  • Cobros
    • Cobro
    • Crear cobro
      POST
    • Registrar cobro parcial
      POST
    • Enviar notificación de cobro
      POST
    • Anular cobro
      POST
    • Marcar como incobrable
      POST
    • Pagar un cobro
      POST
    • Obtener un cobro
      GET
  • Facturas
    • Cargar factura
    • Obtener factura
  • Eventos
    • Evento
    • Tipos de eventos
  1. Clientes

Cliente

Este objeto representa a un cliente en tu cuenta. Utilizalo para crear suscripciones, cobros o facturas, y realizar un seguimiento de los pagos del mismo cliente.

Objeto de suscripción#

Customer
id
string 
read-onlyrequired
Identificador único del objeto.
Example:
cus_MVjtx4BbDdTndKPh8aFdKZuv
email
string <email>
required
La dirección de correo electrónico del cliente. Único para cada cliente y no pueden existir multiples clientes con el mismo correo electrónico
Example:
correo@ejemplo.com
full_name
string 
required
El nombre completo del cliente o el nombre comercial
Example:
John Doe
created_date
string <date-time>
read-onlyrequired
Fecha en la cual se creó el objeto.
Example:
2024-11-15 16:44:50
is_test
boolean 
read-onlyrequired
Tiene el valor false si el objeto existe en modo en producción o el valor true si el objeto existe en modo de prueba
Example:
false
billing_address
object (Billing Address) 
optional
first_name
string 
optional
Nombre del cliente.
last_name
string 
optional
Apellido del cliente.
id_type
enum<string> 
optional
Tipo de identificación del cliente
Allowed values:
CCNITPPCEFOREIGN_NIT
identification
string 
optional
Número de identificación del cliente.
address_1
string 
optional
Dirección de facturación.
address_2
string 
optional
Casa, oficina, apartamento, etc.
phone
string 
optional
El número de teléfono del cliente. Se utiliza para todas las notificaciones de cobro por WhatsApp.
phone_country_code
string 
optional
El indicativo telefónico del cliente, representado por el pais_indicativo. Ejemplo, CO_57. Si no se define, se utiliza el indicativo según el country de la dirección de facturación.
city
string 
optional
Ciudad, distrito, suburbio, pueblo o aldea.
state
string 
optional
Estado, departamento, provincia o región.
postcode
string 
optional
Código postal.
country
string 
optional
Código de país de dos letras (ISO 3166-1 alfa-2).
company
string 
optional
Compañía del cliente.
person_type
enum<string> 
optional
Tipo de persona
Allowed values:
personcompany
regimen_type
enum<string> 
optional
Regimen tributario.
Allowed values:
common_regimesimplified_regime
default_payment_method
string 
read-onlyoptional
El ID del método de pago por defecto del cliente.
is_deleted
boolean 
read-onlyrequired
Tiene el valor false si el cliente ha sido eliminado.
Example:
false
collection_emails
array[string <email>]
optional
Lista de hasta 5 destinatarios adicionales para notificarles sobre los cobros.
Previous
Crear item de suscripción
Next
Crear cliente
Built with