Usage Endpoint

Monitor your credit balance and usage.

Get Current Usage

GET /v1/usage

Response

{
  "credit_balance": {
    "total": 247,
    "remaining": 247
  },
  "current_month": {
    "api_calls": 53,
    "credits_consumed": 103,
    "average_per_parse": 1.9,
    "success_rate": 98.1
  },
  "billing_cycle": {
    "reset_date": "2026-03-01",
    "plan": "beginner",
    "monthly_allowance": 500
  }
}

Response Fields

credit_balance

• total: Total available credits remaining this billing cycle
• remaining: Credits remaining (same as total)

current_month

• api_calls: Parse requests this month
• credits_consumed: Credits used this month
• average_per_parse: Average credits per request
• success_rate: Percentage of successful parses

billing_cycle

• reset_date: Date when credits reset for the next billing cycle
• plan: Your current subscription plan (beginner or professional)
• monthly_allowance: Total credits included in your plan per month

Get Usage History

GET /v1/usage/history

Query Parameters

• start_date: ISO date (e.g., 2025-11-01)
• end_date: ISO date
• limit: Results per page (default: 20, max: 100)
• offset: Pagination offset

Example

GET /v1/usage/history?start_date=2025-11-01&end_date=2025-11-15&limit=50

Response

{
  "history": [
    {
      "date": "2025-11-15",
      "parse_count": 12,
      "credits_consumed": 18,
      "breakdown": {
        "nano": 10,
        "standard": 2,
        "ocr_standard": 4
      }
    },
    {
      "date": "2025-11-14",
      "parse_count": 8,
      "credits_consumed": 11
    }
  ],
  "pagination": {
    "total": 45,
    "limit": 50,
    "offset": 0
  }
}

Credit Transactions

View detailed credit transactions in your dashboard, including:

• Monthly plan allowance grants (on billing cycle reset)
• Consumptions (linked to parse requests)