Ad Server Fees API endpoints
Endpoint reference for the Ad Server Fees tag (4 endpoints): Administrators only: what the ad server charges this network — the pricing type, the fee plans with their rates, and which plan the network is on. Reading needs the Ad Server Fees console permission, changing anything needs Ad Server Fees Management
Administrators only: what the ad server charges this network — the pricing type, the fee plans with their rates, and which plan the network is on. Reading needs the Ad Server Fees console permission, changing anything needs Ad Server Fees Management. 4 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.
GET /rest-api/ad-server-fees.do
Read the network’s ad server fees.
No parameters beyond authentication.
Responses: 200 — {success, pricingType, activePlanId, activePlanName, editable, defaultAiPriceMultiplier, plans:[…]}. Errors follow the shared conventions.
POST /rest-api/ad-server-fees.do
Change the pricing type or the network’s plan.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pricingType | form | string | no | How impressions are charged: SPLIT (desktop, mobile and video rates), GLOBAL (one rate) or LEGACY Values: SPLIT, GLOBAL, LEGACY. |
activePlanId | form | integer | no | The plan the network is to run on; it replaces the one it is on now |
Responses: 200 — {success, changed:[…], pricingType, activePlanId, activePlanName}. Errors follow the shared conventions.
GET /rest-api/ad-server-fees/months.do
Read what each month was billed.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
year | query | integer | no | Only this calendar year |
month | query | integer | no | Only this month of the year, 1-12 |
limit | query | integer | no | How many months to return, 1-120. Default 12 |
start | query | integer | no | To page back: how many months to skip |
Responses: 200 — {success, months:[{year, month, planId, planName, …charges}], returned, total, more}. Errors follow the shared conventions.
POST /rest-api/ad-server-fees/plans.do
Change a fee plan’s rates, or add a plan.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | form | integer | no | The plan to change; leave it out to add a plan |
name | form | string | no | What the plan is called, up to 128 characters |
planPrice | form | number | no | What the plan costs a month, before any overage |
globalImpressions | form | integer | no | Impressions of every kind the plan includes; charged under GLOBAL pricing |
desktopImpressions | form | integer | no | Desktop impressions the plan includes; charged under SPLIT pricing |
mobileImpressions | form | integer | no | Mobile impressions the plan includes; charged under SPLIT pricing |
videoImpressions | form | integer | no | Video impressions the plan includes; charged under SPLIT pricing |
trafficAmountInGb | form | integer | no | Traffic the plan includes, in GB |
globalImpressionOverageCpm | form | number | no | Charged per thousand impressions of any kind beyond what the plan includes |
desktopImpressionOverageCpm | form | number | no | Charged per thousand desktop impressions beyond what the plan includes |
mobileImpressionOverageCpm | form | number | no | Charged per thousand mobile impressions beyond what the plan includes |
videoImpressionOverageCpm | form | number | no | Charged per thousand video impressions beyond what the plan includes |
trafficOveragePricePerGb | form | number | no | Charged per GB of traffic beyond what the plan includes |
premiumAccount | form | boolean | no | Whether the plan is a premium account |
premiumAccountPrice | form | number | no | What a premium account adds to the monthly price |
flexiblePrice | form | boolean | no | Charge every impression at the prices below instead of only the ones beyond the plan |
globalImpressionPriceCpm | form | number | no | With flexible pricing: charged per thousand impressions of any kind |
desktopImpressionPriceCpm | form | number | no | With flexible pricing: charged per thousand desktop impressions |
mobileImpressionPriceCpm | form | number | no | With flexible pricing: charged per thousand mobile impressions |
videoImpressionPriceCpm | form | number | no | With flexible pricing: charged per thousand video impressions |
hbFillsAsImpressions | form | boolean | no | Count a header-bidding fill won by other demand as an impression, at this plan’s rates |
hbFillPriceCpm | form | number | no | What a header-bidding fill costs per thousand when it is not counted as an impression |
autoSwitchForwardBillingPlanId | form | string | no | Plan to move up to when this one is outgrown; empty to clear |
autoSwitchBackwardBillingPlanId | form | string | no | Plan to fall back to when this one is not used up; empty to clear |
aiEpomKeyEnabled | form | boolean | no | Let this network run the AI assistant on the ad server’s own key, billed |
aiPriceMultiplier | form | string | no | Billed AI cost is the list price times this, 1-100; empty for the platform default |
aiPromoUntil | form | string | no | Last day (UTC) on which AI assistant calls cost the network nothing, yyyy-MM-dd; empty for no promo |
aiPromoAllowanceUsd | form | string | no | What the promo waives for the whole network, in USD; empty for the platform default |
Responses: 200 — {success, id, created, changed:[…], notCharged:{…}, plan:{…}} · 404 — No plan with that id. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
- Network services and miscellaneous APIs