---
title: "List Payments"
method: GET
path: "/v1/payments/"
tags: ["payments", "public"]
---

# List Payments

`GET /v1/payments/`

List payments.

**Scopes**: `payments:read`

## Query parameters

- `organization_id` union — Filter by organization ID.
  - string, uuid4 — The organization ID.
  - string[]
- `checkout_id` union — Filter by checkout ID.
  - string, uuid4
  - string[]
- `order_id` union — Filter by order ID.
  - string, uuid4
  - string[]
- `customer_id` union — Filter by customer ID.
  - string, uuid4 — The customer ID.
  - string[]
- `status` union — Filter by payment status.
  - 'pending' | 'succeeded' | 'failed'
  - PaymentStatus[]
- `method` union — Filter by payment method.
  - string
  - string[]
- `customer_email` union — Filter by customer email.
  - string
  - string[]
- `page` integer — Page number, defaults to 1.
- `limit` integer — Size of a page, defaults to 10. Maximum is 100.
- `sorting` PaymentSortProperty[], nullable — Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

## Response `200`

Successful Response

- ListResourcePayment
  - `items` Payment[], required
    - union
      - CardPayment — Schema of a payment with a card payment method.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `processor` 'stripe', required
        - `status` 'pending' | 'succeeded' | 'failed', required
        - `amount` integer, required — The payment amount in cents.
        - `currency` string, required — The payment currency. Currently, only `usd` is supported.
        - `method` 'card', required — The payment method used.
        - `trigger` 'purchase' | 'subscription_cycle' | 'retry_dunning' | 'retry_customer' | 'retry_payment_method_update' | 'retry_admin', required
        - `decline_reason` string, nullable, required — Error code, if the payment was declined.
        - `decline_message` string, nullable, required — Human-readable error message, if the payment was declined.
        - `organization_id` string, uuid4, required — The ID of the organization that owns the payment.
        - `checkout_id` string, uuid4, nullable, required — The ID of the checkout session associated with this payment.
        - `order_id` string, uuid4, nullable, required — The ID of the order associated with this payment.
        - `processor_metadata` object — Additional metadata from the payment processor for internal use.
        - `method_metadata` CardPaymentMetadata, required — Additional metadata for a card payment method.
          - `brand` string, required — The brand of the card used for the payment.
          - `last4` string, required — The last 4 digits of the card number.
      - GenericPayment — Schema of a payment with a generic payment method.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `processor` 'stripe', required
        - `status` 'pending' | 'succeeded' | 'failed', required
        - `amount` integer, required — The payment amount in cents.
        - `currency` string, required — The payment currency. Currently, only `usd` is supported.
        - `method` string, required — The payment method used.
        - `trigger` 'purchase' | 'subscription_cycle' | 'retry_dunning' | 'retry_customer' | 'retry_payment_method_update' | 'retry_admin', required
        - `decline_reason` string, nullable, required — Error code, if the payment was declined.
        - `decline_message` string, nullable, required — Human-readable error message, if the payment was declined.
        - `organization_id` string, uuid4, required — The ID of the organization that owns the payment.
        - `checkout_id` string, uuid4, nullable, required — The ID of the checkout session associated with this payment.
        - `order_id` string, uuid4, nullable, required — The ID of the order associated with this payment.
        - `processor_metadata` object — Additional metadata from the payment processor for internal use.
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/polar/apis/polar-api.md) · [All operations](https://skmtc.net/polar/apis/polar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polar/polar-api/revisions/ff24109feac4/schema)