मुख्य सामग्री पर जाएं
POST
/
subscriptions
/
{subscription_id}
/
update-payment-method
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.updatePaymentMethod('subscription_id', { type: 'new' });

console.log(response.payment_id);
{
  "client_secret": "<string>",
  "expires_on": "2023-11-07T05:31:56Z",
  "payment_id": "<string>",
  "payment_link": "<string>"
}
एक सदस्यता के लिए भुगतान विधि को अपडेट करें। यह एंडपॉइंट सक्रिय सदस्यताओं और on_hold स्थिति में सदस्यताओं दोनों का समर्थन करता है।
on_hold स्थिति में सदस्यताओं के लिए, भुगतान विधि को अपडेट करने से स्वचालित रूप से बकाया राशि के लिए एक चार्ज बनाया जाता है, एक चालान उत्पन्न होता है, और सफल भुगतान पर सदस्यता को active स्थिति में पुनः सक्रिय किया जाता है।

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

  • सक्रिय सदस्यताएँ: जब कार्ड समाप्त हो जाता है या ग्राहक एक अलग भुगतान विधि का उपयोग करना चाहता है तो भुगतान विधि को अपडेट करें
  • रुकी हुई सदस्यताएँ: उन सदस्यताओं को पुनः सक्रिय करें जो असफल भुगतानों के कारण रुकी हुई थीं, भुगतान विधि को अपडेट करके
  • भुगतान विधि प्रबंधन: सहेजी गई भुगतान विधियों के बीच स्विच करें या नई जोड़ें
एक ग्राहक के लिए मौजूदा भुगतान विधियों की सूची बनाने के लिए, भुगतान विधियों की सूची API का उपयोग करें। यह आपको सदस्यता के भुगतान विधि को अपडेट करने के लिए type: "existing" का उपयोग करते समय उपलब्ध भुगतान विधि आईडी प्राप्त करने में मदद करता है।

सक्रिय सदस्यताओं के लिए व्यवहार

जब सक्रिय सदस्यता के लिए भुगतान विधि को अपडेट किया जाता है:
  • भुगतान विधि तुरंत अपडेट की जाती है
  • कोई चार्ज नहीं बनाया जाता है
  • सदस्यता सक्रिय रहती है
  • भविष्य के नवीनीकरण नई भुगतान विधि का उपयोग करेंगे

रुकी हुई सदस्यताओं के लिए व्यवहार

जब on_hold स्थिति में सदस्यता के लिए भुगतान विधि को अपडेट किया जाता है:
  1. बकाया राशि के लिए स्वचालित रूप से एक चार्ज बनाया जाता है
  2. चार्ज के लिए एक चालान उत्पन्न होता है
  3. नए भुगतान विधि का उपयोग करके भुगतान संसाधित किया जाता है
  4. सफल भुगतान पर, सदस्यता को active स्थिति में पुनः सक्रिय किया जाता है
  5. आपको वेबहुक घटनाएँ प्राप्त होंगी: payment.succeeded उसके बाद subscription.active
यदि on_hold सदस्यता के लिए भुगतान विधि को अपडेट करने के बाद भुगतान विफल हो जाता है, तो सदस्यता on_hold स्थिति में बनी रहेगी। भुगतान स्थिति को ट्रैक करने के लिए वेबहुक घटनाओं की निगरानी करें।

वेबहुक घटनाएँ

जब on_hold सदस्यता के लिए भुगतान विधि को अपडेट किया जाता है, तो आपको निम्नलिखित वेबहुक घटनाएँ प्राप्त होंगी:
  1. payment.succeeded - बकाया राशि के लिए चार्ज सफल रहा
  2. subscription.active - सदस्यता को पुनः सक्रिय किया गया है

प्राधिकरण

Authorization
string
header
आवश्यक

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

पथ पैरामीटर

subscription_id
string
आवश्यक

Subscription Id

बॉडी

application/json
type
enum<string>
आवश्यक
उपलब्ध विकल्प:
new
return_url
string | null

प्रतिक्रिया

Payment method updated

client_secret
string | null
expires_on
string<date-time> | null
payment_id
string | null