List price plans.

get

https://api.jamaibase.com/api/v2/prices/plans/list

Permissions: None (public) to list publicly-available price plans; system.MEMBER to list all price plans.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

offset

integer

≥ 0

Defaults to 0

Items offset.

limit

integer

≤ 1000

Defaults to 1000

Number of items.

order_by

string

enum

Defaults to updated_at

Sort by this attribute.

Allowed:

order_ascending

boolean

Defaults to true

Whether to sort in ascending order.

search_query

string

length ≤ 10000

A string to search for as a filter. The string is interpreted as both POSIX regular expression and literal string. Defaults to "" (no filter). It will be combined other filters using AND.

search_columns

array of strings

length ≥ 1

Defaults to name

A list of attribute names to search for search_query. Defaults to ["name"].

Search Columns

after

Opaque cursor token to paginate results. If provided, the query will return items after this cursor and offset will be ignored. Defaults to None (no cursor).

Headers

Authorization

string

Service key (optional).

X-USER-ID

string

User ID (optional). Must be present if Authorization is present.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error