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

# Get Organization Usage

> Get current organization usage and billing information.



## OpenAPI

````yaml get /v1/usage
openapi: 3.1.0
info:
  title: Cuadra AI API
  description: >-
    REST API for AI-powered chat, RAG, and multi-channel messaging. Full
    documentation at https://docs.cuadra.ai
  version: 1.0.0
  contact:
    name: Cuadra AI Support
    url: https://cuadra.ai/support
    email: support@cuadra.ai
  license:
    name: Proprietary
    url: https://cuadra.ai/terms
  termsOfService: https://cuadra.ai/terms
servers:
  - url: https://api.cuadra.ai
    description: Production
security:
  - bearerAuth: []
  - oauth2: []
tags:
  - name: Health
    description: >-
      System health monitoring and readiness checks. Essential for load
      balancers and deployment automation.
  - name: Models
    description: >-
      Manage custom AI model configurations derived from base models. Create,
      update, and delete with flexible pricing and token limits.
  - name: Chats
    description: >-
      Interact with AI models for intelligent chat completions. Supports
      streaming and non-streaming modes with message history.
  - name: Files
    description: >-
      Manage file uploads for chat attachments and dataset knowledge bases.
      Supports automatic processing, chunking, and embedding for RAG.
  - name: Datasets
    description: >-
      Manage RAG knowledge base datasets with versioning and semantic search.
      Organize uploaded files into searchable knowledge bases.
  - name: Particles
    description: >-
      Manage reusable system prompt particles for AI model behavior. Particles
      are modular components (role, tone, guardrails, constraints, format) that
      compose into system prompts.
  - name: System Prompts
    description: >-
      Compose particles into complete system prompts for AI models. System
      prompts define model behavior through ordered particle compositions with
      support for version pinning and token budget validation.
  - name: Usage
    description: >-
      Monitor and analyze API usage with detailed token counting. Track usage
      across models, tenants, and time periods.
  - name: Artifacts
    description: >-
      Manage rich content artifacts generated during chat conversations.
      Supports markdown, code, HTML, SVG, and Mermaid diagrams.
paths:
  /v1/usage:
    get:
      tags:
        - Usage
      summary: Get Organization Usage
      description: Get current organization usage and billing information.
      operationId: getUsage
      responses:
        '200':
          description: Current usage information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
              example:
                storage:
                  used: 524288000
                  limit: 53687091200
                credits:
                  used: 7500
                  limit: 50000
                  available: 42500
                  overageCredits: 0
                  isInOverage: false
                  hardCap: false
                  billingPeriod: monthly
                  periodStart: '2026-04-01T00:00:00Z'
                  periodEnd: '2026-04-30T23:59:59Z'
                plan:
                  tier: pro
                  name: Pro
                  billingCycle: monthly
        '401':
          description: Unauthorized - Invalid or missing authentication
        '403':
          description: Forbidden - Billing not configured
        '500':
          description: Internal server error
components:
  schemas:
    UsageResponse:
      properties:
        storage:
          allOf:
            - $ref: '#/components/schemas/StorageUsage'
          description: Storage usage and limits
        credits:
          allOf:
            - $ref: '#/components/schemas/CreditUsage'
          description: Credit usage and billing info
        plan:
          allOf:
            - $ref: '#/components/schemas/PlanInfo'
          description: Current subscription plan
        limits:
          anyOf:
            - $ref: '#/components/schemas/TierLimits'
            - type: 'null'
          description: Tier-specific restrictions and quotas for frontend gating
      type: object
      required:
        - storage
        - credits
        - plan
      title: UsageResponse
      description: Organization usage information.
      example:
        credits:
          available: 42500
          billingPeriod: monthly
          hardCap: false
          isInOverage: false
          limit: 50000
          overageCredits: 0
          periodEnd: '2026-04-30T23:59:59Z'
          periodStart: '2026-04-01T00:00:00Z'
          used: 7500
        plan:
          billingCycle: monthly
          name: Pro
          seatCount: 5
          tier: pro
        storage:
          limit: 53687091200
          used: 524288000
    StorageUsage:
      properties:
        used:
          type: integer
          minimum: 0
          title: Used
          description: Current storage used in bytes
          examples:
            - 524288000
        limit:
          type: integer
          exclusiveMinimum: 0
          title: Limit
          description: Storage limit in bytes
          examples:
            - 1073741824
      type: object
      required:
        - used
        - limit
      title: StorageUsage
      description: Storage usage information.
    CreditUsage:
      properties:
        used:
          type: integer
          minimum: 0
          title: Used
          description: Credits used this billing period
          examples:
            - 7500
        limit:
          type: integer
          minimum: 0
          title: Limit
          description: Credit allocation for this period
          examples:
            - 50000
        available:
          type: integer
          minimum: 0
          title: Available
          description: Remaining credits for current period
          examples:
            - 42500
        overageCredits:
          type: integer
          minimum: 0
          title: Overagecredits
          description: Credits consumed beyond included allocation (billed at overage rate)
          default: 0
          examples:
            - 0
            - 2300
        isInOverage:
          type: boolean
          title: Isinoverage
          description: True when org has exceeded included credits and is consuming overage
          default: false
          examples:
            - false
        hardCap:
          type: boolean
          title: Hardcap
          description: If true, purchased credits cannot be used (Free tier)
          examples:
            - false
        billingPeriod:
          type: string
          pattern: ^(monthly|annual|daily)$
          title: Billingperiod
          description: Billing period type
          examples:
            - monthly
        periodStart:
          type: string
          format: date-time
          title: Periodstart
          description: Current billing period start (ISO 8601)
          examples:
            - '2025-12-01T00:00:00Z'
        periodEnd:
          type: string
          format: date-time
          title: Periodend
          description: Current billing period end (ISO 8601)
          examples:
            - '2025-12-31T23:59:59Z'
      type: object
      required:
        - used
        - limit
        - available
        - hardCap
        - billingPeriod
        - periodStart
        - periodEnd
      title: CreditUsage
      description: Credit usage information.
    PlanInfo:
      properties:
        tier:
          type: string
          title: Tier
          description: Subscription tier (free, pro, business, enterprise)
          examples:
            - pro
        name:
          type: string
          minLength: 1
          title: Name
          description: Plan display name
          examples:
            - Pro
        billingCycle:
          type: string
          pattern: ^(monthly|annual|daily)$
          title: Billingcycle
          description: Billing cycle
          examples:
            - monthly
        seatCount:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Seatcount
          description: Number of seats (admin-only, null for non-admins)
          examples:
            - 5
      type: object
      required:
        - tier
        - name
        - billingCycle
      title: PlanInfo
      description: Current plan information from Stripe subscription.
    TierLimits:
      properties:
        dailyCredits:
          type: integer
          minimum: 0
          title: Dailycredits
          description: Daily credit allowance (0 = uses monthly pool instead)
          default: 0
          examples:
            - 0
            - 500
        dailyCreditsUsed:
          type: integer
          minimum: 0
          title: Dailycreditsused
          description: Credits consumed today (only relevant when dailyCredits > 0)
          default: 0
          examples:
            - 0
            - 120
        dailyCreditsAvailable:
          type: integer
          minimum: 0
          title: Dailycreditsavailable
          description: Daily credits remaining today (only relevant when dailyCredits > 0)
          default: 0
          examples:
            - 0
            - 380
        modelTierAccess:
          type: string
          title: Modeltieraccess
          description: >-
            Comma-separated list of model tiers this plan can use (e.g.
            'standard' or 'standard,premium'). Driven by Stripe metadata.
          default: standard,premium
          examples:
            - standard
            - standard,premium
        rateLimitOrgRpm:
          type: integer
          minimum: 1
          title: Ratelimitorgrpm
          description: Organization-wide requests per minute
          default: 300
          examples:
            - 30
            - 300
            - 600
        rateLimitUserRpm:
          type: integer
          minimum: 1
          title: Ratelimituserrpm
          description: Per-user requests per minute
          default: 60
          examples:
            - 10
            - 60
            - 120
        allowOverage:
          type: boolean
          title: Allowoverage
          description: Whether the plan allows overage billing when credits are exhausted
          default: false
          examples:
            - true
            - false
        overageRatePer1k:
          type: string
          title: Overagerateper1K
          description: EUR per 1,000 overage credits (string for precision)
          default: '0'
          examples:
            - '0'
            - '0.10'
            - '0.08'
        seatsIncluded:
          type: integer
          minimum: 0
          title: Seatsincluded
          description: Seats included in the plan's base price
          default: 0
          examples:
            - 3
            - 5
            - 15
        seatAddonPrice:
          type: string
          title: Seataddonprice
          description: EUR per additional seat per month (string for precision)
          default: '0'
          examples:
            - '0'
            - '5.00'
        maxChannels:
          type: integer
          minimum: 0
          title: Maxchannels
          description: Maximum active channels allowed (0 = unlimited)
          default: 0
          examples:
            - 0
            - 1
      type: object
      title: TierLimits
      description: Tier-specific restrictions for frontend gating.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token from Stytch B2B authentication (magic link, SSO, or M2M)
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.cuadra.ai/oauth/token
          scopes:
            chats:invoke: Invoke chat completions (billable)
            chats:read: Read and list chats
            chats:write: Create and update chats
            chats:delete: Delete chats
            chats:admin: Full chat access (read/write/delete/invoke)
            models:read: Read model configurations
            models:write: Create and update models
            models:delete: Delete models
            models:admin: Full access to models (grants read + write + delete)
            datasets:read: Read and list datasets and snapshots
            datasets:write: Create and update datasets and snapshots
            datasets:delete: Delete datasets and snapshots
            datasets:admin: Full dataset access (read/write/delete)
            files:read: Read, list, and download files
            files:write: Upload, associate, and reprocess files
            files:delete: Delete files (single and bulk)
            files:admin: Full access to files (grants read + write + delete)
            particles:read: View particles and particle versions
            particles:write: Create and update particles
            particles:delete: Delete particles
            particles:admin: Full particle access (read/write/delete)
            system-prompts:read: View system prompts and compositions
            system-prompts:write: Create and update system prompts
            system-prompts:delete: Delete system prompts
            system-prompts:admin: Full system prompt access (read/write/delete)
            usage:read: Read usage and billing information
            usage:admin: Full access to usage data (grants read)
            connections:read: View external connections and sync status
            connections:write: Create and update external connections
            connections:delete: Delete connections and sync configurations
            connections:admin: Full connection access (read/write/delete)
            channels:read: View channels and channel configuration
            channels:write: Create and update channels
            channels:delete: Delete channels and release phone numbers
            channels:admin: Full channel access (read/write/delete)
            org:admin: Full resource access, manage members
            org:owner: 'Owner: all access including billing'
            chat:write: Delete and manage chats

````