TRtrytoku
Subscriptions

Editar Subscription

Actualiza los datos de una Subscription existente.

Solo modifica los campos presentes en el cuerpo; los omitidos o enviados como null se mantienen sin cambios. Al ajustar la configuración de recurrencia, los cambios aplican a las Invoices que se generen en adelante.

Excepción: enviar is_recurring=false en una Subscription recurrente elimina su recurrencia: deja de generar Invoices nuevas y se borran amount y due_day. Para detener los cobros de forma temporal sin perder la configuración, usa POST /subscriptions/{id}/status con status=PAUSED.

Responde 404 si la Subscription no existe bajo la organización y Account autenticadas.

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

put/subscriptions/{encrypted_subscription_id}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/subscriptions/{encrypted_subscription_id}
  • Auth
    API key in header x-api-key

Path parameters

encrypted_subscription_idstring required

Identificador público de la Subscription a editar (sub_...).

Example:sub_Y_EgOXMloD5-IJn6d9S2IxkNvp9p0iiP

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

x-api-versionstring date

Versión del API para esta petición, como cualquier fecha YYYY-MM-DD. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.

Example:2026-10-08

Request body

amountnumber

Monto de cada Invoice de la Subscription, en la unidad mínima de la moneda. Debe ser menor que 1.000.000.000.000.000 (10^15).

creation_lead_daysinteger

Días de anticipación con los que se crea cada Invoice antes de su vencimiento. Se respeta como máximo: la creación nunca se adelanta al vencimiento del ciclo anterior. En una recurrencia mensual, creation_lead_days = due_day - 1 crea la Invoice el día 1 del mes de vencimiento, incluso cuando el vencimiento se ajusta a un mes más corto.

currency_code'CLP' | 'CLF' | 'MXN' | 'BRL' | 'USD'

Moneda, en código ISO 4217. Cubre las monedas de los países donde Toku opera —CLP (peso chileno), MXN (peso mexicano) y BRL (real)— más USD y CLF, la Unidad de Fomento chilena. La moneda determina cuántos decimales admiten los montos: CLP no admite decimales, MXN, BRL y USD admiten dos, y CLF cuatro.

customerstring

Identificador público del Customer (cus_...) dueño de la Subscription.

due_dayinteger

Día de vencimiento de las Invoices. 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).

end_datestring date

Fecha hasta la cual la Subscription genera Invoices. Si es null, no tiene término.

frequency'daily' | 'weekly' | 'monthly' | 'yearly'

Frecuencia del ciclo de cobro.

intervalinteger

Número de unidades de frequency entre cada Invoice (por ejemplo, 2 con frecuencia mensual genera una Invoice cada dos meses).

is_recurringboolean

Indica si la Subscription es recurrente. Si se omite o es null, se mantiene el valor actual. Enviar false en una Subscription recurrente elimina la recurrencia y borra amount y due_day; para pausarla sin perder la configuración, usa el endpoint de cambio de estado.

max_active_invoicesinteger

Número máximo de Invoices activas (impagas) que la recurrencia mantiene en simultáneo.

metadataobject
pac_mandate_idstring

Identificador del mandato PAC asociado a la Subscription.

product_idstring

Identificador del producto de la organización asociado a la Subscription.

receipt_product_codestring

Example request

{
  "amount": 19990,
  "customer": "cus_ejC08yLqOWoFhVx4Fx42E3IR9X50tNx2",
  "due_day": 5,
  "interval": 1,
  "is_recurring": true,
  "product_id": "plan-oro-2025"
}

Response

Successful Response

amountnumber

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

currency_code'CLP' | 'CLF' | 'MXN' | 'BRL' | 'USD'

Moneda, en código ISO 4217. Cubre las monedas de los países donde Toku opera —CLP (peso chileno), MXN (peso mexicano) y BRL (real)— más USD y CLF, la Unidad de Fomento chilena. La moneda determina cuántos decimales admiten los montos: CLP no admite decimales, MXN, BRL y USD admiten dos, y CLF cuatro.

customerstring required

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

due_dayinteger

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).

idstring required

Identificador público de la suscripción.

id_accountstring required

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

is_recurringboolean

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

metadataobject

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

pac_mandate_idstring

Identificador del mandato PAC asociado a la suscripción.

product_idstring required

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

receipt_product_codestring

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

Example response

{
  "customer": "cus_ejC08yLqOWoFhVx4Fx42E3IR9X50tNx2",
  "id": "sub_Y_EgOXMloD5-IJn6d9S2IxkNvp9p0iiP",
  "id_account": "acc_gzD0XoUTFxbUFcItpWOCqN686noSd9HQ"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.