Skip to content

Mercury: Create a budget

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

← Budgets operations · Get started

Operation mercury.createbudget

Provider route: POST /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"]["createBudget"]>[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.createBudget(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.create_budget(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptional
bodyModelOptionalExpand Create a budget — request body — body

Referenced models: Create a budget — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a budget — response body

Referenced models: Create a budget — response body

Create a budget — response body
FieldTypePresenceDescription and constraints
$objectRoot
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the budget
Format: uuid
Create a budget — request body — body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountPerUserPerPeriodJSONOptional
amountPerUserPerPeriod (anyOf 1)JSONAlternative
amountPerUserPerPeriod (anyOf 1) (allOf 1)numberAll variants applyA non-negative dollar amount
Format: double
Minimum: 0
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 applyOne of: oneTime, daily, weekly, monthly, yearly
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

SDK function policy ID: mercury.createbudget. Catalog operation: mercury:createBudget. 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.