---
title: "Get tunnels project plan"
method: GET
path: "/api/projects/tunnels/{projectId}/plan"
tags: ["usage"]
---

# Get tunnels project plan

`GET /api/projects/tunnels/{projectId}/plan`

## Request

- Base URL: `https://rstream.io`
- URL: `https://rstream.io/api/projects/tunnels/{projectId}/plan`
- Auth: HTTP bearer

## Path parameters

- `projectId` string, required

## Response `200`

Successful response.

- TunnelsProjectPlan
  - `id` string, required
  - `name` string, required
  - `price` union, required
    - string
    - object
      - `value` object, required
        - `amount` integer, required
        - `currency` string, required
      - `recurring` string, required
  - `description` string, required
  - `features` string[], required
  - `metadata` object
    - `maxInstantBandwidthMbps` number
    - `maxInstantConnections` number
    - `maxInstantConnectionTimeMinutes` number
    - `maxInstantTunnels` number
    - `maxTotalBandwidthMB` number
    - `maxTotalConnections` number
    - `maxTotalConnectionTimeMinutes` number
  - `currentPeriod` object, required
    - `start` string, date-time, required
    - `end` string, date-time, required
  - `cancelAtPeriodEnd` boolean

## Other responses

- `401`: Authentication is required.
- `403`: The token is not authorized.
- `404`: Project or plan not found.

---

[API](https://skmtc.dev/rstream/apis/rstream-api.md) · [All operations](https://skmtc.dev/rstream/apis/rstream-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rstream/apis/rstream-api/revisions/a840a2c91f22?raw)