commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The refund policy's decision for this order without opening a request — whether it is eligible, the amount that would be refunded, and whether it needs staff approval (docs/05 §4.13). Requires `billing.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
orderId (path) | Uuid | Yes | The order's id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
eligible | boolean | Yes | — |
policy_class | RefundPolicyClass | Yes | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Yes | — |
auto_approved | boolean | Yes | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Yes | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Yes | A customer-safe explanation of the decision. |
Errors this endpoint can return
401 · 403 · 404 · 429