comecerodocs

Get a refund item

GET
/refunds/{refund_id}/items/{item_id}

Returns one item of a refund. 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.

item_id*string

The item_id of the order or invoice item.

Query Parameters

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

The refund item.

application/json
  1. response

One item refunded, with the quantity and amounts given back. Fields marked "not for limited tokens" are left out when a limited token reads it.

object*"refund_item"

The object type. Always refund_item.

Value in"refund_item"
url*string

The full URL of this refund item.

Formaturi
item_id*string

The item_id of the order or invoice item refunded.

date_created?string

When the item was created.

Formatdate-time
date_modified?string

When the item was last changed.

Formatdate-time
refund_id*string

The refund this item belongs to.

name*string

The product name.

type*string

The product type.

Value in"digital""physical""service""bundle"
quantity*number

The quantity refunded. Can be a decimal.

currency*string

The refund currency (ISO 4217).

price*number

The unit price, in currency.

reference_price?|

The price in the reference currency. Not for limited tokens.

reference_currency?|

The currency of reference_price. Not for limited tokens.

subtotal*number

The amount refunded for this item without tax, in currency.

tax*number

The tax refunded for this item, in currency.

total*number

subtotal plus tax, in currency.

tax_rate*number

The tax rate as a decimal.

tax_code?|

The tax code of the product. Not for limited tokens.

settlement_currency?string

The settlement currency. Not for limited tokens.

settlement_price?number

price in the settlement currency. Not for limited tokens.

settlement_subtotal?number

subtotal in the settlement currency. Not for limited tokens.

settlement_tax?number

tax in the settlement currency. Not for limited tokens.

settlement_total?number

total in the settlement currency. Not for limited tokens.

fulfilled*boolean

Whether the order item was fulfilled when it was refunded.

product?||

A link to the product, or the product when expanded.

subscription?||

A link to the subscription of the item, or the subscription when expanded. Null when the item is not a subscription.

meta*||

Your own data for this item, a string or an object.

formatted?

Display text. Only present when you send formatted=true.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/refunds/string/items/string'
Example Response
{  "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}