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

# Get usage

> Check your quota and usage for the current month.



## OpenAPI

````yaml /openapi.json get /v1/usage
openapi: 3.1.0
info:
  title: Swippee API
  version: 1.0.0
  description: >-
    Convert Nepali bank statement PDFs into structured financial data, derive
    lending products from a parse, and read Nepal's public-sector financial
    datasets — over one REST API.
servers:
  - url: https://api.swippee.com
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/usage:
    get:
      tags:
        - Account
      summary: Get usage
      description: Check your quota and usage for the current month.
      operationId: getUsage
      responses:
        '200':
          description: Usage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Usage:
      type: object
      properties:
        plan:
          type: string
          example: sandbox
        quota:
          type: integer
          example: 100
        used:
          type: integer
          example: 23
        remaining:
          type: integer
          example: 77
        period:
          type: string
          example: 2026-05
        resets_at:
          type: string
          format: date-time
    Error:
      type: object
      description: >-
        Flat, industry-standard error envelope. Branch on error_code, not the
        HTTP status.
      properties:
        error_type:
          type: string
          example: AUTHENTICATION_ERROR
        error_code:
          type: string
          example: INVALID_API_KEY
        error_message:
          type: string
          example: Unknown API key.
        display_message:
          type: string
          nullable: true
          example: null
        request_id:
          type: string
          example: req_8f3c9b2e4a1d4f7c9e0b1a2c3d4e5f60
        documentation_url:
          type: string
          example: https://docs.swippee.com/concepts/errors#invalid_api_key
        suggested_action:
          type: string
          example: Check your API key in the Authorization header.
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key from the dashboard, sent as `Authorization: Bearer
        swippee_sk_live_...`.

````