Check budget status for a session-scoped budget.
GET
/v1/budgets/{budget_id}/check
const url = 'https://app.everruns.com/api/v1/budgets/example/check';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://app.everruns.com/api/v1/budgets/example/checkParameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”budget_id
required
string
Prefixed public identifier
Responses
Section titled “ Responses ”Success
Media typeapplication/json
Result of checking all budgets for a session.
object
action
required
Most restrictive action across all budgets.
string
balance
Remaining balance on the most restrictive budget.
number | null format: double
budget_id
Budget that triggered the action.
string | null
currency
Currency of the most restrictive budget.
string | null
error_code
Stable error code for user-facing budget failures.
string | null
error_fields
Structured interpolation fields for localized error rendering.
object | null
message
Human-readable message (set when action != “continue”).
string | null
Examplegenerated
{ "action": "example", "balance": 1, "budget_id": "example", "currency": "example", "error_code": "example", "error_fields": "example", "message": "example"}