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

# Read a workspace's plan

> The plan, whether it is paid up, and how many apps are live against how many it pays for, as Dojo last stored them.



## OpenAPI

````yaml https://dojo.frogbot.ai/api/openapi.json get /api/workspaces/{id}/billing
openapi: 3.1.0
info:
  title: Dojo API
  version: '1'
  description: >-
    Everything Dojo's pages do, for scripts and agents. Sign in with an API key
    as `Authorization: Bearer fb_…`. Paying and accepting the terms happen at a
    link a route answers, for a person to open.
servers:
  - url: https://dojo.frogbot.ai
security:
  - apiKey: []
tags:
  - name: Sign-in
  - name: Workspaces
  - name: Projects
  - name: Apps
  - name: Templates
  - name: Sharing
  - name: Deployments
  - name: Environment variables
  - name: Domains
  - name: Data
  - name: Billing
  - name: API keys
paths:
  /api/workspaces/{id}/billing:
    get:
      tags:
        - Billing
      summary: Read a workspace's plan
      description: >-
        The plan, whether it is paid up, and how many apps are live against how
        many it pays for, as Dojo last stored them.
      operationId: get/api/workspaces/:id/billing
      parameters:
        - name: id
          in: path
          required: true
          description: The workspace's id.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                    enum:
                      - none
                      - pro
                      - business
                      - platform
                  state:
                    type: string
                    enum:
                      - none
                      - active
                      - past_due
                      - cancelling
                      - stopped
                  liveApps:
                    type: integer
                  paidApps:
                    type: integer
                  periodEnd:
                    anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                required:
                  - plan
                  - state
                  - liveApps
                  - paidApps
                  - periodEnd
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: '`forbidden`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              data:
                type: object
                properties:
                  code:
                    type: string
                  url:
                    type: string
                    description: Where a person takes the next step, such as paying.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or
        the API keys page.

````

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