4.1 KiB
4.1 KiB
Balances
Fields
| Field | Type | Required | Description |
|---|---|---|---|
feature_id |
str | ✔️ | The feature ID this balance is for. |
feature |
Optional[models.CustomerFeature] | ➖ | The full feature object if expanded. |
granted |
float | ✔️ | Total balance granted (included + prepaid). |
remaining |
float | ✔️ | Remaining balance available for use. |
usage |
float | ✔️ | Total usage consumed in the current period. |
unlimited |
bool | ✔️ | Whether this feature has unlimited usage. |
overage_allowed |
bool | ✔️ | Whether usage beyond the granted balance is allowed (with overage charges). |
max_purchase |
Nullable[float] | ✔️ | Maximum quantity that can be purchased as a top-up, or null for unlimited. |
next_reset_at |
Nullable[float] | ✔️ | Timestamp when the balance will reset, or null for no reset. |
breakdown |
List[models.Breakdown] | ➖ | Detailed breakdown of balance sources when stacking multiple plans or grants. |
rollovers |
List[models.CustomerRollover] | ➖ | Rollover balances carried over from previous periods. |