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

# Get billinghard cap



## OpenAPI

````yaml /openapi.json get /billing/hard-cap
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /billing/hard-cap:
    get:
      operationId: billing.getHardCap
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  enabled:
                    type: boolean
                    description: >-
                      Global hard-cap toggle. When false ALL meters bypass
                      enforcement.
                  monthlyCapCents:
                    type: integer
                    minimum: 0
                    description: Default monthly cap when no per-meter override applies
                  meters:
                    type: object
                    properties:
                      email:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                            description: >-
                              Whether the cap is enforced for this meter
                              (default true)
                          mode:
                            enum:
                              - block
                              - alert-only
                            type: string
                            description: >-
                              block: refuse the action at 100%. alert-only:
                              notify the operator but allow traffic to continue.
                          capCents:
                            anyOf:
                              - type: integer
                                minimum: 0
                              - type: 'null'
                            description: >-
                              Per-meter cap in cents; null falls back to global
                              monthlyCapCents
                        required:
                          - enabled
                          - mode
                          - capCents
                        description: Per-meter hard-cap configuration
                      sms:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                            description: >-
                              Whether the cap is enforced for this meter
                              (default true)
                          mode:
                            enum:
                              - block
                              - alert-only
                            type: string
                            description: >-
                              block: refuse the action at 100%. alert-only:
                              notify the operator but allow traffic to continue.
                          capCents:
                            anyOf:
                              - type: integer
                                minimum: 0
                              - type: 'null'
                            description: >-
                              Per-meter cap in cents; null falls back to global
                              monthlyCapCents
                        required:
                          - enabled
                          - mode
                          - capCents
                        description: Per-meter hard-cap configuration
                      voice:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                            description: >-
                              Whether the cap is enforced for this meter
                              (default true)
                          mode:
                            enum:
                              - block
                              - alert-only
                            type: string
                            description: >-
                              block: refuse the action at 100%. alert-only:
                              notify the operator but allow traffic to continue.
                          capCents:
                            anyOf:
                              - type: integer
                                minimum: 0
                              - type: 'null'
                            description: >-
                              Per-meter cap in cents; null falls back to global
                              monthlyCapCents
                        required:
                          - enabled
                          - mode
                          - capCents
                        description: Per-meter hard-cap configuration
                    required:
                      - email
                      - sms
                      - voice
                    description: >-
                      Per-meter configuration; each meter can override mode/cap
                      independently
                required:
                  - enabled
                  - monthlyCapCents
                  - meters
                description: Hard-cap settings for the requesting org
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````