Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
whop
/
payments
Error
A valid request URL is required to generate request examples
{}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
​
from
string<date-time>

Start date (ISO 8601)

​
to
string<date-time>

End date (ISO 8601)

​
eventType
string

Filter by event type (e.g., payment.succeeded, membership.went_valid)

​
contactId
string<uuid>

Filter by linked contact

​
sort
enum<string>
default:-paidAt

Sort field

Available options:
paidAt,
-paidAt,
total,
-total,
createdAt,
-createdAt

Response

Paginated list of Whop payments

The response is of type object.