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

# Get Credit Balance

> Get current credit balance and tier information.

Returns the organization's credit balance, current tier, and usage statistics.
Useful for displaying billing status in dashboards.

**Requirements:**
- Read permission

**Example:**
```python
response = await client.get("/v1/organizations/billing/balance")
print(f"Balance: {response['credit_balance']} credits")
print(f"Tier: {response['account_tier']}")
```



## OpenAPI

````yaml get /v1/organizations/billing/balance
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/organizations/billing/balance:
    get:
      tags:
        - Organization Billing
      summary: Get Credit Balance
      description: >-
        Get current credit balance and tier information.


        Returns the organization's credit balance, current tier, and usage
        statistics.

        Useful for displaying billing status in dashboards.


        **Requirements:**

        - Read permission


        **Example:**

        ```python

        response = await client.get("/v1/organizations/billing/balance")

        print(f"Balance: {response['credit_balance']} credits")

        print(f"Tier: {response['account_tier']}")

        ```
      operationId: get_credit_balance_v1_organizations_billing_balance_get
      parameters: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalanceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CreditBalanceResponse:
      properties:
        organization_id:
          type: string
          title: Organization Id
          description: Organization identifier
          examples:
            - org_demo123
        credit_balance:
          type: integer
          title: Credit Balance
          description: >-
            Current credit balance. For FREE tier without auto-billing, this is
            remaining free tier credits. For auto-billing accounts, this shows
            current month usage (negative indicates consumption).
          examples:
            - 45230
            - 750
        account_tier:
          type: string
          title: Account Tier
          description: 'Current account tier: free, pro, team, enterprise'
          examples:
            - free
            - pro
            - team
        next_tier:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Tier
          description: Next available tier or null if at max tier
          examples:
            - pro
            - enterprise
        credits_until_next_tier:
          anyOf:
            - type: integer
            - type: 'null'
          title: Credits Until Next Tier
          description: Credits needed to reach next tier (null if at max tier or N/A)
          examples:
            - 954770
            - 0
        estimated_days_remaining:
          anyOf:
            - type: integer
            - type: 'null'
          title: Estimated Days Remaining
          description: >-
            Estimated days until credits depleted based on 7-day burn rate. Null
            if no usage history or unlimited (auto-billing enabled).
          examples:
            - 15
            - 30
        daily_burn_rate:
          type: number
          title: Daily Burn Rate
          description: Average credits consumed per day (7-day rolling average)
          default: 0
          examples:
            - 3015.3
            - 142.5
      type: object
      required:
        - organization_id
        - credit_balance
        - account_tier
      title: CreditBalanceResponse
      description: Response with current credit balance and tier information.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````