Credit Grants
A credit grant is a quantified allocation of credits given to a subscription through a configured item price or as a promotional grant, consumed over time through ledger operations.
Example
A subscription receives a credit grant of 100 AI credits as a balance. As the customer uses AI features (e.g., Image Generation), the provisioned balance is consumed first. Once exhausted, further consumption is deducted from the overdraft balance until its limit is reached.
The Ledger Account Balance object
The ledger_account_balance object is a real-time snapshot of credit grants for a single combination of subscription_id, unit_id and unit_type.
The ledger tracks two balances:
- provisioned_balance: Reflects the credit grants given through the configured item price or promotional grants. These are prepaid credit grants for which the customer has already paid. Any ledger operation will prioritize consuming this balance first.
- overdraft_balance: Reflects the extra limit provided to a subscription in case it exhausts all credit grants before they are renewed or refreshed. Any ledger operation will consume this balance only when the provisioned balance has been exhausted.
Note
These two balances are always tracked together for a subscription with credit grants.
Example
A subscription has a credit grant of 100 AI credits, added to its provisioned balance. Once the provisioned balance is exhausted, further consumption is drawn from the overdraft balance up to its configured limit.
Returned by
- List ledger account balances API.
- Ledger operations such as capture and authorize.