SharedBudgetCreate

The request body for creating a new budget order.

Declaration

object SharedBudgetCreate

Properties

Name	Type	Description
`name` Required	string	A descriptive label for the budget order. Must be non-empty.
`startTime` Required	date-time	The date and time the budget becomes active. Format: `yyyy-MM-dd'T'HH:mm:ss.SSS` in UTC (for example, `2026-06-07T00:00:00.000`). Must be tomorrow or later (midnight UTC). Today is rejected.
`endTime`	date-time	The date and time the budget expires. Format: `yyyy-MM-dd'T'HH:mm:ss.SSS` in UTC. Must be after `startTime`. Omit for an open-ended budget.
`value` Required	`Money`	The total budget amount as a `Money` object with `amount` and ISO 4217 `currency` code. See Money.
`adAccountIds` Required	[int64]	The ad account IDs that can draw from this budget. Exactly one ID is allowed at creation. The API rejects requests that send more than one ID.
`invoiceDetail` Required	`SharedBudgetCreate.InvoiceDetail`	Billing contact details. See InvoiceDetail.

Discussion

The SharedBudgetCreate object is the request payload for creating a new budget order.

Ensure the currency in the Money object matches the ad account’s currency. Once created, you can assign the budget order to one or more campaigns using SharedBudgetAssignment on each campaign.

Example

{
  "name": "AwayFinder Q3 Budget Order",
  "startTime": "2026-08-01T00:00:00.000",
  "endTime": "2026-09-30T23:59:59.000",
  "value": {
    "amount": "50000.00",
    "currency": "USD"
  },
  "adAccountIds": [
    123456789
  ],
  "invoiceDetail": {
    "name": "AwayFinder Inc.",
    "orderNumber": "PO-987654321",
    "clientName": "AwayFinder Marketing",
    "primaryBuyerName": "Jordan Rivera",
    "primaryBuyerEmail": "jordan.rivera@awayfinder.com",
    "billingEmail": "billing@awayfinder.com"
  }
}

Topics

Dictionaries

SharedBudgetCreate.InvoiceDetail