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 |
|---|---|---|---|
| 400 | bad_request |
Malformed JSON syntax or missing required top-level parameters. | Validate JSON payload with Content-Type: application/json and ensure all required fields are present. |
| 401 | unauthorized |
Missing, revoked, or incorrectly formatted x-api-key header. |
Verify API key exists in Dashboard → API Keys and pass in x-api-key or Authorization: Bearer. |
| 402 | insufficient_credits |
Account credit balance is lower than the base required credits (0 credits). | Top up credits in billing settings or enable auto-recharge to prevent pipeline interruption. |
| 422 | validation_error |
Input failed parameter constraints (e.g., character length exceeded or invalid array types). | Review parameters table above and adjust payload length, types, or structure accordingly. |
| 429 | rate_limit_exceeded |
Concurrency limit (60 requests/minute default) reached for this endpoint key. | Back off and retry using the timestamp in Retry-After response header, or batch requests. |