Cambia piano
Modifica il piano di un abbonamento esistente, consentendo sia gli aggiornamenti che i downgrade a diversi livelli di prezzo.
Nota: Questo utilizzerà le informazioni di pagamento esistenti del cliente per aggiornare/downgradare il piano.
Modifiche Pianificate al Piano
Usa il parametroeffective_at per controllare quando la modifica del piano ha effetto:
Gestione dei Fallimenti di Pagamento
Usa il parametroon_payment_failure per controllare cosa succede quando il pagamento per la modifica del piano fallisce:
on_payment_failure non è specificato, il comportamento predefinito dipende dal tuo settaggio aziendale configurato nella dashboard.Codici Sconto
Puoi applicare uno o più codici sconto cumulabili quando cambi piano passando l’arraydiscount_codes (massimo 20 voci, applicate nell’ordine dell’array). Il campo singolare discount_code è deprecato ma funziona ancora per le integrazioni esistenti; non può essere combinato con discount_codes nella stessa richiesta.
Autorizzazioni
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parametri del percorso
Subscription Id
Corpo
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 Risposta
Subscription plan changed. If on_payment_failure=prevent_change, the plan change is pending until payment succeeds.