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

# Get balance

> Shows the credit left this period, as on the billing page, and the limit creating and waking workspaces is checked against. Check it before starting work to stop before requests return 402. Any API key can call it.



## OpenAPI

````yaml /openapi.json get /v1/organization/billing/balance
openapi: 3.1.0
info:
  title: Replicas API
  version: 2.0.0
  description: >-
    Create and control workspaces, and manage the environments, automations, and
    learnings they run with.
servers:
  - url: https://api.replicas.dev
    description: Production API
security:
  - apiKey: []
tags:
  - name: Replica
    description: >-
      A replica is a Replicas workspace: a cloud sandbox where a coding agent
      works on your repositories.
  - name: Chats
    description: Manage the agent chats inside a replica.
  - name: Message queue
    description: Messages waiting for the agent to finish its turn.
  - name: Commands and terminals
    description: Run commands and open shells in a replica.
  - name: Pull requests
    description: Inspect and act on pull requests a replica opened.
  - name: Previews
    description: Public URLs for ports in a replica.
  - name: Canvas
    description: Plans, reports, and other files agents produce.
  - name: Sharing
    description: Add replicas to members' Shared view.
  - name: Environments
    description: >-
      Environments define what a workspace starts with. A fork builds on the
      environments it was forked from.
  - name: Environment variables
    description: Variables injected into workspaces.
  - name: Environment files
    description: Files written into workspaces.
  - name: Environment skills
    description: Agent skills installed into workspaces.
  - name: Environment MCPs
    description: MCP servers available to workspace agents.
  - name: Hooks
    description: Scripts that run when warm pool snapshots build and when workspaces start.
  - name: Warm pools
    description: Pre-built workspaces that start faster.
  - name: Automations
    description: Run agents on schedules and events.
  - name: Repositories
    description: Repositories connected to the organization.
  - name: Learnings
    description: Organization skills every workspace agent loads.
  - name: Agent credentials
    description: >-
      API keys and endpoints that coding agents use. Connect Claude, Codex, and
      Muse subscriptions with the CLI.
  - name: Plugins
    description: Connect integrations that workspace agents can use.
  - name: Organization
    description: Who you are and who is in your organization.
  - name: Billing
    description: Credit left, usage limits, and usage cost.
  - name: Media
    description: Screenshots, recordings, and other files workspaces produce.
  - name: Slack
    description: Route Slack threads to workspaces.
  - name: Workspace identity
    description: OIDC keys for verifying workspace identity tokens.
paths:
  /v1/organization/billing/balance:
    get:
      tags:
        - Billing
      summary: Get balance
      description: >-
        Shows the credit left this period, as on the billing page, and the limit
        creating and waking workspaces is checked against. Check it before
        starting work to stop before requests return 402. Any API key can call
        it.
      operationId: getBillingBalance
      parameters:
        - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: Balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingBalance'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    ApiVersion:
      name: X-Replicas-Api-Version
      in: header
      description: >-
        API version. `2026-10-07` returns `snake_case` responses. See
        [versioning](/features/api#versioning).
      required: false
      schema:
        type: string
        enum:
          - '2026-10-07'
  schemas:
    BillingBalance:
      type: object
      properties:
        plan:
          type: string
          enum:
            - trial
            - developer
            - team
            - enterprise
        period_start:
          type: string
          format: date-time
        period_end:
          type: string
          format: date-time
          description: When credit and usage limits reset. Trial credit doesn't reset.
        credit:
          type:
            - object
            - 'null'
          description: >-
            The billing page's Balance card. Null on plans without included
            credit.
          properties:
            total_cents:
              type: integer
              description: '`plan_cents` plus `one_time_cents`'
            plan_cents:
              type: integer
              description: The plan's monthly credit, or the trial or YC deal credit
            one_time_cents:
              type: integer
              description: Credit granted or bought for this period only
            used_cents:
              type: integer
            remaining_cents:
              type: integer
            overage_cents:
              type: integer
              description: >-
                Usage past `total_cents` on Developer and Team, billed at the
                overage rate
          required:
            - total_cents
            - plan_cents
            - one_time_cents
            - used_cents
            - remaining_cents
            - overage_cents
        limit:
          type:
            - object
            - 'null'
          description: >-
            What creating and waking workspaces is checked against. Once
            `remaining_cents` reaches 0 they return 402. Null when nothing caps
            usage.
          properties:
            kind:
              type: string
              enum:
                - credit
                - usage_limit
              description: >-
                `credit` for trial and YC deal credit, `usage_limit` for an
                admin's [usage limit](/admin/billing#usage-limit)
            limit_cents:
              type: integer
            used_cents:
              type: integer
              description: >-
                Includes mobile simulator and GPU usage not yet on the billing
                page
            remaining_cents:
              type: integer
          required:
            - kind
            - limit_cents
            - used_cents
            - remaining_cents
        blocked:
          type:
            - object
            - 'null'
          description: Why creating and waking workspaces returns 402 now
          properties:
            code:
              $ref: '#/components/schemas/BillingBlockCode'
            message:
              type: string
          required:
            - code
            - message
      required:
        - plan
        - period_start
        - period_end
        - credit
        - limit
        - blocked
    BillingBlockCode:
      type: string
      enum:
        - INSUFFICIENT_MINUTES
        - PAYMENT_FAILED
        - USAGE_LIMIT_REACHED
        - ORGANIZATION_BANNED
      description: Machine-readable billing block reason
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        details:
          type:
            - string
            - 'null'
          description: Additional error details
        code:
          type: string
          description: Machine-readable error code when available
      required:
        - error
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Organization or personal API key from **Settings → API Keys**.

````

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