An invoice retry context is the retry segment and the retry settings locked on an invoice when its dunning started. Chargebee retries the invoice under these settings for the rest of its dunning, even if the segment is edited or deleted later. Two invoices on the same segment can therefore carry different settings.
An invoice that matches no other segment locks the default segment, so it has a context too, named Default segment.
Use List invoice retry contexts to read the context of one invoice, or every invoice locked on a segment. The context is also sent in the retry_segment_assigned event.
Note: Invoice retry contexts apply only to invoices in auto_collect dunning, and only when retry segments are enabled for the site.
Sample Invoice retry contextJSON
Invoice Retry Context attributes
Identifier of the invoice the context belongs to.
Identifier of the retry segment the invoice matched when its dunning started.
Retry settings locked on the invoice when its dunning started. Same structure as retry_segment.retry_settings. The invoice is retried under these settings even if the segment is edited or deleted later.