Retrieve an active entitlement
Parameters
- idstringRequired
The ID of the entitlement.
Returns
Returns an active entitlement
{ "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
{ "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.
Represents an ad-hoc execution of a Sigma query via the API
The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.
Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.