मुख्य सामग्री पर जाएं
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 स्थिति में पुनः सक्रिय किया जाता है।

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

  • सक्रिय सदस्यताएँ: जब कार्ड समाप्त हो जाता है या ग्राहक एक अलग भुगतान विधि का उपयोग करना चाहता है तो भुगतान विधि को अपडेट करें
  • रुकी हुई सदस्यताएँ: उन सदस्यताओं को पुनः सक्रिय करें जो असफल भुगतानों के कारण रुकी हुई थीं, भुगतान विधि को अपडेट करके
  • भुगतान विधि प्रबंधन: सहेजी गई भुगतान विधियों के बीच स्विच करें या नई जोड़ें
किसी ग्राहक के लिए मौजूदा भुगतान विधियों को सूचीबद्ध करने के लिए, List Payment Methods 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