5.0 KiB
5.0 KiB
BalancesCheckRequest
Fields
| Field | Type | Required | Description |
|---|---|---|---|
customer_id |
str | ✔️ | ID which you provided when creating the customer |
feature_id |
str | ✔️ | ID of the feature to check access to. |
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. |