Sign in

v1

latestOpenAPI 3.0.12026-07-22204678550.0 KB
Campaign

/2026-01/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}

Return a budget. For example,

{
    "id": "1759183",
    "sellerId": "321392",
    "campaignIds": [
        143962
    ],
    "budgetType": "Capped",
    "amount": 1000,
    "startDate": "2021-01-11",
    "endDate": "2021-01-12",
    "spend": null,
    "status": "Active"
}

A budget limits the spend of a seller for one or more campaigns.

There are three types of budget:<br /><b>Uncapped</b> budgets put no limit on the total amount of spend.<br /><b>Capped</b> budgets limit the total spend to a fixed amount.<br /><b>Daily</b> budgets limit daily spend to a fixed amount.<br />

In addition, budgets can limit the spend to a specific range of dates using the start and end date attributes. Finally a budget must be active to be used.

<b>Spend</b> approximates the current spend against this budget. There may be a lag between when an ad is clicked and the time it accrues to the spend. Daily budgets show spend against the most recent day only.

get/2026-01/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}

Path parameters

budgetIdstring int64 required

Id of the budget.

Response

Success

amountnumber double nullable

Budget amount in the advertiser's currency

budgetTypestring

Type of budget: 'Daily' (daily cap), 'Capped' (lifetime with fixed amount), or 'Uncapped' (lifetime with no limit)

campaignIdsinteger[]

List of campaign IDs this budget applies to

endDatestring

End date of the budget period (format: YYYY-MM-DD), or empty string if open-ended

idstring

Unique budget identifier

isSuspendedboolean

Whether the budget has been manually suspended by the partner

sellerIdstring

Identifier of the seller this budget belongs to

spendnumber double nullable

Amount spent against this budget so far, or null if not available

startDatestring date

Start date of the budget period (format: YYYY-MM-DD)

status'Archived' | 'Current' | 'Scheduled'

Status of a seller budget

Example response

{
  "id": "16501666",
  "sellerId": "10656107",
  "campaignIds": [
    436017
  ],
  "budgetType": "Capped",
  "amount": 462.47,
  "endDate": "2026-04-30",
  "spend": 117.59,
  "status": "Current",
  "isSuspended": false
}