List available plans | NetBird Full API Reference + Read-Only MCP Prototype

3 status codes

200Returns an array of available plans, each with its name, description, features, prices, and free-plan status. Each price includes its identifier, currency, amount, and unit.

descriptionstringrequired

Detailed description of the product.

featuresarray<string>required

List of features provided by the product.

freebooleanrequired

Indicates whether the product is free or not.

namestringrequired

Name of the product.

pricesarray<object>required

List of prices for the product in different currencies

401Returned when the request lacks valid authentication.

500Returned when an internal server error occurs.

Error handling

A 401 is returned when the request lacks valid authentication. A 500 indicates an internal server error.

import { NetBirdManagementAPIUnofficialOctriFullPreview } from "netbird-management-api-|-unofficial-octri-full-preview";

const client = new NetBirdManagementAPIUnofficialOctriFullPreview({
  baseUrl: "https://api.netbird.io",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.plans.list();

[
  {
    "description": "This is the basic plan with limited features.",
    "features": [
      "5 free users",
      "Basic support"
    ],
    "free": false,
    "name": "Basic Plan",
    "prices": [
      {
        "currency": "USD",
        "price": 1000,
        "price_id": "price_H2KmRb4u1tP0sR7s",
        "unit": "user"
      }
    ]
  }
]

Response

Errors