Vai al contenuto principale
POST
/
subscriptions
/
{subscription_id}
/
change-plan
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

await client.subscriptions.changePlan('subscription_id', {
  product_id: 'product_id',
  proration_billing_mode: 'prorated_immediately',
  quantity: 0,
});

​
Gestione dei pagamenti falliti

Usa il parametro on_payment_failure per controllare cosa succede quando il pagamento per il cambio piano fallisce:
ValoreComportamento
prevent_changeMantieni l’abbonamento sul piano attuale finché il pagamento non riesce. Il cambio piano rimane in sospeso.
apply_changeApplica immediatamente il cambio piano indipendentemente dall’esito del pagamento. Questa è l’impostazione predefinita.
Se on_payment_failure non è specificato, il comportamento predefinito corrisponde all’impostazione a livello business configurata nel dashboard.
Usa prevent_change per upgrade critici in cui desideri assicurarti del pagamento prima di concedere l’accesso alle funzionalità premium.

Autorizzazioni

​
Authorization
string
header
obbligatorio

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

Parametri del percorso

​
subscription_id
string
obbligatorio

Subscription Id

Corpo

application/json
​
product_id
string
obbligatorio

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
obbligatorio

Proration Billing Mode

Opzioni disponibili:
prorated_immediately,
full_immediately,
difference_immediately
​
quantity
integer<int32>
obbligatorio

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

Intervallo richiesto: x >= 0
​
addons
Attach Addon Request · object[] | null

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

​
discount_code
string | null

Optional discount code to apply to the new plan. If provided, validates and applies the discount to the plan change. If not provided and the subscription has an existing discount with preserve_on_plan_change=true, the existing discount will be preserved (if applicable to the new product).

​
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.

Opzioni disponibili:
prevent_change,
apply_change

Risposta

Subscription plan changed. If on_payment_failure=prevent_change, the plan change is pending until payment succeeds.