GET
/
v5
/
me
/
payments
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v5/me/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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,
  "billing_address": {
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "user_email": "<string>"
}

Authorizations

​
Authorization
string
header
required

User OAuth token for /v5/me endpoints

Path Parameters

​
id
string
required

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

Response

200 - application/json
payment found
​
id
string
required

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

​
membership_id
string | null
required

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

​
product_id
string | null
required

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

​
user_id
string
required

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

​
plan_id
string | null
required

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

​
company_id
string
required

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

​
line_item_id
string | null
required

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

​
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.

​
status
enum<string>
required

The status of the payment

Available options:
draft,
open,
paid,
pending,
uncollectible,
unresolved,
void
​
final_amount
number
required

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

​
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
​
billing_usage_ids
string[]
required
​
paid_at
string | null

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

​
refunded_at
string | null

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

​
last_payment_attempt
string | null

The UTC timestamp of the last time the Payment was attempted

​
next_payment_attempt
string | null

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

​
subtotal
number | null

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

​
refunded_amount
number | null

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

​
payments_failed
number | null

The number of times the Payment has failed

​
checkout_id
string | null

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

​
card_brand
string | null

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

​
card_last_4
string | null

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

​
funding_method
string | null

The funding method of the payment, if applicable.

​
wallet_type
enum<string> | null

The wallet type of the payment, if applicable.

Available options:
apple_pay,
google_pay,
paypal,
venmo
​
calculated_statement_descriptor
string | null

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

​
issuer_identification_number
string | null

The IIN/BIN of the payment, if applicable.

​
company_buyer_id
number | null

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

​
billing_address
object
​
user_email
string

The email of the user that made the payment

Was this page helpful?

List PaymentsList Reviews