Returns invoices together with the retry segment and retry settings locked on them when their dunning started.
Pass invoice_id[is] to read the context of one invoice, or retry_segment_id[is] to list every invoice locked on a segment. A segment that has since been deleted still returns its invoices.
Each entry pairs the invoice with its invoice_retry_context, since invoices on the same segment can carry different locked settings.
Prerequisites & Constraints
- Retry segments are enabled for the site. Otherwise, the list is empty.
Implementation Notes
Pass at least one of invoice_id[is] or retry_segment_id[is]. Otherwise, the API returns an invalid_request error.
An invoice that is not in auto_collect dunning has no context, so filtering by its invoice_id returns an empty list.
Sample Request
Sample Result[JSON]
URL Format
Input Parameters
Filter Params
optional, string filter
Identifier of the invoice whose context is to be returned. Returns at most one entry.
Supported operators : is
Example → invoice_id[is] = "__demo_inv__17"
Constraints
- Either
invoice_id[is]orretry_segment_id[is]must be passed. Otherwise, the API returns aninvalid_requesterror.
INV-001optional, string filter
Identifier of the retry segment. Returns every invoice locked on this segment, including invoices locked before the segment was edited or deleted.
Supported operators : is
Example → retry_segment_id[is] = "__test__KyVkSOVWbgWtUY"
Constraints
- Either
invoice_id[is]orretry_segment_id[is]must be passed. Otherwise, the API returns aninvalid_requesterror.
rs_high_valueReturns
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.
Resource object representing invoice
Resource object representing invoice retry context