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

# Get credit usage

> Returns subscription-wide current-period credit usage, included allowance, additional credits, remaining balance, next reset, and overage. Includes in-flight ledger charges and refunds. Additional credits settle at period end; additionalUsed and additionalRemaining estimate their current consumption. This read is unmetered, accepts read-only keys, and remains available when credits are exhausted. Returns 503 when billing usage cannot be retrieved.



## OpenAPI

````yaml get /api/v2/credits/usage
openapi: 3.0.0
info:
  version: 6.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/credits/usage:
    get:
      tags:
        - Credits
      summary: Get credit usage
      description: >-
        Returns subscription-wide current-period credit usage, included
        allowance, additional credits, remaining balance, next reset, and
        overage. Includes in-flight ledger charges and refunds. Additional
        credits settle at period end; additionalUsed and additionalRemaining
        estimate their current consumption. This read is unmetered, accepts
        read-only keys, and remains available when credits are exhausted.
        Returns 503 when billing usage cannot be retrieved.
      operationId: getUsage
      responses:
        '200':
          description: Current credit usage
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    type: object
                    properties:
                      scope:
                        type: string
                        enum:
                          - subscription
                        description: >-
                          Shared subscription usage, not usage limited to this
                          API key or workspace.
                      organizationOId:
                        type: string
                      subscription:
                        type: object
                        properties:
                          oId:
                            type: string
                          name:
                            type: string
                            nullable: true
                        required:
                          - oId
                          - name
                      asOf:
                        type: string
                        format: date-time
                      resetAt:
                        type: string
                        nullable: true
                        format: date-time
                        description: >-
                          Next billing-period reset reported by the billing
                          provider; null when unavailable.
                      credits:
                        type: object
                        properties:
                          included:
                            type: number
                            description: Included allowance for the current period.
                          additional:
                            type: number
                            description: >-
                              Additional credit balance available to this
                              period, before its unsettled usage is deducted.
                              Not lifetime grants.
                          total:
                            type: number
                          used:
                            type: number
                            description: >-
                              Current-period usage, including in-flight ledger
                              charges and refunds.
                          remaining:
                            type: number
                            description: >-
                              Unused included plus additional credits, clamped
                              to zero. Overage is reported separately.
                          additionalUsed:
                            type: number
                            description: >-
                              Estimated additional credits used this period
                              after the included allowance, before end-of-period
                              settlement.
                          additionalRemaining:
                            type: number
                            description: >-
                              Additional balance minus estimated current-period
                              consumption; avoids overstating the provider's
                              unsettled balance.
                          exhausted:
                            type: boolean
                        required:
                          - included
                          - additional
                          - total
                          - used
                          - remaining
                          - additionalUsed
                          - additionalRemaining
                          - exhausted
                      overage:
                        type: object
                        nullable: true
                        properties:
                          mode:
                            type: string
                            enum:
                              - GRADIENT
                              - VOLUME
                              - STEP
                          usedUnits:
                            type: number
                          costCents:
                            type: number
                          ceilingCents:
                            type: number
                            nullable: true
                          ceilingReached:
                            type: boolean
                        required:
                          - mode
                          - usedUnits
                          - costCents
                          - ceilingCents
                          - ceilingReached
                    required:
                      - scope
                      - organizationOId
                      - subscription
                      - asOf
                      - resetAt
                      - credits
                      - overage
                required:
                  - _metadata
                  - data
        '503':
          description: Credit usage temporarily unavailable
components:
  schemas:
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          example: 0
          description: API usage
        requestId:
          type: string
          example: requestId
          description: Request ID
        message:
          type: string
          example: message
          description: Message
        timestamp:
          type: string
          example: '2021-01-01T00:00:00.000Z'
          description: Timestamp
      required:
        - requestId
        - timestamp
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````