SharedBudgetUpdate

Request body for updating an existing budget order.

Declaration

object SharedBudgetUpdate

Properties

Name	Type	Description
`name`	string	New display name for the budget order.
`startTime`	date-time	Updated budget start date and time. Format: `yyyy-MM-dd'T'HH:mm:ss.SSS` in UTC (for example, `2026-07-01T00:00:00.000`). Must be tomorrow or later (midnight UTC). Today is rejected.
`endTime`	date-time	Updated budget end date and time. Format: `yyyy-MM-dd'T'HH:mm:ss.SSS` in UTC. Set to `null` to remove an expiration date, making the budget open-ended.
`value`	`Money`	Updated budget amount. Specify `amount` and `currency`. See Money.
`adAccountIds`	[int64]	The ad account ID this budget order applies to. Exactly one ID is allowed, the same single-ID constraint as at creation. The API rejects requests that send more than one ID. Mutable.
`invoiceDetail`	`SharedBudgetUpdate.InvoiceDetail`	Updated billing contact details. See InvoiceDetail.

Discussion

The SharedBudgetUpdate object is the partial-update request payload for modifying an existing budget order. Include only the fields you want to change. Fields you leave out of the request body stay unchanged. To extend a budget that is approaching exhaustion, increase the value.amount.

Example

The example below shows every updatable field for reference. In a real request, include only the fields you want to change.

{
  "name": "AwayFinder Q3+Q4 2025 Budget",
  "startTime": "2025-07-01T00:00:00.000",
  "endTime": "2025-12-31T23:59:59.000",
  "value": {
    "amount": "25000.00",
    "currency": "USD"
  },
  "adAccountIds": [
    123456789
  ],
  "invoiceDetail": {
    "orderNumber": "PO-2025-Q3Q4"
  }
}

Topics

Dictionaries

SharedBudgetUpdate.InvoiceDetail