--- title: "Pricing API endpoints" description: "Endpoint reference for the Pricing tag (11 endpoints): Pricing and bid floor configuration" type: "reference" audience: [network-manager, admin] keywords: [api, rest, endpoints, pricing] --- Fetch the complete documentation index at: https://epom.com/ad-server/docs/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version. # Pricing API endpoints Pricing and bid floor configuration. 11 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see [REST API overview](https://epom.com/ad-server/docs/api.md). Parameters marked `form` go in an `application/x-www-form-urlencoded` request body. ### GET /rest-api/bid-floor/banner/{bannerId}.do [Request examples](https://epom.com/ad-server/docs/api/pricing/get-bid-floor-banner.md) Get banner bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `bannerId` | path | integer | yes | Unique numeric identifier of the banner whose bid floor should be retrieved | **Responses:** `200` — Banner bid floor retrieved successfully · `404` — Banner not found or deleted. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### POST /rest-api/bid-floor/banner/{bannerId}/delete.do [Request examples](https://epom.com/ad-server/docs/api/pricing/post-bid-floor-banner-delete.md) Delete banner bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `bannerId` | path | integer | yes | Unique numeric identifier of the banner whose bid floor entry should be deleted | | `country` | form | string | yes | ISO alpha-2 country code (e.g., 'US', 'DE') of the bid floor to remove, or '*' to reset the global bid floor to zero | **Responses:** `200` — Banner bid floor deleted, or the global one reset to 0 · `404` — Banner, its bid floor, or the country's bid floor not found. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### POST /rest-api/bid-floor/banner/{bannerId}/update.do [Request examples](https://epom.com/ad-server/docs/api/pricing/post-bid-floor-banner-update.md) Update banner bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `bannerId` | path | integer | yes | Unique numeric identifier of the banner to set the bid floor for | | `country` | form | string | yes | ISO alpha-2 country code (e.g., 'US', 'DE') or '*' for the global default bid floor | | `bidFloor` | form | number | yes | Minimum bid floor price value as a decimal number (e.g., 0.50) | **Responses:** `200` — Banner bid floor updated successfully · `404` — Banner not found or deleted. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### GET /rest-api/bid-floor/placement/{placementId}.do [Request examples](https://epom.com/ad-server/docs/api/pricing/get-bid-floor-placement.md) Get placement bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `placementId` | path | integer | yes | Unique numeric identifier of the placement whose bid floor configuration should be retrieved | **Responses:** `200` — Placement bid floor retrieved successfully · `404` — Not found — resource does not exist. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### POST /rest-api/bid-floor/placement/{placementId}/delete.do [Request examples](https://epom.com/ad-server/docs/api/pricing/post-bid-floor-placement-delete.md) Delete placement bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `placementId` | path | integer | yes | Unique numeric identifier of the placement whose bid floor entry should be deleted | | `country` | form | string | yes | ISO alpha-2 country code (e.g., 'US', 'DE') of the bid floor to remove, or '*' to reset all country bid floors to zero | **Responses:** `200` — Placement bid floor deleted successfully · `404` — Not found — resource does not exist. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### POST /rest-api/bid-floor/placement/{placementId}/update.do [Request examples](https://epom.com/ad-server/docs/api/pricing/post-bid-floor-placement-update.md) Update placement bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `placementId` | path | integer | yes | Unique numeric identifier of the placement to set the bid floor for | | `country` | form | string | yes | ISO alpha-2 country code (e.g., 'US', 'DE') or '*' for the global default bid floor | | `bidFloor` | form | number | yes | Minimum bid floor price value as a decimal number (e.g., 0.50) | **Responses:** `200` — Placement bid floor updated successfully · `404` — Not found — resource does not exist. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### GET /rest-api/bid-floor/site/{siteId}.do [Request examples](https://epom.com/ad-server/docs/api/pricing/get-bid-floor-site.md) Get site bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `siteId` | path | integer | yes | Unique numeric identifier of the site whose bid floor configuration should be retrieved | **Responses:** `200` — Site bid floor retrieved successfully · `404` — Not found — resource does not exist. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### POST /rest-api/bid-floor/site/{siteId}/delete.do [Request examples](https://epom.com/ad-server/docs/api/pricing/post-bid-floor-site-delete.md) Delete site bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `siteId` | path | integer | yes | Unique numeric identifier of the site whose bid floor entry should be deleted | | `country` | form | string | yes | ISO alpha-2 country code (e.g., 'US', 'DE') of the bid floor to remove, or '*' to reset all country bid floors to zero | **Responses:** `200` — Site bid floor deleted successfully · `404` — Not found — resource does not exist. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### POST /rest-api/bid-floor/site/{siteId}/update.do [Request examples](https://epom.com/ad-server/docs/api/pricing/post-bid-floor-site-update.md) Update site bid floor. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `siteId` | path | integer | yes | Unique numeric identifier of the site to set the bid floor for | | `country` | form | string | yes | ISO alpha-2 country code (e.g., 'US', 'DE') or '*' for the global default bid floor | | `bidFloor` | form | number | yes | Minimum bid floor price value as a decimal number (e.g., 0.50) | **Responses:** `200` — Site bid floor updated successfully · `404` — Not found — resource does not exist. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### GET /rest-api/floorCPMs.do [Request examples](https://epom.com/ad-server/docs/api/pricing/get-floorcpms.md) Search CPM floor rates. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `campaignType` | query | integer | yes | Self-Serve campaign type ID (1=BANNER_DESKTOP, 2=BANNER_MOBILE, 3=BANNER_APPLICATION, 4=BANNER_NATIVE, 5=POP_UNDER, 6=INTERSTITIAL_MOBILE, 7=INTERSTITIAL_APPLICATION) | | `os` | query | integer | yes | Operating system ID, as listed by the operating-system targeting values | | `geo` | query | array<string> | no | Array of country codes, '*' being global | | `region` | query | integer | no | World region ID — resolves to constituent country codes | **Responses:** `200` — CPM floor rates retrieved successfully as a JSON array of CampaignCpmFloorRate objects · `500` — Internal server error during rate lookup · `503` — The geo service did not answer while resolving the region. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ### GET /rest-api/floorCPMs/suggest.do [Request examples](https://epom.com/ad-server/docs/api/pricing/get-floorcpms-suggest.md) Suggest CPM floor rate. | Parameter | In | Type | Required | Description | |---|---|---|---|---| | `campaignType` | query | string | yes | Self-serve campaign type. Accepts enum name or integer ID for backward compatibility Values: `BANNER_DESKTOP`, `BANNER_MOBILE`, `BANNER_APPLICATION`, `BANNER_NATIVE`, `POP_UNDER`, `INTERSTITIAL_MOBILE`, `INTERSTITIAL_APPLICATION`. | | `advertiser` | query | integer | yes | Unique numeric identifier of the advertiser whose CPM floor adjustment will be applied to the suggested rate | | `os` | query | string | no | Comma-separated operating system names or IDs (e.g. 'WINDOWS,ANDROID' or '1,5'). When omitted, all operating systems are included. | | `geo` | query | string | no | Comma-separated ISO 3166-1 alpha-2 country codes (e.g. 'US,GB,DE'). Prefix the entire value with '-' to exclude those countries instead of including them. Use '0' or '*' for global targeting. When omitted, all countries are included. | **Responses:** `200` — JSON object with 'SuggestedCPM' key containing the calculated floor rate value · `404` — Advertiser not found, campaign type not recognized, or no matching CPM rates exist · `500` — Internal server error during rate calculation. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes). ## Related - [REST API overview](https://epom.com/ad-server/docs/api.md) — authentication and conventions - [API endpoint reference by tag](https://epom.com/ad-server/docs/api/endpoints.md) - [Targeting, capping and limits via API](https://epom.com/ad-server/docs/api/targeting-capping-limits.md)