Usage Endpoint

Monitor your credit balance and usage.

Get Current Usage

GET /v1/usage

Response

{
  "credit_balance": {
    "total": 247,
    "welcome": 100,
    "regular": 147,
    "promo": 0
  },
  "current_month": {
    "api_calls": 53,
    "credits_consumed": 103,
    "average_per_parse": 1.9,
    "success_rate": 98.1
  },
  "next_expiration": {
    "date": "2026-11-15",
    "amount": 100,
    "type": "welcome"
  }
}

Response Fields

credit_balance

• total: Total available credits
• welcome: Credits from welcome pack
• regular: Purchased credits
• promo: Promotional credits

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

next_expiration

• date: When credits expire
• amount: Number of expiring credits
• type: Credit type expiring

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:

• Purchases
• Consumptions (linked to parse requests)
• Promotional grants
• Expirations