Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Query Parameters

after
string | null

Returns the elements in the list that come after the specified cursor.

before
string | null

Returns the elements in the list that come before the specified cursor.

first
integer | null

Returns the first n elements from the list.

Example:

42

last
integer | null

Returns the last n elements from the list.

Example:

42

payment_id
string | null

Filter refunds to only those associated with this specific payment.

Example:

"pay_xxxxxxxxxxxxxx"

company_id
string | null

Filter refunds to only those belonging to this company.

Example:

"biz_xxxxxxxxxxxxxx"

user_id
string | null

Filter refunds to only those associated with this specific user.

Example:

"user_xxxxxxxxxxxxx"

direction
enum<string> | null

The sort direction for ordering results, either ascending or descending.

Available options:
asc,
desc
created_before
string<date-time> | null

Only return refunds created before this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

created_after
string<date-time> | null

Only return refunds created after this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

Response

A successful response

The connection type for Refund.

data
object[]
required

A list of nodes.

page_info
object
required

Information to aid in pagination.