# Enable or disable subscription entitlements

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


[Idempotency Supported](/docs/api/idempotency)

Enables or disables specific `subscription_entitlements` for a subscription.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__In7qXwSnDpTCF1k/subscription_entitlements/set_availability \
     -X POST  \
     -u {site_api_key}:\
     -d is_enabled="false" \
     -d "subscription_entitlements[feature_id][0]"="fea-e1958ced-c993-4235-bb10-ed67934b4c90"
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = SubscriptionEntitlement.SetSubscriptionEntitlementAvailability("__test__In7qXwSnDpTCF1k")
		.IsEnabled(false)
		.SubscriptionEntitlementFeatureId(0, "fea-e1958ced-c993-4235-bb10-ed67934b4c90")
		.Request();

SubscriptionEntitlement subscriptionEntitlement = result.SubscriptionEntitlement;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    subscriptionentitlementAction "github.com/chargebee/chargebee-go/v3/actions/subscriptionentitlement"
    "github.com/chargebee/chargebee-go/v3/models/subscriptionentitlement"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := subscriptionentitlementAction.SetSubscriptionEntitlementAvailability("__test__In7qXwSnDpTCF1k", &subscriptionentitlement.SetSubscriptionEntitlementAvailabilityRequestParams{
        SubscriptionEntitlements : []*subscriptionentitlement.SetSubscriptionEntitlementAvailabilitySubscriptionEntitlementParams{
            {
                FeatureId : "fea-e1958ced-c993-4235-bb10-ed67934b4c90",
            },
        },
        IsEnabled : chargebee.Bool(false),
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        List := res.List
    }
}
```

#### 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.SubscriptionEntitlementSetSubscriptionEntitlementAvailabilityRequest{
    SubscriptionEntitlements : []*chargebee.SubscriptionEntitlementSetSubscriptionEntitlementAvailabilitySubscriptionEntitlement{
        {
            FeatureId : "fea-e1958ced-c993-4235-bb10-ed67934b4c90",
        },
    },
    IsEnabled : chargebee.Bool(false),
}
  res, err := client.SubscriptionEntitlement.SetSubscriptionEntitlementAvailability("__test__In7qXwSnDpTCF1k", req)
      if err != nil {
        fmt.Println(err)
    } else {
        List := res.List
    }
}
```

#### 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}");
        Result result = SubscriptionEntitlement.setSubscriptionEntitlementAvailability("__test__In7qXwSnDpTCF1k")
            .isEnabled(false)
            .subscriptionEntitlementFeatureId(0, "fea-e1958ced-c993-4235-bb10-ed67934b4c90")
            .request();

    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.subscriptionEntitlement.params.SetSubscriptionEntitlementAvailabilityParams;
import com.chargebee.v4.models.subscriptionEntitlement.responses.SetSubscriptionEntitlementAvailabilityResponse;
import java.util.List;

public class SetSubscriptionEntitlementAvailability {

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

        SetSubscriptionEntitlementAvailabilityParams.SubscriptionEntitlementsParams subscriptionEntitlement0 =
            SetSubscriptionEntitlementAvailabilityParams.SubscriptionEntitlementsParams.builder()
                .featureId("fea-e1958ced-c993-4235-bb10-ed67934b4c90")
                .build();

        List<SetSubscriptionEntitlementAvailabilityParams.SubscriptionEntitlementsParams> subscriptionEntitlementsList =
            List.of(subscriptionEntitlement0);

        SetSubscriptionEntitlementAvailabilityParams params = SetSubscriptionEntitlementAvailabilityParams.builder()
            .isEnabled(false)
            .subscriptionEntitlements(subscriptionEntitlementsList)
            .build();

        SetSubscriptionEntitlementAvailabilityResponse response = client
            .subscriptionEntitlements()
            .setSubscriptionEntitlementAvailability("__test__In7qXwSnDpTCF1k", params);

    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.subscriptionEntitlement.setSubscriptionEntitlementAvailability("__test__In7qXwSnDpTCF1k", {
        subscription_entitlements: [
            {
                feature_id: "fea-e1958ced-c993-4235-bb10-ed67934b4c90"
            }
        ],
        is_enabled: false
    });

    console.log(result);
    const list = result.list;
} 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()->setSubscriptionEntitlementAvailability("__test__In7qXwSnDpTCF1k", [
    "subscription_entitlements" => [
        [
            "feature_id" => "fea-e1958ced-c993-4235-bb10-ed67934b4c90"
        ]
    ],
    "is_enabled" => false
]);
$list = $result->list;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.SubscriptionEntitlement.set_subscription_entitlement_availability("__test__In7qXwSnDpTCF1k",
    cb_client.SubscriptionEntitlement.SetSubscriptionEntitlementAvailabilityParams(
        subscription_entitlements=[
            cb_client.SubscriptionEntitlement.SetSubscriptionEntitlementAvailabilitySubscriptionEntitlementParams(
              feature_id="fea-e1958ced-c993-4235-bb10-ed67934b4c90"
            )
        ],
        is_enabled=False
    )
)
entries = response.list
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::SubscriptionEntitlement.set_subscription_entitlement_availability("__test__In7qXwSnDpTCF1k",{
  :is_enabled => "false",
  :subscription_entitlements => [
    {
      :feature_id => "fea-e1958ced-c993-4235-bb10-ed67934b4c90"
    }
  ]
})

list = result.list
```

## Sample Response

```json
{
  "list": [
    {
      "subscription_entitlement": {
        "feature_id": "fea-e1958ced-c993-4235-bb10-ed67934b4c90",
        "feature_name": "Phone Support",
        "feature_type": "custom",
        "is_enabled": false,
        "is_overridden": true,
        "name": "Disabled",
        "object": "subscription_entitlement",
        "subscription_id": "__test__In7qXwSnDpTCF1k"
      }
    },
    {..}
  ]
}
```

## URL Format

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

## Input Parameters

- `is_enabled` (required, boolean)
  Specifies whether the `subscription_entitlements` are to be enabled or disabled.

- `subscription_entitlements` (optional, array)
  Parameters for subscription\_entitlements
  - `feature_id` (required, string, max chars=50)
    The `id` of the feature towards which the `subscription_entitlement` is to be enabled or disabled. An error is returned if a `subscription_entitlement` does not exist for the feature.

## Returns

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