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

# List payments

`GET /payments/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `customer` string
- `invoice` string
- `source` integer
- `sources` integer
- `status` 'cancelled' | 'failed' | 'incomplete' | 'processing' | 'requires_payment_method' | 'succeeded'
- `amount` number
- `balance` number
- `currency` string
- `date` string, date
- `payment_date` string, date-time
- `description` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated payment list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Payment[], required — The items in the current page.
    - `id` integer
    - `invoice` string, nullable — Invoice ID this payment applies to.
    - `subscription` string, nullable — Subscription ID when generated by a subscription cycle.
    - `customer` string, nullable
    - `amount` number, required
    - `balance` number — Remaining balance to charge against this payment.
    - `currency` string, required — ISO currency code.
    - `date` string, date, required
    - `payment_date` string, date-time, nullable — Effective date the payment was completed.
    - `description` string, required
    - `source` integer, nullable — Primary source ID. (Legacy single source link.)
    - `sources` integer[] — All source IDs linked to this payment (multi-source support).
    - `status` 'cancelled' | 'failed' | 'incomplete' | 'processing' | 'requires_payment_method' | 'succeeded'
    - `failed_reason` string, nullable — Reason code when `status=failed`.
    - `return_url` string, uri, nullable — URL the payer is sent back to after a redirect-flow checkout.
    - `enable_checkout` boolean — Whether the publishable checkout `/pay/` is reachable for this payment.
    - `metadata` object
    - `test_mode` boolean
    - `created` string, date-time
    - `updated` string, date-time

---

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