Skip to content

Mercury: List budgets

Mercury budgets.listBudgets: arguments, response, policy and SDK examples.

← Budgets operations · Get started

Operation mercury.listbudgets

Provider route: GET /spend/budgets. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["budgets"]["listBudgets"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.budgets.listBudgets(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.budgets.list_budgets(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.start_atstringOptionalThe ID of the budget to start the page at (inclusive). Cannot be combined with start_after or end_before.
Format: uuid
query.start_afterstringOptionalThe ID of the budget to start the page after (exclusive). When provided, results will begin with the budget immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
query.end_beforestringOptionalThe ID of the budget to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid
query.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List budgets — response body

Referenced models: List budgets — response body

List budgets — response body
FieldTypePresenceDescription and constraints
$objectRoot
budgetsarrayRequired within parent
budgets[]ModelEach itemExpand Get a budget — response body
pageobjectRequired within parent
page.nextPagestringOptionalID for the budget
Format: uuid
page.previousPagestringOptionalID for the budget
Format: uuid

Referenced models: Get a budget — response body

Get a budget — response body
FieldTypePresenceDescription and constraints
$objectRoot
amountPerUserPerPeriodJSONOptional
amountPerUserPerPeriod (anyOf 1)JSONAlternative
amountPerUserPerPeriod (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a budget — response body — amount Per User Per Period value value
amountPerUserPerPeriod (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
endDateJSONOptional
endDate (anyOf 1)JSONAlternative
endDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
endDate (anyOf 2)nullAlternative
frequencyJSONRequired within parent
frequency (allOf 1)stringAll variants applyKnown values: oneTime, daily, weekly, monthly, yearly
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the budget
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
name (anyOf 2)nullAlternative
startDateJSONOptional
startDate (anyOf 1)JSONAlternative
startDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
startDate (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: draft, published, archived

Referenced models: Get a budget — response body — amount Per User Per Period value value

Get a budget — response body — amount Per User Per Period value value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeA non-negative dollar amount
Format: double
Minimum: 0
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: mercury.listbudgets. Catalog operation: mercury:listBudgets. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.