Files
cfw-autumn/others/python-sdk/docs/models/breakdown.md
2026-02-19 14:14:12 +00:00

3.7 KiB
Raw Blame History

Breakdown

Fields

Field Type Required Description
id Optional[str] The unique identifier for this balance breakdown.
plan_id Nullable[str] ✔️ The plan ID this balance originates from, or null for standalone balances.
included_grant float ✔️ Amount granted from the plan's included usage.
prepaid_grant float ✔️ Amount granted from prepaid purchases or top-ups.
remaining float ✔️ Remaining balance available for use.
usage float ✔️ Amount consumed in the current period.
unlimited bool ✔️ Whether this balance has unlimited usage.
reset Nullable[models.BalanceReset] ✔️ Reset configuration for this balance, or null if no reset.
price Nullable[models.BalancePrice] ✔️ Pricing configuration if this balance has usage-based pricing.
expires_at Nullable[float] ✔️ Timestamp when this balance expires, or null for no expiration.