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.
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
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
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.
Response
{
"id": "prodft_BcMBZUWCIOEgEc",
"object": "product_feature",
"deleted": true
}