CheckParams

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).
`required_balance`	Optional[float]	➖	Minimum balance required for access. Returns allowed: false if the customer's balance is below this value. Defaults to 1.
`properties`	Dict[str, Any]	➖	Additional properties to attach to the usage event if send_event is true.
`send_event`	Optional[bool]	➖	If true, atomically records a usage event while checking access. The required_balance value is used as the usage amount. Combines check + track in one call.
`with_preview`	Optional[bool]	➖	If true, includes upgrade/upsell information in the response when access is denied. Useful for displaying paywalls.