Get current usage
usageCheck billing-cycle usage before large scrape jobs to confirm available credit. View total, used, and available credits, quota percent, max concurrency, and reset time.
Instructions
Return the current billing-cycle usage for the authenticated organization: total / used / available credits, used quota percent, max concurrency, and cycle reset time. Call this before launching large scrape jobs to confirm available credit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| usage_reset | Yes | ISO 8601 UTC timestamp when the current billing cycle ends and used_credits resets. | |
| used_credits | Yes | Credits spent so far in the current billing cycle. May exceed total_credits on plans that allow overages. | |
| total_credits | Yes | Total credits available for the current billing cycle (plan base + purchased + gifted). | |
| max_concurrency | Yes | Maximum number of concurrent jobs allowed for this organization (plan base + purchased + gifted extras). | |
| available_credits | Yes | Remaining credits (max(0, total_credits - used_credits)). Clamped to 0 when in overage. | |
| used_quota_percent | Yes | Percentage of total_credits used in the current cycle, rounded to 1 decimal. Not capped — values >100 indicate overage. |