Skip to main content

​
Usage

Check your current page usage and remaining quota for the billing period. 
curl -X GET https://parse.pantherpulse.ai/v1/usage \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Request

​
Path

GET /v1/usage

​
Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer YOUR_API_KEY

​
Response

{
  "current_month": "2025-10",
  "plan": "Professional",
  "pages_limit": 1000,
  "pages_used": 347,
  "pages_remaining": 653,
  "usage_percentage": 34.7,
  "reset_date": "2025-11-01T00:00:00Z",
  "month_started": "2025-10-01T00:00:00Z"
}

​
Response Fields

FieldTypeDescription
current_monthstringCurrent billing month (YYYY-MM)
planstringYour active plan (Starter, Professional, Business)
pages_limitnumberTotal pages allowed this month
pages_usednumberPages consumed so far this month
pages_remainingnumberPages available to use
usage_percentagenumberPercentage of quota used (0-100)
reset_datestringISO 8601 timestamp when quota resets
month_startedstringISO 8601 timestamp when billing month started

​
Page Consumption

Pages are consumed when you successfully upload PDFs:
  • Each page of the PDF = 1 page consumed
  • Consumption happens on upload (even if processing fails later)
  • Pages reset automatically at month start

​
Examples

​
Check Before Uploading

import requests

def safe_upload(files, api_key):
    # Check usage first
    usage = requests.get(
        'https://parse.pantherpulse.ai/v1/usage',
        headers={'Authorization': f'Bearer {api_key}'}
    ).json()
    
    total_pages = sum(get_page_count(f) for f in files)
    
    if total_pages > usage['pages_remaining']:
        print(f"Not enough quota. Need {total_pages}, have {usage['pages_remaining']}")
        return False
    
    # Safe to upload
    return upload_files(files, api_key)

​
Monitor Usage Percentage

usage = requests.get(...).json()

if usage['usage_percentage'] > 80:
    print(f"⚠️  Warning: {usage['usage_percentage']}% quota used")
elif usage['usage_percentage'] > 95:
    print(f"🚨 Critical: {usage['usage_percentage']}% quota used")

​
Quota Plans

PlanPages/MonthMonthly Cost
Starter250$99
Professional1,000$299
Business3,500$699
To upgrade, contact [email protected] or visit your dashboard.

​
FAQ

Q: When do pages reset?
A: On the 1st of each calendar month at 00:00 UTC. Q: What if I exceed my quota?
A: Uploads will be rejected with a limit_exceeded error. Upgrade your plan to continue. Q: Can I carry over unused pages?
A: No, pages don’t roll over. They reset each month. Q: What counts as a page?
A: Each physical page of the PDF file uploaded. A 10-page statement = 10 pages consumed.