Credit Balance Alerts
Credit Balance Threshold Breached Alerts in Octane offer vendors a robust solution to stay informed about customer credit balance fluctuations. This feature serves various purposes, such as preventing fraudulent activities, alerting customers about their balance status, and identifying upsell opportunities for rapid credit consumption.
Similar to Spend Alerts, Credit Balance Alerts provide proactive insights into a critical financial aspect – the available credit balance. Available Credit Balance is calculated as the Ledger Balance at the beginning of the cycle minus any accrued revenue.
- Fraud Prevention: Identify and block potentially fraudulent customers operating below their balance threshold.
- Customer Communication: Alert and inform customers when they approach or cross certain balance amounts in their account.
- Upsell Opportunities: Recognize opportunities to upsell services for customers rapidly consuming their available credits.
Vendors can configure multiple thresholds for a single customer, allowing for flexibility in monitoring and responding to various credit balance scenarios.
When an alert is triggered due to a breached threshold, Octane sends a webhook (customer.credit_threshold_breached) containing essential details, including the threshold UUID and the breached threshold amount. For more information, refer to our Webhook Documentation.
Unlike Spend Alerts, Credit Balance Alerts operate solely on the available credit balance and do not involve specific timeframe configurations.
By default, this event is triggered only once when the threshold is breached. It does not re-trigger until a credit grant (regardless of the amount) is created after the breach. Vendors have the option to receive repeated alerts if the customer's balance remains below the threshold and no grants have been added. By setting the should_repeat_alert flag to True, the webhook will re-trigger at the specified repetition_frequency. The is_repeat_alert field on the webhook is set to True in this case.
It is important to note that the repetition frequency may not trigger if no measurements or subscription changes have occurred since the last alert. Octane computes available balance only when there are new measurements or relevant subscription changes.
For detailed information about fields, endpoints, and API configurations, please refer to our API Documentation.