Set Placement Pricing

Set Pricing model for a given Placement.

Requires ENABLED level on SITE_PAYMENT_MODEL permission.

URL: /rest-api/placements/{placementId}/pricing.do

Method: POST

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • placementId – a given Placement ID.
  • paymentModel – one of the following JSON parameters: FIXED_CPM, FIXED_CPC.
    Example:
    {"paymentModel":"FIXED_CPM","price":10.0,"countryPricing":[{"TT":3.0},{"US":5.0},...]} - fixed pricing model{"revenueShare":90, "advertiserPricing":[{"advertiserId":208, "revenueShare":75.0},{"advertiserId":180, "revenueShare":85.0}]} - revenue share model.

Update the Country Pricing

Updates the Country Pricing for the given Placement.
Requires ENABLED level on SITE_PAYMENT_MODEL permission.

URL: /rest-api/placements/{placementId}/pricing/{countryCode}.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters, no Placement or Country with such code exists, or Pricing disabled for the given Placement.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Request parameters:

  • placementId – ID of Placement;
  • countryCode – ISO Country code. To pass multiple Country codes use: "UK, US, CA".
  • price – Price value as a double.
  • actionId – Action ID or null.

Parameters:

  • hash – a MD5 digest of concatenated username's MD5 password and the given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Remove Country Pricing

Requires ENABLED level on SITE_PAYMENT_MODEL permission.

URL: /rest-api/placements/{placementId}/pricing/{countryCode}.do

Method: DELETE

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters, no Placement or Country with such code exists, or Pricing disabled for the given Placement.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Request parameters:

  • placementId – ID of Placement;
  • countryCode – ISO Country code. To pass multiple Country codes use: "UK, US, CA".
  • actionId – Action ID or

Parameters:

  • hash – a MD5 digest of concatenated username's MD5 password and the given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.