Webhook Payloads
الفوترة المعتمدة على الرصيد
الحمولة المرسلة إلى نقطة اتصال الويب هوك الخاصة بك عند حدوث أحداث الفوترة المعتمدة على الرصيد — اعتمادات افتراضية (استدعاءات API، رموز مميزة، ساعات حوسبة) مُنحت، مُستهلكة، منتهية الصلاحية، مُرحلة، أو تنبيهات الرصيد. لا ترتبط هذه الويب هوكات بـ محافظ العملاء (الأرصدة النقدية).
أحداث الويب هوك للفوترة المعتمدة على الرصيد
الأحداث التالية للويب هوك متاحة لتعقب تغييرات دورة حياة الفوترة المعتمدة على الرصيد. تنطبق هذه الأحداث على استحقاقات الاعتماد الافتراضي (استدعاءات API، رموز مميزة، ساعات حوسبة)، ولا تنطبق على محافظ العملاء (الأرصدة النقدية).أحداث دفتر الأستاذ
تشترك جميع أحداث دفتر الأستاذ (credit.added وحتى credit.manual_adjustment) في نفس الحمولة CreditLedgerEntryResponse الموضحة في المخطط أدناه.
حدث انخفاض الرصيد (credit.balance_low)
يستخدم الحدثcredit.balance_low حمولة مختلفة (CreditBalanceLowPayload) تركز على تنبيه العتبة:
string
العميل الذي أدى رصيده من الاعتماد إلى تشغيل التنبيه.
string
الاشتراك المرتبط بهذا الاستحقاق الاعتمادي.
string
الاستحقاق الاعتمادي الذي أصبح رصيده منخفضًا.
string
اسم العرض للاستحقاق الاعتمادي.
string
الرصيد الحالي من الاعتماد وقت حدوث التنبيه.
string
إجمالي الاعتمادات الممنوحة خلال كل دورة فوترة لهذا الاشتراك.
integer
نسبة حد الرصيد المنخفض المكوَّنة.
string
مقدار الاعتماد المطلق الذي تتوافق معه العتبة.
استخدام credit.balance_low لتنبيهات استباقية
استخدم ويب هوك credit.balance_low لإخطار العملاء قبل نفاد اعتماداتهم:
Get Customer Balance
تحقق من الرصيد الحالي للعميل عبر API.
Create Ledger Entry
قم بمناولة الإضافة أو الخصم يدويًا لرصيد العميل.
مخطط حمولة الويب هوك
مخطط حزمة بيانات Webhook
Response for a ledger entry
Brand id this credit ledger entry belongs to
Metadata associated with the credit grant's source (the subscription or payment created at checkout). Empty when the grant has no resolvable source (e.g. credits granted directly via the API).
الخيارات المتاحة:
credit_added, credit_deducted, credit_expired, credit_rolled_over, rollover_forfeited, overage_charged, overage_reset, auto_top_up, manual_adjustment, refund آخر تعديل في ٩ يوليو ٢٠٢٦