Interface BalanceStatus

Detailed balance snapshot used by the low-balance UI — includes the thresholds that drive balance.low_20 / balance.low_10 / balance.depleted webhook events so consumers can render accurate progress bars without reimplementing the math.

interface BalanceStatus {
    balance: number;
    initial_balance: null | number;
    lifetime_used: number;
    percentage_remaining: number;
    current_threshold: BalanceThreshold;
    next_threshold: null | BalanceStatusNextThreshold;
    tier: string;
    last_topup_at: null | string;
}

Properties

balance: number
initial_balance: null | number
lifetime_used: number
percentage_remaining: number
current_threshold: BalanceThreshold
next_threshold: null | BalanceStatusNextThreshold
tier: string
last_topup_at: null | string