Skip to main content
GET
/
topups
List topups
curl --request GET \
  --url https://api.whop.com/api/v1/topups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pay_xxxxxxxxxxxxxx",
      "status": "draft",
      "created_at": "2023-12-01T05:00:00.401Z",
      "paid_at": "2023-12-01T05:00:00.401Z",
      "currency": "usd",
      "total": 6.9,
      "failure_message": "<string>"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

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

​
company_id
string
required

The ID of the company to list topups for

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The direction to sort the topups by

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

The maximum creation date to filter by

Example:

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

​
created_after
string<date-time> | null

The minimum creation date to filter by

Example:

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

Response

A successful response

The connection type for Receipt.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.