Objeto Subscription

Producto o servicio que la organización le presta a un Customer, y el vínculo por el que se le cobra.

Las Invoices dependen siempre de una Subscription: si es recurrente, Toku las genera por su cuenta según la recurrencia configurada; si no lo es, las carga la organización.

El product_id identifica a la Subscription dentro de la Account de cobro y no se repite en ella, así que sirve para referenciarla sin conocer su identificador de Toku.

Atributos

amount number
Monto de las deudas generadas por la suscripción, expresado en la moneda indicada por currency_code.

currency_code string
Moneda de la suscripción en formato ISO 4217.

Valores posibles: CLP, CLF, MXN, BRL, USD.

customer string
Identificador público del cliente dueño de la suscripción.

due_day integer
Día de vencimiento de las deudas. Para las frecuencias mensual y anual es el día del mes (1–31); para la semanal, el día de la semana (1 = lunes).

id string
Identificador público de la suscripción.

id_account string
Identificador público de la cuenta a la que pertenece la suscripción.

is_recurring boolean
Indica si la suscripción es recurrente, es decir, si genera deudas de forma periódica y automática.

metadata object
Campos adicionales definidos por la organización para la suscripción.

pac_mandate_id string
Identificador del mandato PAC asociado a la suscripción.

product_id string
Identificador del producto de la organización asociado a la suscripción.

receipt_product_code string
Código de producto usado al emitir el documento tributario de la suscripción.

recurring RecurringSubscriptionDataResponse
Configuración de recurrencia de la suscripción. Presente solo cuando is_recurring es verdadero.

recurring.amount number
Monto de cada deuda recurrente, expresado en la moneda de la suscripción.

recurring.anchor string (date)
Fecha ancla del ciclo de facturación desde la cual se calculan los períodos de recurrencia.

recurring.creation_lead_days integer
Días de anticipación con los que se crea cada deuda antes de su fecha de vencimiento.

recurring.due_day integer
Día de vencimiento de las deudas. Para las frecuencias mensual y anual es el día del mes (1–31); para la semanal, el día de la semana (1 = lunes).

recurring.end_date string (date)
Fecha hasta la cual la suscripción genera deudas. Si es null, la recurrencia no tiene fecha de término.

recurring.frequency string
Unidad con la que avanza el ciclo de cobro. Se combina con interval, que dice cada cuántas de esas unidades se genera una deuda, y determina cómo se lee due_day: daily cobra todos los días y no lo usa; weekly lo interpreta como día de la semana, de 1 (lunes) a 7 (domingo); monthly y yearly lo interpretan como día del mes y lo recortan al último día cuando el mes es más corto —un due_day 31 cae el 28 en febrero y el ciclo siguiente vuelve al 31—.

Valores posibles: daily, weekly, monthly, yearly.

recurring.interval integer
Número de unidades de frequency entre cada deuda (por ejemplo, un interval de 2 con frequency mensual genera una deuda cada dos meses).

recurring.max_active_invoices integer
Número máximo de deudas activas (impagas) que la recurrencia mantiene de forma simultánea.

recurring.status string
Estado actual de la recurrencia. Además de la pausa explícita, pasa a PAUSED de forma automática al alcanzar max_active_invoices.

Valores posibles: ACTIVE, PAUSED, FINISHED.

Ejemplo

{
  "amount": 0.0,
  "currency_code": "CLP",
  "customer": "cus_ejC08yLqOWoFhVx4Fx42E3IR9X50tNx2",
  "due_day": 1.0,
  "id": "sub_Y_EgOXMloD5-IJn6d9S2IxkNvp9p0iiP",
  "id_account": "acc_gzD0XoUTFxbUFcItpWOCqN686noSd9HQ",
  "is_recurring": false,
  "metadata": {},
  "pac_mandate_id": "string",
  "product_id": "string",
  "receipt_product_code": "string",
  "recurring": {
    "amount": 0.0,
    "anchor": "2026-01-20",
    "creation_lead_days": 0.0,
    "due_day": 1.0,
    "end_date": "2026-01-20",
    "frequency": "daily",
    "interval": 1.0,
    "max_active_invoices": 1.0,
    "status": "ACTIVE"
  }
}