List Payments

get https://api.whop.com/api/v2/payments

Returns a collection of Payments, based on the supplied filters. Only Payments with a status of paid have been successfully processed.

Query Params

page

int32

Defaults to 1

The page number to retrieve

per

int32

Defaults to 10

The number of resources to return per page. There is a limit of 50 results per page.

status

string

The status of the Payment

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

array of strings

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]

expand

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 ***************************

Response

Response body

object

pagination

object

Pagination model

current_page

int32

The current page of the paginated response

total_page

int32

The total number of pages in the paginated response

total_count

int32

The total number of objects in the paginated response (automatically maxed out at 50)

data

array of objects

data

object

string

The ID of the Payment, which will look like pay_*************

product

string

The Product this Payment is for. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.

membership

string

affiliate_reward

float

The amount paid to the Affiliate for this Payment

plan

string

The Plan this Payment is under. By default this will just be the ID of the Plan, but you can expand it to get more information about the Plan by passing [plan] in the expand parameter.

user

string

The User who made the Payment. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing [user] in the expand parameter.

final_amount

float

The total amount paid by the User, including any discounts or taxes

subtotal

float

The amount paid by the User, before any discounts or taxes

currency

string

The three letter currency the Payment was made in

last4

string

The last four digits of the credit/debit card used to make the Payment

payments_failed

int32

The number of times the Payment has failed

payment_processor

string

Which platform was used to process the Payment

refunded_amount

float

The amount that was refunded to the User (if applicable)

status

string

The status of the Payment

crypto_tx_hash

string

The transaction hash for the Payment if it was made with a cryptocurrency

wallet_address

string

The crypto wallet address use to make this Payment

created_at

int32

The time at which the Payment was created. Measured in seconds since the Unix epoch. Does not necessarily reflect the time the Payment was successful.

paid_at

int32

The time at which the Payment was successfully paid at. Measured in seconds since the Unix epoch.

refunded_at

int32

The UTC timestamp of the date the Payment was refunded (if applicable)

last_payment_attempt

int32

The UTC timestamp of the last time the Payment was attempted

next_payment_attempt

int32

The UTC timestamp of the next time the Payment will be attempted

access_pass

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.whop.com/api/v2/payments?page=1&per=10' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List Payments