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

The Feature object

Attributes

  • idstring

    Unique identifier for the object.

  • lookup_keystring

    A unique key you provide as your own system identifier. This may be up to 80 characters.

  • 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.

    The maximum length is 80 characters.

More attributes

  • objectstring

  • activeboolean

  • livemodeboolean

The Feature object
{
  "id": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu",
  "object": "entitlements.feature",
  "livemode": false,
  "name": "My super awesome feature",
  "lookup_key": "my-super-awesome-feature",
  "active": true,
  "metadata": {}
}

Create a feature

POST /v1/entitlements/features

Creates a feature

Parameters

  • lookup_keystringRequired

    A unique key you provide as your own system identifier. This may be up to 80 characters.

    The maximum length is 80 characters.

  • namestringRequired

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

    The maximum length is 80 characters.

  • 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.

Returns

Returns a feature

curl https://api.stripe.com/v1/entitlements/features \
  -u "sk_test_VePHdqK...NInc7u56JBrQsk_test_VePHdqKTYQjKNInc7u56JBrQ:" \
  -d "name=My super awesome feature" \
  -d lookup_key=my-super-awesome-feature
Response
{
  "id": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu",
  "object": "entitlements.feature",
  "livemode": false,
  "name": "My super awesome feature",
  "lookup_key": "my-super-awesome-feature",
  "active": true,
  "metadata": {}
}

List all features

GET /v1/entitlements/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

curl -G https://api.stripe.com/v1/entitlements/features \
  -u "sk_test_VePHdqK...NInc7u56JBrQsk_test_VePHdqKTYQjKNInc7u56JBrQ:" \
  -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": {}
    }
  ]
}