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

> Returns the current plan, feature flags, and usage quotas for the authenticated tenant.

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

Returns the resolved entitlements for your tenant, including the active plan, unlocked feature flags, and numeric quotas. Use this to check what your current plan allows before performing billable operations.

## Response

<ResponseField name="plan_key" type="string">
  The active plan identifier (e.g., `plan_starter`, `plan_business`).
</ResponseField>

<ResponseField name="features" type="object">
  Feature flags unlocked by your plan and add-ons. Each key is a feature name and the value indicates whether it is enabled.

  <Expandable>
    <ResponseField name="online_verification" type="boolean">
      Whether online verification is enabled.
    </ResponseField>

    <ResponseField name="offline_bundles" type="boolean">
      Whether offline proof bundles are enabled.
    </ResponseField>

    <ResponseField name="sso_scim" type="boolean">
      Whether SSO and SCIM provisioning are enabled.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="quotas" type="object">
  Numeric limits for billable resources. Each key is a metric name and the value is the limit.

  <Expandable>
    <ResponseField name="attestations.mint" type="integer">
      Maximum attestation mints per billing cycle.
    </ResponseField>

    <ResponseField name="seats" type="integer">
      Maximum team members.
    </ResponseField>

    <ResponseField name="api_rate_limit" type="integer">
      API rate limit in requests per minute.
    </ResponseField>

    <ResponseField name="storage_bytes" type="integer">
      Maximum storage in bytes.
    </ResponseField>

    <ResponseField name="webhook_endpoints" type="integer">
      Maximum webhook endpoints.
    </ResponseField>
  </Expandable>
</ResponseField>

<Info>
  To check your active add-ons, see [billing overview](/billing/overview). Add-on entitlements are merged into the `features` and `quotas` objects automatically.
</Info>


## OpenAPI

````yaml mint-openapi.yaml GET /v1/billing/entitlements
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/entitlements:
    get:
      tags:
        - Billing
      summary: Get billing entitlements
      description: >-
        Returns all entitlements (feature limits and quotas) for the
        authenticated tenant's plan.
      operationId: billing.entitlements
      responses:
        '200':
          description: Entitlements list
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                  entitlements:
                    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

````