Webhook Payloads
क्रेडिट-आधारित बिलिंग
क्रेडिट-आधारित बिलिंग इवेंट्स होने पर आपके वेबहुक एंडपॉइंट पर भेजा जाने वाला पेलोड — वर्चुअल क्रेडिट (API कॉल, टोकन, कंप्यूट घंटे) प्रदान किए गए, उपयोग किए गए, समाप्त हो गए, रोलओवर किए गए, या बैलेंस अलर्ट। ये वेबहुक Customer Wallets (मॉनिटरी बैलेंस) से संबंधित नहीं हैं।
क्रेडिट-आधारित बिलिंग वेबहुक इवेंट्स
निम्नलिखित वेबहुक इवेंट्स क्रेडिट-आधारित बिलिंग जीवनचक्र परिवर्तन को ट्रैक करने के लिए उपलब्ध हैं। ये इवेंट्स वर्चुअल क्रेडिट अधिकारों (API कॉल, टोकन, कंप्यूट घंटे) पर लागू होते हैं, Customer Wallets (मॉनिटरी बैलेंस) पर नहीं।| इवेंट | विवरण |
|---|---|
credit.added | ग्राहक को क्रेडिट प्रदान किए जाते हैं (सदस्यता, एकमुश्त खरीद, ऐड-ऑन, या API के माध्यम से) |
credit.deducted | उपयोग या मैनुअल डेबिट के माध्यम से क्रेडिट का उपभोग किया जाता है |
credit.expired | निर्धारित समाप्ति अवधि के बाद अप्रयुक्त क्रेडिट की समाप्ति हो जाती है |
credit.rolled_over | अप्रयुक्त क्रेडिट को नई ग्रांट में आगे बढ़ाया जाता है जब चक्र समाप्त होता है |
credit.rollover_forfeited | अधिकतम रोलओवर गणना तक पहुँचने के कारण क्रेडिट जब्त कर लिया गया |
credit.overage_charged | जब उपयोग शून्य शेष राशि से परे जारी रहता है, तो अतिरिक्त शुल्क लागू होता है |
credit.overage_reset | संचित अतिरिक्त शुल्क रीसेट किया जाता है (उदाहरण के लिए, नए बिलिंग चक्र की शुरुआत में) |
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 अंतिम संशोधन 22 मई 2026