GET
/
v2
/
payments
/
{id}
Header
Path
Query
curl --request GET \
  --url https://api.whop.com/api/v2/payments/{id}
{
  "access_pass": "<string>",
  "affiliate_reward": 123,
  "created_at": 123,
  "crypto_tx_hash": "<string>",
  "currency": "<string>",
  "final_amount": 123,
  "id": "<string>",
  "last4": "<string>",
  "last_payment_attempt": 123,
  "membership": "<string>",
  "next_payment_attempt": 123,
  "paid_at": 123,
  "payment_processor": "<string>",
  "payments_failed": 123,
  "plan": "<string>",
  "product": "<string>",
  "refunded_amount": 123,
  "refunded_at": 123,
  "status": "<string>",
  "subtotal": 123,
  "user": "<string>",
  "wallet_address": "<string>"
}

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

Path Parameters

id
string
required

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

Query Parameters

expand
enum<string>[]

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]

Available options:
product,
membership,
plan,
user

Response

200 - application/json
access_pass
string

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

affiliate_reward
number

The amount paid to the Affiliate for this Payment

created_at
integer

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.

crypto_tx_hash
string

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

currency
string

The three letter currency the Payment was made in

final_amount
number

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

id
string

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

last4
string

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

last_payment_attempt
integer

The UTC timestamp of the last time the Payment was attempted

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

next_payment_attempt
integer

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

paid_at
integer

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

payment_processor
string

Which platform was used to process the Payment

payments_failed
integer

The number of times the Payment has failed

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.

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.

refunded_amount
number

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

refunded_at
integer

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

status
string

The status of the Payment

subtotal
number

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

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.

wallet_address
string

The crypto wallet address use to make this Payment

Was this page helpful?