सदस्यता एकीकरण गाइड

​

पूर्वापेक्षाएँ

• एक डोडो पेमेंट्स व्यापारी खाता
• डैशबोर्ड से API क्रेडेंशियल्स (API कुंजी और वेबहुक गुप्त कुंजी)

​

API एकीकरण

​

चेकआउट सत्र

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode', // defaults to 'live_mode'
});

async function main() {
  const session = await client.checkoutSessions.create({
    product_cart: [
      { product_id: 'prod_subscription_monthly', quantity: 1 }
    ],
    // Optional: configure trials for subscription products
    subscription_data: { trial_period_days: 14 },
    customer: {
      email: 'subscriber@example.com',
      name: 'Jane Doe',
    },
    return_url: 'https://example.com/success',
  });

  console.log(session.checkout_url);
}

main();

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",  # defaults to "live_mode"
)

session = client.checkout_sessions.create(
    product_cart=[
        {"product_id": "prod_subscription_monthly", "quantity": 1}
    ],
    subscription_data={"trial_period_days": 14},  # optional
    customer={
        "email": "subscriber@example.com",
        "name": "Jane Doe",
    },
    return_url="https://example.com/success",
)

print(session.checkout_url)

const response = await fetch('https://test.dodopayments.com/checkouts', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.DODO_PAYMENTS_API_KEY}`
  },
  body: JSON.stringify({
    product_cart: [
      { product_id: 'prod_subscription_monthly', quantity: 1 }
    ],
    subscription_data: { trial_period_days: 14 }, // optional
    customer: {
      email: 'subscriber@example.com',
      name: 'Jane Doe'
    },
    return_url: 'https://example.com/success'
  })
});

if (!response.ok) {
  throw new Error(`HTTP error! status: ${response.status}`);
}

const session = await response.json();
console.log(session.checkout_url);

​

API प्रतिक्रिया

{
  "session_id": "cks_Gi6KGJ2zFJo9rq9Ukifwa",
  "checkout_url": "https://test.checkout.dodopayments.com/session/cks_Gi6KGJ2zFJo9rq9Ukifwa"
}

​

वेबहुक

​

सदस्यता घटना प्रकार

1. subscription.active - सदस्यता सफलतापूर्वक सक्रिय हो गई है।
2. subscription.updated - सदस्यता वस्तु को अपडेट किया गया (किसी भी फ़ील्ड परिवर्तन पर फायर करता है)।
3. subscription.on_hold - सदस्यता नवीनीकरण में विफलता के कारण होल्ड पर है।
4. subscription.failed - जनादेश निर्माण के दौरान सदस्यता निर्माण विफल हो गया।
5. subscription.renewed - अगली बिलिंग अवधि के लिए सदस्यता नवीनीकरण किया गया।

​

भुगतान परिदृश्य

1. subscription.active - सदस्यता सक्रियण को इंगित करता है
2. payment.succeeded - प्रारंभिक भुगतान की पुष्टि करता है:
   • तात्कालिक बिलिंग (0 परीक्षण दिन): 2-10 मिनट के भीतर अपेक्षा करें
   • परीक्षण दिनों के लिए: जब भी वह समाप्त होता है
3. subscription.renewed - अगले चक्र के लिए भुगतान कटौती और नवीनीकरण को इंगित करता है। (आधार रूप से, जब भी सदस्यता उत्पादों के लिए भुगतान कट जाता है, आपको subscription.renewed वेबहुक के साथ payment.succeeded भी मिलेगा)

1. सदस्यता विफलता

• subscription.failed - जनादेश बनाने में विफलता के कारण सदस्यता निर्माण विफल हो गया।
• payment.failed - विफल भुगतान को इंगित करता है।

2. सदस्यता होल्ड पर

• subscription.on_hold - सदस्यता नवीनीकरण भुगतान या योजना परिवर्तन शुल्क में विफलता के कारण होल्ड पर है।
• जब एक सदस्यता होल्ड पर जाती है, तो यह स्वचालित रूप से नवीनीकरण नहीं करेगी जब तक कि भुगतान विधि को अपडेट नहीं किया जाता।

​

सदस्यता होल्ड पर रखने का प्रबंधन

​

जब सदस्यताएँ होल्ड पर जाती हैं

• नवीनीकरण भुगतान विफल: स्वचालित नवीनीकरण शुल्क अपर्याप्त धन, समाप्त कार्ड, या बैंक द्वारा अस्वीकृति के कारण विफल हो जाता है
• योजना परिवर्तन शुल्क विफल: योजना अपग्रेड/डाउनग्रेड के दौरान तत्काल शुल्क विफल हो जाता है
• भुगतान विधि प्राधिकरण विफल: भुगतान विधि को आवर्ती शुल्क के लिए प्राधिकृत नहीं किया जा सकता है

​

होल्ड से सदस्यताओं को पुनः सक्रिय करना

1. शेष बकाया के लिए एक शुल्क बनाता है
2. शुल्क के लिए एक चालान उत्पन्न करता है
3. नई भुगतान विधि का उपयोग करके भुगतान को संसाधित करता है
4. सफल भुगतान पर सदस्यता को active स्थिति में फिर से सक्रिय करता है

// Webhook handler
app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;
  
  if (event.type === 'subscription.on_hold') {
    const subscription = event.data;
    
    // Update subscription status in your database
    await updateSubscriptionStatus(subscription.subscription_id, 'on_hold');
    
    // Notify customer to update payment method
    await sendEmailToCustomer(subscription.customer_id, {
      subject: 'Payment Required - Subscription On Hold',
      message: 'Your subscription is on hold. Please update your payment method to continue service.'
    });
  }
  
  res.json({ received: true });
});

// Update with new payment method
const response = await client.subscriptions.updatePaymentMethod(subscriptionId, {
  type: 'new',
  return_url: 'https://example.com/return'
});

// For on_hold subscriptions, a charge is automatically created
if (response.payment_id) {
  console.log('Charge created for remaining dues:', response.payment_id);
  // Redirect customer to response.payment_link to complete payment
}

await client.subscriptions.updatePaymentMethod(subscriptionId, {
  type: 'existing',
  payment_method_id: 'pm_abc123'
});

if (event.type === 'payment.succeeded') {
  const payment = event.data;
  
  // Check if this payment is for an on_hold subscription
  if (payment.subscription_id) {
    // Wait for subscription.active webhook to confirm reactivation
  }
}

if (event.type === 'subscription.active') {
  const subscription = event.data;
  
  // Update subscription status in your database
  await updateSubscriptionStatus(subscription.subscription_id, 'active');
  
  // Restore customer access
  await restoreCustomerAccess(subscription.customer_id);
  
  // Notify customer of successful reactivation
  await sendEmailToCustomer(subscription.customer_id, {
    subject: 'Subscription Reactivated',
    message: 'Your subscription has been reactivated successfully.'
  });
}

​

सदस्यता घटना पेलोड का उदाहरण

​

सदस्यता योजनाएँ बदलना

​

प्रोरशन विकल्प

​

1. prorated_immediately

• वर्तमान बिलिंग चक्र में शेष समय के आधार पर प्रोराटा राशि की गणना करता है
• ग्राहक से केवल पुराने और नए योजना के बीच के अंतर के लिए शुल्क लेता है
• परीक्षण अवधि के दौरान, यह तुरंत उपयोगकर्ता को नई योजना में स्विच कर देता है, ग्राहक से तुरंत शुल्क लेता है

​

2. full_immediately

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

​

3. difference_immediately

• जब अपग्रेड करते हैं, तो ग्राहक को दोनों योजना की राशि के बीच का अंतर तुरंत चार्ज किया जाता है।
• उदाहरण के लिए, यदि वर्तमान योजना 30 डॉलर है और ग्राहक 80 डॉलर की योजना में अपग्रेड करता है, तो उन्हें तुरंत $50 चार्ज किया जाता है।
• डाउनग्रेड करते समय, वर्तमान योजना से अप्रयुक्त राशि आंतरिक क्रेडिट के रूप में जोड़ी जाती है और भविष्य के सदस्यता नवीनीकरण पर स्वचालित रूप से लागू की जाती है।
• उदाहरण के लिए, यदि वर्तमान योजना 50 डॉलर है और ग्राहक 20 डॉलर की योजना में स्विच करता है, तो शेष $30 को क्रेडिट किया जाता है और अगले बिलिंग चक्र के लिए उपयोग किया जाता है।

​

व्यवहार

• जब आप इस एपीआई को कॉल करते हैं, तो डोडो पेमेंट्स तुरंत आपके द्वारा चुने गए प्रोराटा विकल्प के आधार पर एक शुल्क शुरू करता है
• यदि योजना परिवर्तन डाउनग्रेड है और आप prorated_immediately का उपयोग करते हैं, तो क्रेडिट स्वचालित रूप से गणना की जाती है और सदस्यता के क्रेडिट बैलेंस में जोड़ी जाती है। ये क्रेडिट उस सदस्यता के लिए विशिष्ट होते हैं और केवल उसी सदस्यता के भविष्य के आवर्ती भुगतानों को ऑफसेट करने के लिए उपयोग किए जाएंगे
• full_immediately विकल्प क्रेडिट गणनाओं को बायपास करता है और पूरी नई योजना की राशि का शुल्क लेता है

​

शुल्क प्रसंस्करण

• योजना परिवर्तन पर शुरू किया गया तत्काल शुल्क आमतौर पर 2 मिनट से कम समय में प्रसंस्कृत होता है
• यदि यह तत्काल शुल्क किसी भी कारण से विफल होता है, तो सदस्यता स्वचालित रूप से होल्ड पर रखी जाती है जब तक कि समस्या का समाधान नहीं हो जाता

​

ऑन-डिमांड सदस्यताएँ