# List preference definitions

> 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 preference definitions 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 definitions in the selected groups.

## Sample Request

### Default

#### Chargebee CLI

```bash
chargebee preference-definition list-definitions \
    -d 'preference_group[in]=["subscription_reactivation","trial_end_actions"]'
```

#### cURL

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

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;
using Newtonsoft.Json.Linq;

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = PreferenceDefinition.ListDefinitions()
		.PreferenceGroup().In(PreferenceGroupEnum.SubscriptionReactivation, PreferenceGroupEnum.TrialEndActions)
		.Request();

foreach (var listItem in result.List){
  PreferenceDefinition preferenceDefinition = listItem.PreferenceDefinition;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    preferencedefinitionAction "github.com/chargebee/chargebee-go/v3/actions/preferencedefinition"
    "github.com/chargebee/chargebee-go/v3/models/preferencedefinition"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := preferencedefinitionAction.ListDefinitions(&preferencedefinition.ListDefinitionsRequestParams{
        PreferenceGroup : &filter.EnumFilter{
            In : []interface{}{"subscription_reactivation","trial_end_actions"},
        },
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            PreferenceDefinition := res.List[idx].PreferenceDefinition
        }
    }
}
```

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

#### 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 = PreferenceDefinition.listDefinitions().preferenceGroup().in(PreferenceGroup.SUBSCRIPTION_REACTIVATION, PreferenceGroup.TRIAL_END_ACTIONS).request();

        for (ListResult.Entry entry : result) {
            PreferenceDefinition preferenceDefinition = entry.preferenceDefinition();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.preferenceDefinition.PreferenceDefinition;
import com.chargebee.v4.models.preferenceDefinition.params.PreferenceDefinitionListDefinitionsParams;
import com.chargebee.v4.models.preferenceDefinition.responses.PreferenceDefinitionListDefinitionsResponse;
import java.util.List;

public class PreferenceDefinitionListDefinitions {

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

        PreferenceDefinitionListDefinitionsParams params = PreferenceDefinitionListDefinitionsParams.builder()
            .preferenceGroup()
            .in(PreferenceDefinitionListDefinitionsParams.PreferenceGroup.SUBSCRIPTION_REACTIVATION, PreferenceDefinitionListDefinitionsParams.PreferenceGroup.TRIAL_END_ACTIONS)
            .build();

        PreferenceDefinitionListDefinitionsResponse response = client.preferenceDefinitions().listDefinitions(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.preferenceDefinition.listDefinitions({
        preference_group: {
            in: ["subscription_reactivation", "trial_end_actions"]
        }
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const preferenceDefinition = entry.preference_definition;
    });
} 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->preferenceDefinition()->listDefinitions([
    "preference_group" => [
        "in" => ["subscription_reactivation", "trial_end_actions"]
    ]
]);
foreach($result->list as $entry) {
    $preferenceDefinition = $entry->preference_definition;
}
```

#### Python

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

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.PreferenceDefinition.list_definitions(
    cb_client.PreferenceDefinition.ListDefinitionsParams(
        preference_group=Filters.EnumFilter(IN=[chargebee.PreferenceGroup.SUBSCRIPTION_REACTIVATION, chargebee.PreferenceGroup.TRIAL_END_ACTIONS])
    )
)
for entry in entries.list:
    preference_definition = entry.preference_definition
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::PreferenceDefinition.list_definitions({
  "preference_group[in]" => "[\"subscription_reactivation\",\"trial_end_actions\"]"
})

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

### unbilled charges

#### Chargebee CLI

```bash
chargebee preference-definition list-definitions \
    -d 'preference_group[is]=unbilled_charges'
```

#### cURL

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

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = PreferenceDefinition.ListDefinitions()
		.PreferenceGroup().Is(PreferenceGroupEnum.UnbilledCharges)
		.Request();

foreach (var listItem in result.List){
  PreferenceDefinition preferenceDefinition = listItem.PreferenceDefinition;
}
```

#### Go

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

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

#### 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 = PreferenceDefinition.listDefinitions().preferenceGroup().is(PreferenceGroup.UNBILLED_CHARGES).request();

        for (ListResult.Entry entry : result) {
            PreferenceDefinition preferenceDefinition = entry.preferenceDefinition();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.preferenceDefinition.PreferenceDefinition;
import com.chargebee.v4.models.preferenceDefinition.params.PreferenceDefinitionListDefinitionsParams;
import com.chargebee.v4.models.preferenceDefinition.responses.PreferenceDefinitionListDefinitionsResponse;
import java.util.List;

public class PreferenceDefinitionListDefinitions {

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

        PreferenceDefinitionListDefinitionsParams params = PreferenceDefinitionListDefinitionsParams.builder()
            .preferenceGroup()
            .is(PreferenceDefinitionListDefinitionsParams.PreferenceGroup.UNBILLED_CHARGES)
            .build();

        PreferenceDefinitionListDefinitionsResponse response = client.preferenceDefinitions().listDefinitions(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

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

#### Python

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

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.PreferenceDefinition.list_definitions(
    cb_client.PreferenceDefinition.ListDefinitionsParams(
        preference_group=Filters.EnumFilter(IS=chargebee.PreferenceGroup.UNBILLED_CHARGES)
    )
)
for entry in entries.list:
    preference_definition = entry.preference_definition
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::PreferenceDefinition.list_definitions({
  "preference_group[is]" => "unbilled_charges"
})

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

## Sample Response

```json
{
  "list": [
    {
      "preference_definition": {
        "id": "subscription_reactivation.in_term_reactivation_option",
        "preference_group": "subscription_reactivation",
        "main_group": "billing_logiq",
        "sub_group": "customers_and_subscriptions",
        "description": "Defines how in-term reactivation of a cancelled subscription is handled when current-term invoices are unpaid.",
        "access_mode": "read_write",
        "overridable_in_interface": true,
        "overridable_in_api": false,
        "object": "preference_definition",
        "value_schema": {
          "type": "string",
          "object": "value_schema",
          "allowed_values": [
            {
              "value": "allow_reactivation",
              "description": "You can allow in-term reactivation of subscriptions even with current term invoices remaining unpaid.",
              "object": "allowed_value"
            },
            {..}
          ]
        },
        "criteria_schema": [
          {
            "operand": "request_source",
            "object": "criteria_schema",
            "allowed_operator": [
              "in",
              {..}
            ],
            "value_schema": {
              "type": "string",
              "object": "criteria_value_schema",
              "allowed_values": [
                {
                  "value": "chargebee_interface",
                  "description": "The request originated from the Chargebee interface.",
                  "object": "allowed_value"
                },
                {..}
              ]
            }
          },
          {..}
        ]
      }
    },
    {..}
  ]
}
```

## URL Format

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

## Returns

- `preference_definition` (Preference definition object)
  Resource object representing preference\_definition
