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]

Response

200 - application/json

Retrieve a Payment

Payment model