List refund reasons
The store’s refund reason catalogue: the vocabulary every refund on this store is categorised against, and what a refund’s reason id resolves to. ONE LIST COVERS BOTH QUESTIONS a client asks. ?is_active=true is the set a merchant still offers on a new refund; ?is_active=false is what they have retired; omitting it returns both, which is what you want when resolving the reason on a historical refund, because a retired reason stays attached to every refund that already cites it. PAGED BY CREATION TIME, NOT BY code. code reads first in the dashboard, but a merchant can rename one, and a cursor over an editable column would drop or repeat reasons the moment they did. Sort on code yourself once you hold the page. created_by IS NOT PUBLISHED. The row records the merchant user who authored the reason for their own audit trail; it is an internal identifier, and it is empty on every reason written through this API, since a key has no user.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Query Parameters
true narrows the page to the reasons the merchant still offers on a new refund, false to the ones they have retired. Omit it for both, which is what you want when resolving the reason on a historical refund: a retired reason stays attached to every refund that already cites it. A value that is not a boolean is a 400 rather than an ignored filter, because a client handed every reason in the store would offer a withdrawn one back to an agent.
Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.
1 <= x <= 100The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.
