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

# List Plans

`GET /v1/plan`

The **List Plans** endpoint allows you to retrieve a list of all subscription plans available within your organization. This includes details such as the plan's `name`, `currency`, and `billing_scheme`, among others. Use this endpoint to review and manage the subscription options your organization offers.

> 📘 Note
> 
> A plan is synonymous with a product in BoomFi. You can have multiple plans for different currencies or pricing structures for the same product.

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `page` integer
- `since` string
- `sort` 'asc' | 'desc'
- `until` string

## Response `200`

OK

- InternalPaginatedResponsePlanPlanResponse
  - `data` InternalPaginatedItemsPlanPlanResponse
    - `items` PlanPlanResponse[]
      - `id` string — The unique identifier of the plan.
      - `org_id` string — The identifier of the organization associated with the plan.
      - `source` 1 | 2 | 3 | 4 — The source of this billing information. Can be one of the following: - 1 = Lago - 2 = Boomfi - 3 = Stripe - 4 = Chargebee
      - `name` '1' | '2' | '3' — The type of the plan: - **1** = Unknown - **2** = Onetime - **3** = Recurring
      - `type` string — The type of the plan.
      - `billing_scheme` 1 | 2 | 3 | 4 — The billing scheme determines how the charges are calculated for the subscription. - 1 = Flatfee - 2 = Perunit - 3 = Graduated - 4 = Volume
      - `price` string — The price of the plan.
      - `currency` string — The currency of the plan.
      - `available_quantity` integer — The available quantity of the plan.
      - `trial_period` string — The trial period of the plan.
      - `recurring_interval` 'Week' | 'Month' | 'Year' — The recurring interval for the payment link: - **Week** - **Month** - **Year**
      - `recurring_interval_count` integer — The count of recurring intervals for the plan.
      - `recurring_usage_type` 1 | 2 | 3
      - `reference` string — The reference of the plan.
      - `enabled` boolean — Indicates whether the plan is enabled or not.
      - `v1` string — Additional information about the plan.
      - `created_by` string — The identifier of the user who created the plan.
      - `created_at` string, date-time — The timestamp when the plan was created.
      - `updated_at` string, date-time — The timestamp when the plan was last updated.
      - `deleted_at` string, date-time — The timestamp when the plan was deleted, if applicable.
      - `metadata` object — Additional metadata associated with the plan.
      - `properties` object — Additional properties of the plan.
    - `last_update` string
    - `next` integer
    - `total` integer
  - `error` boolean

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.net/boomfi/apis/boomfi-merchants-api.md) · [All operations](https://skmtc.net/boomfi/apis/boomfi-merchants-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/boomfi/boomfi-merchants-api/versions/ace3c3df05fe/schema)