# Retrieve a retry segment

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


[Strongly Consistent](/docs/api/v2/pcv-1/read-consistency)

Retrieves the retry segment with the specified `id`, as currently published in the dunning settings. This includes the [default segment](/docs/api/v2/pcv-1/retry_segments#the-default-segment).

Invoices already in dunning under this segment keep the settings locked on them when their dunning started, which can differ from the current configuration. To read those, use [List invoice retry contexts](/docs/api/v2/pcv-1/invoice_retry_contexts/list-invoice-retry-contexts).

### Prerequisites & Constraints

-   Retry segments are enabled for the site.
-   The segment is published.

### Implementation Notes

The API returns a `resource_not_found` error when no published segment has this `id`, or when retry segments are not enabled for the site.

## Sample Request

### Default

#### Chargebee CLI

```bash
chargebee retry-segment retrieve __test__KyVkSOVWbgWtUY
```

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/retry_segments/__test__KyVkSOVWbgWtUY \
     -u {site_api_key}:
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = RetrySegment.Retrieve("__test__KyVkSOVWbgWtUY").Request();

RetrySegment retrySegment = result.RetrySegment;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    retrysegmentAction "github.com/chargebee/chargebee-go/v3/actions/retrysegment"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := retrysegmentAction.Retrieve("__test__KyVkSOVWbgWtUY").Request()
    if err != nil {
        fmt.Println(err)
    } else {
        RetrySegment := res.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.RetrySegmentRetrieveRequest{
    Id : "__test__KyVkSOVWbgWtUY",
}
  res, err := client.RetrySegment.Retrieve(req)
      if err != nil {
        fmt.Println(err)
    } else {
        RetrySegment := res.RetrySegment
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = RetrySegment.retrieve("__test__KyVkSOVWbgWtUY").request();

        RetrySegment retrySegment = result.retrySegment();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.retrySegment.RetrySegment;
import com.chargebee.v4.models.retrySegment.params.RetrySegmentRetrieveParams;
import com.chargebee.v4.models.retrySegment.responses.RetrySegmentRetrieveResponse;

public class RetrySegmentRetrieve {

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

        RetrySegmentRetrieveResponse response = client.retrySegments().retrieve("__test__KyVkSOVWbgWtUY");

        RetrySegment retrySegment = response.getRetrySegment();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.retrySegment.retrieve("__test__KyVkSOVWbgWtUY");

    console.log(result);
    const retrySegment = result.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()->retrieve("__test__KyVkSOVWbgWtUY");
$retrySegment = $result->retry_segment;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.RetrySegment.retrieve("__test__KyVkSOVWbgWtUY")
retry_segment = response.retry_segment
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::RetrySegment.retrieve("__test__KyVkSOVWbgWtUY")

retry_segment = result.retry_segment
```

### Retrieve The Default Segment

#### Chargebee CLI

```bash
chargebee retry-segment retrieve __test__KyVkSOVWbgWtZ9
```

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/retry_segments/__test__KyVkSOVWbgWtZ9 \
     -u {site_api_key}:
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = RetrySegment.Retrieve("__test__KyVkSOVWbgWtZ9").Request();

RetrySegment retrySegment = result.RetrySegment;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    retrysegmentAction "github.com/chargebee/chargebee-go/v3/actions/retrysegment"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := retrysegmentAction.Retrieve("__test__KyVkSOVWbgWtZ9").Request()
    if err != nil {
        fmt.Println(err)
    } else {
        RetrySegment := res.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.RetrySegmentRetrieveRequest{
    Id : "__test__KyVkSOVWbgWtZ9",
}
  res, err := client.RetrySegment.Retrieve(req)
      if err != nil {
        fmt.Println(err)
    } else {
        RetrySegment := res.RetrySegment
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = RetrySegment.retrieve("__test__KyVkSOVWbgWtZ9").request();

        RetrySegment retrySegment = result.retrySegment();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.retrySegment.RetrySegment;
import com.chargebee.v4.models.retrySegment.params.RetrySegmentRetrieveParams;
import com.chargebee.v4.models.retrySegment.responses.RetrySegmentRetrieveResponse;

public class RetrySegmentRetrieve {

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

        RetrySegmentRetrieveResponse response = client.retrySegments().retrieve("__test__KyVkSOVWbgWtZ9");

        RetrySegment retrySegment = response.getRetrySegment();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.retrySegment.retrieve("__test__KyVkSOVWbgWtZ9");

    console.log(result);
    const retrySegment = result.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()->retrieve("__test__KyVkSOVWbgWtZ9");
$retrySegment = $result->retry_segment;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.RetrySegment.retrieve("__test__KyVkSOVWbgWtZ9")
retry_segment = response.retry_segment
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::RetrySegment.retrieve("__test__KyVkSOVWbgWtZ9")

retry_segment = result.retry_segment
```

## Sample Response

```json
{
  "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/{retry-segment-id}

## Returns

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