Cambiar Plan
Modifica el plan de una suscripción existente, permitiendo tanto actualizaciones como degradaciones a diferentes niveles de precios.
Nota: Esto utilizará la información de pago existente del cliente para actualizar/degradar el plan.
Cambios Programados de Plan
Use el parámetroeffective_at para controlar cuándo entrará en vigor el cambio de plan:
Manejo de Fallos de Pago
Use el parámetroon_payment_failure para controlar lo que sucede cuando falla el pago del cambio de plan:
on_payment_failure, el comportamiento predeterminado es el configurado a nivel de negocio en el panel de control.Códigos de Descuento
Puedes aplicar uno o más códigos de descuento acumulados al cambiar de planes pasando el arraydiscount_codes (máximo 20 entradas, aplicadas en el orden del array). El campo singular discount_code está obsoleto pero aún funciona para integraciones existentes; no se puede combinar con discount_codes en la misma solicitud.
Autorizaciones
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parámetros de ruta
Subscription Id
Cuerpo
Unique identifier of the product to subscribe to
Proration Billing Mode
prorated_immediately, full_immediately, difference_immediately, do_not_bill Number of units to subscribe for. Must be at least 1.
x >= 0Whether 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 for the new plan. Note : Leaving this empty would remove any existing addons
DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.
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.
When to apply the plan change.
immediately(default): Apply the plan change right awaynext_billing_date: Schedule the change for the next billing date
immediately, next_billing_date Metadata for the payment. If not passed, the metadata of the subscription will be taken
Controls behavior when the plan change payment fails.
prevent_change: Keep subscription on current plan until payment succeedsapply_change(default): Apply plan change immediately regardless of payment outcome
If not specified, uses the business-level default setting.
prevent_change, apply_change Respuesta
Subscription plan changed. If on_payment_failure=prevent_change, the plan change is pending until payment succeeds.