List Payments - Whop Developers

API Documentation

Apps

Overview
Companies
Experiences
Members
Memberships
Products
Payments
- GET
  List Payments
- GET
  Retrieve a Payment
Reviews
Notifications
Line Items
App Connections
Users
Feed Content Items
Inbound Webhooks
Inbound Webhook Filters
GET
Retrieve the current app
GET
Check Access

Company

Overview
Memberships
Products
Payments
Reviews
Users
GET
Retrieve the current company

Me

Chat

Webhooks

GET

app

payments

curl --request GET \
  --url https://{defaultHost}/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": "<string>",
      "refunded_at": "<string>",
      "last_payment_attempt": "<string>",
      "next_payment_attempt": "<string>",
      "status": "draft",
      "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": "<string>",
      "wallet_type": "apple_pay",
      "calculated_statement_descriptor": "<string>",
      "issuer_identification_number": "<string>",
      "billing_usage_ids": [
        "<string>"
      ],
      "company_buyer_id": 123
    }
  ]
}

Authorizations

Authorization

string

header

required

App API key for /v5/app and /v5/company endpoints

Query Parameters

company_id

string

An ID of a company to filter by, which will look like biz_*************

product_id

string

An ID of a product to filter by, which will look like prod_*************

in_app_payments

boolean

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.

page

integer

default:1

The page number to retrieve

per

integer

default:10

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

Response

200 - application/json

payments retrieved

pagination

object

required

data

object[]

required

data.id

string

required

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

data.membership_id

string | null

required

The ID of the membership, which will look like mem_*************

data.product_id

string | null

required

The ID of the product, which will look like prod_*************

data.user_id

string

required

The ID of the user, which will look like user_*************

data.plan_id

string | null

required

The ID of the plan, which will look like plan_*************

data.company_id

string

required

The ID of the company, which will look like biz_*************

data.line_item_id

string | null

required

The line item this receipt was purchased with. This is for in-app purchases.

data.created_at

number

required

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.

data.status

enum<string>

required

The status of the payment

Available options:

draft,

open,

paid,

pending,

uncollectible,

unresolved,

void

data.final_amount

number

required

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

data.currency

enum<string>

required

The three letter currency the Payment was made in

Available options:

usd,

sgd,

inr,

aud,

brl,

cad,

dkk,

eur,

nok,

gbp,

sek,

chf,

hkd,

huf,

jpy,

mxn,

myr,

pln,

czk,

nzd,

aed,

eth,

ape,

cop,

ron,

thb,

bgn,

idr,

dop,

php,

try,

krw,

twd,

vnd,

pkr,

clp,

uyu,

ars,

zar,

dzd,

tnd,

mad,

kes,

kwd,

jod,

all,

xcd,

amd,

bsd,

bhd,

bob,

bam,

khr,

crc,

xof,

egp,

etb,

gmd,

ghs,

gtq,

gyd,

ils,

jmd,

mop,

mga,

mur,

mdl,

mnt,

nad,

ngn,

mkd,

omr,

pyg,

pen,

qar,

rwf,

sar,

rsd,

lkr,

tzs,

ttd,

uzs,

rub

data.wallet_type

enum<string> | null

required

The wallet type of the payment, if applicable.

Available options:

apple_pay,

google_pay,

paypal,

venmo

data.billing_usage_ids

string[]

required

The IDs of billing usages connected to this payment, which will look like bu_*************

data.paid_at

string | null

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

data.refunded_at

string | null

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

data.last_payment_attempt

string | null

The UTC timestamp of the last time the Payment was attempted

data.next_payment_attempt

string | null

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

data.subtotal

number | null

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

data.refunded_amount

number | null

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

data.payments_failed

number | null

The number of times the Payment has failed

data.checkout_id

string | null

The ID of the checkout used to execute this payment, if applicable.

data.card_brand

string | null

If the payment was made with a credit/debit card, the brand of the card.

data.card_last_4

string | null

The last 4 digits of the debit/credit card used to make the payment, if applicable.

data.funding_method

string | null

The funding method of the payment, if applicable.

data.calculated_statement_descriptor

string | null

The statement descriptor that appears on the customer's bank statement for the payment, if applicable.

data.issuer_identification_number

string | null

The IIN/BIN of the payment, if applicable.

data.company_buyer_id

number | null

The ID of the company that made the payment. (For example, they installed an app). Looks like biz_*************

Was this page helpful?

Retrieve a Product Retrieve a Payment

curl --request GET \
  --url https://{defaultHost}/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": "<string>",
      "refunded_at": "<string>",
      "last_payment_attempt": "<string>",
      "next_payment_attempt": "<string>",
      "status": "draft",
      "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": "<string>",
      "wallet_type": "apple_pay",
      "calculated_statement_descriptor": "<string>",
      "issuer_identification_number": "<string>",
      "billing_usage_ids": [
        "<string>"
      ],
      "company_buyer_id": 123
    }
  ]
}