Treli API
Docs
Soporte
  1. Items de suscripción
  • 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. Items de suscripción

Obtener item de suscripción

Developing
GET
/v1/subscription_items/{id}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.treli.co/v1/subscription_items/' \
--header 'Authorization: Basic Og=='
Response Response Example
{
    "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"
    }
}

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 *****************
Path Params
id
string 
required
Identificador único del objeto

Responses

🟢200Success
application/json
Body
id
string 
read-onlyrequired
Identificador único del objeto.
Example:
si_d7d2UrHwSG5A5YkYF7vfZmFf
name
string 
read-onlyrequired
Nombre del producto del producto, al momento de asociarlo a la suscripción.
Example:
Nombre del producto
unit_price
string 
optional
Precio unitario a cobrar del item. Al asociar un precio a un object, si no se define, se utiliza el precio unitario configurado en el precio.
Example:
20000.00
quantity
integer 
required
Cantidad a cobrar del item.
>= 1
Example:
1
subtotal
string 
read-onlyoptional
Subtotal a cobrar del item antes, antes de descuentos.
Example:
20000.00
total
string 
read-onlyoptional
Total a cobrar del item, despues de descuentos.
Example:
20000.00
product
object (Producto) 
read-onlyoptional
Producto asociado al item.
id
string 
read-onlyrequired
Identificador único del objeto.
Example:
prod_GYzZ5BXNRu6DxqQcEPJNoeCk
name
string 
required
El nombre del producto, visible para el cliente.
Example:
Nombre del producto
description
string  | null 
optional
Descripción del producto, visible para el cliente. Utiliza este campo para guardar opcionalmente una explicación detallada del producto que se vende.
status
enum<string> 
required
Estado del producto.
Allowed values:
activearchived
Example:
active
product_merchant_id
string  | null 
optional
Identificador interno del producto. Esto puede ser un ID interno que te ayude a identificar el producto en tu sistema.
Example:
null
product_invoicing_id
string  | null 
optional
Identificador del producto en tu sistema contable. Es requerido si haces uso de la automatización contable en Treli para la generación automática de facturas.
Example:
null
product_shopify_id
string  | null 
optional
Identificador del producto en tu tienda de Shopify. Es requerido si haces uso de la integración con Shopify para la generación automática de pedidos.
Example:
null
product_woocommerce_id
string  | null 
optional
Identificador del producto en tu tienda de WooCommerce. Es requerido si haces uso de la integración con WooCommerce para la generación automática de pedidos.
Example:
null
created_date
string <date-time>
read-onlyrequired
Fecha y hora en la cual se creó el objeto.
Example:
2024-11-15 16:44:50
image
string <uri> | null 
optional
URL de la imagen del producto, visible para el cliente.
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
invoice_settings
object  | null 
optional
Objeto con ajustes de facturación especificos para el producto. Unicamente disponible si haces uso de la automatización contable en Treli para la generación automática de facturas.
price
object (Precio) 
read-onlyoptional
Precio asociado al item.
id
string 
read-onlyrequired
Identificador único del objeto.
Example:
price_zUI6hNgEkX8sOLIUjnB9JpaQ
unit_price
string  | null 
optional
El precio unitario a cobrar, representado como una cadena flotante con dos decimales. Solo se configura si pricing_model=standard
Example:
20000.00
pricing_model
enum<string> 
required
Describe cómo calcular el precio. Puede ser standard, graduated, volume o ntp. standard indica que el valor unitario (especificado en unit_price) se cobrará por unidad de cantidad. graduated calcula el valor de manera escalonada según el rango de unidades (especificado en pricing_tiers). volume calcula el valor por unidad según el total de unidades (especificado en pricing_tiers). ntp permite que tu cliente defina el valor total a pagar (especificado en ntp_pricing).
Allowed values:
standardgraduatedvolumentp
Example:
standard
currency
enum<string> 
required
Código de moneda ISO de tres letras, en mayúsculas.
>= 3 characters<= 3 characters
Allowed values:
COPUSDBRLMXNPENARSCLP
Example:
COP
billing_period
enum<string>  | enum<null> 
optional
Especifica la frecuencia de facturación. Requerido si type=recurring
Allowed values:
dayweekmonthyear
Example:
month
billing_interval
integer  | null 
optional
Especifica la el intervalo del periodo. Requerido si type=recurring
>= 1
Example:
1
type
enum<string> 
required
one_time o recurring dependiendo de si el precio es por una compra única o una compra recurrente (suscripción)
Allowed values:
recurringone_time
Example:
recurring
pricing_tiers
null 
optional
Example:
null
ntp_pricing
null 
optional
Example:
null
created_date
string <date-time>
read-onlyrequired
Fecha y hora en la cual se creó el objeto.
Example:
2024-11-15 16:44:50
active
boolean 
required
Si el precio se puede utilizar para nuevas compras
is_test
boolean 
required
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
product_id
string 
read-onlyrequired
El ID del producto al que está asociado este precio.
Example:
prod_GYzZ5BXNRu6DxqQcEPJNoeCk
Previous
Reanudar suscripción
Next
Eliminar item de suscripción
Built with