> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List plans

> Returns every billing plan with its price, feature flags
and included usage. No credential is needed.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/plans
openapi: 3.1.0
info:
  title: Qumo Deploy REST API
  description: >
    The Qumo Deploy control plane: organizations, projects, signing keys,
    machine

    identities, access control, audit and billing. Relay credentials are not

    issued here: your app signs them with its own

    [signing keys](/guides/signing-keys).


    Every operation here is generated against the routes the server registers

    and checked in CI, so an operation in this reference exists and a route

    missing from it is deliberately internal (relay mesh, webhooks, probes,

    operator-only and browser sign-in routes).


    Errors are JSON objects with one `error` field. What each status code means

    is in [Error codes](/guides/error-codes); the token scope each permission

    needs is in [Scopes and permissions](/guides/scopes-permissions).
  version: 1.0.0
servers:
  - url: https://api.qumo-deploy.com
    description: Public API (Bearer tokens only; cookies are ignored)
security: []
tags:
  - name: Account
    description: The signed-in user's own sessions, tokens, security settings and data.
  - name: Device flow
    description: OAuth 2.0 device authorization, used by `qumod login`.
  - name: Organizations
    description: Organizations, their members and usage.
  - name: Projects
    description: Projects inside an organization.
  - name: Signing keys
    description: Keys your app signs relay credentials with.
  - name: Relays
    description: Where clients of a broadcast path connect.
  - name: Identities
    description: Machine identities, their tokens and IP allowlists.
  - name: Access control
    description: Roles, IAM bindings and invitations.
  - name: Audit
    description: The audit log and its webhook.
  - name: Notifications
    description: Notification policies.
  - name: Billing
    description: Plans, usage cost, budgets, invoices and payment methods.
  - name: Pricing
    description: Public price list.
paths:
  /v1/plans:
    get:
      tags:
        - Pricing
      summary: List plans
      description: |
        Returns every billing plan with its price, feature flags
        and included usage. No credential is needed.
      operationId: listPlans
      responses:
        '200':
          description: The plans.
          headers:
            Cache-Control:
              description: The response may be cached for five minutes.
              schema:
                type: string
              example: public, max-age=300
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Plan'
      security: []
components:
  schemas:
    Plan:
      type: object
      description: A billing plan.
      required:
        - name
        - price_usd_per_month
        - tagline
        - feature_flags
        - included_usage_bytes
      properties:
        name:
          type: string
          enum:
            - Free
            - Pay as you go
            - Enterprise
          description: The plan's name; case-sensitive wherever it is sent to the server.
          example: Pay as you go
        price_usd_per_month:
          type: integer
          description: >-
            Monthly fee in USD. 0 on every plan; Pay as you go bills relay
            egress per GB beyond its free allowance, and Enterprise is priced
            per contract.
          example: 0
        tagline:
          type: string
          description: Short description of the plan.
          example: Pay only for the bandwidth you use
        feature_flags:
          $ref: '#/components/schemas/PlanFeatureFlags'
        included_usage_bytes:
          type: integer
          format: int64
          description: >-
            Egress bytes free per billing period, summed across every active
            product. 0 on Free; 100000000000 (100 GB) on Pay as you go. On
            Enterprise it is a reference figure; the contract sets the actual
            terms.
          example: 100000000000
    PlanFeatureFlags:
      type: object
      description: Features the plan includes.
      properties:
        relay_network:
          type: boolean
          description: Access to the managed relay network, needed for prod projects.
          example: true
        sso:
          type: boolean
          description: >-
            Enterprise identity (verified domains, SSO and SCIM), needed to add
            or verify an organization's domains. True on every paid plan.
          example: true
      additionalProperties: true

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.