Aviate Wallet

The Aviate plugin enables the management of Account wallets — credit pools that can be replenished manually or automatically based on configurable criteria. These credits are consumed by the system to pay for usage, and the wallet mechanism is primarily intended for prepaid scenarios. This helps mitigate financial risk typically associated with billing for usage in arrears.

Credits can be granted either for free or as part of a payment. In the latter case, a Kill Bill invoice is generated and a payment is processed using the Account’s default payment method. An optional expiration date can be assigned to credits. If the payment fails, the credit is recorded but remains inactive; it is only activated once the payment against the invoice is successfully completed.

Wallets can be configured with automatic replenishment rules (top-off), which support two modes: restoring the balance to a target level or adding a fixed amount when the balance falls below a threshold. These automatically granted credits can also include an expiration date. Additionally, wallets can be initialized with a predefined amount of free or paid credits.

The wallet is implemented as a ledger that tracks all transactions, including credit additions and consumptions. It exposes two values: the balance, representing currently available credits, and the live balance, which includes credits reserved for pending invoice generation.

Currently, each customer Account supports a single wallet, and the wallet must use the Account’s default currency.

This section provides a step-by-step guide to start using the Aviate Wallet functionality.