---
title: SharedBudget
framework: Apple Ads Platform API
role: symbol
role_heading: Object
platforms: [apple ads platform api 1.0+]
path: apple-ads-platform-api/sharedbudget
---

# SharedBudget

A budget order.

## Declaration

```data
object SharedBudget
```

## Properties

name: Non-empty string label for the budget order. Mutable. startTime: The start date and time for this budget. 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. Mutable. endTime: The end date and time for this budget. Format: yyyy-MM-dd'T'HH:mm:ss.SSS in UTC. Must be after startTime. Omit for an open-ended budget. Mutable. value: The budget amount as a Money object with amount and ISO 4217 currency code. See Money. Mutable. adAccountIds: The ad account IDs this budget order applies to. Exactly one allowed at creation. Mutable. orgId: The identifier of the organization that owns this budget order. Read-only. systemStatus: Current system status of this budget order. See BudgetSystemStatus. Read-only. systemStatusReasons: Status reasons applied based on system factors. Values: CANCELED, CAMPAIGN_BUDGET_UNASSIGNED, DELETED_BY_USER, EXHAUSTED, PROCESSING, SCHEDULE_EXPIRED, SCHEDULE_PENDING. Read-only. invoiceDetail: Invoice details required on create for Line of Credit accounts. Required fields: name, primaryBuyerName, primaryBuyerEmail, billingEmail. clientName and orderNumber are optional and nullable. See InvoiceDetail. Mutable. id: The unique budget identifier. Read-only. creationTime: Timestamp when the budget was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS in UTC. Read-only. modificationTime: Timestamp of the last modification. Format: yyyy-MM-dd'T'HH:mm:ss.SSS in UTC. Read-only. deleted: Indicates if the budget has been deleted. Read-only.

## Discussion

Discussion A SharedBudget creates a spending cap across a group of campaigns within an ad account. Campaigns participating in the same SharedBudget draw from a common spend limit. The startTime and endTime fields define the active window. The systemStatus field reflects whether the budget is currently usable. Common blocking reasons in systemStatusReasons include EXHAUSTED and SCHEDULE_PENDING. Example {   "id": 777890001,   "name": "AwayFinder - Q3 2026 Budget",   "startTime": "2026-07-01T00:00:00.000",   "endTime": "2026-09-30T23:59:59.000",   "value": {     "amount": "20000.00",     "currency": "USD"   },   "adAccountIds": [     123456789   ],   "orgId": 555666777,   "systemStatus": "ACTIVE",   "systemStatusReasons": [],   "invoiceDetail": {     "name": "AwayFinder Q3 2026 Invoice",     "primaryBuyerName": "Jane Smith",     "primaryBuyerEmail": "jane.smith@awayfinder.com",     "billingEmail": "billing@awayfinder.com"   },   "creationTime": "2026-06-06T10:00:00.000",   "modificationTime": "2026-06-06T10:00:00.000",   "deleted": false }

## Topics

### Dictionaries

- [SharedBudget.InvoiceDetail](apple-ads-platform-api/sharedbudget/invoicedetail-data.dictionary.md)

### Type Aliases

- [SharedBudget.SystemStatus](apple-ads-platform-api/sharedbudget/systemstatus-data.typealias.md)
- [SharedBudget.SystemStatusReasons](apple-ads-platform-api/sharedbudget/systemstatusreasons-data.typealias.md)

## See Also

- [SharedBudgetCreate](apple-ads-platform-api/sharedbudgetcreate.md)
- [SharedBudgetUpdate](apple-ads-platform-api/sharedbudgetupdate.md)
- [SharedBudgetResponse](apple-ads-platform-api/sharedbudgetresponse.md)
- [SharedBudgetQueryResponse](apple-ads-platform-api/sharedbudgetqueryresponse.md)
- [SharedBudgetAssignment](apple-ads-platform-api/sharedbudgetassignment.md)
- [SharedBudgetAssignmentCreate](apple-ads-platform-api/sharedbudgetassignmentcreate.md)
- [SharedBudgetAssignmentUpdate](apple-ads-platform-api/sharedbudgetassignmentupdate.md)
- [InvoiceDetail](apple-ads-platform-api/invoicedetail.md)
- [InvoiceDetailUpdate](apple-ads-platform-api/invoicedetailupdate.md)