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

​

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

• एक डोडो पेमेंट्स व्यापारी खाता
• डैशबोर्ड से 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 - Subscription सफलतापूर्वक सक्रिय हो गई है।
2. subscription.updated - Subscription ऑब्जेक्ट अपडेट हो गया था (कोई भी फ़ील्ड बदलते ही ट्रिगर होता है)।
3. subscription.on_hold - असफल नवीनीकरण के कारण Subscription को होल्ड पर रखा गया है।
4. subscription.failed - मैनडेट बनाने के दौरान Subscription निर्माण विफल हो गया।
5. subscription.renewed - Subscription अगले बिलिंग अवधि के लिए नवीनीकृत कर दी गई है।

​

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

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

1. Subscription Failure

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

2. Subscription On Hold

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

​

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

​

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

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

​

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

1. शेष बकाया के लिए एक चार्ज बनाता है
2. चार्ज के लिए एक इनवॉइस बनाता है
3. नई भुगतान विधि का उपयोग करके भुगतान संसाधित करता है
4. सफल भुगतान पर Subscription को 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 Dollars है और ग्राहक 80 Dollars योजना में अपग्रेड करता है, तो उन्हें तुरंत 50 डॉलर चार्ज किया जाता है।
• डाउनग्रेड करते समय, वर्तमान योजना से अप्रयुक्त राशि आंतरिक क्रेडिट के रूप में जोड़ी जाती है और भविष्य की सदस्यता नवीनीकरणों पर स्वचालित रूप से लागू होती है।
• उदाहरण के लिए, यदि वर्तमान योजना 50 Dollars है और ग्राहक 20 Dollars योजना पर स्विच करता है, तो शेष $30 को क्रेडिट किया जाता है और अगले बिलिंग चक्र के लिए उपयोग किया जाता है।

​

व्यवहार

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

​

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

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

​

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