# Entitlements

Determine when you can grant or revoke product feature access to customers.

Entitlements enable you to map the features of your internal service to Stripe products. After you map your features, Stripe notifies you about when to provision or de-provision access (according to your customer’s subscription status), and to what features, based on your mapping choices.

Use Entitlements to:

- Launch, change, and experiment with your pricing without needing to change your codebase
- Grant, revoke, and manage customer’s feature access
- Simplify your billing integration

Stripe Billing Entitlements API demo

This guide assumes that you’re already using Stripe [Subscriptions](https://docs.stripe.com/billing/subscriptions/build-subscriptions.md) and [Customer](https://docs.stripe.com/invoicing/customer.md) resources.

# Dashboard

> This is a Dashboard for when dashboard-or-api is dashboard. View the original doc at https://docs.stripe.com/billing/entitlements?dashboard-or-api=dashboard.

## Get started 

To get started with Entitlements:

- **Set up your features**: Create each feature in Stripe Billing from the Dashboard. Here are some examples of features you can include:
  - API access
  - AI assistant
  - Premium support
  - Advanced reporting
  - Extended data retention
- **Add your features to products**: Attach features to corresponding Stripe Products. You can add a single feature to multiple products.
- **Manage your features**: Edit or archive each feature from the Dashboard.

## Set up your features

To create a feature in the Dashboard, do the following:

1. In the Dashboard, go to the [Product catalog](https://dashboard.stripe.com/products) and click **Features**.
1. Click **+ Create feature** and enter a Name and a Lookup Key for the feature. You can optionally also add Metadata.
1. Because the Lookup Key is unique to each feature, you can’t reuse it across different features unless you archive the feature associated with the Lookup Key.
1. Click **Create feature**.

## Add your features to products

To add a feature to a product in the Dashboard, do the following:

1. In the Dashboard, from the [Features](https://dashboard.stripe.com/features) tab, click the feature that you want to add.
1. Click **Attach to product** and select a product from the menu.
1. Click **Confirm**.

When a customer subscribes to the product, you can view what features they’re entitled to. To do this, go to the [Customers](https://dashboard.stripe.com/customers) page, select the customer, and review the Entitlements section.

## Manage features

You can manage features from the Dashboard.

### Edit a feature

To edit a feature’s Name or add Metadata, go to the [Features](https://dashboard.stripe.com/features) tab, click the overflow menu (⋯), and click **Edit feature**. You can’t edit a feature’s Lookup Key after the feature is created.

### Remove a feature from a product

To remove a feature from a product, go to the [Features](https://dashboard.stripe.com/features) tab and select the feature. Then click the overflow menu (⋯) next to the product name and click **Remove product**.

### Archive a feature

To archive a feature, go to the [Features](https://dashboard.stripe.com/features) tab, click the overflow menu (⋯), and click **Archive feature**.

Before you archive a feature, keep in mind the following:

- Archived features can’t be edited or added to any new products.
- Archived features still create entitlements if attached to existing products.
- An archived feature’s lookup key can be used again.
- You can’t unarchive a feature.

# API

> This is a API for when dashboard-or-api is api. View the original doc at https://docs.stripe.com/billing/entitlements?dashboard-or-api=api.

## Get started 

To get started with Entitlements:

- **Set up your features**: Create each feature in Stripe Billing using the [Feature API](https://docs.stripe.com/api/entitlements/feature/object.md). Here are some examples of features you can include:
  - API access
  - AI assistant
  - Premium support
  - Advanced reporting
  - Extended data retention
- **Add your features to products**: Attach Features to corresponding Stripe Products. You can add a single feature to multiple products.
- **Get customers’ active entitlements**: When customers subscribe to your products, Stripe Billing entitles the customer to the product’s features. Listen to the [Active Entitlement Summary webhook](#webhooks) and use the [List Active Entitlements API](https://docs.stripe.com/api/entitlements/active-entitlement/list.md) for a given customer to execute your feature provisioning process.

![Diagram with Entitlements and its relationship with a Customer and Product's features](images/billing/entitlements/entitlements-diagram.png)

## Set up your features

Provide a name and a unique `lookup_key` for each feature you create. Because the `lookup_key` is unique to each feature, you can’t reuse it across different features.

```dotnet
StripeConfiguration.ApiKey = "<<secret key>>";

var options = new Stripe.Entitlements.FeatureCreateOptions
{
    Name = "My feature",
    LookupKey = "myinternalfeaturecode",
};
var service = new Stripe.Entitlements.FeatureService();
Stripe.Entitlements.Feature feature = service.Create(options);
```

```go
stripe.Key = "<<secret key>>"

params := &stripe.EntitlementsFeatureParams{
  Name: stripe.String("My feature"),
  LookupKey: stripe.String("myinternalfeaturecode"),
};
result, err := feature.New(params);
```

```java
Stripe.apiKey = "<<secret key>>";

FeatureCreateParams params =
  FeatureCreateParams.builder().setName("My feature").setLookupKey("myinternalfeaturecode").build();

Feature feature = Feature.create(params);
```

```node
const stripe = require('stripe')('<<secret key>>');

const feature = await stripe.entitlements.features.create({
  name: 'My feature',
  lookup_key: 'myinternalfeaturecode',
});
```

```python
import stripe
stripe.api_key = "<<secret key>>"

feature =
stripe.entitlements.Feature.create(
  name="My feature",
  lookup_key="myinternalfeaturecode",
)
```

```php
$stripe = new \Stripe\StripeClient('<<secret key>>');

$feature = $stripe->entitlements->features->create([
  'name' => 'My feature',
  'lookup_key' => 'myinternalfeaturecode',
]);
```

```ruby
Stripe.api_key = '<<secret key>>'

feature = Stripe::Entitlements::Feature.create({
  name: 'My feature',
  lookup_key: 'myinternalfeaturecode',
})
```

## Add your features to products

Assign your feature to one or more products.

Existing subscriptions will create active entitlements for any product feature changes at the start of the next billing period.

```dotnet
StripeConfiguration.ApiKey = "<<secret key>>";

var options = new ProductFeatureCreateOptions { EntitlementFeature = "<<entitlementsFeature>>" };
var service = new ProductFeatureService();
ProductFeature productFeature = service.Create("<<product>>", options);
```

```go
stripe.Key = "<<secret key>>"

params := &stripe.ProductFeatureParams{
  EntitlementFeature: stripe.String("<<entitlementsFeature>>"),
  Product: stripe.String("<<product>>"),
};
result, err := productfeature.New(params);
```

```java
Stripe.apiKey = "<<secret key>>";

ProductFeatureCreateParams params =
  ProductFeatureCreateParams.builder().setEntitlementFeature("<<entitlementsFeature>>").build();

ProductFeature productFeature = ProductFeature.create("<<product>>", params);
```

```node
const stripe = require('stripe')('<<secret key>>');

const productFeature = await stripe.products.createFeature(
  '<<product>>',
  {
    entitlement_feature: '<<entitlementsFeature>>',
  }
);
```

```python
import stripe
stripe.api_key = "<<secret key>>"

product_feature =
stripe.Product.create_feature(
  "<<product>>",
  entitlement_feature="<<entitlementsFeature>>",
)
```

```php
$stripe = new \Stripe\StripeClient('<<secret key>>');

$productFeature = $stripe->products->createFeature(
  '<<product>>',
  ['entitlement_feature' => '<<entitlementsFeature>>']
);
```

```ruby
Stripe.api_key = '<<secret key>>'

product_feature = Stripe::Product.create_feature(
  '<<product>>',
  {entitlement_feature: '<<entitlementsFeature>>'},
)
```

After you submit a request to attach your feature to your product, you receive a response similar to the following:

```json
{
  "id": "{{PRODUCT_FEATURE_ID}}",
  "object": "product_feature",
  "entitlement_feature": {
    "id": "{{ENTITLEMENTS_FEATURE_ID}}",
    "object": "entitlements.feature",
    "name": "My feature",
    "lookup_key": "myinternalfeaturecode"
  }
}
```

List the features attached to a product by paging through the list of product features:

```dotnet
StripeConfiguration.ApiKey = "<<secret key>>";

var service = new ProductFeatureService();
StripeList<ProductFeature> productFeatures = service.List("<<product>>");
```

```go
stripe.Key = "<<secret key>>"

params := &stripe.ProductFeatureListParams{Product: stripe.String("<<product>>")};
result := productfeature.List(params);
```

```java
Stripe.apiKey = "<<secret key>>";

ProductFeatureListParams params = ProductFeatureListParams.builder().build();

ProductFeatureCollection productFeatures = ProductFeature.list("<<product>>", params);
```

```node
const stripe = require('stripe')('<<secret key>>');

const productFeatures = await stripe.products.listFeatures('<<product>>');
```

```python
import stripe
stripe.api_key = "<<secret key>>"

product_features =
stripe.Product.list_features("<<product>>")
```

```php
$stripe = new \Stripe\StripeClient('<<secret key>>');

$productFeatures = $stripe->products->allFeatures('<<product>>', []);
```

```ruby
Stripe.api_key = '<<secret key>>'

product_features = Stripe::Product.list_features('<<product>>')
```

And remove a feature from a specific product by deleting the product feature attachment:

```dotnet
StripeConfiguration.ApiKey = "<<secret key>>";

var service = new ProductFeatureService();
ProductFeature deleted = service.Delete("<<product>>", "<<productFeature>>");
```

```go
stripe.Key = "<<secret key>>"

params := &stripe.ProductFeatureParams{Product: stripe.String("<<product>>")};
result, err := productfeature.Del("<<productFeature>>", params);
```

```java
Stripe.apiKey = "<<secret key>>";

ProductFeature resource = ProductFeature.retrieve("<<product>>", "<<productFeature>>");

ProductFeature productFeature = resource.delete();
```

```node
const stripe = require('stripe')('<<secret key>>');

const deleted = await stripe.products.deleteFeature('<<product>>', '<<productFeature>>');
```

```python
import stripe
stripe.api_key = "<<secret key>>"

deleted =
stripe.Product.delete_feature(
  "<<product>>",
  "<<productFeature>>",
)
```

```php
$stripe = new \Stripe\StripeClient('<<secret key>>');

$deleted = $stripe->products->deleteFeature('<<product>>', '<<productFeature>>', []);
```

```ruby
Stripe.api_key = '<<secret key>>'

deleted = Stripe::Product.delete_feature('<<product>>', '<<productFeature>>')
```

## Get customers' active entitlements

During the lifecycle of a customer’s subscription, from activation, through upgrades, downgrades, and so on, Stripe updates the customer’s entitlements based on your mapped features.

When a customer’s subscription is first activated, Stripe creates entitlements for the features that they’re subscribed to.

As long as a customer maintains an active subscription for a feature, they retain an active entitlement. Make sure you provision access in your system for any users entitled to this feature.

### Listen for webhook events 

If your webhooks are enabled, we send the following webhook event to notify you when a customer’s entitlements change.

The entitlement summary’s `active_entitlements` property only contains a maximum of 10 entitlements. We also provide a URL to retrieve the full, paginated list of the customer’s entitlements.

| Event                                             | Description                                               |
| ------------------------------------------------- | --------------------------------------------------------- |
| `entitlements.active_entitlement_summary.updated` | Occurs each time a customer’s active entitlements change. |

### Retrieve the list of all active entitlements for a customer 

The list endpoint returns paginated view of a customer’s active entitlements.

```dotnet
StripeConfiguration.ApiKey = "<<secret key>>";

var options = new Stripe.Entitlements.ActiveEntitlementListOptions { Customer = "<<customer>>" };
var service = new Stripe.Entitlements.ActiveEntitlementService();
StripeList<Stripe.Entitlements.ActiveEntitlement> activeEntitlements = service.List(options);
```

```go
stripe.Key = "<<secret key>>"

params := &stripe.EntitlementsActiveEntitlementListParams{Customer: stripe.String("<<customer>>")};
result := activeentitlement.List(params);
```

```java
Stripe.apiKey = "<<secret key>>";

ActiveEntitlementListParams params =
  ActiveEntitlementListParams.builder().setCustomer("<<customer>>").build();

ActiveEntitlementCollection activeEntitlements = ActiveEntitlement.list(params);
```

```node
const stripe = require('stripe')('<<secret key>>');

const activeEntitlements = await stripe.entitlements.activeEntitlements.list({
  customer: '<<customer>>',
});
```

```python
import stripe
stripe.api_key = "<<secret key>>"

active_entitlements =
stripe.entitlements.ActiveEntitlement.list(customer="<<customer>>")
```

```php
$stripe = new \Stripe\StripeClient('<<secret key>>');

$activeEntitlements = $stripe->entitlements->activeEntitlements->all([
  'customer' => '<<customer>>',
]);
```

```ruby
Stripe.api_key = '<<secret key>>'

active_entitlements = Stripe::Entitlements::ActiveEntitlement.list({customer: '<<customer>>'})
```

We recommend you persist these entitlements internally for faster resolution.

Subscription pricing, plan, and entitlement changes might be subject to certain legal requirements. Consult with your legal counsel for advice specific to your business.