Skip to main content

أحداث الويب هوك للفوترة المعتمدة على الرصيد

الأحداث التالية للويب هوك متاحة لتعقب تغييرات دورة حياة الفوترة المعتمدة على الرصيد. تنطبق هذه الأحداث على استحقاقات الاعتماد الافتراضي (استدعاءات 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 لإخطار العملاء قبل نفاد أرصدتهم الائتمانية:
اشترك في credit.balance_low لإخطار العملاء استباقيًا قبل استنفاد أرصدتهم الائتمانية. ادمجه مع credit.deducted لتتبّع أنماط الاستهلاك في الوقت الفعلي.

Get Customer Balance

تحقّق من الرصيد الحالي للعميل عبر API.

Create Ledger Entry

أضف رصيدًا إلى رصيد العميل أو اخصم منه يدويًا.

مخطط حمولة Webhook

Response for a ledger entry

amount
string
مطلوب
balance_after
string
مطلوب
balance_before
string
مطلوب
brand_id
string
مطلوب

Brand id this credit ledger entry belongs to

business_id
string
مطلوب
created_at
string<date-time>
مطلوب
credit_entitlement_id
string
مطلوب
customer_id
string
مطلوب
id
string
مطلوب
is_credit
boolean
مطلوب
metadata
Metadata · object
مطلوب

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

overage_after
string
مطلوب
overage_before
string
مطلوب
transaction_type
enum<string>
مطلوب
الخيارات المتاحة:
credit_added,
credit_deducted,
credit_expired,
credit_rolled_over,
rollover_forfeited,
overage_charged,
overage_reset,
auto_top_up,
manual_adjustment,
refund
description
string | null
grant_id
string | null
reference_id
string | null
reference_type
string | null
آخر تعديل في ٦ أغسطس ٢٠٢٦