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