Ir al contenido principal

¿Cómo crear suscripciones vía API en Treli?

Escrito por Olainer
Actualizado hace más de 2 semanas

A continuación encontrarás una guía clara para crear suscripciones utilizando el endpoint oficial de Treli:

1. Endpoint: Crear suscripciones.

2. Autenticación

Proporciona tu clave API como nombre de usuario de autenticación básica. No necesita proporcionar una contraseña.

3. Estructura del Body

Para crear una suscripción, debes enviar un JSON con la siguiente estructura base:

{
"customer": "cus_xxx",
"items": [
{
"unit_price": "20000.00",
"quantity": 1,
"price": "price_xxx"
}
],
"currency": "COP",
"collection_method": "collect",
"trial_days": 0,
"payment_method": "string",
"days_until_due": 1
}

4. Parámetros principales

  • Customer: ID del cliente en Treli.

    • Ejemplo: "cus_TgfdA2vL9rnWblZM8LtWMsdY"

  • Currency: Código de moneda ISO de tres letras, en mayúsculas.

    • Ejemplo: COP

  • Price: El ID del objeto de precio.

    • Ejemplo: price_ TgfdA2vL9rnWblZM8LtWMsdY

  • Items: Lista de productos o planes a suscribir:

    • unit_price: valor del plan

    • quantity: cantidad

    • price: ID del precio (plan creado previamente)

  • collection_method: Define cómo se cobra la suscripción:

    • "charge" → cobro automático

    • "collect" → Envía notificaciones de cobro al cliente para que la pague manualmente

  • payment_information: Si collection_method=charge, payment_method=null, y recolectas la información de pago del cliente desde tu servidor, envíala para cobrar al cliente automáticamente.

5.Respuesta esperada

Si la creación es exitosa, recibirás un objeto con:

  • id: ID de la suscripción

  • status: estado (ej: active)

  • next_renewal_date: próxima renovación

  • customer: cliente asociado

Además, se generan eventos automáticamente como:

  • subscription.created

  • collection.created

  • transaction.created

¿Ha quedado contestada tu pregunta?