HubSpot: Retrieve budget details

← Campaigns operations · Get started

Operation hubspot.campaigns_get_budget_totals

Provider route: GET /marketing/campaigns/2026-09/{campaignGuid}/budget/totals. Alter supplies the connection’s credentials and routing.

Call through Alter

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

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["campaigns"]["getBudgetTotals"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.campaigns.getBudgetTotals(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.campaigns.get_budget_totals(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.campaignGuid	string	Required within parent

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 Retrieve budget details — response body

Referenced models: Retrieve budget details — response body

Schemas

Retrieve budget details — response body

Field	Type	Presence	Description and constraints
$	object	Root
budgetItems	array	Required within parent	An array of budget items associated with the campaign, each represented by a PublicBudgetItem object.
budgetItems[]	Model	Each item	Expand Add budget item — response body
budgetTotal	JSON	Optional
budgetTotal (anyOf 1)	number	Alternative	The total amount of the budget allocated for the campaign, expressed as a number.
budgetTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyCode	string	Required within parent	The currency code used for the budget and spending amounts, represented as a string. Valid values include standard currency codes such as 'USD', 'EUR', 'JPY', etc. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL
remainingBudget	JSON	Optional
remainingBudget (anyOf 1)	number	Alternative	The remaining budget available for the campaign, calculated as the difference between the budgetTotal and spendTotal, expressed as a number.
remainingBudget (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
spendItems	array	Required within parent	An array of spend items associated with the campaign, each represented by a PublicSpendItem object.
spendItems[]	Model	Each item	Expand Create spend item — response body
spendTotal	JSON	Optional
spendTotal (anyOf 1)	number	Alternative	The total amount spent in the campaign, expressed as a number.
spendTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Add budget item — response body, Create spend item — response body

Add budget item — response body

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	The financial amount allocated to this budget item, represented as a number.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when this budget item was created. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	A description of the budget item, represented as a string.
id	string	Required within parent	The unique identifier for this budget item, represented as a string.
name	string	Required within parent	The name of the budget item, represented as a string.
order	JSON	Required within parent
order (anyOf 1)	integer	Alternative	An integer representing the order or sequence of this budget item within the campaign. Format: int32
order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when this budget item was last updated. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create spend item — response body

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	The financial amount associated with the spend item, represented as a number.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when the spend item was created. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	A string providing additional details about the spend item.
id	string	Required within parent	The unique identifier for the spend item, represented as a string.
name	string	Required within parent	The name of the spend item, represented as a string.
order	JSON	Required within parent
order (anyOf 1)	integer	Alternative	An integer indicating the order or sequence of the spend item. Format: int32
order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when the spend item was last updated. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.campaigns_get_budget_totals. Catalog operation: campaigns_get_budget_totals. 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.

Required provider scopes: ["marketing.campaigns.read"]

Official provider source