योजना बदलें

एक मौजूदा सदस्यता की योजना को संशोधित करें, जो विभिन्न मूल्य स्तरों पर अपग्रेड और डाउनग्रेड दोनों को सक्षम बनाता है।

नोट: यह योजना को अपग्रेड/डाउनग्रेड करने के लिए ग्राहक की मौजूदा भुगतान जानकारी का उपयोग करेगा।

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

​

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

on_payment_failure पैरामीटर का उपयोग उस समय को नियंत्रित करने के लिए करें जब प्लान परिवर्तन का भुगतान विफल हो जाता है:

Value	Behavior
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

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

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

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

प्रतिक्रिया

200

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