Introducing the Chargebee CLI

List preferences

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 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 are met. For example, unbilled_charges.invoicing_options.add_charge appears only when unbilled_charges.enabled is true.

Sample Request

Sample Result[JSON]

URL Format

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

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.
preference_group[<operator>]

required, string filter

The area of Chargebee this preference belongs to. Use is for one group or in for several. An in value is a JSON array. See preference_group.

Example → preference_group[is] = "subscription_reactivation"

preference_group[in] = ["subscription_reactivation", "trial_end_actions"]

Supported operators: is, in
Example → subscription_reactivation

Returns

Preference object

Resource object representing preference.