Payments
List Payments
Returns a collection of Payments, based on the supplied filters. Only Payments with a status of paid have been successfully processed.
GET
/
v2
/
payments
Header
Query
curl --request GET \
--url https://api.whop.com/api/v2/payments
{
"data": [
{
"access_pass": "<string>",
"affiliate_reward": 123,
"created_at": 123,
"crypto_tx_hash": "<string>",
"currency": "<string>",
"final_amount": 123,
"id": "<string>",
"last4": "<string>",
"last_payment_attempt": 123,
"membership": "<string>",
"next_payment_attempt": 123,
"paid_at": 123,
"payment_processor": "<string>",
"payments_failed": 123,
"plan": "<string>",
"product": "<string>",
"refunded_amount": 123,
"refunded_at": 123,
"status": "<string>",
"subtotal": 123,
"user": "<string>",
"wallet_address": "<string>"
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}
Headers
Authorization
string
Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************
Query Parameters
page
integer
default: 1The page number to retrieve
per
integer
default: 10The number of resources to return per page. There is a limit of 50 results per page.
status
enum<string>
The status of the Payment
Available options:
draft
, open
, paid
, uncollectible
, void
membership_id
string
The Membership this Payment part of. By default this will just be the ID of the Membership, but you can expand it to get more information about the Membership by passing [membership]
in the expand
parameter.
expand
enum<string>[]
Whether or not to expand the User, Membership, Plan, or Product on the returned Payment. Pass an array with each object(s) you want to expand, e.g. [product, plan, membership, user]
Available options:
product
, membership
, plan
, user
Response
200 - application/json
data
object[]
pagination
object
Pagination model
Was this page helpful?
curl --request GET \
--url https://api.whop.com/api/v2/payments
{
"data": [
{
"access_pass": "<string>",
"affiliate_reward": 123,
"created_at": 123,
"crypto_tx_hash": "<string>",
"currency": "<string>",
"final_amount": 123,
"id": "<string>",
"last4": "<string>",
"last_payment_attempt": 123,
"membership": "<string>",
"next_payment_attempt": 123,
"paid_at": 123,
"payment_processor": "<string>",
"payments_failed": 123,
"plan": "<string>",
"product": "<string>",
"refunded_amount": 123,
"refunded_at": 123,
"status": "<string>",
"subtotal": 123,
"user": "<string>",
"wallet_address": "<string>"
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}