List payments

Returns a paginated list of payments for the actor in context, with optional filtering by product, plan, status, billing reason, currency, and creation date.

Required permissions:

• payment:basic:read
• plan:basic:read
• access_pass:basic:read
• member:email:read
• member:basic:read
• member:phone:read
• promo_code:basic:read
• shipment:basic:read

GET /payments

JavaScript

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);
}

200

{
  "data": [
    {
      "amount_after_fees": 6.9,
      "application_fee": {
        "amount": 6.9,
        "amount_captured": 6.9,
        "amount_refunded": 6.9,
        "created_at": "2023-12-01T05:00:00.401Z",
        "currency": "usd",
        "id": "apfee_xxxxxxxxxxxx"
      },
      "auto_refunded": true,
      "billing_address": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "name": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "billing_reason": "subscription_create",
      "card_brand": "mastercard",
      "card_last4": "4242",
      "checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "route": "<string>",
        "title": "<string>"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "currency": "usd",
      "customer_phone": "<string>",
      "decline_code": "insufficient_funds",
      "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
      "failure_message": "<string>",
      "id": "pay_xxxxxxxxxxxxxx",
      "last_payment_attempt": "2023-12-01T05:00:00.401Z",
      "member": {
        "id": "<string>",
        "phone": "<string>"
      },
      "membership": {
        "id": "mem_xxxxxxxxxxxxxx",
        "phone_number": "<string>",
        "status": "trialing"
      },
      "metadata": {},
      "needs_tracking": true,
      "next_payment_attempt": "2023-12-01T05:00:00.401Z",
      "paid_at": "2023-12-01T05:00:00.401Z",
      "payment_instrument": {
        "card": {
          "brand": "<string>",
          "last4": "<string>"
        },
        "display_name": "<string>",
        "icons": {
          "card": {
            "dark": {
              "png_1x": "<string>",
              "png_2x": "<string>",
              "png_4x": "<string>",
              "svg": "<string>"
            },
            "light": {
              "png_1x": "<string>",
              "png_2x": "<string>",
              "png_4x": "<string>",
              "svg": "<string>"
            }
          },
          "square": {
            "dark": {
              "png_1x": "<string>",
              "png_2x": "<string>",
              "png_4x": "<string>",
              "svg": "<string>"
            },
            "light": {
              "png_1x": "<string>",
              "png_2x": "<string>",
              "png_4x": "<string>",
              "svg": "<string>"
            }
          }
        },
        "installment_count": 42,
        "payment_method_type": "<string>"
      },
      "payment_method": {
        "card": {
          "brand": "mastercard",
          "exp_month": 42,
          "exp_year": 42,
          "fingerprint": "<string>",
          "last4": "4242"
        },
        "created_at": "2023-12-01T05:00:00.401Z",
        "id": "payt_xxxxxxxxxxxxx",
        "payment_method_type": "acss_debit"
      },
      "payment_method_type": "acss_debit",
      "payments_failed": 42,
      "plan": {
        "id": "plan_xxxxxxxxxxxxx",
        "internal_notes": "<string>",
        "metadata": {}
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx",
        "metadata": {},
        "route": "pickaxe-analytics",
        "title": "Pickaxe Analytics"
      },
      "promo_code": {
        "amount_off": 6.9,
        "base_currency": "usd",
        "code": "<string>",
        "id": "promo_xxxxxxxxxxxx",
        "number_of_intervals": 42,
        "promo_type": "percentage"
      },
      "refundable": true,
      "refunded_amount": 6.9,
      "refunded_at": "2023-12-01T05:00:00.401Z",
      "retryable": true,
      "settlement_currency": "usd",
      "shipment": {
        "carrier": "usps",
        "id": "ship_xxxxxxxxxxxxx",
        "status": "unknown",
        "tracking_number": "9400111899223456789012",
        "tracking_url": "https://track.aftership.com/9400111899223456789012"
      },
      "shipping_address": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "name": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "status": "draft",
      "substatus": "succeeded",
      "subtotal": 6.9,
      "tax_amount": 6.9,
      "tax_behavior": "exclusive",
      "total": 6.9,
      "updated_at": "2023-12-01T05:00:00.401Z",
      "usd_total": 6.9,
      "user": {
        "email": "[e-mail]",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "voidable": true
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Query Parameters

after · string

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

before · string

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

first · integer

Returns the first n elements from the list.

Example:

42

last · integer

Returns the last n elements from the list.

Example:

42

company_id · string

The unique identifier of the company to list payments for.

Example:

"biz_xxxxxxxxxxxxxx"

direction · enum<string>

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

Available options: asc, desc

order · enum<string>

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

Available options: final_amount, created_at, paid_at

product_ids · string[]

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>[]

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>[]

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, usdt, kzt, awg, whop_usd, xau

plan_ids · string[]

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>[]

Filter payments by their current status.

The status of a receipt

Available options: draft, open, paid, pending, uncollectible, unresolved, void

substatuses · enum<string>[]

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

Whether to include payments with a zero amount.

created_before · string<date-time>

Only return payments created before this timestamp.

Example:

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

created_after · string<date-time>

Only return payments created after this timestamp.

Example:

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

updated_before · string<date-time>

Only return payments last updated before this timestamp.

Example:

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

updated_after · string<date-time>

Only return payments last updated after this timestamp.

Example:

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

query · string

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

checkout_configuration_ids · string[]

Only return payments from these checkout configurations.

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.

Response

200

application/json

A successful response

The connection type for Receipt.

data · object[] · required

A list of nodes.

Show child attributes

page_info · object · required

Information to aid in pagination.

Show child attributes