<!--
{
  "availability" : [
    "Apple Ads Platform API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Apple-Ads-Platform-API",
  "identifier" : "/documentation/Apple-Ads-Platform-API/SharedBudget",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Apple Ads Platform API"
    ],
    "preciseIdentifier" : "data:apple-ads-platform-api:SharedBudget"
  },
  "title" : "SharedBudget"
}
-->

# SharedBudget

A budget order.

```
object SharedBudget
```

## 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

```json
{
  "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

[`object SharedBudget.InvoiceDetail`](/documentation/Apple-Ads-Platform-API/SharedBudget/InvoiceDetail-data.dictionary)

Invoice billing details for accounts on the Line of Credit (LOC) payment model.

### Type Aliases

[`string SharedBudget.SystemStatus`](/documentation/Apple-Ads-Platform-API/SharedBudget/SystemStatus-data.typealias)

The system-derived operational state of a budget order.

[`string SharedBudget.SystemStatusReasons`](/documentation/Apple-Ads-Platform-API/SharedBudget/SystemStatusReasons-data.typealias)

Reason codes explaining a budget order’s current system status.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)