# List business rules

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


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

Returns a list of business rules satisfying all the conditions specified in the filter parameters.

Each rule is returned as its released version. Deleted rules are not returned.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/business_rules \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2 \
     --data-urlencode "active[is]"="true"
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = BusinessRule.List()
		.Limit(2)
		.Active().Is("True")
		.Request();

foreach (var listItem in result.List){
  BusinessRule businessRule = listItem.BusinessRule;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    businessruleAction "github.com/chargebee/chargebee-go/v3/actions/businessrule"
    "github.com/chargebee/chargebee-go/v3/models/businessrule"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := businessruleAction.List(&businessrule.ListRequestParams{
        Limit : chargebee.Int32(2),
        Active : &filter.BooleanFilter{
            Is : chargebee.Bool(true),
        },
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            BusinessRule := res.List[idx].BusinessRule
        }
    }
}
```

#### 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.BusinessRuleListRequest{
    Limit : chargebee.Int32(2),
    Active : &chargebee.BooleanFilter{
        Is : chargebee.Bool(true),
    },
}
  res, err := client.BusinessRule.List(req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            BusinessRule := res.List[idx].BusinessRule
        }
    }
}
```

#### 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 = BusinessRule.list()
            .limit(2)
            .active().is("true")
            .request();

        for (ListResult.Entry entry : result) {
            BusinessRule businessRule = entry.businessRule();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.businessRule.BusinessRule;
import com.chargebee.v4.models.businessRule.params.BusinessRuleListParams;
import com.chargebee.v4.models.businessRule.responses.BusinessRuleListResponse;
import java.util.List;

public class BusinessRuleList {

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

        BusinessRuleListParams params = BusinessRuleListParams.builder()
            .limit(2)
            .active()
            .is(true)
            .build();

        BusinessRuleListResponse response = client.businessRules().list(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.businessRule.list({
        limit: 2,
        active: {
            is: true
        }
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const businessRule = entry.business_rule;
    });
} 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->businessRule()->all([
    "limit" => 2,
    "active" => [
        "is" => true
    ]
]);
foreach($result->list as $entry) {
    $businessRule = $entry->business_rule;
}
```

#### Python

```python
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.BusinessRule.list(
    cb_client.BusinessRule.ListParams(
        limit=2,
        active=Filters.BooleanFilter(IS=True)
    )
)
for entry in entries.list:
    business_rule = entry.business_rule
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::BusinessRule.list({
  :limit => 2,
  "active[is]" => "true"
})

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

## Sample Response

```json
{
  "list": [
    {
      "business_rule": {
        "id": "custom-uuid-1",
        "name": "Apply 12 percentage discount at invoice level",
        "description": "Apply 12 percentage discount at invoice level",
        "latest_version": 1,
        "active": true,
        "released_at": 1788510782,
        "released_by": "full_access_key_v1",
        "updated_at": 1788510782,
        "updated_by": "full_access_key_v1",
        "created_by": "full_access_key_v1",
        "created_at": 1788510782,
        "tags": [
          "CPQ",
          {..}
        ],
        "structured_expression": {
          "type": "GROUP",
          "operation": "AND",
          "children": [
            {
              "type": "CONDITION",
              "field": "customer.language",
              "operator": "CONTAINS",
              "value": "en"
            },
            {..}
          ]
        },
        "actions_on_success": [
          {
            "input": {
              "apply_on": "invoice_amount",
              "duration_type": "one_time",
              "discount": 12,
              "discount_type": "percentage"
            },
            "action_template_id": "action-apply-discount",
            "type": "APPLY_DISCOUNT"
          },
          {..}
        ],
        "resource_version": 1788510782918,
        "object": "business_rule"
      }
    },
    {..}
  ],
  "next_offset": "[\"1788510782000\",\"162000000178\"]"
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/business_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.

## Returns

- `next_offset` (optional, string, max chars=1000)
  This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

- `business_rule` (Business rule object)
  A business rule matching the filters, returned as its released version. Unreleased changes are not included; read them with [Retrieve a business rule draft](/docs/api/business_rules/retrieve-a-business-rule-draft).