TRtrytoku
Subscriptions

Cambiar estado de Subscription

Changed on

Pausa o reanuda una Subscription recurrente según el estado indicado.

Con PAUSED se pausa una Subscription activa: mientras esté pausada, la generación automática de Invoices la omite; las Invoices ya generadas no se ven afectadas. Con ACTIVE se reanuda una Subscription pausada: la facturación se retoma en el primer ciclo con vencimiento hoy o posterior, y los ciclos transcurridos durante la pausa no se facturan retroactivamente. Solo se permiten las transiciones entre ACTIVE y PAUSED; cualquier otra responde 409.

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

post/subscriptions/{encrypted_subscription_id}/status

Request

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

Path parameters

encrypted_subscription_idstring required

Identificador público de la Subscription (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

status'ACTIVE' | 'PAUSED' required

Estado objetivo de la recurrencia. PAUSED pausa la generación automática de Invoices; ACTIVE reanuda una Subscription pausada desde el primer ciclo con vencimiento vigente.

Example request

{
  "status": "PAUSED"
}

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