Budget Orders Endpoints
Create, retrieve, update, and delete budget orders through these endpoints.
Overview
Budget orders are available to Apple Ads customers that are on monthly invoicing. Budget orders work in addition to your daily budget to help you control costs. With a budget order, you can cap your total spend across campaigns in a campaign group set up through Apple Ads.
To use budget orders, an ad account must have a LOC (Line of Credit) paymentModel. In the API, Line of Credit (LOC) invoicing details are in InvoiceDetail. If you don’t have a billing model set up, campaigns default to Pay as You Go (PAYG) and budget orders aren’t available.
To confirm your payment model, call Get Ad Account by ID and check the AdAccount.PaymentModel field in the AdAccount response object. If you don’t have a payment model set up, you can still create campaigns, but you need to select a payment model before a campaign is eligible to run.
Set the X-AP-Context Header
Budget orders belong to an organization, so the X-AP-Context header works differently here than on other ad account scoped endpoints.
Create a Budget Order, Update a Budget Order, and Delete a Budget Order require organization-level permissions. Omit the
X-AP-Contextheader on these calls. If you send an ad account header, the API returns403 Forbiddenwith “User does not have required permissions”, even when your user has organization-level permissions.Query Budget Orders and Get a Budget Order by ID don’t require the header for users with organization-level permissions, and sending it doesn’t change the result.
Users limited to specific ad accounts must send
X-AP-Context: adAccountId=<id>on Query Budget Orders and Get a Budget Order by ID. Without it, the API returns403 Forbidden.
Call the Budget Orders Endpoints
Use the following endpoints to create, retrieve, update, and delete budget orders:
Method | Path | Description |
|---|---|---|
|
| Creates a new budget order via Post Shared Budgets. |
|
| Retrieves budget orders that match specified filters via Post Shared Budgets Query. |
|
| Retrieves a single budget order by its ID via Get Shared Budgets _id_. |
|
| Updates a budget order via Put Shared Budgets _id_. |
|
| Deletes a budget order by its ID via Delete Shared Budgets _id_. |