Skip to main content
GET
/
plans
Typescript (SDK)
import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.plans.list();

  console.log(result);
}

run();
{
  "data": [
    {
      "id": "plan_g1mbDw8BOLv5B",
      "type": "plans",
      "attributes": {
        "slug": "m4-metal-small-42",
        "name": "m4.metal.small-42",
        "features": [],
        "specs": {
          "cpu": {
            "type": "E-2276G",
            "clock": 3.8,
            "cores": 6,
            "count": 1
          },
          "memory": {
            "total": 32
          },
          "drives": [
            {
              "count": 1,
              "size": "3.8TB",
              "type": "SSD"
            }
          ],
          "nics": [
            {
              "count": 1,
              "type": "10 Gbps"
            }
          ],
          "gpu": {
            "count": 4,
            "type": "NVIDIA H100",
            "vram_per_gpu": null,
            "interconnect": null
          }
        },
        "regions": [
          {
            "name": "Brazil",
            "deploys_instantly": [],
            "locations": {
              "available": [
                "SAO"
              ],
              "in_stock": [
                "SAO"
              ]
            },
            "stock_level": "medium",
            "pricing": {
              "USD": {
                "hour": 10,
                "month": 50,
                "year": 100
              },
              "BRL": {
                "hour": 53,
                "month": 108.5,
                "year": 205
              }
            }
          }
        ]
      }
    }
  ],
  "meta": {}
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
filter[name]
string

The plan name to filter by

​
filter[slug]
string

The plan slug to filter by

​
filter[location]
string

The location of the site to filter by

​
filter[stock_level]
enum<string>

The stock level at the site to filter by

Available options:
unavailable,
low,
medium,
high,
unique
​
filter[in_stock]
boolean

The stock available at the site to filter by

​
filter[gpu]
boolean

Filter by the existence of an associated GPU

​
filter[ram]
integer

The ram size in Gigabytes to filter by, should be used with the following options: [eql] to filter for values equal to the provided value. [gte] to filter for values greater or equal to the provided value. [lte] to filter by values lower or equal to the provided value.

​
filter[disk]
integer

The disk size in Gigabytes to filter by, should be used with the following options: [eql] to filter for values equal to the provided value. [gte] to filter for values greater or equal to the provided value. [lte] to filter by values lower or equal to the provided value.

Response

200 - application/vnd.api+json

Success

​
data
object[]