List Payments

curl --request GET \
  --url https://api.whop.com/api/v1/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "amount_after_fees": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "auto_refunded": false,
      "billing_address": {
        "city": "Austin",
        "country": "US",
        "line1": "1114 Bouldin Ave",
        "line2": "Unit B",
        "name": "Dana Whitfield",
        "postal_code": "78704",
        "state": "TX"
      },
      "billing_reason": "subscription_create",
      "checkout_configuration_id": null,
      "client_secret": "pay_xxxxxxxxxxxxxx_secret_vdefault_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "created_at": "2026-01-01T12:00:00.000Z",
      "currency": "usd",
      "customer_email": "marcus@shinetime.example",
      "customer_phone": "+xxxxxxxxxxx",
      "decline_code": "insufficient_funds",
      "dispute_alerted_at": null,
      "failure_message": null,
      "financing_installments_count": null,
      "holds": [
        {
          "amount": {
            "amount": "-1234.56",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          },
          "percentage": 123,
          "release_at": "<string>",
          "type": "reserve"
        }
      ],
      "id": "pay_xxxxxxxxxxxxxx",
      "last_payment_attempt_at": null,
      "line_items": [
        {
          "id": "li_xxxxxxxxxxxxxx",
          "label": "Ceramic Coating Package",
          "plan_id": "plan_xxxxxxxxxxxxxx",
          "plan_title": "Ceramic Coating — Full Vehicle",
          "product_id": "prod_xxxxxxxxxxxxxx",
          "product_title": "Ceramic Coating Package",
          "quantity": 1,
          "sku": null,
          "subtotal": {
            "amount": "-1234.56",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          }
        }
      ],
      "member_id": "mber_xxxxxxxxxxxxxx",
      "membership_id": "mem_xxxxxxxxxxxxxx",
      "metadata": {
        "order_ref": "SHINE-4417"
      },
      "needs_tracking": false,
      "next_payment_attempt_at": null,
      "paid_at": "2026-01-01T12:00:00.000Z",
      "payment_instrument": {
        "card": {
          "brand": "visa",
          "exp_month": 10,
          "exp_year": 2031,
          "issuer_identification_number": "41111111",
          "last4": "4242"
        },
        "display_name": "Visa •••• 4242",
        "icons": {
          "card": {
            "dark": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            },
            "light": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            }
          },
          "square": {
            "dark": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            },
            "light": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            }
          }
        },
        "installment_count": null,
        "payment_method_type": "card"
      },
      "payment_method_id": "payt_xxxxxxxxxxxxxx",
      "payment_method_type": "acss_debit",
      "payment_rule_matches": [
        {
          "action": "allow",
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "payments_failed": 0,
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "presentment_total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "product_id": "prod_xxxxxxxxxxxxxx",
      "promo_code_id": null,
      "quote_id": null,
      "recovery_url": null,
      "refundable": false,
      "refunded_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "refunded_at": null,
      "retryable": true,
      "risk_score": null,
      "risk_signals": null,
      "settlement_time_at": null,
      "shipment_id": null,
      "shipping_address": {
        "city": "Austin",
        "country": "US",
        "line1": "1114 Bouldin Ave",
        "line2": "Unit B",
        "name": "Dana Whitfield",
        "postal_code": "78704",
        "state": "TX"
      },
      "status": "draft",
      "substatus": "succeeded",
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_behavior": "exclusive",
      "tax_refunded_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "three_ds_verified": false,
      "total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "updated_at": "2026-01-01T12:00:00.000Z",
      "usd_total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "user": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Dana Whitfield",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "danawhitfield"
      },
      "verification_checks": {
        "address_line1": "PASS",
        "arn": "74123456789",
        "authorization_code": "A1B2C3",
        "card_holder_name": "PASS",
        "card_security_code": "PASS",
        "zip_code": "PASS"
      },
      "voidable": false
    }
  ],
  "page_info": {
    "end_cursor": null,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

payments

List Payments

curl --request GET \
  --url https://api.whop.com/api/v1/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "amount_after_fees": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "auto_refunded": false,
      "billing_address": {
        "city": "Austin",
        "country": "US",
        "line1": "1114 Bouldin Ave",
        "line2": "Unit B",
        "name": "Dana Whitfield",
        "postal_code": "78704",
        "state": "TX"
      },
      "billing_reason": "subscription_create",
      "checkout_configuration_id": null,
      "client_secret": "pay_xxxxxxxxxxxxxx_secret_vdefault_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "created_at": "2026-01-01T12:00:00.000Z",
      "currency": "usd",
      "customer_email": "marcus@shinetime.example",
      "customer_phone": "+xxxxxxxxxxx",
      "decline_code": "insufficient_funds",
      "dispute_alerted_at": null,
      "failure_message": null,
      "financing_installments_count": null,
      "holds": [
        {
          "amount": {
            "amount": "-1234.56",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          },
          "percentage": 123,
          "release_at": "<string>",
          "type": "reserve"
        }
      ],
      "id": "pay_xxxxxxxxxxxxxx",
      "last_payment_attempt_at": null,
      "line_items": [
        {
          "id": "li_xxxxxxxxxxxxxx",
          "label": "Ceramic Coating Package",
          "plan_id": "plan_xxxxxxxxxxxxxx",
          "plan_title": "Ceramic Coating — Full Vehicle",
          "product_id": "prod_xxxxxxxxxxxxxx",
          "product_title": "Ceramic Coating Package",
          "quantity": 1,
          "sku": null,
          "subtotal": {
            "amount": "-1234.56",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          }
        }
      ],
      "member_id": "mber_xxxxxxxxxxxxxx",
      "membership_id": "mem_xxxxxxxxxxxxxx",
      "metadata": {
        "order_ref": "SHINE-4417"
      },
      "needs_tracking": false,
      "next_payment_attempt_at": null,
      "paid_at": "2026-01-01T12:00:00.000Z",
      "payment_instrument": {
        "card": {
          "brand": "visa",
          "exp_month": 10,
          "exp_year": 2031,
          "issuer_identification_number": "41111111",
          "last4": "4242"
        },
        "display_name": "Visa •••• 4242",
        "icons": {
          "card": {
            "dark": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            },
            "light": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            }
          },
          "square": {
            "dark": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            },
            "light": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            }
          }
        },
        "installment_count": null,
        "payment_method_type": "card"
      },
      "payment_method_id": "payt_xxxxxxxxxxxxxx",
      "payment_method_type": "acss_debit",
      "payment_rule_matches": [
        {
          "action": "allow",
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "payments_failed": 0,
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "presentment_total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "product_id": "prod_xxxxxxxxxxxxxx",
      "promo_code_id": null,
      "quote_id": null,
      "recovery_url": null,
      "refundable": false,
      "refunded_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "refunded_at": null,
      "retryable": true,
      "risk_score": null,
      "risk_signals": null,
      "settlement_time_at": null,
      "shipment_id": null,
      "shipping_address": {
        "city": "Austin",
        "country": "US",
        "line1": "1114 Bouldin Ave",
        "line2": "Unit B",
        "name": "Dana Whitfield",
        "postal_code": "78704",
        "state": "TX"
      },
      "status": "draft",
      "substatus": "succeeded",
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_behavior": "exclusive",
      "tax_refunded_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "three_ds_verified": false,
      "total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "updated_at": "2026-01-01T12:00:00.000Z",
      "usd_total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "user": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Dana Whitfield",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "danawhitfield"
      },
      "verification_checks": {
        "address_line1": "PASS",
        "arn": "74123456789",
        "authorization_code": "A1B2C3",
        "card_holder_name": "PASS",
        "card_security_code": "PASS",
        "zip_code": "PASS"
      },
      "voidable": false
    }
  ],
  "page_info": {
    "end_cursor": null,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-10-13"

Query Parameters

mode

enum<string>

default:account_sales

Which sales to list. account_sales returns sales for the accounts the caller can read. user_sales returns only sales the signed-in user received personally, outside any account; it requires the user's own Whop login session and cannot be combined with account_id.

Available options:

account_sales,

user_sales

account_id

string

Only payments charged by this account, prefixed biz_.

status

enum<string>

Only payments in this lifecycle state.

Available options:

open,

authorized,

paid,

pending,

uncollectible,

unresolved,

void

billing_reason

enum<string>

Only payments charged for this reason. subscription_cycle also matches renewals recorded as subscription_update.

Available options:

subscription_create,

subscription_cycle,

subscription_update,

one_time,

manual,

subscription

currency

string

Only payments presented in this three-letter currency, such as usd.

user_id

string

Only payments made by this buyer, prefixed user_. This filters sales the caller can read, so me is not accepted; list the caller's own purchases with GET /memberships?user_id=me.

query

string

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

member_id

string

Only payments made by this member, prefixed mber_.

membership_id

string

Only payments billed under this membership, prefixed mem_.

product_id

string

Only payments for this product, prefixed prod_.

plan_id

string

Only payments priced by this variant, prefixed plan_.

created_before

string<date-time>

Only payments created before this ISO 8601 timestamp.

created_after

string<date-time>

Only payments created after this ISO 8601 timestamp.

order

enum<string>

The field to sort by.

Available options:

created_at,

paid_at

direction

enum<string>

The sort direction.

Available options:

asc,

desc

first

integer

default:20

Number of results to return from the start of the range.

Required range: x <= 100

after

string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last

integer

Number of results to return from the end of the range.

Required range: x <= 100

before

string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

payments listed

data

object[]

required

Show child attributes

page_info

object

required

Show child attributes