Actualizar una suscripción
Actualiza una suscripción. Puedes:
- Cambiar el método de pago: Envía
payment_method_idcon el ID de un método de pago activo del suscriptor. Si la suscripción tiene un pago pendiente, se intentará cobrar automáticamente con el nuevo método de pago. - Pausar: Envía
act: "pause". Opcionalmente, incluyeresumes_onpara reactivación automática. - Reactivar: Envía
act: "unpause". - Agregar o eliminar productos: Envía un arreglo
itemscon los cambios. Cada item identifica un precio conprice_ido un producto conproduct_id(usa el primer precio del producto), y opcionalmentequantity(default1) odeleted: truepara removerlo. Usamodepara decidir cuándo aplican:"next_cycle"(al siguiente cobro, default),"now"(inmediato; el prorrateo se suma al próximo cobro) o"now_and_charge"(inmediato y cobra el prorrateo al instante). En un Sandbox, una suscripción asociada a un Test Clock evalúa sus productos con la hora congelada de ese cliente. Para previsualizar el prorrateo antes de aplicar, usaPOST /subscriptions/{id}/proration_preview.
Para un cobro único o crédito (una multa, un cargo puntual o un crédito de cortesía) tienes dos opciones: envía add_invoice_items en este mismo endpoint (se agregan como pendientes al próximo cobro, ideal para combinarlos con un cambio de productos en una sola llamada), o usa POST /one_time_payments con subscription_id (que además permite cobrar de inmediato con mode: now). Un monto negativo es un crédito. Consulta o cancela los pendientes con GET y DELETE /subscriptions/{subscription_id}/invoice_items.
Authentication
Tu clave secreta de API.
Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.
La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).
Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.
Path parameters
ID de la suscripción
Request
Response
Suscripción actualizada
ID único de la suscripción
Descripción de la suscripción
Estado de la suscripción
Fecha de creación
Última actualización
Inicio del período de facturación actual
Fin del período de facturación actual
Fecha de reactivación automática (si está pausada)
Próximo intento de cobro automático (solo cuando el estado es past_due)
Número de reintentos de cobro realizados para el período actual. Recurrente intenta cobrar una vez al día por 15 días antes de cancelar la suscripción.
Metadata persistida durante todo el ciclo de vida de la suscripción y expuesta en sus webhooks.
ID del test clock heredado del Customer. Solo está presente en un Sandbox nombrado.
Método de pago predeterminado de la suscripción
Lo que la suscripción cobra hoy y lo que un cambio con next_cycle dejó programado.
Transferencias automáticas recurrentes de esta suscripción. En cada cobro exitoso, cada una transfiere su amount_percent del total de la factura a la cuenta destinataria.
Comisión de plataforma como porcentaje del total de cada factura. null cuando la suscripción no paga comisión.
Presente solo con mode: now_and_charge: detalla el cobro inmediato del prorrateo. null en los demás modos.

