List Payments

GET

company

payments

Authorization

Query

curl --request GET \
  --url https://api.whop.com/api/v5/company/payments \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "billing_usage_ids": [],
      "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"
    }
  ],
  "pagination": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization

string

headerrequired

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

Query Parameters

product_id

string

An ID of a product to filter by, which will look like prod_*************

page

integer

default: 1

The page number to retrieve

per

integer

default: 10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

data

object[]

required

data.billing_usage_ids

string[]

data.calculated_statement_descriptor

string

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

data.card_brand

string

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

data.card_last_4

string

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

data.checkout_id

string

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

data.company_buyer_id

string

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

data.company_id

string

required

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

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

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

data.final_amount

number

required

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

data.funding_method

enum<string>

The funding method of the payment, if applicable.

Available options:

credit,

debit,

prepaid,

unknown

data.id

string

required

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

data.issuer_identification_number

string

The IIN/BIN of the payment, if applicable.

data.last_payment_attempt

number

The UTC timestamp of the last time the Payment was attempted

data.line_item_id

string

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

data.membership_id

string

required

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

data.next_payment_attempt

number

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

data.paid_at

number

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

data.payments_failed

number

required

The number of times the Payment has failed

data.plan_id

string

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

data.product_id

string

required

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

data.refunded_amount

number

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

data.refunded_at

number

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

data.status

enum<string>

required

The status of the payment

Available options:

paid,

open,

void,

draft,

uncollectible

data.subtotal

number

required

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

data.user_id

string

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

data.wallet_type

enum<string>

The wallet type of the payment, if applicable.

Available options:

apple_pay,

google_pay,

paypal,

venmo

pagination

object

required

Was this page helpful?

Retrieve a Product Retrieve a Payment

curl --request GET \
  --url https://api.whop.com/api/v5/company/payments \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "billing_usage_ids": [],
      "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"
    }
  ],
  "pagination": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

API Documentation

Apps

Company

Me

Authorizations

Query Parameters

Response