Sign in
Payments

List Payments

Lists payments, newest first. Without filters this is every payment the caller can read: a company credential's own account, or for a user every account they can read payments for. Filters narrow by account, buyer, product, plan, membership, status, billing reason, currency, and creation window. Filtering by billing_reason=subscription_cycle also matches renewals recorded as subscription_update. settlement_time_at is null on list rows — retrieve the payment for it.

get/payments

Query parameters

account_idstring

Only payments charged by this account, prefixed biz_.

status'open' | 'authorized' | 'paid' | 'pending' | 'uncollectible' | 'unresolved' | 'void'

Only payments in this lifecycle state.

billing_reason'subscription_create' | 'subscription_cycle' | 'subscription_update' | 'one_time' | 'manual' | 'subscription'

Only payments charged for this reason.

currencystring

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

user_idstring

Only payments made by this buyer, prefixed user_. Payments are listed for the accounts the caller manages, so me is not accepted; list the caller's own purchases with GET /memberships?user_id=me.

querystring

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

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

member_idstring

Only payments made by this member, prefixed mber_.

membership_idstring

Only payments billed under this membership, prefixed mem_.

product_idstring

Only payments for this product, prefixed prod_.

plan_idstring

Only payments priced by this plan, prefixed plan_.

created_beforestring date-time

Only payments created before this ISO 8601 timestamp.

created_afterstring date-time

Only payments created after this ISO 8601 timestamp.

order'created_at' | 'paid_at'

The field to sort by.

direction'asc' | 'desc'

The sort direction.

firstinteger

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

afterstring

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

lastinteger

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

beforestring

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

Response

payments listed

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "amount_after_fees": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "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",
      "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",
      "holds": [
        {
          "amount": {
            "amount": "-2.50",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          },
          "type": "reserve"
        }
      ],
      "id": "pay_xxxxxxxxxxxxxx",
      "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,
          "subtotal": {
            "amount": "-2.50",
            "currency": "usd",
            "decimals": 2,
            "display_decimals": 2
          }
        }
      ],
      "member_id": "mber_xxxxxxxxxxxxxx",
      "membership_id": "mem_xxxxxxxxxxxxxx",
      "metadata": {
        "order_ref": "SHINE-4417"
      },
      "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"
            }
          }
        },
        "payment_method_type": "card"
      },
      "payment_method_id": "payt_xxxxxxxxxxxxxx",
      "payment_method_type": "acss_debit",
      "payment_rule_matches": [
        {
          "action": "allow"
        }
      ],
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "presentment_total": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "product_id": "prod_xxxxxxxxxxxxxx",
      "refunded_amount": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "retryable": true,
      "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": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_behavior": "exclusive",
      "tax_refunded_amount": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "total": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "updated_at": "2026-01-01T12:00:00.000Z",
      "usd_total": {
        "amount": "-2.50",
        "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",
        "authorization_code": "A1B2C3",
        "card_holder_name": "PASS",
        "card_security_code": "PASS",
        "zip_code": "PASS"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 22 of the 74 revisions of this API.686072

  • 86b97292852d1See the full diff
    • ●

      added the new alipayhk enum value to the ////// response property for the response status

      response-property-enum-value-added

  • 7fcefabddb0a1See the full diff
    • ●

      added the new tabby enum value to the ////// response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b996614See the full diff
    • ▲

      the response property //////////// became nullable for the status

      response-property-became-nullable

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property //////////// to the response with the status

      response-required-property-added

    • ○

      added the required property //////////// to the response with the status

      response-required-property-added

    • ○

      added the required property /////// to the response with the status

      response-required-property-added

  • 076176906e3f1See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

  • ef86d14ef6911See the full diff
    • ●

      added the new review enum value to the //// response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ff3a76573563122See the full diff
    • ▲

      for the query request parameter first, default value 20 was added

      request-parameter-default-value-added

    • ●

      for the query request parameter first, the max was set to 100.00

      request-parameter-max-set

    • ●

      for the query request parameter last, the max was set to 100.00

      request-parameter-max-set

    • ○

      response property data/items/risk_signals deprecated

      response-property-deprecated

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • c19acf2e254821See the full diff
    • ●

      added the new blocked enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new touch_n_go enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ○

      removed the bizum enum value from the ////// response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 18cde81b67631See the full diff
    • ○

      added the required property //////////// to the response with the status

      response-required-property-added

  • 5fa504e786951See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2fa9dfe9535a5See the full diff
    • ●

      added the new mercado_pago_ar enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_mx enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nupay enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new opay enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new verve enum value to the ////// response property for the response status

      response-property-enum-value-added

Of the 74 revisions, 1 has no diff computed.