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

# Get credit balance

> Returns the workspace's available credit balance, plan tier (machine identifier), and display plan name. Available to all workspace members.



## OpenAPI

````yaml /openapi/billing.yaml get /workspaces/{workspaceId}/billing/credits-balance
openapi: 3.1.0
info:
  title: Connie Billing API
  version: 1.0.0
  description: >
    API for managing workspace billing, subscriptions, credits, and invoices.
    Most endpoints require admin role. All endpoints require authentication.
servers:
  - url: https://connie.ai/api
    description: Production
security:
  - cookieAuth: []
tags:
  - name: Credits
    description: Credit balance and top-up settings
paths:
  /workspaces/{workspaceId}/billing/credits-balance:
    get:
      tags:
        - Credits
      summary: Get credit balance
      description: >-
        Returns the workspace's available credit balance, plan tier (machine
        identifier), and display plan name. Available to all workspace members.
      operationId: getCreditsBalance
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      responses:
        '200':
          description: Credit balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsBalance'
              example:
                balance: 32000
                seatBalance: 32000
                tier: scale
                planName: Scale I
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    workspaceId:
      name: workspaceId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    CreditsBalance:
      type: object
      properties:
        balance:
          type: number
          description: Total available credits
        seatBalance:
          type: number
          description: Plan credits pool
        tier:
          $ref: '#/components/schemas/PlanTier'
        planName:
          type: string
          description: >-
            Human-readable plan name as shown in the app (e.g. "Starter II",
            "Scale I"). Use this for display; `tier` is the stable machine
            identifier.
          example: Scale I
    PlanTier:
      type: string
      enum:
        - free
        - starter
        - plus
        - build
        - scale
        - growth
        - pro_max
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: Not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: session

````

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