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

​

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

• एक डोडो पेमेंट्स व्यापारी खाता
• डैशबोर्ड से 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"
}

​

Webhooks

​

सब्सक्रिप्शन इवेंट प्रकार

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 - असफल रिन्यूअल भुगतान या प्लान परिवर्तन शुल्क के कारण सब्सक्रिप्शन होल्ड पर है।
• जब एक सब्सक्रिप्शन होल्ड पर जाता है, तो यह स्वचालित रूप से नवीनीकरण नहीं करेगा जब तक कि भुगतान विधि अपडेट नहीं की जाती।

​

subscription.failed बनाम 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
}

# Update with new payment method
response = client.subscriptions.update_payment_method(
    subscription_id=subscription_id,
    type="new",
    return_url="https://example.com/return"
)

# For on_hold subscriptions, a charge is automatically created
if response.payment_id:
    print("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 क्रेडिट के रूप में सहेजा जाता है और अगले बिलिंग चक्र में लागू होता है।

​

व्यवहार

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

​

चार्ज प्रोसेसिंग

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

​

ऑन-डिमांड सब्सक्रिप्शन

​

संबंधित API संदर्श