Hoppa till huvudinnehåll
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,
});

​
Schemalagda ändringar av plan

Använd parametern effective_at för att kontrollera när planändringen träder i kraft:
VärdeBeteende
immediatelyTillämpa planändringen direkt. Detta är standard.
next_billing_datePlanera ändringen till nästa faktureringsdatum. Kunden behåller tillgången till sin nuvarande plan tills faktureringsperioden slutar.
Schemalagda planändringar är idealiska för nedgradering — kunder behåller sina nuvarande planförmåner till slutet av faktureringsperioden, och byter sedan automatiskt till den nya planen.
För att avbryta en schemalagd planändring innan den träder i kraft, använd slutpunkten Cancel Scheduled Plan Change.

​
Hantering av betalningsfel

Använd parametern on_payment_failure för att kontrollera vad som händer när betalningen för planändringen misslyckas:
VärdeBeteende
prevent_changeBehåll abonnemanget på nuvarande plan tills betalningen lyckas. Planändring förblir väntande.
apply_changeTillämpa planändringen omedelbart oavsett betalningsresultat. Detta är standard.
Om on_payment_failure inte anges, är beteendet förvalt till din affärsnivåinställning som konfigureras i instrumentpanelen.

​
Rabattkoder

Du kan tillämpa en rabattkod när du ändrar planer genom att skicka parametern discount_code.
ScenarioBeteende
discount_code angivenValiderar och tillämpar rabatten på den nya planen.
discount_code ej angiven, befintlig rabatt med preserve_on_plan_change=trueBefintlig rabatt bevaras om den är tillämplig på den nya produkten.
discount_code ej angiven, ingen bevarbar rabattIngen rabatt tillämpas.
Använd rabattkoder under planändringar för att erbjuda kampanjpriser vid uppgraderingar, eller skicka en kod vid migrering av kunder till en ny plan.
Använd prevent_change för kritiska uppgraderingar där du vill säkerställa betalning innan du ger åtkomst till premiumfunktioner.

Auktoriseringar

​
Authorization
string
header
obligatorisk

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

Sökvägsparametrar

​
subscription_id
string
obligatorisk

Subscription Id

Kropp

application/json
​
product_id
string
obligatorisk

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
obligatorisk

Proration Billing Mode

Tillgängliga alternativ:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
​
quantity
integer<int32>
obligatorisk

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

Obligatoriskt intervall: 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).

​
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
Tillgängliga alternativ:
immediately,
next_billing_date
​
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.

Tillgängliga alternativ:
prevent_change,
apply_change

Svar

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

Last modified on April 20, 2026