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

# List payments

`GET /payments`

## Request

- Base URL: `https://www.billingengine.com/api/v1`
- URL: `https://www.billingengine.com/api/v1/payments`
- Auth: HTTP bearer

All payments, newest first.

## Query parameters

- `invoice_id` integer
- `page` integer
- `per_page` integer

## Response `200`

A page of payments.

- object
  - `data` Payment[], required
    - `id` integer
    - `number` union
      - string
      - integer
    - `date` string, date
    - `amount` number
    - `currency` string
    - `payment_method` 'transfer' | 'cash'
    - `cancelled` boolean
    - `customer` CustomerReference
      - `id` integer
      - `name` string
    - `invoice_ids` integer[]
  - `pagination` Pagination, required
    - `page` integer, required
    - `per_page` integer, required
    - `pages` integer, required
    - `count` integer, required

## Other responses

- `400`: Malformed request: missing parameter, invalid JSON, invalid date or invalid filter.
- `401`: Missing or invalid API key.
- `403`: The API is not available in the Free plan, or the monthly invoice maximum of the plan has been reached.

---

[API](https://skmtc.dev/billingengine/apis/billingengine-api.md) · [All operations](https://skmtc.dev/billingengine/apis/billingengine-api/llms.txt) · [OpenAPI document](https://skmtc.dev/billingengine/apis/billingengine-api/revisions/71d8ea5fb554?raw)