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



## OpenAPI

````yaml /openapi.json get /billing/usage
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: []
paths:
  /billing/usage:
    get:
      operationId: billing.getUsage
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: string
                    pattern: ^\d{4}-\d{2}(-\d{2})?$
                    description: >-
                      Billing period, identified by its start date (YYYY-MM-DD).
                      Periods follow the org's billing anchor day, not the
                      calendar month. Legacy periods recorded before anchored
                      billing use YYYY-MM.
                  usage:
                    type: object
                    properties:
                      message_sent:
                        type: integer
                        minimum: 0
                        description: Total email messages sent during the period
                      message_received:
                        type: integer
                        minimum: 0
                        description: Total email messages received during the period
                      sms_sent:
                        type: integer
                        minimum: 0
                        description: Total SMS messages sent during the period
                      sms_received:
                        type: integer
                        minimum: 0
                        description: Total SMS messages received during the period
                      call_minute:
                        type: integer
                        minimum: 0
                        description: Total voice call minutes consumed during the period
                      voice_credit:
                        type: integer
                        minimum: 0
                        description: >-
                          Voice credits drawn from the plan allowance this
                          period. 1 credit = 1 US minute; mobile-abroad minutes
                          draw more. This — not call_minute — is what the
                          included voice allowance is measured in.
                      embedding_generated:
                        type: integer
                        minimum: 0
                        description: Total embeddings generated during the period
                    required:
                      - message_sent
                      - message_received
                      - sms_sent
                      - sms_received
                      - call_minute
                      - voice_credit
                      - embedding_generated
                    description: Breakdown of resource usage by category
                  storage:
                    anyOf:
                      - type: object
                        properties:
                          bytes:
                            type: integer
                            minimum: 0
                            description: Bytes held in object storage
                          measuredAt:
                            type: string
                            description: ISO timestamp of the measurement
                        required:
                          - bytes
                          - measuredAt
                      - type: 'null'
                    description: >-
                      Last measured object-storage usage; null when never
                      measured
                required:
                  - period
                  - usage
                  - storage
                description: Usage metrics for a specific billing period
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>'

````

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