Ask for an invitation
Menu

Webhook event

invoice.voided

The invoice was voided.

Type
invoice.voided
The object it carries
the invoice object
Subscribe with
invoice.voided, invoice.* or *

Example payload

The body of the request your endpoint receives, shown here over several lines. On the wire it is compact JSON; check its signature over the bytes exactly as they arrive.

Example payload

{
  "id": "evt_r3a2xgr9smm3spk83wwyyxt9",
  "object": "event",
  "livemode": true,
  "created": "2026-10-09T10:00:00.000Z",
  "type": "invoice.voided",
  "api_version": "2026-10-11",
  "data": {
    "object": {
      "id": "inv_sxr44t9zk7krg104gmhsqx2p",
      "object": "invoice",
      "livemode": true,
      "created": "2026-10-08T09:00:00.000Z",
      "updated": "2026-10-09T10:00:00.000Z",
      "number": "INV-0042",
      "status": "void",
      "overdue": false,
      "customer": "cus_8ea07c40qsvv19f7rgmeb8ha",
      "order": "ord_18ayqdcy8s50t2dp5r257ep3",
      "currency": "USD",
      "line_items": [
        {
          "name": "Wholesale beans, 20 kg",
          "quantity": 20,
          "unit_amount": "17.50",
          "amount": "350.00",
          "price": null
        }
      ],
      "subtotal": "350.00",
      "discount_amount": "0.00",
      "tax_amount": "0.00",
      "total": "350.00",
      "amount_paid": "0.00",
      "amount_due": "350.00",
      "due_date": "2026-10-22",
      "memo": "Thank you for your order.",
      "footer": "Acme Coffee Roasters LLC",
      "url": "https://pay.orrerie.com/i/inv_sxr44t9zk7krg104gmhsqx2p",
      "pdf": "file_jgxe7twfcheqtdha9pafpnc3",
      "reminders": {
        "days_before_due": [
          3
        ],
        "days_after_due": [
          1,
          7
        ]
      },
      "finalized_at": "2026-10-08T09:02:00.000Z",
      "sent_at": "2026-10-08T09:02:05.000Z",
      "paid_at": null,
      "voided_at": "2026-10-09T10:00:00.000Z",
      "metadata": {}
    },
    "previous_attributes": {
      "status": "open",
      "voided_at": null
    }
  },
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "pending_webhooks": 1
}

Fields of data.object

Fields of data.object in invoice.voided
FieldIn this example
id"inv_sxr44t9zk7krg104gmhsqx2p"
object"invoice"
livemodetrue
created"2026-10-08T09:00:00.000Z"
updated"2026-10-09T10:00:00.000Z"
number"INV-0042"
status"void"
overduefalse
customer"cus_8ea07c40qsvv19f7rgmeb8ha"
order"ord_18ayqdcy8s50t2dp5r257ep3"
currency"USD"
line_itemsA list of 1 item
subtotal"350.00"
discount_amount"0.00"
tax_amount"0.00"
total"350.00"
amount_paid"0.00"
amount_due"350.00"
due_date"2026-10-22"
memo"Thank you for your order."
footer"Acme Coffee Roasters LLC"
url"https://pay.orrerie.com/i/inv_sxr44t9zk7krg104gmhsqx2p"
pdf"file_jgxe7twfcheqtdha9pafpnc3"
remindersAn object with days_before_due, days_after_due
finalized_at"2026-10-08T09:02:00.000Z"
sent_at"2026-10-08T09:02:05.000Z"
paid_atnull
voided_at"2026-10-09T10:00:00.000Z"
metadataAn object with no fields

What each field means is on the page of the invoice object. data.previous_attributes holds the old values of exactly the fields that changed: here status, voided_at.

Endpoints behind it

Calls that change invoices. An event is also sent when a payer, the network, a timer or a person in the dashboard causes the change; the sentence above says which.