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

6.2 KiB
Raw Blame History

BalancesCheckRequest

Fields

Field Type Required Description
customer_id str ✔️ ID which you provided when creating the customer
feature_id Optional[str] N/A
entity_id Optional[str] If using entity balances (eg, seats), the entity ID to check access for.
required_balance Optional[float] If you know the amount of the feature the end user is consuming in advance. If their balance is below this quantity, allowed will be false.
properties Dict[str, Any] N/A
send_event Optional[bool] If true, a usage event will be recorded together with checking access. The required_balance field will be used as the usage value.
with_preview Optional[bool] If true, the response will include a preview object, which can be used to display information such as a paywall or upgrade confirmation.
product_id Optional[str] N/A
required_quantity Optional[float] N/A