Skip to main content
GET
Get payment plans

Authorizations

Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

tenantId
string<uuid>
required

Id of the tenant the payment plans belong to

Query Parameters

page
integer

Page to get. Starting from 0.

pageSize
integer

Number of items per page.

Required range: x <= 500
caseId
string<uuid>

Filter by the case the payment plans belong to.

status
enum<string>

Filter by the status of the payment plan.

Available options:
CREATED,
ACTIVE,
FINISHED,
CANCELED,
DELETED

Response

Successful operation

meta
object
items
object[]