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

# Get company budget

> Return the company's monthly budget configuration, current spend, and alert thresholds.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/billing/budget
openapi: 3.1.0
info:
  title: LightOn API
  version: 3.15.0 (v3)
  description: >-
    LightOn gives you an API to search, parse, and ingest documents at scale.
    Build knowledge-retrieval pipelines without managing vector databases or OCR
    models.
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Facets
    description: Operations about facets
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Files Processing
    description: Operations about files processing
  - name: Users
    description: Operations about users
  - name: API Keys
    description: Operations about API keys
  - name: User Groups
    description: Operations about user groups
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/billing/budget:
    get:
      tags:
        - Budget
      summary: Get company budget
      description: >-
        Return the company's monthly budget configuration, current spend, and
        alert thresholds.
      operationId: api_v3_billing_budget_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetResponse'
          description: ''
        '503':
          description: >-
            API is under maintenance. Check `GET /api/v3/system/status` for
            active periods and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceMaintenance503'
      security:
        - bearerAuth: []
components:
  schemas:
    BudgetResponse:
      properties:
        is_enabled:
          description: Whether this budget is actively enforced.
          title: Is Enabled
          type: boolean
        amount_eur:
          description: Monthly budget cap in EUR.
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Amount Eur
          type: string
        currency:
          default: EUR
          description: ISO 4217 currency code.
          title: Currency
          type: string
        current_cycle_start:
          description: First day of the current billing cycle (ISO date).
          title: Current Cycle Start
          type: string
        next_cycle_start:
          description: First day of the next billing cycle (ISO date).
          title: Next Cycle Start
          type: string
        monthly_spend_eur:
          description: Current month's spend in EUR.
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Monthly Spend Eur
          type: string
        available_eur:
          description: Remaining budget for the current cycle in EUR.
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Available Eur
          type: string
        alerts:
          description: Alert thresholds.
          items:
            $ref: '#/components/schemas/BudgetAlertResponse'
          title: Alerts
          type: array
      required:
        - is_enabled
        - amount_eur
        - current_cycle_start
        - next_cycle_start
        - monthly_spend_eur
        - available_eur
      title: BudgetResponse
      type: object
    ServiceMaintenance503:
      type: object
      description: >-
        Returned by the maintenance middleware when the requested endpoint is
        blocked.
      required:
        - detail
        - error
        - mode
      properties:
        detail:
          type: string
          example: System is under maintenance.
        error:
          type: string
          example: service_maintenance
        mode:
          type: string
          enum:
            - full_shutdown
            - warning_banner
          description: >-
            `full_shutdown` blocks all traffic; `warning_banner` also blocks and
            shows a dismissible toast.
        reason:
          type: string
          description: Operator-supplied maintenance reason, if any.
        started_at:
          type: string
          format: date-time
        endpoint_category_names:
          type: array
          items:
            type: string
          description: >-
            Non-empty only for category-scoped periods. Empty means all
            endpoints are affected.
    BudgetAlertResponse:
      properties:
        id:
          title: Id
          type: integer
        is_enabled:
          title: Is Enabled
          type: boolean
        threshold_type:
          title: Threshold Type
          type: string
        threshold_value:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Threshold Value
          type: string
      required:
        - id
        - is_enabled
        - threshold_type
        - threshold_value
      title: BudgetAlertResponse
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````