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

# Get subscription status

> Retrieve user subscription tier and usage quotas



## OpenAPI

````yaml /api-reference/openapi.json get /api/subscription/status
openapi: 3.1.0
info:
  title: AI2Fin Financial Management API
  description: >-
    Financial management platform with AI-powered categorization, tax
    optimization, and bill management.
  version: 1.0.0
  contact:
    name: AI2Fin Support
    url: https://ai2fin.com
  license:
    name: Proprietary
servers:
  - url: https://api.ai2fin.com
    description: Production
  - url: http://localhost:3001
    description: Local Development
security:
  - bearerAuth: []
  - apiTokenAuth: []
  - cookieAuth: []
  - apiKeyAuth: []
tags:
  - name: Authentication
    description: User authentication and authorization
  - name: Bank Transactions
    description: Bank transaction management and CSV import
  - name: Bills & Recurring Payments
    description: Bill management with pattern recognition and auto-linking
  - name: Expenses
    description: Expense tracking with tax deduction support
  - name: AI Services
    description: AI-powered categorization and tax analysis
  - name: Automation
    description: Custom rules engine for automated workflows
  - name: Categories
    description: Transaction and expense category management
  - name: Smart Categories
    description: >-
      Category sets, multi-category assignments, and transaction history (Elite+
      only)
  - name: Analytics & Reports
    description: Financial analytics and tax report generation
  - name: Travel & Vehicles
    description: Vehicle registration and business trip tracking
  - name: Search
    description: AI-powered unified search across all entities
  - name: Subscription
    description: Subscription and quota management
  - name: AI Analysis
    description: AI-driven categorization and tax analysis endpoints
  - name: AI Assistant
    description: Chat conversations, messaging, and assistant file handling
  - name: GST & Tax
    description: Global GST/VAT rate lookup and calculations
  - name: Receipts & Attachments
    description: Receipt ingestion, AI analysis, and linkage APIs
  - name: MCP Server
    description: >-
      Model Context Protocol endpoints for AI integrations. Finance MCP server
      with 65+ tools for expense tracking, tax deductions, bill management, and
      financial analysis. Supports OAuth (JWT) and API key authentication.
paths:
  /api/subscription/status:
    get:
      tags:
        - Subscription
      summary: Get subscription status
      description: Retrieve user subscription tier and usage quotas
      responses:
        '200':
          description: Subscription status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionStatus'
components:
  schemas:
    SubscriptionStatus:
      type: object
      properties:
        tier:
          type: string
          enum:
            - free
            - starter
            - professional
            - enterprise
        status:
          type: string
          enum:
            - active
            - trial
            - expired
            - cancelled
        quotas:
          type: object
          properties:
            transactionsLimit:
              type: integer
            transactionsUsed:
              type: integer
            aiCallsLimit:
              type: integer
            aiCallsUsed:
              type: integer
        expiryDate:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT token obtained from /api/enterprise-auth/login endpoint. Use for
        standard API access and OAuth-based integrations.
    apiTokenAuth:
      type: http
      scheme: bearer
      bearerFormat: API_TOKEN
      description: >-
        API token (from /api/api-keys or /api/admin/api-keys) used in
        Authorization header. Alternative to X-API-Key header. Format: mcp_<64
        hex characters>. Can be used for all API endpoints that support API key
        authentication.
    cookieAuth:
      type: apiKey
      in: cookie
      name: ai2_sess
      description: Session cookie for web applications
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key/token for MCP integrations, automation, and server-to-server
        communication. Generate via /api/api-keys (user endpoint) or
        /api/admin/api-keys (admin endpoint). Format: mcp_<64 hex characters>.
        Can be used in X-API-Key header or Authorization: Bearer header. Ideal
        for /mcp/inspector endpoint and custom integrations.

````