Actualizar una suscripción
Changed onActualiza una suscripción. Puedes:
- Cambiar el método de pago: Envía payment_method_id con 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, incluye resumes_on para reactivación automática.
- Reactivar: Envía act: "unpause".
- Agregar o eliminar productos: Envía un arreglo items con los cambios. Cada item identifica un precio con price_id o un producto con product_id (usa el primer precio del producto), y opcionalmente quantity (default 1) o deleted: true para removerlo. Usa mode para 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). Para previsualizar el prorrateo antes de aplicar, usa POST /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.
Request
- Base URLhttps://app.recurrente.com/api
- AuthAPI key in header X-SECRET-KEY
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID de la suscripción
Request body
Response
Suscripción actualizada
Changes
- breaking
added to the
response propertyoneOflist for the response status - breaking
added to the
response propertyoneOflist for the response status - breaking
added to the
response propertyoneOflist for the response status - breaking
the
/response's property type changed fromobjecttoarrayfor status - breaking
the
/response's property type changed fromobjecttoarrayfor status - breaking
the
/response's property type changed fromobjecttoarrayfor status - info
added the optional property
to the response with the status
- breaking
- warning
deleted the
headerrequest parameterX-SECRET-KEY - info
the endpoint scheme security
secretKeywas added to the API
- warning