List plans

Discover the available service and database plans before creating or resizing a resource.

GET/api/plansHTTPS

Request & response examples

Request exampleServer-side

curl --fail-with-body --request GET \
  'https://app.helicarrier.xyz/api/plans' \
  -H "Authorization: Bearer $HELI_API_KEY"

const response = await fetch(
  "https://app.helicarrier.xyz/api/plans",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`
    }
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "GET",
    "https://app.helicarrier.xyz/api/plans",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example200

{
  "currency": "USD",
  "fxRate": 0,
  "plans": []
}

Illustrative values · selected fields

Response details OpenAPI

Authorization

Any valid API key. Catalog and identity reads do not require a capability category.

Authorization: Bearer <key>Key setup

Parameters

This request does not require path, query, or body parameters.

Response 200

Returns available plans, pricing rates, display currency, and the applicable exchange rate. Read the current catalog before choosing a plan key; example plan lists are not price quotes.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

currencystring

Display currency associated with the caller.

fxRateinteger

Exchange rate for the display currency; zero when not applicable.

plansarray

Available service and database plans.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`list_plans`

Required MCP arguments: none. Send path, query, and body fields together as tool arguments.

Connect your agent

import os import requests response = requests.request( "GET", "https://app.helicarrier.xyz/api/plans", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.