GET
/
v5
/
company
/
payments
/
{id}
Authorization
Path
curl --request GET \
  --url https://api.whop.com/api/v5/company/payments/{id} \
  --header 'Authorization: <authorization>'
{
  "billing_usage_ids": [
    "<string>"
  ],
  "calculated_statement_descriptor": "<string>",
  "card_brand": "<string>",
  "card_last_4": "<string>",
  "checkout_id": "<string>",
  "company_buyer_id": "<string>",
  "company_id": "<string>",
  "created_at": 123,
  "currency": "usd",
  "final_amount": 123,
  "funding_method": "credit",
  "id": "<string>",
  "issuer_identification_number": "<string>",
  "last_payment_attempt": 123,
  "line_item_id": "<string>",
  "membership_id": "<string>",
  "next_payment_attempt": 123,
  "paid_at": 123,
  "payments_failed": 123,
  "plan_id": "<string>",
  "product_id": "<string>",
  "refunded_amount": 123,
  "refunded_at": 123,
  "status": "paid",
  "subtotal": 123,
  "user_id": "<string>",
  "wallet_type": "apple_pay"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

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

Response

200 - application/json
billing_usage_ids
string[]
calculated_statement_descriptor
string

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

card_brand
string

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

card_last_4
string

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

checkout_id
string

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

company_buyer_id
string

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

company_id
string
required

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

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.

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,
cop,
ron,
thb,
eth
final_amount
number
required

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

funding_method
enum<string>

The funding method of the payment, if applicable.

Available options:
credit,
debit,
prepaid,
unknown
id
string
required

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

issuer_identification_number
string

The IIN/BIN of the payment, if applicable.

last_payment_attempt
number

The UTC timestamp of the last time the Payment was attempted

line_item_id
string

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

membership_id
string
required

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

next_payment_attempt
number

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

paid_at
number

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

payments_failed
number
required

The number of times the Payment has failed

plan_id
string

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

product_id
string
required

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

refunded_amount
number

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

refunded_at
number

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

status
enum<string>
required

The status of the payment

Available options:
paid,
open,
void,
draft,
uncollectible
subtotal
number
required

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

user_id
string

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

wallet_type
enum<string>

The wallet type of the payment, if applicable.

Available options:
apple_pay,
google_pay,
paypal,
venmo

Was this page helpful?

List PaymentsCreate a Billing Item