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

The ProductFeature object 

Attributes

  • idstring

    Unique identifier for the object.

  • entitlement_featureobject

    The Feature object attached to this product.

More attributes

  • objectstring

  • livemodeboolean

The ProductFeature object
{
  "id": "prodft_BcMBZUWCIOEgEc",
  "object": "product_feature",
  "livemode": false,
  "entitlement_feature": {
    "id": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu",
    "object": "entitlements.feature",
    "livemode": false,
    "name": "My super awesome feature",
    "lookup_key": "my-super-awesome-feature",
    "metadata": {}
  }
}

List all features attached to a product 

Retrieve a list of features for a product

Parameters

No parameters.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

Returns a list of features for a product

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

Attach a feature to a product 

Creates a product_feature, which represents a feature attachment to a product

Parameters

  • entitlement_featurestringRequired

    The ID of the Feature object attached to this product.

Returns

Returns a product_feature

POST /v1/products/:id/features
curl https://api.stripe.com/v1/products/prod_NWjs8kKbJWmuuc/features \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d entitlement_feature=feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu
Response
{
  "id": "prodft_BcMBZUWCIOEgEc",
  "object": "product_feature",
  "livemode": false,
  "entitlement_feature": {
    "id": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu",
    "object": "entitlements.feature",
    "livemode": false,
    "name": "My super awesome feature",
    "lookup_key": "my-super-awesome-feature",
    "metadata": {}
  }
}

Remove a feature from a product 

Deletes the feature attachment to a product

Parameters

No parameters.

Returns

Returns an object with a deleted parameter on success. If the product feature ID does not exist, this call raises an error.

DELETE /v1/products/:id/features/:id
curl -X DELETE https://api.stripe.com/v1/products/prod_NWjs8kKbJWmuuc/features/prodft_BcMBZUWCIOEgEc \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "prodft_BcMBZUWCIOEgEc",
  "object": "product_feature",
  "deleted": true
}

Active Entitlement 

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

Endpoints