curl --request GET \
--url 'https://api.nsr.stateset.com/api/v1/billing/usage' \
--header 'X-API-Key: YOUR_API_KEY'
{
"account": {
"can_produce_outcome": true,
"included_outcomes_remaining": 1,
"prepaid_credits_remaining_cents": 1,
"status": "string",
"trial_credits_remaining_cents": 1
},
"api_requests_month": 1,
"entities": 1,
"inference_requests_month": 1,
"limits": {
"max_entities": 1,
"max_requests_per_minute": 1,
"max_rules": 1,
"max_triples": 1
},
"outcomes": {
"base_fee": 1,
"estimated_total": 1,
"outcome_charges": 1,
"outcomes_billable": 1,
"outcomes_included": 1,
"outcomes_month": 1,
"price_per_outcome": 1
},
"recursive": {
"grounded_outcome_rate": 1,
"ready_action_responses_month": 1,
"requests_month": 1,
"review_required_rate": 1,
"review_required_responses_month": 1,
"tool_call_responses_month": 1
},
"rules": 1,
"storage_bytes": 1,
"tier": "string",
"triples": 1
}
Get usage handlers
Returns the tenant’s current usage metrics from the tenancy system. Required scope: read
GET
/
api
/
v1
/
billing
/
usage
curl --request GET \
--url 'https://api.nsr.stateset.com/api/v1/billing/usage' \
--header 'X-API-Key: YOUR_API_KEY'
{
"account": {
"can_produce_outcome": true,
"included_outcomes_remaining": 1,
"prepaid_credits_remaining_cents": 1,
"status": "string",
"trial_credits_remaining_cents": 1
},
"api_requests_month": 1,
"entities": 1,
"inference_requests_month": 1,
"limits": {
"max_entities": 1,
"max_requests_per_minute": 1,
"max_rules": 1,
"max_triples": 1
},
"outcomes": {
"base_fee": 1,
"estimated_total": 1,
"outcome_charges": 1,
"outcomes_billable": 1,
"outcomes_included": 1,
"outcomes_month": 1,
"price_per_outcome": 1
},
"recursive": {
"grounded_outcome_rate": 1,
"ready_action_responses_month": 1,
"requests_month": 1,
"review_required_rate": 1,
"review_required_responses_month": 1,
"tool_call_responses_month": 1
},
"rules": 1,
"storage_bytes": 1,
"tier": "string",
"triples": 1
}
Returns the tenant’s current usage metrics from the tenancy system.
Required scope:
read
Response
UsageResponse
UsageAccount
required
Show UsageAccount
Show UsageAccount
boolean
required
Whether the tenant can currently produce another billable outcome.
integer (int64)
required
Included outcomes remaining before billable overage starts.
integer (int64)
Prepaid (purchased) credits remaining in cents. Never expire.
string
required
Tenant status from the tenancy system.
integer (int64)
required
Trial credits remaining in cents.
integer (int64)
required
integer
required
integer (int64)
required
UsageLimits
required
OutcomeUsage
required
Show OutcomeUsage
Show OutcomeUsage
number (double)
required
Base platform fee in dollars.
number (double)
required
Total estimated bill (base + outcome charges).
number (double)
required
Total outcome charges this month in dollars.
integer (int64)
required
Billable outcomes (beyond included quota).
integer (int64)
required
Outcomes included in the tier (no extra charge).
integer (int64)
required
Total resolved outcomes this month.
number (double)
required
Price per billable outcome in dollars.
RecursiveUsage
required
Show RecursiveUsage
Show RecursiveUsage
number (double)
required
Grounded outcome rate across recursive requests.
integer (int64)
required
Number of recursive responses that returned one or more ready actions.
integer (int64)
required
Number of recursive chat requests this month.
number (double)
required
Review-required rate across recursive requests.
integer (int64)
required
Number of recursive responses that required human review.
integer (int64)
required
Number of recursive responses that returned one or more tool calls.
integer
required
integer (int64)
required
string
required
integer
required
Status codes
| Code | Meaning |
|---|---|
200 | Usage metrics |
401 | Unauthorized — missing or invalid credentials |
403 | Forbidden — the key/token lacks the required scope |
429 | Rate limited — see Retry-After / X-RateLimit-Reset |
curl --request GET \
--url 'https://api.nsr.stateset.com/api/v1/billing/usage' \
--header 'X-API-Key: YOUR_API_KEY'
{
"account": {
"can_produce_outcome": true,
"included_outcomes_remaining": 1,
"prepaid_credits_remaining_cents": 1,
"status": "string",
"trial_credits_remaining_cents": 1
},
"api_requests_month": 1,
"entities": 1,
"inference_requests_month": 1,
"limits": {
"max_entities": 1,
"max_requests_per_minute": 1,
"max_rules": 1,
"max_triples": 1
},
"outcomes": {
"base_fee": 1,
"estimated_total": 1,
"outcome_charges": 1,
"outcomes_billable": 1,
"outcomes_included": 1,
"outcomes_month": 1,
"price_per_outcome": 1
},
"recursive": {
"grounded_outcome_rate": 1,
"ready_action_responses_month": 1,
"requests_month": 1,
"review_required_rate": 1,
"review_required_responses_month": 1,
"tool_call_responses_month": 1
},
"rules": 1,
"storage_bytes": 1,
"tier": "string",
"triples": 1
}