List rules in a business ruleset

Returns the business rules that belong to a ruleset, along with the priority that determines their evaluation order. The results can be filtered by active status and are paginated.

Each entry carries the rule_id of the rule and its priority within this ruleset. Use rule_id with Retrieve a business rule to read the definition of a rule.

Implementation Notes

Call this operation before passing rules to Update a business ruleset, because that parameter replaces the entire membership of the ruleset.

Sample Request

Sample Result[JSON]

URL Format

GET https://[site].chargebee.com/api/v2/business_rulesets/{business-ruleset-id}/rules

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.

Filter Params

For operator usages, see the Pagination and Filtering section.

active[<operator>]

optional, boolean filter

Filters the results by the active status of the business rules in the ruleset. Pass true to return only the rules that are evaluated when the ruleset is applied, and false to return only the rules that are switched off. When omitted, rules are returned irrespective of their active status. Supported operators : is

Example → active[is] = "true"

Supported operators: is

Example → true

Returns

business_ruleset_rule

Business ruleset rule object

The membership of one rule in the ruleset. It carries rule_id, the identifier of the business rule, and priority, the number that fixes the position of that rule in the ruleset's evaluation order. Priorities are unique within a ruleset.

The definition of the rule is not included. Use rule_id with Retrieve a business rule to read its expression and actions.