List refunds
list_refundsRetrieve label refunds with status, amount, tracking and recipient, newest first; filter by request date, status or search to review pending, approved or declined refunds.
Instructions
Label refunds with their status and amount, newest request first.
The Reports, Refunds table: every label refund the account asked for (or Pirate Ship made automatically for an unused label), when it was requested, approved, declined or reversed, the tracking number, recipient and amount in US dollars. from_date and to_date narrow by the request day.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_refunds"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Order by date. | newest |
| limit | No | Rows per page, 1 to 100. | |
| offset | No | Rows to skip: the next page starts at offset + limit while it is below total. | |
| search | No | Free text, as in the report's search box. | |
| status | No | Refund status as the table shows it, e.g. Pending, Approved, Declined. | |
| to_date | No | Last day, YYYY-MM-DD, included. | |
| from_date | No | First day, YYYY-MM-DD, in your timezone. |