# List preferences

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


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

Retrieves a list of current preference values available for your Chargebee site within the specified **`preference_group`**. **`preference_group[<operator>]`** is required. Use **`is`** to select one group or **`in`** to select multiple groups.

This endpoint is not paginated and returns all applicable preferences in the selected groups.

A base preference and each of its [variants](/docs/api/preferences#preference-variants) are returned as separate entries that share the same `id`. Variants also include `level` and `criteria`; the base entry has neither.

**Note:** Only preferences that apply to your site's current configuration are returned. A preference is returned only when its [applicability conditions](/docs/api/preference_definitions/preference-definition-object#applicability-rules) are met. For example, `unbilled_charges.invoicing_options.add_charge` appears only when `unbilled_charges.enabled` is `true`.

## Sample Request

#### Chargebee CLI

```bash
chargebee preference list \
    -d 'preference_group[is]=subscription_reactivation'
```

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/preferences \
     -G  \
     -u {site_api_key}:\
     --data-urlencode "preference_group[is]"="subscription_reactivation"
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = Preference.List()
		.PreferenceGroup().Is(PreferenceGroupEnum.SubscriptionReactivation)
		.Request();

foreach (var listItem in result.List){
  Preference preference = listItem.Preference;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    preferenceAction "github.com/chargebee/chargebee-go/v3/actions/preference"
    "github.com/chargebee/chargebee-go/v3/models/preference"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := preferenceAction.List(&preference.ListRequestParams{
        PreferenceGroup : &filter.EnumFilter{
            Is : "subscription_reactivation",
        },
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Preference := res.List[idx].Preference
        }
    }
}
```

#### 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.PreferenceListRequest{
    PreferenceGroup : &chargebee.EnumFilter{
        Is : "subscription_reactivation",
    },
}
  res, err := client.Preference.List(req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Preference := res.List[idx].Preference
        }
    }
}
```

#### 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 = Preference.list().preferenceGroup().is(PreferenceGroup.SUBSCRIPTION_REACTIVATION).request();

        for (ListResult.Entry entry : result) {
            Preference preference = entry.preference();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.preference.Preference;
import com.chargebee.v4.models.preference.params.PreferenceListParams;
import com.chargebee.v4.models.preference.responses.PreferenceListResponse;
import java.util.List;

public class PreferenceList {

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

        PreferenceListParams params = PreferenceListParams.builder()
            .preferenceGroup()
            .is(PreferenceListParams.PreferenceGroup.SUBSCRIPTION_REACTIVATION)
            .build();

        PreferenceListResponse response = client.preferences().list(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.preference.list({
        preference_group: {
            is: "subscription_reactivation"
        }
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const preference = entry.preference;
    });
} 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->preference()->all([
    "preference_group" => [
        "is" => "subscription_reactivation"
    ]
]);
foreach($result->list as $entry) {
    $preference = $entry->preference;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.Preference.list(
    cb_client.Preference.ListParams(
        preference_group=Filters.EnumFilter(IS=chargebee.PreferenceGroup.SUBSCRIPTION_REACTIVATION)
    )
)
for entry in entries.list:
    preference = entry.preference
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::Preference.list({
  "preference_group[is]" => "subscription_reactivation"
})

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

## Sample Response

```json
{
  "list": [
    {
      "preference": {
        "id": "subscription_reactivation.in_term_reactivation_option",
        "preference_group": "subscription_reactivation",
        "value": "allow_reactivation",
        "allow_override_in_interface": true,
        "modified_at": 1787543613,
        "object": "preference"
      }
    },
    {..}
  ]
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/preferences

## Returns

- `preference` (Preference object)
  Resource object representing preference.
