Plans

List plans

Changed on
get/api/v1/plans

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

product_family_idstring MeteroidId
Example:pf_7n42DGM5Tflk9n8mt7Fhc7
searchstring

Search by plan name

statusstring[]

Filter by plan status (can be repeated)

plan_typestring[]

Filter by plan type (can be repeated)

order_bystring

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

pageinteger

Page number (0-indexed)

per_pageinteger

Number of items per page

Response

List of plans

Changes

  • v14e013b4e4a8fRevision changes
    • breaking

      the response property //////////////////// became nullable for the status

    • breaking

      the response property //////////////////// became nullable for the status

    • breaking

      the response property //////////////////// became nullable for the status

    • breaking

      the response property //////////////////// became nullable for the status

    • breaking

      the response property //////////////////// became optional for the status

    • breaking

      the response property //////////////////// became optional for the status

    • breaking

      the response property //////////////////// became optional for the status

    • breaking

      the response property //////////////////// became optional for the status

  • v107a61fe347a5Revision changes
    • breaking

      removed the required property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status