Webhook Payloads
الفوترة المعتمدة على الرصيد
الحمولة المرسلة إلى نقطة اتصال الويب هوك الخاصة بك عند حدوث أحداث الفوترة المعتمدة على الرصيد — اعتمادات افتراضية (استدعاءات API، رموز مميزة، ساعات حوسبة) مُنحت، مُستهلكة، منتهية الصلاحية، مُرحلة، أو تنبيهات الرصيد. لا ترتبط هذه الويب هوكات بـ محافظ العملاء (الأرصدة النقدية).
أحداث الويب هوك للفوترة المعتمدة على الرصيد
الأحداث التالية للويب هوك متاحة لتعقب تغييرات دورة حياة الفوترة المعتمدة على الرصيد. تنطبق هذه الأحداث على استحقاقات الاعتماد الافتراضي (استدعاءات API، رموز مميزة، ساعات حوسبة)، ولا تنطبق على محافظ العملاء (الأرصدة النقدية).أحداث دفتر الأستاذ
تشترك جميع أحداث دفتر الأستاذ (credit.added وحتى credit.manual_adjustment) في نفس الحمولة CreditLedgerEntryResponse الموضحة في المخطط أدناه.
حدث انخفاض الرصيد (credit.balance_low)
يستخدم الحدثcredit.balance_low حمولة مختلفة (CreditBalanceLowPayload) تركز على تنبيه العتبة:
string
العلامة التجارية التي ينتمي إليها استحقاق الائتمان هذا.
string
العميل الذي أدى رصيد ائتمانه إلى تشغيل التنبيه.
string
الاشتراك المرتبط باستحقاق الائتمان هذا.
string
استحقاق الائتمان الذي لديه رصيد منخفض.
string
الاسم المعروض لاستحقاق الائتمان.
string
رصيد الائتمان الحالي وقت إطلاق التنبيه.
string
إجمالي الأرصدة الائتمانية المُصدرة لكل دورة فوترة لهذا الاشتراك.
integer
النسبة المئوية المكوّنة لحد الرصيد المنخفض.
string
مقدار الائتمان المطلق الذي يقابله الحد.
استخدام credit.balance_low للتنبيهات الاستباقية
استخدم webhook 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 آخر تعديل في ٦ أغسطس ٢٠٢٦