Skip to main content
GET
/
payments
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const paymentListResponse of client.payments.list()) {
  console.log(paymentListResponse.id);
}
{
  "data": [
    {
      "id": "pay_xxxxxxxxxxxxxx",
      "status": "draft",
      "substatus": "succeeded",
      "refundable": true,
      "retryable": true,
      "voidable": true,
      "created_at": "2023-12-01T05:00:00.401Z",
      "paid_at": "2023-12-01T05:00:00.401Z",
      "last_payment_attempt": "2023-12-01T05:00:00.401Z",
      "next_payment_attempt": "2023-12-01T05:00:00.401Z",
      "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
      "refunded_at": "2023-12-01T05:00:00.401Z",
      "plan": {
        "id": "plan_xxxxxxxxxxxxx"
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "title": "Pickaxe Analytics",
        "route": "pickaxe-analytics"
      },
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42",
        "email": "john.doe@example.com"
      },
      "membership": {
        "id": "mem_xxxxxxxxxxxxxx",
        "status": "trialing"
      },
      "member": {
        "id": "<string>",
        "phone": "<string>"
      },
      "payment_method": {
        "id": "payt_xxxxxxxxxxxxx",
        "created_at": "2023-12-01T05:00:00.401Z",
        "payment_method_type": "acss_debit",
        "card": {
          "brand": "mastercard",
          "last4": "4242",
          "exp_month": 42,
          "exp_year": 42
        }
      },
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "<string>",
        "route": "<string>"
      },
      "promo_code": {
        "id": "promo_xxxxxxxxxxxx",
        "code": "<string>",
        "amount_off": 6.9,
        "base_currency": "usd",
        "promo_type": "percentage",
        "number_of_intervals": 42
      },
      "currency": "usd",
      "total": 6.9,
      "subtotal": 6.9,
      "usd_total": 6.9,
      "refunded_amount": 6.9,
      "auto_refunded": true,
      "amount_after_fees": 6.9,
      "application_fee": {
        "id": "apfee_xxxxxxxxxxxx",
        "amount": 6.9,
        "amount_captured": 6.9,
        "amount_refunded": 6.9,
        "currency": "usd",
        "created_at": "2023-12-01T05:00:00.401Z"
      },
      "card_brand": "mastercard",
      "card_last4": "4242",
      "billing_address": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "payment_method_type": "acss_debit",
      "billing_reason": "subscription_create",
      "payments_failed": 42,
      "failure_message": "<string>",
      "metadata": {}
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Query Parameters

​
after
string | null

Returns the elements in the list that come after the specified cursor.

​
before
string | null

Returns the elements in the list that come before the specified cursor.

​
first
integer | null

Returns the first n elements from the list.

Example:

42

​
last
integer | null

Returns the last n elements from the list.

Example:

42

​
company_id
string | null

The unique identifier of the company to list payments for.

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The sort direction for ordering results, either ascending or descending.

Available options:
asc,
desc
​
order
enum<string> | null

The field to order results by, such as creation date.

Available options:
final_amount,
created_at,
paid_at
​
product_ids
string[] | null

Filter payments to only those associated with these specific product identifiers.

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

​
billing_reasons
enum<string>[] | null

Filter payments by their billing reason.

The reason why a specific payment was billed

Available options:
subscription_create,
subscription_cycle,
subscription_update,
one_time,
manual,
subscription
​
currencies
enum<string>[] | null

Filter payments by their currency code.

The available currencies on the platform

Available options:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub,
btc,
cny
​
plan_ids
string[] | null

Filter payments to only those associated with these specific plan identifiers.

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

​
statuses
enum<string>[] | null

Filter payments by their current status.

The status of a receipt

Available options:
draft,
open,
paid,
pending,
uncollectible,
unresolved,
void
​
substatuses
enum<string>[] | null

Filter payments by their current substatus for more granular filtering.

The friendly status of a payment. This is a derived status that provides a human-readable summary of the payment state, combining the underlying status and substatus fields.

Available options:
succeeded,
pending,
failed,
past_due,
canceled,
price_too_low,
uncollectible,
refunded,
auto_refunded,
partially_refunded,
dispute_warning,
dispute_needs_response,
dispute_warning_needs_response,
resolution_needs_response,
dispute_under_review,
dispute_warning_under_review,
resolution_under_review,
dispute_won,
dispute_warning_closed,
resolution_won,
dispute_lost,
dispute_closed,
resolution_lost,
drafted,
incomplete,
unresolved,
open_dispute,
open_resolution
​
include_free
boolean | null

Whether to include payments with a zero amount.

​
created_before
string<date-time> | null

Only return payments created before this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

​
created_after
string<date-time> | null

Only return payments created after this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

​
query
string | null

Search payments by user ID, membership ID, user email, name, or username. Email filtering requires the member:email:read permission.

Response

A successful response

The connection type for Receipt.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.