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

# Get credit balance

> Retrieve current credit balance and plan information. `balance` is the ledger balance (can go negative) and is what spend checks compare against; `spendableCredits` additionally subtracts credits already reserved by in-flight workflows and is the number to check before starting new, billable work — spending requires `spendableCredits >= cost` (an exact match is sufficient). `monthlyPlanCredits` / `monthlyAddonCredits` are plan allowances that refill on renewal, not a measure of what is currently available to spend.

    > **Required scope:** `WORKSPACE_READ`
    >
    > **Rate limit:** 100 requests per minute



## OpenAPI

````yaml https://openapi.enginy.ai/definitions.json get /v1/credits
openapi: 3.1.0
info:
  title: Enginy API
  version: 1.0.0
  description: Public API for Enginy platform
servers:
  - url: https://openapi.enginy.ai
    description: Configured server
security: []
tags:
  - name: AI Variables
    description: >-
      Manage AI variables and discover the entity fields you can reference in
      prompts and entity requests.
  - name: Inbox
    description: >-
      Inbox endpoints for listing contact threads, reading thread messages,
      managing tags, and sending manual replies.
  - name: Workflows
    description: >-
      Build, validate, publish, run, and inspect advanced (graph) workflows,
      plus the block/condition catalog needed to author a workflow plan.
paths:
  /v1/credits:
    get:
      tags:
        - Credits
      summary: Get credit balance
      description: >-
        Retrieve current credit balance and plan information. `balance` is the
        ledger balance (can go negative) and is what spend checks compare
        against; `spendableCredits` additionally subtracts credits already
        reserved by in-flight workflows and is the number to check before
        starting new, billable work — spending requires `spendableCredits >=
        cost` (an exact match is sufficient). `monthlyPlanCredits` /
        `monthlyAddonCredits` are plan allowances that refill on renewal, not a
        measure of what is currently available to spend.

            > **Required scope:** `WORKSPACE_READ`
            >
            > **Rate limit:** 100 requests per minute
      responses:
        '200':
          description: Credits information retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      balance:
                        type: number
                        description: >-
                          Current ledger balance (signed sum of every credit
                          transaction). This is the number spend checks compare
                          against and can go negative. It does NOT subtract
                          credits already pinned to in-flight workflows — use
                          `spendableCredits` to know what is free to spend right
                          now.
                      spendableCredits:
                        type: number
                        description: >-
                          `balance` minus credits currently reserved by
                          in-flight workflows — the amount actually available to
                          spend right now. Use this (not `monthlyPlanCredits` /
                          `monthlyAddonCredits`) to decide whether the workspace
                          can afford an action: spending requires
                          `spendableCredits >= cost` (an exact match is
                          sufficient). Some per-user credit restrictions can
                          impose an additional, lower cap not reflected in this
                          workspace-level figure.
                      nextRenewalDate:
                        type: string
                        format: date-time
                        description: >-
                          Date when credits will renew for the next billing
                          cycle
                      monthlyPlanCredits:
                        type: number
                        description: >-
                          Monthly plan credit allowance — refills on renewal.
                          This is a plan entitlement, not spendable credits; it
                          does not reflect how many credits are currently
                          available (see `spendableCredits`).
                      monthlyAddonCredits:
                        type: number
                        description: >-
                          Additional monthly credit allowance purchased as an
                          addon — refills on renewal alongside
                          `monthlyPlanCredits`. Also not a measure of currently
                          available credits (see `spendableCredits`).
                    required:
                      - balance
                      - spendableCredits
                      - nextRenewalDate
                      - monthlyPlanCredits
                      - monthlyAddonCredits
                required:
                  - status
                  - message
                  - data
        '404':
          description: Client not found
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````