> ## 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.

# Company free-tier credits

> Returns the company's cumulative metered-API-call spend in euros plus the free-tier budget and a per-playground-endpoint estimate of how many operations the remaining credits buy at current list price. `limit_eur`, `remaining_eur` and `estimates` are populated only for non-exempt companies while `LIMIT_ENFORCEMENT_ENABLED` is on; otherwise they are `null`/empty.

**Free-tier only.** Credits are a free-tier concept, so a company that is *not* on the free tier — a paid or otherwise exempt tier, or any company while `LIMIT_ENFORCEMENT_ENABLED` is off — receives **403 Forbidden** by design. The 403 is expected, not a failure: clients should treat it as "no free-tier credits apply to this company" (e.g. hide the credits banner) rather than surfacing it as an error.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/credits
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/credits:
    get:
      tags:
        - Usage
      summary: Company free-tier credits
      description: >-
        Returns the company's cumulative metered-API-call spend in euros plus
        the free-tier budget and a per-playground-endpoint estimate of how many
        operations the remaining credits buy at current list price. `limit_eur`,
        `remaining_eur` and `estimates` are populated only for non-exempt
        companies while `LIMIT_ENFORCEMENT_ENABLED` is on; otherwise they are
        `null`/empty.


        **Free-tier only.** Credits are a free-tier concept, so a company that
        is *not* on the free tier — a paid or otherwise exempt tier, or any
        company while `LIMIT_ENFORCEMENT_ENABLED` is off — receives **403
        Forbidden** by design. The 403 is expected, not a failure: clients
        should treat it as "no free-tier credits apply to this company" (e.g.
        hide the credits banner) rather than surfacing it as an error.
      operationId: api_v3_credits_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyCreditsResponse'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIV3ErrorResponse'
              examples:
                NotOnFreeTier:
                  value:
                    id: null
                    code: 403
                    error: insufficient_permissions
                    detail: >-
                      Free-tier credits are only available to companies on the
                      free tier.
                    doc_url: >-
                      https://developers.lighton.ai/errors#insufficient_permissions
                  summary: Not on free tier
          description: >-
            Company is not on the free tier (paid/exempt tier, or enforcement
            disabled) — expected, not an error.
        '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:
    CompanyCreditsResponse:
      type: object
      properties:
        currency:
          type: string
          description: ISO 4217 code applied to all €-value fields in the response
        used_eur:
          type: string
          format: decimal
          description: >-
            Cumulative cost of the company's metered API calls so far, priced at
            each event's version.
        limit_eur:
          type:
            - string
            - 'null'
          format: decimal
          description: >-
            Free-tier API-call budget for non-exempt companies. `null` when the
            company is exempt (metered/paid tier) or the
            LIMIT_ENFORCEMENT_ENABLED feature flag is off — the banner hides in
            that case.
        remaining_eur:
          type:
            - string
            - 'null'
          format: decimal
          description: >-
            `limit_eur - used_eur`, floored at 0. `null` whenever `limit_eur` is
            null.
        metered:
          type: boolean
          description: >-
            True when the company is on a paid/metered plan — free-tier credits
            do not apply.
        estimates:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CreditEstimateResponse'
          default: {}
          description: >-
            How many operations the remaining credits buy, keyed by playground
            endpoint (`parse`, `extract`, `search`, `ask`). Empty when there is
            no free-tier cap.
      required:
        - currency
        - metered
        - used_eur
    APIV3ErrorResponse:
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
          description: >-
            Job/resource id when one already exists (useful for async error
            diagnosis); null otherwise.
        code:
          type: integer
          description: HTTP status code
        error:
          type: string
          description: Error code used by the UI as a translation key
        detail:
          type: string
          description: Human-readable error message for developers
        doc_url:
          type: string
          description: Link to the error-code documentation page
      required:
        - code
        - detail
        - doc_url
        - error
        - id
    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.
    CreditEstimateResponse:
      type: object
      properties:
        feature:
          type: string
          description: Feature slug priced for this endpoint, e.g. 'parsing' or 'rag'
        unit:
          type: string
          description: Unit of the estimate, e.g. 'page' or 'query'
        count:
          type: integer
          minimum: 0
          description: >-
            How many operations the remaining credits buy at current list price
            (floored).
      required:
        - count
        - feature
        - unit
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````