# List retry segments

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


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

Returns the published retry segments of the site, in `priority` order. The [default segment](/docs/api/retry_segments#the-default-segment) is last.

The response describes each segment as currently published. Invoices already in dunning keep the settings locked on them when their dunning started; use [List invoice retry contexts](/docs/api/invoice_retry_contexts/list-invoice-retry-contexts) to read those.

### Prerequisites & Constraints

-   Retry segments are enabled for the site. Otherwise, the list is empty.

## Sample Request

#### Chargebee CLI

```bash
chargebee retry-segment list \
    -d limit=3
```

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/retry_segments \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = RetrySegment.List()
		.Limit(3)
		.Request();

foreach (var listItem in result.List){
  RetrySegment retrySegment = listItem.RetrySegment;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    retrysegmentAction "github.com/chargebee/chargebee-go/v3/actions/retrysegment"
    "github.com/chargebee/chargebee-go/v3/models/retrysegment"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := retrysegmentAction.List(&retrysegment.ListRequestParams{
        Limit : chargebee.Int32(3),
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            RetrySegment := res.List[idx].RetrySegment
        }
    }
}
```

#### 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.RetrySegmentListRequest{
    Limit : chargebee.Int32(3),
}
  res, err := client.RetrySegment.List(req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            RetrySegment := res.List[idx].RetrySegment
        }
    }
}
```

#### 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 = RetrySegment.list()
            .limit(3)
            .request();

        for (ListResult.Entry entry : result) {
            RetrySegment retrySegment = entry.retrySegment();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.retrySegment.RetrySegment;
import com.chargebee.v4.models.retrySegment.params.RetrySegmentListParams;
import com.chargebee.v4.models.retrySegment.responses.RetrySegmentListResponse;
import java.util.List;

public class RetrySegmentList {

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

        RetrySegmentListParams params = RetrySegmentListParams.builder()
            .limit(3)
            .build();

        RetrySegmentListResponse response = client.retrySegments().list(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

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

#### Python

```python
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.RetrySegment.list(
    cb_client.RetrySegment.ListParams(
        limit=3
    )
)
for entry in entries.list:
    retry_segment = entry.retry_segment
```

#### Ruby

```ruby
require 'chargebee'

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

list = ChargeBee::RetrySegment.list({
  :limit => 3
})

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

## Sample Response

```json
{
  "list": [
    {
      "retry_segment": {
        "object": "retry_segment",
        "id": "__test__KyVkSOVWbgWtUY",
        "name": "High-value monthly invoices",
        "retry_type": "auto_collect",
        "enabled": true,
        "priority": 1,
        "criteria": {
          "type": "group",
          "logical_operator": "and",
          "conditions": [
            {
              "type": "condition",
              "field": "billing_frequency",
              "operator": "in",
              "value": [
                {
                  "billing_period": 1,
                  "billing_period_unit": "month"
                },
                {..}
              ]
            },
            {..}
          ]
        },
        "retry_settings": {
          "dunning_days": 15,
          "retry_mode": "custom",
          "retry_schedule_days": [
            1,
            {..}
          ],
          "retry_weekdays": [
            "monday",
            {..}
          ],
          "retry_time_window": "09:00-21:00 America/New_York",
          "skip_retries_for_hard_failures": true,
          "flexpay": {
            "enabled": true,
            "chargebee_days": 9,
            "flexpay_days": 6
          },
          "final_actions": {
            "subscription": "retain_as_active",
            "invoice": "mark_as_not_paid"
          },
          "applies_to": {
            "future_and_trial_subs": true,
            "onetime_invoices": true
          }
        }
      }
    },
    {..}
  ]
}
```

## URL Format

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

## 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`.

- `retry_segment` (Retry segment object)
  Resource object representing retry segment
