Sign in

v1

latestOpenAPI 3.0.02026-07-243678114.1 KB
Plans

List Plans

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.

get/v1/plan

Query parameters

afterstring

Filters plans to include only those created after the specified timestamp.

beforestring

Filters plans to include only those created before the specified timestamp.

limitinteger

Specifies the maximum number of plans to be included in the API response.

pageinteger

Indicates the page number of the results to be retrieved.

sincestring

Filters plans to include only those created on or after the specified timestamp.

sort'asc' | 'desc'

Specifies the sorting order for the returned plans.

untilstring

Filters plans to include only those created on or before the specified timestamp.

Response

OK

errorboolean

Example response

{
  "data": {
    "items": [
      {
        "id": "2eJh1L1rDrCZxTyE6vwGhck7LWI",
        "org_id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
        "metadata": {
          "key": "value"
        },
        "properties": {
          "key": "value"
        }
      }
    ],
    "last_update": "2021-01-01T00:00:00Z",
    "next": 10,
    "total": 10
  }
}