मुख्य सामग्री पर जाएं
POST
/
subscriptions
/
{subscription_id}
/
change-plan
/
preview
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const response = await client.subscriptions.previewChangePlan('subscription_id', {
  product_id: 'product_id',
  proration_billing_mode: 'prorated_immediately',
  quantity: 0,
});

console.log(response.immediate_charge);
{
  "immediate_charge": {
    "line_items": [
      {
        "currency": "AED",
        "id": "<string>",
        "product_id": "<string>",
        "proration_factor": 123,
        "quantity": 123,
        "tax_inclusive": true,
        "type": "subscription",
        "unit_price": 123,
        "description": "<string>",
        "name": "<string>",
        "tax": 123,
        "tax_rate": 123
      }
    ],
    "summary": {
      "currency": "AED",
      "customer_credits": 123,
      "settlement_amount": 123,
      "settlement_currency": "AED",
      "total_amount": 123,
      "settlement_tax": 123,
      "tax": 123
    }
  },
  "new_plan": {
    "addons": [
      {
        "addon_id": "<string>",
        "quantity": 123
      }
    ],
    "billing": {
      "country": "AF",
      "city": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zipcode": "<string>"
    },
    "cancel_at_next_billing_date": true,
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "AED",
    "customer": {
      "customer_id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "metadata": {},
      "phone_number": "<string>"
    },
    "metadata": {},
    "meters": [
      {
        "currency": "AED",
        "free_threshold": 123,
        "measurement_unit": "<string>",
        "meter_id": "<string>",
        "name": "<string>",
        "price_per_unit": "10.50",
        "description": "<string>"
      }
    ],
    "next_billing_date": "2023-11-07T05:31:56Z",
    "on_demand": true,
    "payment_frequency_count": 123,
    "payment_frequency_interval": "Day",
    "previous_billing_date": "2023-11-07T05:31:56Z",
    "product_id": "<string>",
    "quantity": 123,
    "recurring_pre_tax_amount": 123,
    "status": "pending",
    "subscription_id": "<string>",
    "subscription_period_count": 123,
    "subscription_period_interval": "Day",
    "tax_inclusive": true,
    "trial_period_days": 123,
    "cancelled_at": "2023-11-07T05:31:56Z",
    "discount_cycles_remaining": 123,
    "discount_id": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "payment_method_id": "<string>",
    "tax_id": "<string>"
  }
}
इस एंडपॉइंट का उपयोग ग्राहकों को यह दिखाने के लिए करें कि जब वे अपनी सदस्यता को अपग्रेड या डाउनग्रेड करते हैं तो उन्हें कितना चार्ज किया जाएगा, जिससे पारदर्शिता में सुधार होता है और समर्थन अनुरोधों में कमी आती है।

उपयोग के मामले

  • चेकआउट पुष्टि: ग्राहकों को योजना परिवर्तन की पुष्टि करने से पहले प्रोराटा चार्ज दिखाएं
  • मूल्य निर्धारण कैलकुलेटर: अपने एप्लिकेशन में अपग्रेड/डाउनग्रेड कैलकुलेटर बनाएं
  • ग्राहक स्व-सेवा: ग्राहकों को सटीक मूल्य निर्धारण के साथ योजना विकल्पों का अन्वेषण करने दें

प्रतिक्रिया फ़ील्ड

पूर्वावलोकन प्रतिक्रिया में शामिल हैं:
फ़ील्डविवरण
immediate_chargeवह चार्ज जो तुरंत बनाया जाएगा, जिसमें लाइन आइटम और सारांश शामिल हैं
new_planपूरा सदस्यता ऑब्जेक्ट जो दिखाता है कि यह योजना परिवर्तन के बाद कैसा दिखेगा
immediate_charge.summary में वह कुल राशि शामिल है जो चार्ज की जाएगी। इसका उपयोग अपने ग्राहकों को योजना परिवर्तन की पुष्टि करने से पहले मूल्य निर्धारण दिखाने के लिए करें।

प्राधिकरण

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

प्रतिक्रिया

Preview of subscription plan change

immediate_charge
object
आवश्यक
new_plan
object
आवश्यक

Response struct representing subscription details