Stripe: Entitlements schemas

← Entitlements operations · All schemas

Create a feature — response body

Field	Type	Presence	Description and constraints
$	object	Root	A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
active	boolean	Required within parent	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
lookup_key	string	Required within parent	A unique key you provide as your own system identifier. This may be up to 80 characters. Maximum length: 5000
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
name	string	Required within parent	The feature's name, for your own purpose, not meant to be displayable to the customer. Maximum length: 80
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: entitlements.feature

Retrieve an active entitlement — response body

Field	Type	Presence	Description and constraints
$	object	Root	An active entitlement describes access to a feature for a customer.
feature	JSON	Required within parent	The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to.
feature (anyOf 1)	string	Alternative	Maximum length: 5000
feature (anyOf 2)	Model	Alternative	Expand Create a feature — response body
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
lookup_key	string	Required within parent	A unique key you provide as your own system identifier. This may be up to 80 characters. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: entitlements.active_entitlement

Referenced models: Create a feature — response body