Webhook Payloads
الفوترة المعتمدة على الرصيد
الحمولة المرسلة إلى نقطة اتصال الويب هوك الخاصة بك عند حدوث أحداث الفوترة المعتمدة على الرصيد — اعتمادات افتراضية (استدعاءات API، رموز مميزة، ساعات حوسبة) مُنحت، مُستهلكة، منتهية الصلاحية، مُرحلة، أو تنبيهات الرصيد. لا ترتبط هذه الويب هوكات بـ محافظ العملاء (الأرصدة النقدية).
Documentation Index
Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
Use this file to discover all available pages before exploring further.
أحداث الويب هوك للفوترة المعتمدة على الرصيد
الأحداث التالية للويب هوك متاحة لتعقب تغييرات دورة حياة الفوترة المعتمدة على الرصيد. تنطبق هذه الأحداث على استحقاقات الاعتماد الافتراضي (استدعاءات API، رموز مميزة، ساعات حوسبة)، ولا تنطبق على محافظ العملاء (الأرصدة النقدية).| الحدث | الوصف |
|---|---|
credit.added | يتم منح الاعتمادات للعميل (من خلال الاشتراك، أو عملية شراء لمرة واحدة، أو إضافة، أو API) |
credit.deducted | يتم استهلاك الاعتمادات من خلال الاستخدام أو الخصم اليدوي |
credit.expired | تنتهي صلاحية الاعتمادات غير المستخدمة بعد فترة انتهاء الصلاحية المكوَّنة |
credit.rolled_over | تُرحَّل الاعتمادات غير المستخدمة إلى منحة جديدة عند نهاية الدورة |
credit.rollover_forfeited | يتم مصادرة الاعتمادات لأن الحد الأقصى لعدد عمليات الترحيل قد تم بلوغه |
credit.overage_charged | يتم تطبيق رسوم تجاوز عند استمرار الاستخدام بعد وصول الرصيد إلى الصفر |
credit.manual_adjustment | تعديل يدوي على الاعتماد أو الخصم يتم عبر لوحة التحكم أو API |
credit.balance_low | ينخفض رصيد الاعتماد إلى ما دون الحد الأدنى المكوَّن |
أحداث دفتر الأستاذ
تشترك جميع أحداث دفتر الأستاذ (credit.added وحتى credit.manual_adjustment) في نفس الحمولة CreditLedgerEntryResponse الموضحة في المخطط أدناه.
حدث انخفاض الرصيد (credit.balance_low)
يستخدم الحدثcredit.balance_low حمولة مختلفة (CreditBalanceLowPayload) تركز على تنبيه العتبة:
العميل الذي أدى رصيده من الاعتماد إلى تشغيل التنبيه.
الاشتراك المرتبط بهذا الاستحقاق الاعتمادي.
الاستحقاق الاعتمادي الذي أصبح رصيده منخفضًا.
اسم العرض للاستحقاق الاعتمادي.
الرصيد الحالي من الاعتماد وقت حدوث التنبيه.
إجمالي الاعتمادات الممنوحة خلال كل دورة فوترة لهذا الاشتراك.
نسبة حد الرصيد المنخفض المكوَّنة.
مقدار الاعتماد المطلق الذي تتوافق معه العتبة.
استخدام credit.balance_low لتنبيهات استباقية
استخدم ويب هوك credit.balance_low لإخطار العملاء قبل نفاد اعتماداتهم:
Get Customer Balance
تحقق من الرصيد الحالي للعميل عبر API.
Create Ledger Entry
قم بمناولة الإضافة أو الخصم يدويًا لرصيد العميل.
مخطط حمولة الويب هوك
Response for a ledger entry
الخيارات المتاحة:
credit_added, credit_deducted, credit_expired, credit_rolled_over, rollover_forfeited, overage_charged, overage_reset, auto_top_up, manual_adjustment, refund Last modified on March 2, 2026