Account
Retrieve your workspace, credit balance, plan limits and usage.
GET /v1/account
Your workspace, its credit balance and its plan limits.
curl https://api.netraflow.com/v1/account \
-H "X-Api-Key: sk_live_your_key_here"{
"data": {
"tenant_id": "ten_abc123",
"name": "Acme Corp",
"email": "[email protected]",
"plan": "pro",
"credits": {
"balance": 850,
"plan_credits": 850,
"purchased_credits": 0,
"monthly_allowance": 1000,
"resets_at": "2026-08-17T09:30:00.000Z",
"used_this_period": 150
},
"limits": {
"max_video_duration_minutes": 10,
"max_audio_duration_minutes": 90,
"max_fps": 3,
"max_requests_per_minute": 60,
"max_concurrent_jobs": 10,
"max_queries_per_job": 10,
"webhooks_enabled": true,
"downloadable_reports": true,
"max_batch_size": 25,
"max_aggregate_queries_per_batch": 5
},
"created_at": "2026-01-15T10:00:00.000Z"
},
"meta": { "request_id": "req_xyz789" }
}Credits fields
| Prop | Type | Description |
|---|---|---|
| balance | integer | Credits available: plan plus purchased. |
| plan_credits | integer | What is left of this period's plan credits. |
| purchased_credits | integer | What is left of credits you bought. They never expire. |
| monthly_allowance | integer | Plan credits per billing period. 0 on Free; -1 for a custom Scale allowance. |
| resets_at | string (ISO 8601) | null | When plan credits next reset, on your billing date. Unused plan credits are forfeited then. null when no reset is scheduled. |
| used_this_period | integer | Credits used this calendar month (not the billing period). |
A running job's estimate is set aside but still counted in balance until it settles. See
Job status values for what happens to a job that doesn't fit.
Limits fields
| Prop | Type | Description |
|---|---|---|
| max_video_duration_minutes | integer | Longest video, in minutes. |
| max_audio_duration_minutes | integer | Longest video for an audio-only job (transcription, metadata or both, no queries). |
| max_requests_per_minute | integer | Sustained request rate. |
| max_concurrent_jobs | integer | Jobs queued or running at once. |
| max_queries_per_job | integer | Questions per job. |
| webhooks_enabled | boolean | Whether webhooks are on your plan. |
| max_fps | integer | Highest fps. A job's fps is clamped to it. |
| downloadable_reports | boolean | Whether report export is on your plan. |
| max_batch_size | integer | Videos per batch. 0 means no batches. |
| max_aggregate_queries_per_batch | integer | Aggregate questions per batch. |
GET /v1/usage
Credit totals for a period, and the transactions behind them.
Query parameters
| Prop | Type | Description |
|---|---|---|
| start_date | string (ISO 8601) | Period start. Defaults to the start of this month. |
| end_date | string (ISO 8601) | Period end. Defaults to now. |
| type | "charge" | "purchase" | "refund" | "grant" | "forfeit" | Only transactions of this type. |
| limit | integer (1-100) | Transactions per page. Defaults to 50. |
| cursor | string | pagination.next_cursor from the previous page. |
curl "https://api.netraflow.com/v1/usage?start_date=2026-04-01T00:00:00Z" \
-H "X-Api-Key: sk_live_your_key_here"{
"data": {
"summary": {
"period": {
"start": "2026-04-01T00:00:00.000Z",
"end": "2026-04-03T15:30:00.000Z"
},
"credits_used": 120,
"credits_purchased": 0,
"credits_refunded": 5,
"credits_granted": 0,
"total_jobs": 15
},
"transactions": [
{
"id": "tx_abc123",
"type": "charge",
"amount": -10,
"job_id": "job_xyz789",
"description": "Job job_xyz789 — transcription",
"created_at": "2026-04-03T14:00:00.000Z"
}
]
},
"pagination": {
"has_more": false,
"next_cursor": null
},
"meta": { "request_id": "req_abc456" }
}amount is in credits (1 credit = $0.10): negative when credits left your balance. A charge that belongs to no single
job, such as a batch's aggregate answers or a chat in the console, has job_id: null. A job has at most one charge,
equal to its credits_charged. A date that can't be read returns VALIDATION_FAILED (422).