- Overview
Companies
Experiences
Memberships
Products
Payments
Reviews
Notifications
Line Items
App Connections
Users
Billing Usages
- GETRetrieve the current app
- GETCheck Access
- Overview
Memberships
Products
Payments
Reviews
Experiences
Companies
- POSTCreate an OAuth Token
- GETRetrieve the current user
- GETList a User's social accounts
Apps
Me
List Payments
Returns a collection of payments
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
An ID of a company to filter by, which will look like biz_*************
An ID of a product to filter by, which will look like prod_*************
A boolean of whether or not to return only payments made with a line item created by the app. If false, returns all payments without a line item.
The page number to retrieve
The number of resources to return per page. There is a limit of 50 results per page.
curl --request GET \
--url https://api.whop.com/api/v5/app/payments \
--header 'Authorization: Bearer <token>'{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"id": "<string>",
"membership_id": "<string>",
"product_id": "<string>",
"user_id": "<string>",
"plan_id": "<string>",
"company_id": "<string>",
"line_item_id": "<string>",
"created_at": 123,
"paid_at": 123,
"refunded_at": 123,
"last_payment_attempt": 123,
"next_payment_attempt": 123,
"status": "paid",
"subtotal": 123,
"final_amount": 123,
"currency": "usd",
"refunded_amount": 123,
"payments_failed": 123,
"checkout_id": "<string>",
"card_brand": "<string>",
"card_last_4": "<string>",
"funding_method": "credit",
"wallet_type": "apple_pay",
"calculated_statement_descriptor": "<string>",
"issuer_identification_number": "<string>",
"billing_usage_ids": [
"<string>"
],
"company_buyer_id": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
An ID of a company to filter by, which will look like biz_*************
An ID of a product to filter by, which will look like prod_*************
A boolean of whether or not to return only payments made with a line item created by the app. If false, returns all payments without a line item.
The page number to retrieve
The number of resources to return per page. There is a limit of 50 results per page.
Response
Current page number
Total number of pages
Next page number
Previous page number
Total number of records
The ID of the payment, which will look like pay_*************
The ID of the membership, which will look like mem_*************
The ID of the product, which will look like prod_*************
The ID of the user, which will look like user_*************
The ID of the plan, which will look like plan_*************
The ID of the company, which will look like biz_*************
The line item this receipt was purchased with. This is for in-app purchases.
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.
The time at which the Payment was successful. Measured in seconds since the Unix epoch.
The time at which the Payment was refunded. Measured in seconds since the Unix epoch.
The UTC timestamp of the last time the Payment was attempted
The UTC timestamp of the next time the Payment will be attempted
The status of the payment
paid, open, void, draft, uncollectible The amount paid by the User, before any discounts or taxes
The total amount paid by the User, including any discounts or taxes
The three letter currency the Payment was made in
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, cop, ron, thb, eth The amount that was refunded to the User (if applicable)
The number of times the Payment has failed
The ID of the checkout used to execute this payment, if applicable.
If the payment was made with a credit/debit card, the brand of the card.
The last 4 digits of the debit/credit card used to make the payment, if applicable.
The funding method of the payment, if applicable.
credit, debit, prepaid, unknown The wallet type of the payment, if applicable.
apple_pay, google_pay, paypal, venmo The statement descriptor that appears on the customer's bank statement for the payment, if applicable.
The IIN/BIN of the payment, if applicable.
The ID of the company that made the payment. (For example, they installed an app). Looks like biz_*************
Was this page helpful?
curl --request GET \
--url https://api.whop.com/api/v5/app/payments \
--header 'Authorization: Bearer <token>'{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"id": "<string>",
"membership_id": "<string>",
"product_id": "<string>",
"user_id": "<string>",
"plan_id": "<string>",
"company_id": "<string>",
"line_item_id": "<string>",
"created_at": 123,
"paid_at": 123,
"refunded_at": 123,
"last_payment_attempt": 123,
"next_payment_attempt": 123,
"status": "paid",
"subtotal": 123,
"final_amount": 123,
"currency": "usd",
"refunded_amount": 123,
"payments_failed": 123,
"checkout_id": "<string>",
"card_brand": "<string>",
"card_last_4": "<string>",
"funding_method": "credit",
"wallet_type": "apple_pay",
"calculated_statement_descriptor": "<string>",
"issuer_identification_number": "<string>",
"billing_usage_ids": [
"<string>"
],
"company_buyer_id": "<string>"
}
]
}