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

​
Umgang mit Zahlungsfehlern

Verwenden Sie den on_payment_failure-Parameter, um zu steuern, was passiert, wenn die Zahlung für die Planänderung fehlschlägt:
ValueVerhalten
prevent_changeBehalten Sie das Abonnement im aktuellen Plan, bis die Zahlung erfolgreich ist. Die Planänderung bleibt ausstehend.
apply_changeWenden Sie die Planänderung sofort an, unabhängig vom Zahlungsergebnis. Dies ist die Standardeinstellung.
Wenn on_payment_failure nicht angegeben ist, gilt das auf Unternehmensebene konfigurierte Verhalten im Dashboard.
Verwenden Sie prevent_change für kritische Upgrades, bei denen Sie sicherstellen möchten, dass die Zahlung erfolgt, bevor Sie Zugriff auf 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
​
quantity
integer<int32>
erforderlich

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

Erforderlicher Bereich: 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.

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.