Introducing the Chargebee CLI

Retrieve a retry segment

Retrieves the retry segment with the specified id, as currently published in the dunning settings. This includes 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.

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

Sample Result[JSON]

URL Format

GET https://[site].chargebee.com/api/v2/retry_segments/{retry-segment-id}

Returns

Retry segment object

Resource object representing retry segment