Mercury: Get a budget
Mercury budgets.getBudget: arguments, response, policy and SDK examples.
← Budgets operations · Get started
Operation mercury.getbudget
Provider route: GET /spend/budgets/{budgetId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["getBudget"]>[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.getBudget(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.get_budget(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.budgetId | string | Required within parent | ID for the budget Format: uuid |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get a budget — response body |
Referenced models: Get a budget — response body
Schemas
Section titled “Schemas”Get a budget — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amountPerUserPerPeriod | JSON | Optional | |
amountPerUserPerPeriod (anyOf 1) | JSON | Alternative | |
amountPerUserPerPeriod (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a budget — response body — amount Per User Per Period value value |
amountPerUserPerPeriod (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
endDate | JSON | Optional | |
endDate (anyOf 1) | JSON | Alternative | |
endDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
endDate (anyOf 2) | null | Alternative | |
frequency | JSON | Required within parent | |
frequency (allOf 1) | string | All variants apply | Known values: oneTime, daily, weekly, monthly, yearly |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the budget Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
name (anyOf 2) | null | Alternative | |
startDate | JSON | Optional | |
startDate (anyOf 1) | JSON | Alternative | |
startDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
startDate (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | number | Alternative | A non-negative dollar amount Format: double Minimum: 0 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.getbudget. Catalog operation: mercury:getBudget. 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.