Skip to main content

​
GET /api/v1/credits/usage

Return credit consumption analytics for the specified date range. Defaults to the last 30 days when no dates are provided.

​
Query parameters

​
start_date
string
Inclusive start date in YYYY-MM-DD format. Defaults to 30 days before end_date.
​
end_date
string
Inclusive end date in YYYY-MM-DD format. Defaults to today.

​
Response

​
start_date
string
The resolved start date used for the query.
​
end_date
string
The resolved end date used for the query.
​
total_used
integer
Total credits consumed in the date range.
​
allowance
integer
Monthly credit allowance for your subscription tier. null if not applicable.
​
percentage_used
number
Percentage of monthly allowance consumed. null when allowance is not set.
​
average_daily
number
Average credits consumed per day in the date range.
​
projected
integer
Projected monthly usage extrapolated from current pace. null when insufficient data.
​
top_tool
string
The tool or package that consumed the most credits in the date range.
​
by_tool
array
Per-tool credit breakdown.
​
by_day
array
Daily credit consumption.

​
Example

cURL
curl "https://api.deepcurrent.app/api/v1/credits/usage?start_date=2026-03-01&end_date=2026-03-31" \
  -H "Authorization: Bearer $TOKEN"
Response
{
  "start_date": "2026-03-01",
  "end_date": "2026-03-31",
  "total_used": 3240,
  "allowance": 5000,
  "percentage_used": 64.8,
  "average_daily": 104.5,
  "projected": 3240,
  "top_tool": "vc-shortlist-v1",
  "by_tool": [
    { "tool_name": "vc-shortlist-v1", "credits": 1800 },
    { "tool_name": "growth_plan", "credits": 950 },
    { "tool_name": "builder-discovery-v1", "credits": 490 }
  ],
  "by_day": [
    { "date": "2026-03-01", "credits": 200 },
    { "date": "2026-03-02", "credits": 150 }
  ]
}