Treli API
Docs
Soporte
  1. Suscripciones
  • 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
    • Listar suscripciones
      GET
  • 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
    • Listar clientes
      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
    • Listar cobros
      GET
    • Modificar total del cobro
      POST
    • Modificar items del cobro
      POST
    • Modificar descuentos del cobro
      POST
    • Eliminar descuento
      DELETE
  • Facturas
    • Cargar factura
    • Obtener factura
    • Listar facturas
    • Anular factura
  • Productos
    • Crear producto
    • Actualizar producto
    • Obtener un producto
    • Listar productos
    • Eliminar producto
  • Precios
    • Crear precio
    • Actualizar precio
    • Obtener un precio
    • Listar precios
    • Eliminar precio
  • Eventos
    • Evento
    • Tipos de eventos
  • Catálogo de parámetros por país
    • Colombia
  • Enlaces de pago
    • Crear enlace de pago
  • Sesión de checkout
    • Sesión de checkout
    • Crear sesión de checkout
    • Obtener sesión de checkout
  1. Suscripciones

Listar suscripciones

Developing
GET
/v1/subscriptions
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.treli.co/v1/subscriptions?limit&start_after&start_before&status&created_after&created_before&customer&price' \
--header 'Authorization: Basic Og=='
Response Response Example
{
    "has_more": true,
    "next_cursor": "string",
    "previous_cursor": "string",
    "data": [
        {
            "id": "sub_IiFWdYgq7QIrx1nkvDcOhXqi",
            "customer": "cus_TgfdA2vL9rnWblZM8LtWMsdY",
            "items": [
                {
                    "id": "si_d7d2UrHwSG5A5YkYF7vfZmFf",
                    "name": "Nombre del producto",
                    "unit_price": "20000.00",
                    "quantity": 1,
                    "subtotal": "20000.00",
                    "total": "20000.00",
                    "product": {
                        "id": "prod_GYzZ5BXNRu6DxqQcEPJNoeCk",
                        "name": "Nombre del producto",
                        "description": "string",
                        "status": "active",
                        "product_merchant_id": null,
                        "product_invoicing_id": null,
                        "product_shopify_id": null,
                        "product_woocommerce_id": null,
                        "created_date": "2024-11-15 16:44:50",
                        "image": "http://example.com",
                        "is_test": false,
                        "invoice_settings": {
                            "invoice_tax_id": "12345",
                            "invoice_tax_percentage": "19"
                        }
                    },
                    "price": {
                        "id": "price_zUI6hNgEkX8sOLIUjnB9JpaQ",
                        "unit_price": "20000.00",
                        "pricing_model": "standard",
                        "currency": "COP",
                        "billing_period": "day",
                        "billing_interval": 1,
                        "type": "recurring",
                        "pricing_tiers": null,
                        "ntp_pricing": null,
                        "created_date": "2024-11-15 16:44:50",
                        "active": true,
                        "is_test": false,
                        "product_id": "prod_GYzZ5BXNRu6DxqQcEPJNoeCk"
                    }
                }
            ],
            "discounts": [
                {
                    "id": "sd_aYbDFQaOd7TmBl0I58D5ax8l",
                    "code": "10OFF",
                    "amount": "10000.00",
                    "percent": "10.00",
                    "duration_in_collections": 1,
                    "elapsed_duration": 0
                }
            ],
            "taxes": [
                {
                    "type": "string",
                    "name": "string",
                    "tax_id": "string",
                    "total": "string"
                }
            ],
            "latest_collection": "col_75jaKNHdYNfFpooDaDJKIMtu",
            "subtotal": "20000.00",
            "total": "20000.00",
            "currency": "COP",
            "collection_method": "charge",
            "status": "active",
            "created_date": "2024-11-15 16:44:50",
            "start_date": "2024-11-15 16:44:50",
            "next_renewal_date": "2024-11-15 16:44:50",
            "latest_renewal_date": "2024-11-15 16:44:50",
            "canceled_at_date": "2019-08-24T14:15:22Z",
            "resumes_at": "2019-08-24T14:15:22Z",
            "ended_at_date": "2019-08-24T14:15:22Z",
            "expires_at_date": "2019-08-24T14:15:22Z",
            "paused_at_date": "2019-08-24T14:15:22Z",
            "billing_period": "month",
            "billing_interval": "1",
            "trial_days": 0,
            "payment_method": "string",
            "payment_method_gateway": "wompi",
            "payment_method_type": "card",
            "is_test": false,
            "days_until_due": 1,
            "tag": "string",
            "exclude_from_batch": true,
            "source": "string",
            "meta_data": {
                "user_id": "261993"
            },
            "duration": 1,
            "commitment_periods": 1,
            "cancelation_details": {
                "feedback": "customer_service",
                "comment": "string"
            },
            "first_payment_invoicing": "create",
            "invoice_settings": {
                "invoice_document_id": "string",
                "invoice_cost_center": "string"
            },
            "invoice_retentions": {
                "reteica": "string",
                "retefte": "string"
            },
            "requires_shipping_address": true,
            "payment_settings": null
        }
    ]
}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Query Params

Responses

🟢200Success
application/json
Body

Previous
Reanudar suscripción
Next
Obtener item de suscripción
Built with