Ändra plan

Ändra en befintlig abonnemangsplan, vilket möjliggör både uppgraderingar och nedgraderingar till olika prisklasser.

Observera: Detta kommer att använda den befintliga betalningsinformationen för kunden för att uppgradera/nedgradera planen.

POST /subscriptions/{subscription_id}/change-plan

JavaScript

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,
});

​

Hantering av betalningsfel

Använd on_payment_failure-parametern för att styra vad som händer när betalning för planändring misslyckas:

Value	Behavior
prevent_change	Behåll prenumerationen på nuvarande plan tills betalningen lyckas. Planändringen förblir väntande.
apply_change	Tillämpa planändringen omedelbart oavsett betalningsresultat. Detta är standard.

Om on_payment_failure inte anges, återgår beteendet till din företagsinställning som konfigurerats i instrumentpanelen.

​

Rabattkoder

Du kan tillämpa en rabattkod när du ändrar planer genom att skicka parametern discount_code.

Scenario	Beteende
discount_code tillhandahölls	Validerar och tillämpar rabatten på den nya planen.
discount_code inte tillhandahölls, befintlig rabatt med preserve_on_plan_change=true	Befintlig rabatt bevaras om tillämplig på den nya produkten.
discount_code inte tillhandahölls, ingen bevaringsbar rabatt	Ingen rabatt tillämpad.

Använd rabattkoder vid planändringar för att erbjuda kampanjpriser vid uppgraderingar, eller skicka en kod när du migrerar kunder till en ny plantyp.

Använd prevent_change för kritiska uppgraderingar där du vill säkerställa betalning innan du beviljar å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

Show child attributes

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

Show child attributes

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

200

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