Skip to main content
GET
List Payment Contracts

Scheduled Payments Guide

Complete guide with examples, contract lifecycle and timezone handling

Query Parameters

templateId
string<uuid>

Optional template ID filter

status
enum<string>

Optional status filter Status of a payment contract

Available options:
Active,
Paused,
Cancelled,
Completed
pageNumber
integer<int32>

Page number (1-indexed, default: 1)

Required range: 1 <= x <= 2147483647
pageSize
integer<int32>

Page size (default: 20, max: 100)

Required range: 1 <= x <= 100

Response

OK

Paginated list response

items
object[] | null

List of items for current page

totalCount
integer<int32>

Total count of items across all pages

pageNumber
integer<int32>

Current page number (1-indexed)

pageSize
integer<int32>

Page size

totalPages
integer<int32>
read-only

Total number of pages

hasNextPage
boolean
read-only

Whether there is a next page

hasPreviousPage
boolean
read-only

Whether there is a previous page