comecerodocs
Refunds

List a refund's items

GET
/refunds/{refund_id}/items

Lists the items given back in a refund of an order or invoice. A refund of an amount (not items) has no items. Offset-based (offset, limit). sort_by takes date_created (default), date_modified or product_id. Note that the paging URLs in the response point to /refunds; build the next page URL from next_page_offset instead.

A limited token may call this for a refund it is bound to.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

refund_id*string

The refund id.

Query Parameters

offset?integer

For offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.

Range0 <= value
Default0
limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
sort_by?string

The field to sort by.

Default"date_created"
Value in"date_created""date_modified""product_id"
expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

An offset-based page of refund items.

application/json
  1. response

A page of an offset-based list. Move between pages with offset, or follow next_page_url and previous_page_url, which keep your other query parameters.

total_items*integer

How many items match, across all pages.

total_pages*integer

How many pages there are at this limit. 0 when nothing matches.

current_page*integer

The number of this page, starting at 1. 0 when nothing matches.

next_page_url*|

The URL of the next page, or null on the last page.

Formaturi
next_page_offset*|

The offset of the next page, or null on the last page.

previous_page_url*|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_offset*|

The offset of the previous page, or null on the first page.

current_page_url*string

The URL of this page.

Formaturi
data*array<>

The refund items on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/refunds/string/items'
Example Response
{  "total_items": 1,  "total_pages": 1,  "current_page": 1,  "next_page_url": null,  "next_page_offset": null,  "previous_page_url": null,  "previous_page_offset": null,  "current_page_url": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5/items",  "data": [    {      "object": "refund_item",      "url": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5/items/1",      "item_id": "1",      "date_created": "2026-11-02T16:46:16Z",      "date_modified": "2026-11-03T10:12:40Z",      "refund_id": "0090374314462Rec3PffZ5",      "name": "PDF Viewer Pro",      "type": "digital",      "quantity": 1,      "currency": "USD",      "price": 49.95,      "reference_price": 49.95,      "reference_currency": "USD",      "subtotal": 49.95,      "tax": 0,      "total": 49.95,      "tax_rate": 0,      "tax_code": null,      "settlement_currency": "USD",      "settlement_price": 49.95,      "settlement_subtotal": 49.95,      "settlement_tax": 0,      "settlement_total": 49.95,      "fulfilled": true,      "product": "https://api.comecero.com/api/v1/products/pdf-pro.test",      "subscription": null,      "meta": null    }  ]}

List a refund's fees GET

Lists the Comecero fees recorded for one refund. Offset-based (`offset`, `limit`). `sort_by` takes `date_created` (default) or `date_modified`. Needs a secret or trusted token that may read fees. Limited tokens get `403`.

Get a refund item GET

Returns one item of a refund. A limited token may call this for a refund it is bound to.