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

# Get the tenant's metered billing month so far

> For a tenant billed per credit in arrears: the mode, the rate per credit and currency, the included credits, the billed credits so far (workflow + chat credits + phone minutes at the agreed credits per minute), the credits the rate applies to, the estimated charge so far before tax, and the monthly cap with its level. `metered_billing` is null for a tenant billed under its plan. Read-only: the Neo account team sets the mode, rate and cap.



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/billing/metered
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: >-
      Every tool call the tenant's agents made in the last 30 days, within the
      caller's workflow access.
    name: Audit Log
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/billing/metered:
    get:
      tags:
        - Billing
      summary: Get the tenant's metered billing month so far
      description: >-
        For a tenant billed per credit in arrears: the mode, the rate per credit
        and currency, the included credits, the billed credits so far (workflow
        + chat credits + phone minutes at the agreed credits per minute), the
        credits the rate applies to, the estimated charge so far before tax, and
        the monthly cap with its level. `metered_billing` is null for a tenant
        billed under its plan. Read-only: the Neo account team sets the mode,
        rate and cap.
      operationId: public_api.billing_metered_get
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MeteredBillingState'
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    MeteredBillingState:
      properties:
        metered_billing:
          anyOf:
            - $ref: '#/components/schemas/MeteredBilling'
            - type: 'null'
          description: Null when the tenant is billed under its plan and credit packs.
      required:
        - metered_billing
      title: MeteredBillingState
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    MeteredBilling:
      description: The calling tenant's metered month so far, at the rate in its agreement.
      properties:
        as_of:
          description: When these figures were read.
          format: date-time
          title: As Of
          type: string
        billed_credits:
          description: >-
            Workflow credits + chat credits + phone minutes x
            `phone_credits_per_minute`, so far this month.
          title: Billed Credits
          type: integer
        cap:
          anyOf:
            - $ref: '#/components/schemas/MeteredCap'
            - type: 'null'
          description: The monthly cap on billed credits. Null when no cap is set.
        chargeable_credits:
          description: >-
            The billed credits the rate applies to: all of them, or those above
            `included_credits`.
          title: Chargeable Credits
          type: integer
        chat_credits:
          title: Chat Credits
          type: integer
        currency:
          description: Lowercase ISO 4217 code of the billing currency.
          title: Currency
          type: string
        estimated_charge_minor:
          description: >-
            `chargeable_credits` x `rate_per_credit` so far, in minor units
            (cents, pence), before tax. The invoice for the whole month is
            issued on the 1st of the next month.
          title: Estimated Charge Minor
          type: integer
        included_credits:
          description: >-
            Credits the plan covers before overage starts. 0 when every billed
            credit is charged.
          title: Included Credits
          type: integer
        mode:
          $ref: '#/components/schemas/MeteredMode'
        period_start:
          description: >-
            Start of the window: the first of the month, or the day metered
            billing began if that is later.
          format: date-time
          title: Period Start
          type: string
        phone_credits_per_minute:
          description: Billed credits per phone agent minute.
          title: Phone Credits Per Minute
          type: integer
        phone_minutes:
          title: Phone Minutes
          type: integer
        rate_per_credit:
          description: >-
            The price of one billed credit in major units of `currency`, as a
            decimal string, for example '0.05'.
          title: Rate Per Credit
          type: string
        workflow_credits:
          title: Workflow Credits
          type: integer
      required:
        - mode
        - rate_per_credit
        - currency
        - period_start
        - as_of
        - included_credits
        - billed_credits
        - workflow_credits
        - chat_credits
        - phone_minutes
        - phone_credits_per_minute
        - chargeable_credits
        - estimated_charge_minor
        - cap
      title: MeteredBilling
      type: object
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
    MeteredCap:
      properties:
        cap_credits:
          description: The most billed credits the tenant may use in one calendar month.
          title: Cap Credits
          type: integer
        level:
          $ref: '#/components/schemas/MeteredCapLevelName'
          description: >-
            OK below 80% of the cap. WARNING from 80%. BLOCKED at 100%: new
            agent and workflow runs are refused until the month resets.
      required:
        - cap_credits
        - level
      title: MeteredCap
      type: object
    MeteredMode:
      description: How a metered tenant is billed.
      enum:
        - FULL_METERED
        - PLAN_PLUS_OVERAGE
      title: MeteredMode
      type: string
    MeteredCapLevelName:
      description: Where the month stands against the cap.
      enum:
        - OK
        - WARNING
        - BLOCKED
      title: MeteredCapLevelName
      type: string
  securitySchemes:
    bearerAuth:
      description: >-
        `Authorization: Bearer <token>` where `<token>` is either a
        `neo_sk_<env>_<secret>` API key (service account) or a Microsoft Entra
        ID access token (dashboard user).
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.