Skip to main content
GET
Get User Usage Stats

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Detailed usage statistics for the current billing cycle.

user_id
string
required

User identifier.

subscription_tier
string
required

Current plan: 'free', 'plus', 'pro', or 'enterprise'.

monthly_limit
integer
required

Maximum operations allowed per month. -1 means unlimited.

monthly_used
integer
required

Operations used this billing cycle.

monthly_remaining
integer
required

Operations remaining this cycle.

total_sessions
integer
required

Total number of chat sessions created.

total_documents
integer
required

Total number of documents processed.

total_operations
integer
required

Lifetime total operations across all billing cycles.

current_month_stats
Current Month Stats · object
required

Breakdown of this month's operations by type, including counts, tokens used, and success rates.

monthly_reset_at
string | null

ISO 8601 timestamp when the monthly counter resets.