--- title: "Editar Subscription" method: PUT path: "/subscriptions/{encrypted_subscription_id}" tags: ["Subscriptions"] --- # Editar Subscription `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` 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](/reference/limites-de-tasa). ## Path parameters - `encrypted_subscription_id` string, required: Identificador público de la Subscription a editar (`sub_...`). ## Headers - `x-account-key` string: Llave de API de una Account, para operar sobre esa Account en lugar de la principal. - `x-api-version` string, 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. ## Request body - UpdateSubscriptionPayload: Campos del cuerpo para actualizar una Subscription. - `amount` number: 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_days` integer: 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](https://www.iso.org/iso-4217-currency-codes.html). 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. - `customer` string: Identificador público del Customer (`cus_...`) dueño de la Subscription. - `due_day` integer: 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_date` string, 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. - `interval` integer: Número de unidades de `frequency` entre cada Invoice (por ejemplo, 2 con frecuencia mensual genera una Invoice cada dos meses). - `is_recurring` boolean: 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](/reference/change_subscription_status). - `max_active_invoices` integer: Número máximo de Invoices activas (impagas) que la recurrencia mantiene en simultáneo. - `metadata` object - `pac_mandate_id` string: Identificador del mandato PAC asociado a la Subscription. - `product_id` string: Identificador del producto de la organización asociado a la Subscription. - `receipt_product_code` string ## Response `200` Successful Response - UpdateSubscriptionResponse: Campos de la respuesta al actualizar una Subscription. - `amount` number: 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](https://www.iso.org/iso-4217-currency-codes.html). 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. - `customer` string, required: 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, required: Identificador público de la suscripción. - `id_account` string, required: 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, required: 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 una suscripción. - `amount` number: Monto de cada deuda recurrente, expresado en la moneda de la suscripción. - `anchor` string, date: Fecha ancla del ciclo de facturación desde la cual se calculan los períodos de recurrencia. - `creation_lead_days` integer: Días de anticipación con los que se crea cada deuda antes de su fecha de vencimiento. - `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). - `end_date` string, date: Fecha hasta la cual la suscripción genera deudas. Si es null, la recurrencia no tiene fecha de término. - `frequency` 'daily' | 'weekly' | 'monthly' | 'yearly': Frecuencia del ciclo de cobro. - `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). - `max_active_invoices` integer: Número máximo de deudas activas (impagas) que la recurrencia mantiene de forma simultánea. - `status` 'ACTIVE' | 'PAUSED' | 'FINISHED': Estado del ciclo de vida de las reglas de cobro de una Subscription recurrente. ## Other responses - `401`: Falta de credenciales. - `403`: Falta de permisos. No tienes por qué estar ahi 👀. - `404`: El recurso no fue encontrado. - `422`: El cuerpo de la petición no pasó la validación. - `429`: Superaste el número máximos de request permitidos, espera un poquito. --- [API](https://skmtc.dev/trytoku/apis/toku-api.md) - [All operations](https://skmtc.dev/trytoku/apis/toku-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trytoku/apis/toku-api/revisions/a6ef070075b1?raw)