GET Usage Summary API
/api/v1/account/usage-summary
Retrieve a monthly billing and usage summary for the authenticated user.
Architecture Role & AI Definition
Usage Summary API provides low-latency, deterministic REST execution for production engineering workflows. It processes structured payloads with strict schema validation, returns uniform JSON envelopes, and is secured via SHA-256 API key authentication with atomic credit pre-authorization locks.
Production Reliability Guidelines
Configure a hard client timeout of 5 to 8 seconds. If network latency spikes, cancel connection to avoid holding open sockets in worker pools.
Upon receiving 429 Rate Limit or transient 5xx, pause with exponential backoff:
wait = min(max_backoff, base * 2^attempt + jitter).
RSFlowHub acquires an atomic lock verifying base credits before model invocation. If validation fails, zero credits are deducted.
This endpoint does not require any parameters. It uses the Bearer token to identify the user.
Example Request
curl -X GET https://rsflowhub.com/api/v1/account/usage-summary \
-H "Authorization: Bearer YOUR_API_KEY"Example Response
{
"success": true,
"request_id": "req_7f3a9c2d1e4b8a6f",
"data": {
"billing_mode": "credits",
"credits_remaining": 700,
"period": {
"starts_at": "2026-05-01T00:00:00.000000Z",
"ends_at": "2026-05-31T23:59:59.000000Z"
},
"totals": {
"requests_count": 50,
"credits_used": 120,
"internal_cost": 0.05,
"cache_hits": 5
},
"endpoints": [
{
"endpoint": "content_generation",
"requests_count": 20,
"credits_used": 60,
"internal_cost": 0.02
},
{
"endpoint": "chat",
"requests_count": 30,
"credits_used": 60,
"internal_cost": 0.03
}
]
},
"meta": {
"version": "v1",
"timestamp": "2026-09-27T12:34:56+00:00"
}
}API Request Example
Use the cURL snippet below to test the endpoint.
curl -X GET 'https://rsflowhub.com/api/v1/account/usage-summary' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '[]'Want to try it without code? Test this request in the live Playground.
Common Failure Modes & Troubleshooting Matrix
| HTTP Code | Error Code | Root Cause | Recommended Remediation |
|---|---|---|---|
| 401 | API_KEY_MISSING / INVALID_API_KEY |
No key sent, or the key was mistyped or regenerated. | Copy the current key from Dashboard → API Keys and send it as Authorization: Bearer (or X-API-Key). |
| 402 | INSUFFICIENT_CREDITS |
Your balance cannot cover the estimate for this call (base 0 credits plus input/output size). | Buy a plan in Dashboard → Billing. Nothing was charged. |
| 422 | VALIDATION_ERROR |
A field is missing, too long or the wrong type, or the body is not valid JSON. | Read error.details for the field messages and fix the request. Do not retry the same body. |
| 429 | RATE_LIMIT_EXCEEDED |
Your plan-wide or per-endpoint per-minute limit was reached. | Wait the seconds in the Retry-After header, then retry with jitter. Rate limits |
| 502 | AI_PROVIDER_ERROR |
The AI model and its backup both failed. | Retry with backoff and check the status page. Nothing was charged. |