An active entitlement describes access to a feature for a customer.
Attributes
- idstring
Unique identifier for the object.
- featurestringExpandable
The Feature that the customer is entitled to.
- lookup_
keystring A unique key you provide as your own system identifier. This may be up to 80 characters.
More attributes
- objectstring
- livemodeboolean
The Active Entitlement object
{ "id": "ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O", "object": "entitlements.active_entitlement", "feature": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu", "lookup_key": "seats-feature", "livemode": false}
Retrieve an active entitlement
Parameters
- idstringRequired
The ID of the entitlement.
Returns
Returns an active entitlement
Response
{ "id": "ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O", "object": "entitlements.active_entitlement", "feature": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu", "lookup_key": "seats-feature", "livemode": false}
Retrieve a list of active entitlements for a customer
Parameters
- customerstringRequired
The ID of the customer.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
Returns a list of active entitlements for a customer
Response
{ "object": "list", "url": "/v1/entitlements/active_entitlements", "has_more": false, "data": [ { "id": "ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O", "object": "entitlements.active_entitlement", "feature": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu", "lookup_key": "seats-feature", "livemode": false } ]}
If you have scheduled a Sigma query, you’ll receive a sigma.
webhook each time the query runs. The webhook contains a ScheduledQueryRun
object, which you can use to retrieve the query results.