Payments
List Payments
Returns a collection of payments
GET
/
v5
/
company
/
payments
Authorization
Query
curl --request GET \
--url https://api.whop.com/api/v5/company/payments \
--header 'Authorization: <authorization>'
{
"data": [
{
"billing_usage_ids": [],
"calculated_statement_descriptor": "<string>",
"card_brand": "<string>",
"card_last_4": "<string>",
"checkout_id": "<string>",
"company_buyer_id": "<string>",
"company_id": "<string>",
"created_at": 123,
"currency": "usd",
"final_amount": 123,
"funding_method": "credit",
"id": "<string>",
"issuer_identification_number": "<string>",
"last_payment_attempt": 123,
"line_item_id": "<string>",
"membership_id": "<string>",
"next_payment_attempt": 123,
"paid_at": 123,
"payments_failed": 123,
"plan_id": "<string>",
"product_id": "<string>",
"refunded_amount": 123,
"refunded_at": 123,
"status": "paid",
"subtotal": 123,
"user_id": "<string>",
"wallet_type": "apple_pay"
}
],
"pagination": {
"current_page": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123,
"total_pages": 123
}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
product_id
string
An ID of a product to filter by, which will look like prod_*************
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.
Response
200 - application/json
data
object[]
requiredpagination
object
requiredWas this page helpful?
curl --request GET \
--url https://api.whop.com/api/v5/company/payments \
--header 'Authorization: <authorization>'
{
"data": [
{
"billing_usage_ids": [],
"calculated_statement_descriptor": "<string>",
"card_brand": "<string>",
"card_last_4": "<string>",
"checkout_id": "<string>",
"company_buyer_id": "<string>",
"company_id": "<string>",
"created_at": 123,
"currency": "usd",
"final_amount": 123,
"funding_method": "credit",
"id": "<string>",
"issuer_identification_number": "<string>",
"last_payment_attempt": 123,
"line_item_id": "<string>",
"membership_id": "<string>",
"next_payment_attempt": 123,
"paid_at": 123,
"payments_failed": 123,
"plan_id": "<string>",
"product_id": "<string>",
"refunded_amount": 123,
"refunded_at": 123,
"status": "paid",
"subtotal": 123,
"user_id": "<string>",
"wallet_type": "apple_pay"
}
],
"pagination": {
"current_page": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123,
"total_pages": 123
}
}