GET
/
v2
/
payments
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v2/payments/{id}
{
  "id": "<string>",
  "product": "<string>",
  "membership": "<string>",
  "affiliate_reward": 123,
  "plan": "<string>",
  "user": "<string>",
  "final_amount": 123,
  "subtotal": 123,
  "total": 123,
  "currency": "<string>",
  "last4": "<string>",
  "card_brand": "<string>",
  "payments_failed": 123,
  "failure_message": "<string>",
  "payment_processor": "<string>",
  "refunded_amount": 123,
  "status": "<string>",
  "crypto_tx_hash": "<string>",
  "wallet_address": "<string>",
  "created_at": 123,
  "paid_at": 123,
  "refunded_at": 123,
  "last_payment_attempt": 123,
  "next_payment_attempt": 123,
  "access_pass": "<string>",
  "billing_first_name": "<string>",
  "billing_last_name": "<string>",
  "billing_address": {
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "membership_metadata": {}
}

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
Retrieve a Payment

Payment model

​
id
string

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

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

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

​
affiliate_reward
number

The amount paid to the Affiliate for this Payment

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

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

​
final_amount
number

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

​
subtotal
number

The subtotal for the payment, before any discounts or taxes

​
total
number

The total amount for the payment

​
currency
string

The three letter currency the Payment was made in

​
last4
string

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

​
card_brand
string

The brand of the credit/debit card used to make the Payment. Ex. visa.

​
payments_failed
integer

The number of times the Payment has failed

​
failure_message
string

The reason why the payment failed, if applicable.

​
payment_processor
string

Which platform was used to process the Payment

​
refunded_amount
number

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

​
status
string

The status of the Payment

​
crypto_tx_hash
string

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

​
wallet_address
string

The crypto wallet address use to make 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.

​
paid_at
integer

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

​
refunded_at
integer

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

​
last_payment_attempt
integer

The UTC timestamp of the last time the Payment was attempted

​
next_payment_attempt
integer

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

​
access_pass
string

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

​
billing_first_name
string

The first name of customer who made the payment

​
billing_last_name
string

The last name of customer who made the payment

​
billing_address
object
​
membership_metadata
object

The metadata attached to the receipt's Membership.

Was this page helpful?