Skip to main content
GET
List cancelled plan agreements

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Search by account name or member/payee company name.

Maximum string length: 255
sort
enum<string>
default:date

Sort column.

Available options:
date,
account_name,
company_name
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
page
integer
default:1
Required range: x >= 1
per_page
integer
default:10
Required range: 1 <= x <= 100

Response

Cancelled plan agreements returned.

data
object[]
required
pagination
object
required
Last modified on July 19, 2026