Create a feature
POST / v1 / entitlements / features
Creates a feature
Parameters
- lookup _ key string Required A unique key you provide as your own system identifier. This may be up to 80 characters. The maximum length is 80 characters.
- name string Required The feature’s name, for your own purpose, not meant to be displayable to the customer. The maximum length is 80 characters.
- metadata map 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
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
- archived boolean If set, filter results to only include features with the given archive status.
- lookup _ key string If set, filter results to only include features with the given lookup_key.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
Returns a list of your features
Response
Updates a feature
POST / v1 / entitlements / features /:id
Update a feature’s metadata or permanently deactivate it.
Parameters
- metadata map 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.
- name string The feature’s name, for your own purpose, not meant to be displayable to the customer. The maximum length is 80 characters.
More parameters
- active boolean
Returns
The updated 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": { "order_id": "6735" }}