Active Entitlement 

An active entitlement describes access to a feature for a customer.

The Active Entitlement object 

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 

Retrieve an active entitlement

Parameters

  • idstringRequired

    The ID of the entitlement.

Returns

Returns an active entitlement

GET /v1/entitlements/active_entitlements/:id
curl https://api.stripe.com/v1/entitlements/active_entitlements/ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"id": "ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O",
"object": "entitlements.active_entitlement",
"feature": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu",
"lookup_key": "seats-feature",
"livemode": false
}

List all active entitlements 

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

GET /v1/entitlements/active_entitlements
curl -G https://api.stripe.com/v1/entitlements/active_entitlements \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d customer=cus_9s6XKzkNRiz8i3
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
}
]
}

Scheduled Queries 

If you have scheduled a Sigma query, you’ll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.