Files
cfw-autumn/others/python-sdk/docs/models/balancescheckitem.md
John Yeo e8366d22ea latest
2026-02-18 16:24:19 +00:00

12 KiB
Raw Blame History

BalancesCheckItem

Product item defining features and pricing within a product

Fields

Field Type Required Description
type OptionalNullable[models.ProductType] The type of the product item
feature_id OptionalNullable[str] The feature ID of the product item. If the item is a fixed price, should be null
feature_type OptionalNullable[models.FeatureType] Single use features are used once and then depleted, like API calls or credits. Continuous use features are those being used on an ongoing-basis, like storage or seats.
included_usage OptionalNullable[models.IncludedUsage] The amount of usage included for this feature.
interval OptionalNullable[models.ProductInterval] The reset or billing interval of the product item. If null, feature will have no reset date, and if there's a price, it will be billed one-off.
interval_count OptionalNullable[float] The interval count of the product item.
price OptionalNullable[float] The price of the product item. Should be null if tiered pricing is set.
tiers List[models.Tiers] Tiered pricing for the product item. Not applicable for fixed price items.
usage_model OptionalNullable[models.UsageModel] Whether the feature should be prepaid upfront or billed for how much they use end of billing period.
billing_units OptionalNullable[float] The amount per billing unit (eg. $9 / 250 units)
reset_usage_when_enabled OptionalNullable[bool] Whether the usage should be reset when the product is enabled.
entity_feature_id OptionalNullable[str] The entity feature ID of the product item if applicable.
display OptionalNullable[models.ProductDisplay] The display of the product item.
quantity OptionalNullable[float] Used in customer context. Quantity of the feature the customer has prepaid for.
next_cycle_quantity OptionalNullable[float] Used in customer context. Quantity of the feature the customer will prepay for in the next cycle.
config OptionalNullable[models.Config] Configuration for rollover and proration behavior of the feature.