List plans

get

https://www.pelcro.com/api/v1/core/plans

Retrieve a paginated list of plans for the site. Supports sorting by id and nickname, and filtering.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

product_id

int32

Filter plans by product ID.

limit

int32

Defaults to 10

The maximum number of objects you want returned per result set. For instance, if you set limit=10, the API will return a maximum of 10 objects in the response. (max: 100)

page

int32

Defaults to 1

The specific page of the result set you want to retrieve, typically used in conjunction with limit. For example, if you set page=2 and limit=10, the API will return the second page of results, containing a maximum of 10 objects starting from the 11th object.

sort

string

enum

One supported attribute to sort on. Prefix with - for descending.

Allowed:

filter[id]

string

Filter by plan ID. Example: eq:42

filter[nickname]

string

Filter by plan nickname. Operators: eq, like. Example: like:Premium

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Response

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

application/json

200Success.

400Invalid request.

401Unauthenticated.