Get invoice dunning status

Retrieve the current dunning state for an invoice, including attempt history.

GET /v1/billing/dunning/invoices/{invoiceId}/dunning

Get invoice dunning status

cURL

curl --request GET \
  --url https://api.example.com/v1/billing/dunning/invoices/{invoiceId}/dunning

Path parameters

invoiceId · string · required

The invoice id.

Response

Field	Type	Description
dunningStatus	string	idle | retrying | exhausted | recovered | stopped
dunningAttemptCount	integer	Number of reminders sent so far.
nextDunningAt	string | null	ISO 8601 timestamp of the next scheduled retry.
attempts	DunningAttempt[]	Full attempt history.

DunningAttempt object

Field	Type	Description
id	string	Attempt id.
attemptNumber	integer	1-based sequence number.
status	string	sent | recovered | exhausted
nextAttemptAt	string | null	When the next attempt is scheduled.
createdAt	string	When this attempt was logged.