Skip to main content
GET
List client plans

Path Parameters

organisationId
string
required

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

recurring
boolean

Filter by whether the plan is recurring (a subscription with a billing frequency). Omit to return both recurring and one-off plans.

q
string

Search plans by plan name, client name, mobile number or email.

expand
enum<string>[]
Available options:
client,
organisation,
bookingCredits,
charges

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10