Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

List all features 

Retrieve a list of features

Parameters

  • archivedboolean

    If set, filter results to only include features with the given archive status.

  • lookup_keystring

    If set, filter results to only include features with the given lookup_key.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

Returns a list of your features

GET /v1/entitlements/features
curl -G https://api.stripe.com/v1/entitlements/features \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/entitlements/features",
  "has_more": false,
  "data": [
    {
      "id": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu",
      "object": "entitlements.feature",
      "livemode": false,
      "name": "My super awesome feature",
      "lookup_key": "my-super-awesome-feature",
      "active": true,
      "metadata": {}
    }
  ]
}

Updates a feature 

Update a feature’s metadata or permanently deactivate it.

Parameters

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • namestring

    The feature’s name, for your own purpose, not meant to be displayable to the customer.

More parameters

  • activeboolean

Returns

The updated feature.

POST /v1/entitlements/features/:id
curl https://api.stripe.com/v1/entitlements/features/feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "metadata[order_id]"=6735
Response
{
  "id": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu",
  "object": "entitlements.feature",
  "livemode": false,
  "name": "My super awesome feature",
  "lookup_key": "my-super-awesome-feature",
  "active": true,
  "metadata": {
    "order_id": "6735"
  }
}

Product Feature 

A product_feature represents an attachment between a feature and a product. When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.

Endpoints

Active Entitlement 

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

Endpoints

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.

Endpoints