Skip to main content
POST
JavaScript

Cambios Programados de Plan

Use el parámetro effective_at para controlar cuándo entrará en vigor el cambio de plan:
Los cambios de plan programados son ideales para degradaciones: los clientes mantienen los beneficios de su plan actual hasta el final del período de facturación, y luego cambian automáticamente al nuevo plan.
Para cancelar un cambio de plan programado antes de que entre en vigor, use el endpoint Cancelar Cambio de Plan Programado.

Manejo de Fallos de Pago

Use el parámetro on_payment_failure para controlar lo que sucede cuando falla el pago del cambio de plan:
Si no se especifica on_payment_failure, el comportamiento predeterminado es el configurado a nivel de negocio en el panel de control.
Establece collect_via_payment_link en true para enviar al cliente a una página de checkout alojada en lugar de cobrar a su método de pago guardado. La respuesta incluye entonces payment_id, payment_link, client_secret y expires_on; redirige al cliente a payment_link para completar el pago. Esto requiere: Una solicitud que no cumpla estos requisitos devuelve 422. Mientras el enlace no esté pagado, la suscripción permanece en su plan actual y una solicitud change-plan posterior devuelve 409.
Consulta la Guía de actualización y cambio de plan de suscripciones para conocer el flujo completo, incluido cómo un cliente vuelve a intentar un pago rechazado y qué ocurre si el enlace caduca.

Códigos de descuento

Puedes aplicar uno o más códigos de descuento apilados al cambiar de plan pasando el array discount_codes (máximo 20 elementos, aplicados en el orden del array). El campo singular discount_code está obsoleto, pero sigue funcionando para integraciones existentes; no se puede combinar con discount_codes en la misma solicitud.
Usa códigos de descuento durante los cambios de plan para ofrecer precios promocionales en las actualizaciones, o pasa códigos al migrar clientes a un nuevo nivel de plan.
Usa prevent_change para actualizaciones críticas en las que quieras asegurarte de que el pago se complete antes de conceder acceso a funciones premium.

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

subscription_id
string
requerido

Subscription Id

Cuerpo

application/json
product_id
string
requerido

Unique identifier of the product to subscribe to

proration_billing_mode
enum<string>
requerido

Proration Billing Mode

Opciones disponibles:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
quantity
integer<int32>
requerido

Number of units to subscribe for. Must be at least 1.

Rango requerido: x >= 0
adaptive_currency_fees_inclusive
boolean | null

Whether adaptive currency fees should be included in the price (true) or added on top (false). If not specified, uses the subscription's stored setting.

addons
Attach Addon Request · object[] | null

Addons for the new plan. Note : Leaving this empty would remove any existing addons

cancel_scheduled_change_plan
boolean

Replace a scheduled plan change with this one.

The scheduled change is cancelled by the transaction that applies this change. A change that never applies leaves the schedule in place.

effective_at: next_billing_date is allowed. The new schedule then replaces the old one in the request transaction.

A pending plan change still gets a 409. This field does not affect it.

The preview route shares this request body, so a preview that sets this field also passes the scheduled-change 409.

Collect the plan-change amount with a payment link. The customer then pays on a checkout page.

The business needs the allow_plan_change_via_payment_link capability. The request needs effective_at: immediately. The request also needs on_payment_failure: prevent_change.

The preview route shares this request body and ignores this field.

discount_code
string | null
obsoleto

DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.

discount_codes
string[] | null

Stacked discount codes to apply to the new plan. Max 20. Cannot be used together with discount_code. If provided, replaces any existing discount codes. Empty array removes all discounts. If not provided (None), existing discounts with preserve_on_plan_change=true are preserved.

effective_at
enum<string>

When to apply the plan change.

  • immediately (default): Apply the plan change right away
  • next_billing_date: Schedule the change for the next billing date
Opciones disponibles:
immediately,
next_billing_date
metadata
null | Metadata · object

Metadata for the payment. If not passed, the metadata of the subscription will be taken

on_payment_failure
null | enum<string>

Controls behavior when the plan change payment fails.

  • prevent_change: Keep subscription on current plan until payment succeeds
  • apply_change (default): Apply plan change immediately regardless of payment outcome

If not specified, uses the business-level default setting.

Opciones disponibles:
prevent_change,
apply_change

Respuesta

Subscription plan changed. A link request can return checkout details. A pending plan change applies after payment succeeds.

Handles for a hosted checkout page that settles a plan change.

The four fields repeat UpdatePaymentMethodResponse and a subset of CreateSubscriptionResponse. A shared type would rename the generated SDK types for all three routes, so each route keeps its own.

client_secret
string | null

Client secret for an embedded checkout.

expires_on
string<date-time> | null

When the link stops working.

payment_id
string | null

Id of the payment that settles the plan change.

Checkout page URL. Give this to the customer.

Última modificación el 26 de agosto de 2026