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

# List payments

`GET /payments`

Retrieve a paginated list of payments with powerful filtering capabilities.

**gigstack Connect:** Access other teams' payments using the `team` parameter.

**Filtering Options:**
- Filter by payment status, currency, amount
- Filter by client ID, email, tax ID (RFC), or name
- Filter by metadata fields using dot or underscore notation (e.g., `metadata.order_id` or `metadata_order_id`)
- Filter by creation date using comparison operators

## Query parameters

- `team` string
- `limit` integer
- `next` string, nullable
- `order_by` 'name' | 'timestamp'
- `sort` 'asc' | 'desc' — Sort direction for list queries
- `created[gte]` union
  - integer
  - string, date
- `created[lte]` union
  - integer
  - string, date
- `status` 'requires_payment_method' | 'succeeded' | 'canceled'
- `currency` string
- `amount` number
- `client_id` string
- `email` string
- `tax_id` string
- `client_name` string
- `metadata.{key}` string

## Response `200`

Payments retrieved successfully

- ListResponse
  - `message` string, required
  - `data` object[], required
  - `next` string, nullable — Cursor for next page
  - `has_more` boolean, required
  - `total_results` number, required

---

[API](https://skmtc.dev/disruptive-learning/apis/gigstack-api-v2.md) · [All operations](https://skmtc.dev/disruptive-learning/apis/gigstack-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/disruptive-learning/gigstack-api-v2/revisions/5cf53ffd7580/schema)