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

​
भुगतान विफलता हैंडलिंग

on_payment_failure पैरामीटर का उपयोग उस समय को नियंत्रित करने के लिए करें जब प्लान परिवर्तन का भुगतान विफल हो जाता है:
ValueBehavior
prevent_changeभुगतान सफल होने तक सदस्यता को वर्तमान प्लान पर रखें। प्लान परिवर्तन पेंडिंग रहता है।
apply_changeभुगतान परिणाम की परवाह किए बिना प्लान परिवर्तन तुरंत लागू करें। यह डिफ़ॉल्ट है।
यदि on_payment_failure निर्दिष्ट नहीं है, तो व्यवहार डैशबोर्ड में कॉन्फ़िगर की गई आपके व्यवसाय-स्तर सेटिंग पर डिफ़ॉल्ट होता है।
सक्रिय उन्नयन के लिए 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
​
quantity
integer<int32>
आवश्यक

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

आवश्यक सीमा: 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.

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

प्रतिक्रिया

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