Browse the help center

Change a fee plan's rates, or add a plan

With id, changes only the rates the call names on that plan and leaves every other one as it is.

Reference
POST https://YOUR-NETWORK-DOMAIN/rest-api/ad-server-fees/plans.do

With id, changes only the rates the call names on that plan and leaves every other one as it is. Without id, adds a plan - name is required then, and the new plan is never the one the network runs on: moving the network onto it is its own change (activePlanId on ad-server-fees.do). Every value is checked the way the console's form checks it, and a call that breaks a rule changes nothing at all. A rate the network's pricing type does not charge against is stored and named under notCharged, so it is clear it will not reach a bill while the network bills that way. Changing the plan the network is on changes what it pays from the next time the month's charges are refreshed. Requires the Ad Server Fees Management console permission.

Form Params

id integer

The plan to change; leave it out to add a plan

3

name string

What the plan is called, up to 128 characters

Standard

planPrice number

What the plan costs a month, before any overage

500

globalImpressions integer

Impressions of every kind the plan includes; charged under GLOBAL pricing

50000000

desktopImpressions integer

Desktop impressions the plan includes; charged under SPLIT pricing

30000000

mobileImpressions integer

Mobile impressions the plan includes; charged under SPLIT pricing

20000000

videoImpressions integer

Video impressions the plan includes; charged under SPLIT pricing

5000000

trafficAmountInGb integer

Traffic the plan includes, in GB

1000

globalImpressionOverageCpm number

Charged per thousand impressions of any kind beyond what the plan includes

0.02

desktopImpressionOverageCpm number

Charged per thousand desktop impressions beyond what the plan includes

0.02

mobileImpressionOverageCpm number

Charged per thousand mobile impressions beyond what the plan includes

0.03

videoImpressionOverageCpm number

Charged per thousand video impressions beyond what the plan includes

0.05

trafficOveragePricePerGb number

Charged per GB of traffic beyond what the plan includes

0.1

premiumAccount boolean

Whether the plan is a premium account

false

premiumAccountPrice number

What a premium account adds to the monthly price

100

flexiblePrice boolean

Charge every impression at the prices below instead of only the ones beyond the plan

false

globalImpressionPriceCpm number

With flexible pricing: charged per thousand impressions of any kind

0.01

desktopImpressionPriceCpm number

With flexible pricing: charged per thousand desktop impressions

0.01

mobileImpressionPriceCpm number

With flexible pricing: charged per thousand mobile impressions

0.02

videoImpressionPriceCpm number

With flexible pricing: charged per thousand video impressions

0.04

hbFillsAsImpressions boolean

Count a header-bidding fill won by other demand as an impression, at this plan's rates

true

hbFillPriceCpm number

What a header-bidding fill costs per thousand when it is not counted as an impression

0.01

autoSwitchForwardBillingPlanId string

Plan to move up to when this one is outgrown; empty to clear

4

autoSwitchBackwardBillingPlanId string

Plan to fall back to when this one is not used up; empty to clear

2

aiEpomKeyEnabled boolean

Let this network run the AI assistant on the ad server's own key, billed

true

aiPriceMultiplier string

Billed AI cost is the list price times this, 1-100; empty for the platform default

2

aiPromoUntil string

Last day (UTC) on which AI assistant calls cost the network nothing, yyyy-MM-dd; empty for no promo

2026-12-31

aiPromoAllowanceUsd string

What the promo waives for the whole network, in USD; empty for the platform default

100

Responses

200

{success, id, created, changed:[...], notCharged:{...}, plan:{...}}

400

A value the console's form would refuse, naming the field; or no field named

401

Authentication error

403

The caller does not hold AD_SERVER_FEES_MANAGEMENT

404

No plan with that id

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.