Skip to main content
POST
Upgrade viewers
  1. Get a quote for the new total viewer limit.
  2. Send the same target_viewers and the quoted amount as max_amount.
  3. Read the actual cost from amount and the payment ID from payment_id.
If the cost exceeds max_amount, the API returns 409 price_changed without applying the upgrade. Request a new quote before trying again. Omit max_amount or pass null to allow the upgrade without a spending limit. The new viewer limit also applies to future renewals. The upgrade does not extend the order duration. In the response, status: "completed" refers to the upgrade payment; the original order can continue running.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
enum<string>
default:en

The language of the response

Available options:
en,
ru

Path Parameters

orderId
integer<int64>
required

ID of the order to upgrade.

Required range: x >= 1

Body

application/json
target_viewers
integer
required

New total viewer limit. For example, send 200 to increase from 100 to 200 viewers. Must exceed the current limit and stay within the maximum allowed for the order.

Example:

200

max_amount
number | null

Maximum amount you agree to pay, in the quoted currency. If the cost exceeds this limit, the API returns 409 price_changed without applying the upgrade. Omit or pass null for no spending limit.

Required range: x >= 0
Example:

12.5

Response

Viewer limit increased successfully.

to_viewers
integer
required

New total viewer limit.

Example:

200

remaining_seconds
integer
required

Remaining order time in seconds.

Required range: x >= 0
Example:

3600

amount
number
required

Cost of the upgrade in the returned currency, including discounts.

Required range: x >= 0.01
Example:

12.5

currency
enum<string>
required
Available options:
usd,
rub
Example:

"usd"

payment_id
integer
required

ID of the upgrade payment.

Example:

12346

status
enum<string>
required

Status of the upgrade payment, not the original order.

Available options:
completed
Example:

"completed"