THthredfi
Refunds

List refunds

List refunds for a business with filtering and search.

get/v1/platform/businesses/{business_id}/invoices/refunds/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Business UUID provided by Thred (unique identifier for the business)

Query parameters

completed_at_endstring date-time

Filter refunds completed at or before this timestamp

completed_at_startstring date-time

Filter refunds completed at or after this timestamp

customer_external_idstring

Filter by customer external ID

customer_idstring

Filter by customer ID (supports comma-separated UUIDs for multiple customers)

external_idstring

Filter by external id

is_dedicatedboolean

Filter by dedicated flag

max_amountinteger

Maximum refunded amount in cents

min_amountinteger

Minimum refunded amount in cents

orderingstring

Ordering fields, e.g. -completed_at,-created_at

pageinteger

Page number (default: 1)

page_sizeinteger

Items per page (default: 20, max: 100)

reference_numbersstring

Comma-separated list of reference numbers

searchstring

Search in external_id, reference_number, memo, customer name

statusstring

Comma-separated statuses (pending,processing,paid,failed,cancelled)

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.