---
title: "List plans"
method: GET
path: "/api/v1/plans"
tags: ["plan"]
---

# List plans

`GET /api/v1/plans`

List plans with optional filtering by product family.

## Query parameters

- `product_family_id` string, MeteroidId
- `page` integer
- `per_page` integer

## Response `200`

List of plans

- PlanListResponse
  - `data` Plan[], required
    - `available_parameters` AvailableParameters, required
      - `billing_periods` object — Map of component_id -> available billing periods (e.g., "MONTHLY", "ANNUAL")
      - `capacity_thresholds` object — Map of component_id -> available capacity values
      - `slot_components` string[] — List of component_ids that support slot parametrization (initial slot count)
    - `created_at` string, date-time, required
    - `currency` string, required
    - `description` string, nullable
    - `id` string, MeteroidId, required
    - `name` string, required
    - `net_terms` integer, required
    - `plan_type` 'STANDARD' | 'FREE' | 'CUSTOM', required
    - `price_components` PriceComponent[], required
      - `fee` union, required
        - RatePlanFee — Recurring rate fee (e.g., monthly subscription)
          - `rates` TermRate[], required
            - `price` string, required
            - `term` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
        - SlotPlanFee — Slot-based fee (e.g., per-seat pricing)
          - `minimum_count` integer, nullable
          - `quota` integer, nullable
          - `rates` TermRate[], required
            - `price` string, required
            - `term` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
          - `slot_unit_name` string, required
        - CapacityPlanFee — Capacity-based fee with included committed usage and overage
          - `cadence` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
          - `metric_id` string, MeteroidId, required
          - `thresholds` CapacityThreshold[], required
            - `included_amount` integer, required
            - `per_unit_overage` string, required
            - `price` string, required
        - UsagePlanFee — Usage-based fee
          - `cadence` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
          - `metric_id` string, MeteroidId, required
          - `pricing` union, required
            - PerUnitPricing
              - …
            - TieredPricing
              - …
            - VolumePricing
              - …
            - PackagePricing
              - …
            - MatrixPricing
              - …
        - ExtraRecurringPlanFee — Extra recurring fee
          - `billing_type` 'ADVANCE' | 'ARREARS', required
          - `cadence` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
          - `quantity` integer, required
          - `unit_price` string, required
        - OneTimePlanFee — One-time fee
          - `quantity` integer, required
          - `unit_price` string, required
      - `id` string, MeteroidId, required
      - `name` string, required
      - `product_id` string, MeteroidId
    - `product_family` ProductFamily, required
      - `id` string, MeteroidId, required
      - `name` string, required
    - `status` 'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED', required
    - `trial` TrialConfig
      - `duration_days` integer, required
      - `is_free` boolean, required
      - `trialing_plan_id` string, MeteroidId
    - `version` integer, required
    - `version_id` string, MeteroidId, required
  - `pagination_meta` PaginationResponse, required
    - `page` integer, required
    - `per_page` integer, required
    - `total_items` integer, required
    - `total_pages` integer, required

## Other responses

- `401` — Unauthorized
- `500` — Internal error

## Changes

- **2025-12-17** (v1) `2244ec0dabe3` — 3 breaking, 4 info
  - for the `query` request parameter `page`, the type/format was changed from `integer`/`` to `integer`/`int32`
  - for the `query` request parameter `per_page`, the type/format was changed from `integer`/`` to `integer`/`int32`
  - added `#/components/schemas/RatePlanFee, #/components/schemas/SlotPlanFee, #/components/schemas/CapacityPlanFee, #/components/schemas/UsagePlanFee, #/components/schemas/ExtraRecurringPlanFee, #/components/schemas/OneTimePlanFee` to the `data/items/price_components/items/fee` response property `oneOf` list for the response status `200`
  - the `query` request parameter `page` became optional
  - …3 more
- **2025-10-20** (v1) `aa51557e5c0b` — 1 breaking, 1 info
  - added `subschema #3, subschema #4` to the `data/items/price_components/items/fee` response property `oneOf` list for the response status `200`
  - removed `subschema #3, subschema #4` from the `data/items/price_components/items/fee` response property `oneOf` list for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/meteroid-oss/apis/meteroid/changes/api/v1/plans/get.md)

---

[API](https://skmtc.dev/meteroid-oss/apis/meteroid.md) · [All operations](https://skmtc.dev/meteroid-oss/apis/meteroid/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/meteroid-oss/meteroid/revisions/2244ec0dabe3/schema)
