मुख्य सामग्री पर जाएं
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,
});

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

​
अनुसूचित योजना परिवर्तन

योजना परिवर्तन कब प्रभावी होता है, इसे नियंत्रित करने के लिए effective_at पैरामीटर का उपयोग करें:
मानव्यवहार
immediatelyयोजना परिवर्तन तुरंत लागू करें। यह डिफ़ॉल्ट है।
next_billing_dateपरिवर्तन को अगले बिलिंग तिथि के लिए अनुसूचित करें। ग्राहक अपनी वर्तमान योजना तक पहुंच बनाए रखते हैं जब तक कि बिलिंग अवधि समाप्त नहीं होती।
अनुसूचित योजना परिवर्तन डाउनग्रेड के लिए आदर्श हैं — ग्राहक अपनी वर्तमान योजना लाभ बिलिंग अवधि समाप्त होने तक रखते हैं, फिर स्वचालित रूप से नई योजना पर स्विच करते हैं।
एक अनुसूचित योजना परिवर्तन को प्रभावी होने से पहले रद्द करने के लिए, अनुसूचित योजना परिवर्तन रद्द करें एंडपॉइंट का उपयोग करें।

​
भुगतान विफलता प्रबंधन

योजना परिवर्तन भुगतान विफल होने पर क्या होता है, इसे नियंत्रित करने के लिए on_payment_failure पैरामीटर का उपयोग करें:
मानव्यवहार
prevent_changeभुगतान सफल होने तक वर्तमान योजना पर सदस्यता बना रहे। योजना परिवर्तन लंबित रहता है।
apply_changeभुगतान परिणाम की परवाह किए बिना तुरंत योजना परिवर्तन लागू करें। यह डिफ़ॉल्ट है।
यदि on_payment_failure निर्दिष्ट नहीं है, तो व्यवहार डैशबोर्ड में आपके व्यवसाय-स्तरीय सेटिंग्स पर डिफ़ॉल्ट होता है।

​
छूट कोड

योजनाओं को बदलते समय छूट कोड लागू करने के लिए discount_code पैरामीटर पास करें।
परिदृश्यव्यवहार
discount_code प्रदान किया गयाछूट को सत्यापित किया और नई योजना पर लागू किया।
discount_code प्रदान नहीं किया गया, मौजूदा छूट के साथ preserve_on_plan_change=trueमौजूदा छूट को संरक्षित किया जाता है यदि यह नए उत्पाद पर लागू होती है।
discount_code प्रदान नहीं किया गया, कोई संरक्षित करने योग्य छूट नहींकोई छूट लागू नहीं।
उन्नयन पर प्रचार मूल्य निर्धारण की पेशकश करने के लिए योजना परिवर्तनों के दौरान छूट कोड का उपयोग करें, या ग्राहकों को नए योजना स्तर पर माइग्रेट करते समय एक कोड पास करें।
महत्वपूर्ण उन्नयन के लिए prevent_change का उपयोग करें जहां आप प्रीमियम सुविधाओं तक पहुंच देने से पहले भुगतान सुनिश्चित करना चाहते हैं।

प्राधिकरण

​
Authorization
string
header
आवश्यक

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

पथ पैरामीटर

​
subscription_id
string
आवश्यक

Subscription Id

बॉडी

application/json
​
product_id
string
आवश्यक

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
आवश्यक

Proration Billing Mode

उपलब्ध विकल्प:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
​
quantity
integer<int32>
आवश्यक

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

आवश्यक सीमा: 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
अप्रचलित

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
उपलब्ध विकल्प:
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.

उपलब्ध विकल्प:
prevent_change,
apply_change

प्रतिक्रिया

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

Last modified on April 20, 2026