Skip to main content
GET
List refunds

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

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

Query Parameters

completed_at_end
string<date-time>

Filter refunds completed at or before this timestamp

completed_at_start
string<date-time>

Filter refunds completed at or after this timestamp

customer_external_id
string

Filter by customer external ID

customer_id
string

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

external_id
string

Filter by external id

is_dedicated
boolean

Filter by dedicated flag

max_amount
integer

Maximum refunded amount in cents

min_amount
integer

Minimum refunded amount in cents

ordering
string

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

page
integer

Page number (default: 1)

page_size
integer

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

reference_numbers
string

Comma-separated list of reference numbers

Search in external_id, reference_number, memo, customer name

status
string

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

Response

count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required