---
title: "Get available tunnels project plan configuration"
method: GET
path: "/api/workspaces/{workspaceId}/projects/tunnels/plan/config"
tags: ["plans"]
---

# Get available tunnels project plan configuration

`GET /api/workspaces/{workspaceId}/projects/tunnels/plan/config`

## Request

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

## Path parameters

- `workspaceId` string, required

## Response `200`

Successful response.

- WorkspaceTunnelsPlanConfig
  - `plans` object[], required
    - `plan` 'basic' | 'pro' | 'enterprise', required
    - `name` string, required
    - `description` string, required
    - `available` boolean, required
    - `unavailableReasonCode` 'plan_disabled' | 'plan_not_supported' | 'billing_required' | 'billing_blocked' | 'billing_out_of_sync' | 'billing_mode_required' | 'basic_project_limit_reached' | 'project_limit_reached' | 'no_capacity'
    - `unavailableReason` string
    - `billingImpact` object, required
      - `type` 'none' | 'free' | 'paid' | 'custom', required
      - `label` string, required
      - `description` string, required
      - `billingEnabled` boolean, required
      - `price` object
        - `amount` integer, required
        - `currency` string, required
      - `compareAtPrice` object
        - `amount` integer, required
        - `currency` string, required
      - `recurring` string
      - `promotion` object
        - `label` string, required
        - `priceHelper` string, required
    - `billingAction` object, required
      - `type` 'none' | 'confirm_create' | 'stripe_checkout', required
      - `label` string, required
      - `description` string, required
      - `submitLabel` string, required
    - `routingModes` string[], required
    - `globalProviders` string[], required
    - `providers` object[], required
      - `provider` 'aws' | 'gcp' | 'azure' | 'onpremise' | 'other', required
      - `regions` object[], required
        - `region` string, required
        - `label` string, required
        - `recommended` boolean, required
    - `creationFingerprint` string, required
  - `recommended` union
    - object
      - `routing` 'global', required
      - `plan` 'basic' | 'pro' | 'enterprise', required
      - `provider` 'aws' | 'gcp' | 'azure' | 'onpremise' | 'other', required
    - object
      - `routing` 'regional', required
      - `plan` 'basic' | 'pro' | 'enterprise', required
      - `provider` 'aws' | 'gcp' | 'azure' | 'onpremise' | 'other', required
      - `region` string, required

## Other responses

- `401`: Authentication is required.
- `403`: The token is not authorized.
- `404`: Workspace 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)