List refunds
list_refundsRetrieve label refunds with status, amount, tracking number, and recipient, sorted newest first. Filter by request date, status, or search text to audit refund activity.
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | newest | |
| limit | No | ||
| offset | No | ||
| 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. |