Skip to main content

क्रेडिट-आधारित बिलिंग वेबहुक इवेंट्स

निम्नलिखित वेबहुक इवेंट्स क्रेडिट-आधारित बिलिंग जीवनचक्र परिवर्तन को ट्रैक करने के लिए उपलब्ध हैं। ये इवेंट्स वर्चुअल क्रेडिट अधिकारों (API कॉल, टोकन, कंप्यूट घंटे) पर लागू होते हैं, Customer Wallets (मॉनिटरी बैलेंस) पर नहीं।

लेज़र इवेंट्स

सभी लेज़र इवेंट्स (credit.added से credit.manual_adjustment तक) नीचे दिए गए स्कीमा में दस्तावेजीकृत समान CreditLedgerEntryResponse पेलोड साझा करते हैं। लोड में वो फ़ील्ड शामिल है जिसे क्रेडिट ग्रांट के स्रोत से हल किया गया है — चेकआउट के समय बनाई गई सदस्यता या भुगतान। यह आपको अपनी चेकआउट टेक्नोलॉजी से वॉलेट क्रेडिट्स को की करने की अनुमति देता है metadata (उदाहरण के लिए, एक orgId) बजाय Dodo-मुद्रित customer_id के: सदस्यता-स्रोत ग्रांट्स सदस्यता का metadata पेश करते हैं और भुगतान-स्रोत ग्रांट्स भुगतान का metadata पेश करते हैं। जब ग्रांट का कोई हल करने योग्य स्रोत नहीं होता है (उदाहरण के लिए, सीधे API के माध्यम से प्रदान किए गए क्रेडिट्स), तो फ़ील्ड खाली होता है।

बैलेंस लो इवेंट (credit.balance_low)

credit.balance_low इवेंट एक अलग पेलोड का उपयोग करता है (CreditBalanceLowPayload) जो थ्रेशोल्ड अलर्टिंग पर केंद्रित होता है:
string
वह ब्रांड जिससे यह क्रेडिट एंटाइटलमेंट संबंधित है।
string
वह ग्राहक जिसके क्रेडिट बैलेंस के कारण अलर्ट ट्रिगर हुआ।
string
इस क्रेडिट एंटाइटलमेंट से संबद्ध सब्सक्रिप्शन।
string
वह क्रेडिट एंटाइटलमेंट जिसका बैलेंस कम है।
string
क्रेडिट एंटाइटलमेंट का डिस्प्ले नाम।
string
अलर्ट के समय का वर्तमान क्रेडिट बैलेंस।
string
इस सब्सक्रिप्शन के लिए प्रत्येक बिलिंग साइकिल में जारी किए गए कुल क्रेडिट।
integer
कॉन्फ़िगर की गई कम बैलेंस सीमा का प्रतिशत।
string
वह निश्चित क्रेडिट राशि जिससे यह सीमा संबंधित है।

Proactive Alerts के लिए credit.balance_low का उपयोग करना

ग्राहकों को क्रेडिट समाप्त होने से पहले सूचित करने के लिए credit.balance_low webhook का उपयोग करें:
ग्राहकों के क्रेडिट समाप्त होने से पहले उन्हें सक्रिय रूप से अलर्ट करने के लिए credit.balance_low को सब्सक्राइब करें। रियल-टाइम उपयोग पैटर्न को ट्रैक करने के लिए इसे credit.deducted के साथ संयोजित करें।

Get Customer Balance

API के माध्यम से ग्राहक का वर्तमान बैलेंस देखें।

Create Ledger Entry

ग्राहक के बैलेंस में मैन्युअल रूप से क्रेडिट या डेबिट करें।

Webhook Payload Schema

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
अंतिम संशोधन 6 अगस्त 2026