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

# Get usage

> Returns current billing cycle usage counters for the authenticated tenant.

```http theme={null}
GET /v1/billing/usage
```

Returns metered usage counters for the current billing period. Each counter tracks a billable resource and shows how much you have consumed relative to your plan limit.

## Response

Returns an array of usage counter objects.

<ResponseField name="metric" type="string">
  The usage metric identifier (e.g., `attestations.mint`, `verifications_monthly`, `storage_bytes`).
</ResponseField>

<ResponseField name="used" type="integer">
  Amount consumed in the current billing period.
</ResponseField>

<ResponseField name="limit" type="integer">
  Maximum allowed for this metric under your plan. A value of `-1` means unlimited.
</ResponseField>

<ResponseField name="period" type="string">
  Billing period for this counter: `monthly` or `total`.
</ResponseField>

<ResponseField name="unit" type="string">
  Unit of measurement: `count` or `bytes`.
</ResponseField>

<ResponseField name="allowed" type="boolean">
  Whether the tenant is currently allowed to consume more of this metric. Returns `false` when the limit has been reached. Only included when relevant.
</ResponseField>

<ResponseField name="delta" type="integer">
  Change in usage since the last query. Only included when the server tracks incremental updates.
</ResponseField>

### Tracked metrics

The usage endpoint returns up to 16 metrics organized by product group. Which metrics appear depends on your plan and active features.

#### Core

| Metric                  | Description              | Unit    |
| ----------------------- | ------------------------ | ------- |
| `attestations.mint`     | Attestations minted      | `count` |
| `verifications_monthly` | Verifications performed  | `count` |
| `storage_bytes`         | Total storage consumed   | `bytes` |
| `proof_bundles`         | Proof bundles generated  | `count` |
| `webhook_endpoints`     | Active webhook endpoints | `count` |
| `webhook_deliveries`    | Webhook deliveries sent  | `count` |
| `seats`                 | Team member seats        | `count` |

#### MAIP (Machine Identity)

| Metric                   | Description                      | Unit    |
| ------------------------ | -------------------------------- | ------- |
| `maip.agents`            | Registered machine agents        | `count` |
| `maip.sessions`          | Agent sessions created           | `count` |
| `maip.trust_computes`    | Trust score calculations         | `count` |
| `maip.compliance_checks` | Compliance verification requests | `count` |

#### AI

| Metric                    | Description                    | Unit    |
| ------------------------- | ------------------------------ | ------- |
| `ai.dataset_attestations` | Datasets attested for lineage  | `count` |
| `ai.model_attestations`   | Models attested for provenance | `count` |

#### Anti-Fraud

| Metric                       | Description                        | Unit    |
| ---------------------------- | ---------------------------------- | ------- |
| `antifraud.risk_signals`     | Risk signals ingested or generated | `count` |
| `antifraud.deepfake_scans`   | Deepfake scan requests             | `count` |
| `antifraud.velocity_records` | Velocity scoring records           | `count` |

<Tip>
  To check whether a specific operation is allowed before performing it, use the [entitlements endpoint](/api-reference/billing/entitlements) to verify your quotas.
</Tip>

## Console dashboard

You can also view usage visually in the console at **Settings > Billing > Usage**. The dashboard shows all 16 metrics organized by product group (Core, MAIP, AI, and Anti-Fraud), each displayed as a progress bar against your plan limit. A projected monthly cost is calculated based on your current consumption and effective per-unit rates.


## OpenAPI

````yaml mint-openapi.yaml GET /v1/billing/usage
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks is a universal verification infrastructure for documents,
    credentials, and digital assets.

    This specification defines the canonical API for interacting with Truthlocks
    services.


    ## Base URLs

    - **Production**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentication

    - **API Keys**: Use `X-API-Key` header for machine-to-machine operations

    - **Bearer Tokens**: Use `Authorization: Bearer <jwt>` for user-initiated
    operations


    ## Tenant Identity

    In production, tenant identity is derived from the authenticated context
    (API key or JWT).

    The `X-Tenant-ID` header is ignored in production to prevent spoofing.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Production API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox Environment
security:
  - APIKey: []
tags:
  - name: Authentication
    description: API key and token management
  - name: Issuers
    description: Issuer registration and trust management
  - name: Keys
    description: Cryptographic key management for issuers
  - name: Attestations
    description: Attestation lifecycle (mint, revoke, supersede)
  - name: Verification
    description: Attestation verification and proof bundles
  - name: Governance
    description: Issuer governance workflows (admin only)
  - name: Identity
    description: Organization, user, and role management
  - name: Audit
    description: Audit event queries
  - name: Platform
    description: Platform administration (super admin only)
  - name: Platform Review
    description: Staff review workflows for issuer applications
  - name: Tenant Console
    description: Tenant profile and lifecycle endpoints
  - name: Health
    description: Service health and readiness endpoints
  - name: Risk
    description: Risk signal ingestion and fraud detection
  - name: Risk Enforcement
    description: Risk enforcement actions — block, challenge, quarantine, and configuration
  - name: Billing
    description: Billing, subscription, and addon management
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
      trust, witness, compliance, orchestration, and observability
externalDocs:
  description: Transparency read-only API (separate service spec)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/usage:
    get:
      tags:
        - Billing
      summary: Get billing usage
      description: Returns metered usage for the current billing period.
      operationId: billing.usage
      parameters:
        - name: period
          in: query
          schema:
            type: string
          description: Billing period (e.g. "2026-04")
      responses:
        '200':
          description: Usage data
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: string
                  usage:
                    type: object
                    additionalProperties: true
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Machine-readable error code
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Human-readable error message
        http_status:
          type: integer
          description: HTTP status code
        retry_after_ms:
          type: integer
          description: Milliseconds to wait before retrying (for rate limits)
        details:
          type: object
          description: Additional error context
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for machine-to-machine authentication

````