# List subscription entitlements

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Eventually Consistent](/docs/api/read-consistency)

Retrieves the list of `subscription_entitlements` for the [subscription](/docs/api/subscriptions).

**Note:**

The `components` attribute is not returned for any of the `subscription_entitlements`. Use the retrieve operation(coming soon) to obtain the `components`.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/subscriptions/JzDnHhSBWlm1j1n4/subscription_entitlements \
     -u {site_api_key}:
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = SubscriptionEntitlement.SubscriptionEntitlementsForSubscription("JzDnHhSBWlm1j1n4").Request();

foreach (var listItem in result.List){
  SubscriptionEntitlement subscriptionEntitlement = listItem.SubscriptionEntitlement;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    subscriptionentitlementAction "github.com/chargebee/chargebee-go/v3/actions/subscriptionentitlement"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := subscriptionentitlementAction.SubscriptionEntitlementsForSubscription("JzDnHhSBWlm1j1n4", nil).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            SubscriptionEntitlement := res.List[idx].SubscriptionEntitlement
        }
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.SubscriptionEntitlementSubscriptionEntitlementsForSubscriptionRequest{}
  res, err := client.SubscriptionEntitlement.SubscriptionEntitlementsForSubscription("JzDnHhSBWlm1j1n4", req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            SubscriptionEntitlement := res.List[idx].SubscriptionEntitlement
        }
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        ListResult result = SubscriptionEntitlement.subscriptionEntitlementsForSubscription("JzDnHhSBWlm1j1n4").request();

        for (ListResult.Entry entry : result) {
            SubscriptionEntitlement subscriptionEntitlement = entry.subscriptionEntitlement();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.subscriptionEntitlement.SubscriptionEntitlement;
import com.chargebee.v4.models.subscriptionEntitlement.params.SubscriptionEntitlementsForSubscriptionParams;
import com.chargebee.v4.models.subscriptionEntitlement.responses.SubscriptionEntitlementsForSubscriptionResponse;
import java.util.List;

public class SubscriptionEntitlementsForSubscription {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        SubscriptionEntitlementsForSubscriptionResponse response = client.subscriptionEntitlements().subscriptionEntitlementsForSubscription("JzDnHhSBWlm1j1n4");
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.subscriptionEntitlement.subscriptionEntitlementsForSubscription("JzDnHhSBWlm1j1n4");
    result.list.forEach((entry) => {
        console.log(entry);
        const subscriptionEntitlement = entry.subscription_entitlement;
    });
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->subscriptionEntitlement()->subscriptionEntitlementsForSubscription("JzDnHhSBWlm1j1n4");
foreach($result->list as $entry) {
    $subscriptionEntitlement = $entry->subscription_entitlement;
}
```

#### Python

```python
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.SubscriptionEntitlement.subscription_entitlements_for_subscription("JzDnHhSBWlm1j1n4")
for entry in entries.list:
    subscription_entitlement = entry.subscription_entitlement
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

list = ChargeBee::SubscriptionEntitlement.subscription_entitlements_for_subscription("JzDnHhSBWlm1j1n4")

list.each do |entry|
  subscription_entitlement = entry.subscription_entitlement
end
```

## Sample Response

```json
{
  "list": [
    {
      "subscription_entitlement": {
        "subscription_id": "Azq8g8ULPXqdL6zM",
        "feature_id": "xero-integration",
        "feature_name": "Xero Integration",
        "feature_type": "SWITCH",
        "value": "true",
        "name": "Available",
        "is_overridden": true,
        "is_enabled": true,
        "object": "subscription_entitlement"
      }
    },
    {..}
  ]
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/subscriptions/{subscription-id}/subscription_entitlements

## Input Parameters

- `limit` (optional, integer, default=10, min=1, max=100)
  The number of resources to be returned.

- `offset` (optional, string, max chars=1000)
  Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

## Returns

- `next_offset` (optional, string, max chars=1000)
  This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

- `subscription_entitlement` (Subscription entitlement object)
  Resource object representing subscription\_entitlement