Introducing the Chargebee CLI

List retry segments

Returns the published retry segments of the site, in priority order. 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 to read those.

Prerequisites & Constraints

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

Sample Request

Sample Result[JSON]

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 object

Resource object representing retry segment