Pausar suscripción
Pausa una suscripción activa, lo que permite reanudarla o cancelarla más adelante.
status de la suscripción cambia a PAUSED. Este estado puede cambiar a ACTIVE o CANCELED.
Pausar por un tiempo determinado
Una pausa es indefinida por defecto: la suscripción permanecePAUSED hasta que la reanudes. Enviar un cuerpo con una duración programa la reanudación por adelantado, y la suscripción vuelve por sí sola cuando llega ese momento.
Indica la duración de una de dos formas, nunca de ambas:
pause_cycles: un entero de 1 a 3, contado desde la pausa en la frecuencia propia de la suscripción.pause_until: un instante RFC 3339. Debe estar en el futuro y caer antes deavailability.finish_atcuando la suscripción lo tenga.
billing_cycle_behavior es opcional y define la fecha de facturación cuando la suscripción se reanuda, con los mismos significados de KEEP/RESTART que en Reanudar suscripción: KEEP (el valor predeterminado) mantiene la fecha de facturación original, RESTART la vuelve a anclar desde la reanudación. Enviarlo sin pause_cycles ni pause_until es válido: es una pausa indefinida que solo registra el comportamiento para cuando la suscripción se reanude más adelante.
reason es una cadena de texto libre opcional, de 255 caracteres como máximo, que se almacena en el campo reason de la suscripción. Un GET posterior sobre la suscripción lo devuelve, y permanece hasta que algo más lo sobrescribe, por ejemplo una reanudación que envía su propio reason.
pause_cycles se resuelve una sola vez, en el momento de la pausa: el instante resuelto es el instante de la pausa más pause_cycles × la frecuencia de la suscripción. A partir de entonces, la suscripción lleva ese instante como pause_until en cada lectura posterior mientras siga pausada: una pausa indicada en ciclos y una indicada como fecha son indistinguibles después. Por ejemplo, { "pause_cycles": 1 } en una suscripción mensual pausada en 2026-09-15T15:54:18Z se resuelve como pause_until: "2026-10-15T15:54:22.780166Z".
Qué sucede mientras está pausada y cuándo vuelve
No se cobra ningún ciclo durante la pausa. Mientras una duración está en curso, la suscripción llevapause_until en cada lectura; vuelve por sí sola al estado con el que estaba facturando, dentro de aproximadamente un minuto de ese instante, y llega un webhook subscription.resume con resume_reason: SCHEDULED. Una reanudación manual antes de ese instante cancela la programación: llama tú mismo a Reanudar suscripción en cualquier momento para terminar la pausa antes. Si la reanudación automática no se puede completar después de sus reintentos, la suscripción permanece PAUSED y se envía en su lugar un evento subscription.auto_resume_failed.
reason están disponibles para las organizaciones habilitadas para ello; contacta a Yuno.Errores
Autorizaciones
Cuerpo
Qué ocurre con el ancla de facturación cuando la suscripción se reanuda (manual o automáticamente). KEEP (por defecto): el ancla original avanza por los períodos completos que se perdió. RESTART: el ancla se reubica en el momento de la reanudación. Enviarlo sin pause_cycles ni pause_until se acepta: es una pausa sin límite que solo registra el comportamiento para cuando la suscripción se reanude más adelante.
KEEP, RESTART "RESTART"
Respuesta
200
Inicio del período de facturación en el que está la suscripción actualmente, una cadencia antes de current_period_end. Dentro de una prueba o de cualquier otra fase del plan, sigue la cadencia de esa fase. Una suscripción terminal (CANCELED o COMPLETED) conserva su ventana final en lugar de pasar a null. Es null solo para una suscripción sin cadencia recurrente. Siempre se devuelve junto con current_period_end.
"2023-01-16T20:00:00.912480Z"
La política de reintentos que se aplica cuando se rechaza un cobro recurrente. Consulta Reintentos.
El enriquecimiento opcional de la orden enviada en la creación, devuelto tal cual. Consulta El objeto Suscripción para ver su estructura completa.
Qué desencadenó la cancelación: MERCHANT, SYSTEM, PLAN_CHANGE o RETRIES_EXHAUSTED. Solo se define una vez que la suscripción llega a CANCELED; null en caso contrario. Trátalo como un valor abierto: maneja los valores no reconocidos de forma adecuada.
"MERCHANT"
Las definiciones de fases del plan vinculado, tal como las declara el plan, incluida la fase terminal REGULAR. Solo está presente en suscripciones vinculadas a un plan que tiene fases. Esta es la escalera propia del plan, no la instantánea de este suscriptor: para lo que se fijó para esta suscripción en la creación, usa billing_phases.
Cuándo la fase indicada por current_phase pasa a la siguiente: para una suscripción en su prueba, cuándo cambia al precio regular. Es el fin del último período de facturación que cubre la fase, así que en el último período de una prueba es igual a current_period_end. Es null para una suscripción sin plan y para una que ya salió de la escalera de fases.
"2023-03-16T20:00:00.786342Z"
Solo está presente en suscripciones vinculadas a un plan cuyo plan tiene fases. Contiene únicamente las fases TRIAL iniciales, capturadas en la creación; la fase terminal REGULAR nunca se incluye, ya que su precio no se fija y se resuelve a partir del plan en cada facturación. current_phase: "REGULAR" es la señal de que la escalera se agotó.
La regla de reembolso almacenada que se usa para resolver un reembolso de cancelación CUSTOM cuando la solicitud de cancelación no envía su propio refund_amount. Solo está presente cuando hay una configurada; se omite, no es null, en caso contrario. Disponible para las organizaciones habilitadas; contacta a Yuno.
Cuándo está programado que la suscripción se reanude automáticamente. Solo está presente en una suscripción actualmente pausada con una duración (pause_cycles o pause_until enviados al pausar); está ausente, no es null, en cualquier otra lectura.
"2026-10-15T15:54:22.780166Z"