v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Schedules

List upcoming payments

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

get/schedules/v1/{schedule_id}/upcoming-payments

Path parameters

schedule_idstring uuid required

The id of the schedule.

Query parameters

fromDatestring date

Only return upcoming payments due on or after this date (inclusive).

toDatestring date

Only return upcoming payments due on or before this date (inclusive).

pageinteger

The page you're requesting - returns page 0 of a response if not specified.

sizeinteger

The number of objects you want to return as a page size.

Response

A paginated list of upcoming payments.