دليل تكامل الاشتراك

​

المتطلبات الأساسية

• حساب تاجر مدفوعات دودو
• بيانات اعتماد واجهة برمجة التطبيقات (مفتاح API ومفتاح سرية webhook) من لوحة التحكم

​

تكامل واجهة برمجة التطبيقات

​

جلسات الدفع

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);

​

استجابة واجهة برمجة التطبيقات

{
  "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 - يشير إلى خصم الدفع وتجديده للدورة التالية. (بشكل أساسي، كلما تم خصم الدفع لمنتجات الاشتراك، ستحصل على webhook 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
}

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 دولار المتبقية للرصيد ويستخدم في دورة الفوترة القادمة.

​

السلوك

• عند استدعاء واجهة برمجة التطبيقات هذه، يبدأ Dodo Payments فورًا في معالجة الرسوم بناءً على خيار التناسب المحدد
• إذا كان تغيير الخطة هو تخفيض واستُخدم prorated_immediately، سيتم حساب الأرصدة تلقائيًا وإضافتها إلى رصيد الاعتمادات للاشتراك. هذه الأرصدة محددة لذلك الاشتراك وستستخدم فقط لتعويض الدفعات المتكررة المستقبلية لنفس الاشتراك
• يتجاوز خيار full_immediately حساب الأرصدة ويفرض المبلغ الكامل للخطة الجديدة

​

معالجة الرسوم

• عادةً ما تكتمل عملية الرسوم الفورية التي تتم عند تغيير الخطة في أقل من دقيقتين
• إذا فشلت هذه الرسوم الفورية لأي سبب، يتم تلقائيًا تعليق الاشتراك حتى يتم حل المشكلة

​

الاشتراكات بحسب الطلب

​

مرجع API المرتبط