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

# Get Overage Summary

> Get overage credit usage for the current billing period.



## OpenAPI

````yaml GET /orgs/{org_id}/billing/overage
openapi: 3.1.0
info:
  title: Timbal Platform API
  description: Public API documentation for the Timbal platform
  license:
    name: ''
  version: 2.0.0
servers:
  - url: https://api.timbal.ai
    description: Production
  - url: https://api.dev.timbal.ai
    description: Development
security: []
tags:
  - name: ace
    description: Action Control Engine (ACE) operations
  - name: analytics
    description: Project analytics
  - name: billing
    description: Subscriptions, usage, and payment-related operations
  - name: content
    description: Re-sign stored content URLs
  - name: files
    description: File operations
  - name: iam
    description: IAM — actions, roles, users, and authorization introspection
  - name: k2
    description: Knowledge Bases v2 operations
  - name: orgs
    description: Organization operations
  - name: projects
    description: Project operations
  - name: runs
    description: Execution operations
  - name: templates
    description: Public project template catalog
  - name: users
    description: Authenticated user profile
paths:
  /orgs/{org_id}/billing/overage:
    get:
      tags:
        - billing
      description: Get overage credit usage for the current billing period.
      operationId: get
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Overage usage summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverageSummary'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - bearer_auth: []
components:
  schemas:
    OverageSummary:
      type: object
      description: >-
        Customer-facing overage usage summary for the current credits period.


        `used_credits = invoiced_credits + pending_credits`. `invoiced_credits`
        is

        the real metered overage billed on finalized invoices this period (see

        [`overage_summary`]); `pending_credits` is the headline "extra usage
        you'll

        be billed for" number, and a non-zero `invoiced_credits` means an
        interim

        (threshold-driven) invoice has already billed part of this period.
      required:
        - enabled
        - used_credits
        - invoiced_credits
        - pending_credits
      properties:
        cap_credits:
          type:
            - integer
            - 'null'
          format: int64
          description: >-
            Org-configured ceiling on overage credits for the period. `null`
            means

            unlimited (or no cap configured); only meaningful when `enabled`.
        enabled:
          type: boolean
          description: >-
            Whether usage-based overage billing is currently enabled for the
            org.
        invoiced_credits:
          type: integer
          format: int64
          description: Overage credits already included on a finalized invoice this period.
        pending_credits:
          type: integer
          format: int64
          description: Overage credits accrued this period that have not been invoiced yet.
        period_end:
          type:
            - string
            - 'null'
          format: date-time
          description: |-
            End of the current credits period — when pending overage bills if no
            interim invoice fires first. `null` when there is no metered window.
        period_start:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Start of the current credits period. `null` when the org has no
            metered

            billing window (e.g. free plan with no period anchor).
        rate_cents_per_1k:
          type:
            - integer
            - 'null'
          format: int64
          description: |-
            Metered overage rate in cents per 1,000 credits. `null` when overage
            pricing is unavailable for the plan.
        threshold_usd:
          type:
            - integer
            - 'null'
          format: int64
          description: >-
            Outstanding overage value (whole USD) that triggers an interim
            invoice.

            `null` means overage bills only at the end of the period.
        used_credits:
          type: integer
          format: int64
          description: Total overage credits consumed this period (`invoiced` + `pending`).
    ErrorMessage:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Machine-readable error code (e.g. `ALREADY_EXISTS`, `BAD_REQUEST`).
        message:
          type: string
          description: Human-readable description.
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        Timbal API key. Obtain your API key from the Timbal platform settings.
        See [Authentication](/api-reference/authentication) for more
        information.

````