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

4.0 KiB
Raw Blame History

CreateBalanceParams

Fields

Field Type Required Description
customer_id str ✔️ The ID of the customer.
feature_id str ✔️ The ID of the feature.
entity_id Optional[str] The ID of the entity for entity-scoped balances (e.g., per-seat limits).
included Optional[float] The initial balance amount to grant. For metered features, this is the number of units the customer can use.
unlimited Optional[bool] If true, the balance has unlimited usage. Cannot be combined with 'included'.
reset Optional[models.CreateBalanceReset] Reset configuration for the balance. If not provided, the balance is a one-time grant that never resets.
expires_at Optional[float] Unix timestamp (milliseconds) when the balance expires. Mutually exclusive with reset.