order.refunded

An order was refunded.

stablev1ordersscope: orders:read

Payload

Webhook deliveries use the common event envelope. The event-specific object is available at data.object.

events/public/payloads/order.refunded.v1.schema.jsonevents/public/examples/order.refunded.v1.json

data.object fields

Field	Type	Required
`id`	`string \| null`	optional
`object`	`string \| null`	optional
`metadata`	`object \| null`	optional
`settlement_modes`	`array`	optional
`refund_methods`	`array`	optional
`payment_methods`	`array`	optional
`invoice_refund_public_ids`	`array`	optional
`provider_refund_ids`	`array`	optional
`accounting_evidence_statuses`	`array`	optional
`out_of_band`	`boolean`	optional

dynamic data.object fields

Field	Type	Required	Description
`(_id\|^id)$`	`string \| null`	optional
`.*_at$`	`string \| null`	optional	format: date-time

Additional public-safe fields may be present. Internal identifiers and secrets are not part of the public payload contract.

Example

Event body

{
  "api_version": "2026-06-09",
  "created": "2026-06-09T12:00:00Z",
  "data": {
    "object": {
      "accounting_evidence_statuses": [
        "posted"
      ],
      "event": "order.refunded",
      "id": "ord_example",
      "invoice_refund_public_ids": [
        "invr_example"
      ],
      "metadata": {
        "example": true
      },
      "object": "order",
      "out_of_band": true,
      "payment_methods": [
        "wire_transfer"
      ],
      "provider_refund_ids": [],
      "refund_methods": [
        "manual"
      ],
      "settlement_modes": [
        "out_of_band"
      ]
    }
  },
  "environment": "test",
  "id": "wevt_Abcdef1234567890Ghijk",
  "livemode": false,
  "object": "event",
  "type": "order.refunded"
}

data.object

{
  "accounting_evidence_statuses": [
    "posted"
  ],
  "event": "order.refunded",
  "id": "ord_example",
  "invoice_refund_public_ids": [
    "invr_example"
  ],
  "metadata": {
    "example": true
  },
  "object": "order",
  "out_of_band": true,
  "payment_methods": [
    "wire_transfer"
  ],
  "provider_refund_ids": [],
  "refund_methods": [
    "manual"
  ],
  "settlement_modes": [
    "out_of_band"
  ]
}