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

​
Geplante Tarifänderungen

Verwenden Sie den effective_at-Parameter, um zu steuern, wann die Tarifänderung wirksam wird:
WertVerhalten
immediatelyAnwenden der Tarifänderung sofort. Dies ist die Standardeinstellung.
next_billing_datePlanen der Änderung für das nächste Abrechnungsdatum. Der Kunde behält Zugriff auf seinen aktuellen Tarif, bis der Abrechnungszeitraum endet.
Geplante Tarifänderungen sind ideal für Downgrades – Kunden behalten ihre aktuellen Tarifvorteile bis zum Ende des Abrechnungszeitraums und wechseln dann automatisch zum neuen Tarif.
Um eine geplante Tarifänderung zu stornieren, bevor sie wirksam wird, verwenden Sie den Geplante Tarifänderung stornieren Endpunkt.

​
Zahlungsfehlerbehandlung

Verwenden Sie den on_payment_failure-Parameter, um zu steuern, was passiert, wenn die Zahlung für die Tarifänderung fehlschlägt:
WertVerhalten
prevent_changeBehalten Sie das Abonnement auf dem aktuellen Plan, bis die Zahlung erfolgreich ist. Tarifänderung bleibt ausstehend.
apply_changeWenden Sie die Tarifänderung unabhängig vom Zahlungsergebnis sofort an. Dies ist die Standardeinstellung.
Falls on_payment_failure nicht angegeben ist, erfolgt die Standardverhalten gemäß Ihrer Geschäftseinstellung im Dashboard.

​
Rabattcodes

Sie können einen oder mehrere stapelbare Rabattcodes anwenden, wenn Sie Pläne ändern, indem Sie das discount_codes Array übergeben (maximal 20 Einträge, in Array-Reihenfolge angewendet). Das einzelne discount_code Feld ist veraltet, funktioniert aber noch für bestehende Integrationen; es kann nicht mit discount_codes in derselben Anfrage kombiniert werden.
discount_codes WertVerhalten
Nicht angegeben (null / weggelassen)Bestehende Rabatte mit preserve_on_plan_change=true werden beibehalten, wenn sie für das neue Produkt anwendbar sind.
[] (leeres Array)Alle bestehenden Rabatte werden aus dem Abonnement entfernt.
["CODE_A", "CODE_B", ...]Ersetzt alle bestehenden Rabatte durch dieses gestapelte Set, validiert und in Array-Reihenfolge angewendet.
Verwenden Sie Rabattcodes bei Planänderungen, um Aktionspreise bei Upgrades anzubieten, oder geben Sie Codes weiter, wenn Sie Kunden in eine neue Planstufe migrieren.
Verwenden Sie prevent_change für kritische Upgrades, bei denen Sie sicherstellen möchten, dass die Zahlung erfolgt, bevor Sie Zugang zu Premium-Funktionen gewähren.

Autorisierungen

​
Authorization
string
header
erforderlich

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

Pfadparameter

​
subscription_id
string
erforderlich

Subscription Id

Body

application/json
​
product_id
string
erforderlich

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
erforderlich

Proration Billing Mode

Verfügbare Optionen:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
​
quantity
integer<int32>
erforderlich

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

Erforderlicher Bereich: x >= 0
​
adaptive_currency_fees_inclusive
boolean | null

Whether 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
Attach Addon Request · object[] | null

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

​
discount_code
string | null
veraltet

DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.

​
discount_codes
string[] | null

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.

​
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
Verfügbare Optionen:
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.

Verfügbare Optionen:
prevent_change,
apply_change

Antwort

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

Last modified on May 22, 2026