×
 

Tariff plans list

This API allows you to retrieve a list of tariffs available for an account, including information about the currency, price, and description.

How to get data

Method

GET

Request address

To get the data, use the address: https://<server_address>/backend/api.php?

Request parameters

  • cmd=pricelist— command to get the list of tariffs
  • node — the number of the node where the command should be executed
  • coden (optional) — currency code:
    — numeric (e.g., 840 for USD, 810 for RUB)
    — alphabetic (e.g., USD or RUR)
 

Example request

https://<server_address>/backend/api.php?cmd=pricelist&coden=840&node=1
Response
{
  "code": 0,
  "data": [
    {
      "id": 143,
      "code": "840",
      "currency": 2,
      "descr": "3 dollars per property per month",
      "name": "US dollar",
      "price": "3.00"
    }
  ],
  "message": "OK"
}
In response to the API request, the following is returned:
  • code — request result code (0 = successful)
  • data — array of tariff objects:
  • id — unique tariff ID
  • code — currency code (numeric)
  • currency — internal currency ID
  • descr — tariff description
  • name — tariff name (e.g., "US dollar")
  • price — tariff price in the specified currency
  • message — text message with the result of the request