---
title: "List upcoming payments"
method: GET
path: "/schedules/v1/{schedule_id}/upcoming-payments"
tags: ["Schedules"]
---

# List upcoming payments

`GET /schedules/v1/{schedule_id}/upcoming-payments`

Returns a paginated list of upcoming (not yet executed) payments for a schedule.

## Path parameters

- `schedule_id` string, uuid, required

## Query parameters

- `fromDate` string, date
- `toDate` string, date
- `page` integer
- `size` integer

## Response `200`

A paginated list of upcoming payments.

- UpcomingPaymentListResponse
  - `content` ScheduleUpcomingPayment[], required — The page of upcoming payments.
    - `due_date` string, date, required — The date the payment is due to be executed.
    - `amount` ScheduleAmount, required — A monetary amount for a scheduled payment.
      - `value` number, required — The amount of money in the currency specified.
      - `currency` string, required — The currency of the amount.
    - `reference` string, nullable — The reference that will be applied to the payment, when set.
  - `page` PageMetadata, required — Metadata about the current page of results
    - `number` integer, required — The current page being returned by the API
    - `size` integer, required — The page size requested
    - `total_elements` integer, required — The total number of elements in all pages
    - `total_pages` integer, required — The total number of pages retrievable
    - `sort` string[] — Sort parameters applied to the results

---

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