# CheckResponse

OK


## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowed`                                                                                                                                                                                                                                                                                                                                                                                                                                                             | *bool*                                                                                                                                                                                                                                                                                                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Whether the customer is allowed to use the feature. True if they have sufficient balance or the feature is unlimited/boolean.                                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `customer_id`                                                                                                                                                                                                                                                                                                                                                                                                                                                         | *str*                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The ID of the customer that was checked.                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `entity_id`                                                                                                                                                                                                                                                                                                                                                                                                                                                           | *OptionalNullable[str]*                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The ID of the entity, if an entity-scoped check was performed.                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `required_balance`                                                                                                                                                                                                                                                                                                                                                                                                                                                    | *Optional[float]*                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The required balance that was checked against.                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `balance`                                                                                                                                                                                                                                                                                                                                                                                                                                                             | [Nullable[models.Balance]](../models/balance.md)                                                                                                                                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The customer's balance for this feature. Null if the customer has no balance for this feature.                                                                                                                                                                                                                                                                                                                                                                        | {<br/>"feature_id": "messages",<br/>"granted": 100,<br/>"remaining": 72,<br/>"usage": 28,<br/>"unlimited": false,<br/>"overage_allowed": false,<br/>"max_purchase": null,<br/>"next_reset_at": 1773851121437,<br/>"breakdown": [<br/>{<br/>"id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",<br/>"plan_id": "pro_plan",<br/>"included_grant": 100,<br/>"prepaid_grant": 0,<br/>"remaining": 72,<br/>"usage": 28,<br/>"unlimited": false,<br/>"reset": {<br/>"interval": "month",<br/>"resets_at": 1773851121437<br/>},<br/>"price": null,<br/>"expires_at": null<br/>}<br/>]<br/>} |
| `preview`                                                                                                                                                                                                                                                                                                                                                                                                                                                             | [Optional[models.Preview]](../models/preview.md)                                                                                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Upgrade/upsell information when access is denied. Only present if with_preview was true and allowed is false.                                                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |