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

# Get credits balance

> Returns the current available credits balance for the user's organization.
Useful for answering questions like "How many credits do I have left?"

NOTE: As of migration 100160, balance is computed from active grants (RemainingAmount-based)
rather than the legacy running Balance ledger column. This is intentional; orgs that relied
on the old positive-balance row while having exhausted their grants will now see 0 instead.



## OpenAPI

````yaml GET /api/v1/billing/credits
openapi: 3.0.1
info:
  title: Sequentum Cloud API
  description: API endpoints for Sequentum Cloud
  version: v1
servers: []
security:
  - ApiKey: []
    Bearer: []
paths:
  /api/v1/billing/credits:
    get:
      tags:
        - ApiBilling
      summary: Get available credits balance
      description: >-
        Returns the current available credits balance for the user's
        organization.

        Useful for answering questions like "How many credits do I have left?"


        NOTE: As of migration 100160, balance is computed from active grants
        (RemainingAmount-based)

        rather than the legacy running Balance ledger column. This is
        intentional; orgs that relied

        on the old positive-balance row while having exhausted their grants will
        now see 0 instead.
      responses:
        '200':
          description: Returns the credits balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsBalanceApiModel'
        '401':
          description: If the API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    CreditsBalanceApiModel:
      type: object
      properties:
        availableCredits:
          type: number
          description: Current available credits balance
          format: double
        organizationId:
          type: integer
          description: Organization ID
          format: int32
        retrievedAt:
          type: string
          description: Timestamp when the balance was retrieved
          format: date-time
      additionalProperties: false
      description: Response model for credits balance
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
  securitySchemes:
    ApiKey:
      type: apiKey
      description: >-
        API Key authorization header. Example: "Authorization: ApiKey
        {your-api-key}"
      name: Authorization
      in: header
    Bearer:
      type: http
      description: 'OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"'
      scheme: bearer
      bearerFormat: JWT

````