Skip to main content
GET
List plans

Authorizations

Authorization
string
header
required

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

Query Parameters

product_family_id
string<MeteroidId>
Example:

"pf_7n42DGM5Tflk9n8mt7Fhc7"

Search by plan name

status
enum<string>[]

Filter by plan status (can be repeated)

Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
plan_type
enum<string>[]

Filter by plan type (can be repeated)

Available options:
STANDARD,
FREE,
CUSTOM
order_by
string

Sort order. Format: column.direction. Allowed columns: name, status, plan_type, created_at. Direction: asc or desc. Default: created_at.desc.

page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of plans

data
object[]
required
pagination_meta
object
required