Skip to main content

When this fires

A daily scan finds outstanding invoices whose dueDate is in the past and emits this event once per invoice. The idempotency key is derived from the invoice, so re-running the scan never sends a duplicate. The invoice keeps its "outstanding" status — overdue is a fact about the due date, not a new status. If the invoice is later paid or voided, payment.received or invoice.voided reflects the outcome. Use it to start your own dunning flow: email the customer, show an in-app banner, or flag the account for follow-up.

Body

application/json
id
string
required
event
string
required
Allowed value: "invoice.overdue"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.