BudgetOrder

The billing email.

This field is updatable.

The total budget amount available for the budget order.

This field is updatable.

The advertiser or product. This is a requirement for agency-type accounts.

This field is updatable only before the startDate of a campaign.

The scheduled end date and time for the budget order in the format of yyyy-mm-dd'T'HH:MM:SS.SSS.

This field is updatable.

A unique identifier for the budget order.

When you create a budget order through Apple Ads Advanced, the system returns a budget order ID (boId) that you can use with Get a Budget Order to return details of a specific budget order for an organization or campaign group.

The name of the budget order, which is unique within an organization. This field is updatable only before the startDate of a campaign.

A purchase order number. This is a requirement for agency-type accounts.

This field is updatable only before the startDate of a campaign.

The unique identifier of the organization that owns the budget order.

The primary buyer’s email address.

This field is updatable.

The primary buyer’s name.

This field is updatable.

The scheduled start date and time for the budget order in the format of yyyy-mm-dd'T'HH:MM:SS.SSS.

This field is updatable only before the startDate of a campaign and is only editable if there are no campaigns assigned to the budget order.

The system-controlled status indicator for the budget order.

ACTIVE

This status occurs when the budget order reaches its start date.

CANCELED

This status occurs when you cancel the budget order.

COMPLETED

This status occurs when the budget order reaches its end date.

EXHAUSTED

This status occurs when you exhaust the budget for the budget order before it reaches its end date.

INACTIVE

This status occurs after you create the budget order and before it reaches its start date.

The supply source of ads to use in a budget order and a campaign. As of 5.3, the Create a Budget Order endpoint does not support a single placement type. In all responses, the supplySources field contains all possible values.