Tariff — информация о тарифах сервиса, доступных абоненту.

Дата последней модификации страницы: 03.03.2023

Методы группы Tariff внешнего программного интерфейса Менеджера сервиса предназначены для получения информации о тарифах сервиса, доступных абоненту.

Сводка по методам

Метод

Примечание

root

list

Возвращает список доступных абоненту тарифов.

info

Возвращает информацию об указанном тарифе.

tariff/list

Метод возвращает список тарифов, доступных абоненту.

ПараметрТипОписаниеПример
Запрос
name *Строка переменная (150)Фильтр по наименованию тарифаОсновной
scope *Массив из Строка переменная (255)

Параметры получения данных:

  • is_payable – признак вывода только платных тарифов
  • validity_periods – включать периоды действия
  • is_extension – только тарифы с типом "Расширение"

["is_payable",
"validity_periods"]

available_tariffs ** Массив из Строка переменная (9)Отбор доступных тарифов["000000002","000000003"]
Ответ:  tariff  (0..*)
idСтрока переменная (9)Код тарифа000000001
nameСтрока переменная (150)Наименование тарифаОсновной тариф
updated *Дата и время в строке формата ISOДата изменения
start *Дата в строке формата ISO (без времени)Начало действия
expiration *Дата в строке формата ISO (без времени)Окончание действия
description *Строка неограниченной длиныОписание
prolongation_validity *Число (+10.0)Число дней действия продлевающей подписки3
extension_validity *Число (+10.0)Число дней действия расширяющей подписки3
prolongation_during *Число (+10.0)Число дней для создания продлевающей подписки после завершения основной7
is_extensionБулевоЭто расширение тарифаfalse
is_payableБулевоЭто платный тарифtrue
is_trialБулевоЭто тестовый тарифfalse
payment_by_periodsБулевоЭто тариф с периодической оплатойfalse
periods_frequency *Строка неограниченной длиныПериодичность оплаты тарифаmonth
has_condition *БулевоЕсть условиеtrue
validity_periodsСписок (0..*)Периоды действия тарифа
  - idСтрока переменная (10)Код периода1YR
  - nameСтрока переменная (50)Наименование периода1 год
  - quantityЧисло (+10.0)Количество периодов1
  - cost *Число (+10.2)Стоимость1500
  - comment *Строка переменная (1024)КомментарийКомментарий периода действия
  - periodСтрока неограниченной длиныТип периода действияyear
Пример запроса  Развернуть 
{
  "auth": {
    "account": 1010
  },
  "scope": ["is_payable", "validity_periods"],
  "general": {
    "type": "usr",
    "method": "tariff/list",
    "debug": true
   }
}
Пример ответа  Развернуть 
{
  "tariff": [
    {
      "id": "000000001",
      "name": "Основной тариф",
      "updated": "0001-01-01T00:00:00",
      "start": "0001-01-01T00:00:00",
      "expiration": "0001-01-01T00:00:00",
      "description": "",
      "prolongation_validity": 3,
      "extension_validity": 3,
      "prolongation_during": 7,
      "is_extension": false,
      "is_payable": true,
      "is_trial": false,
      "payment_by_periods": false,
      "periods_frequency": "month",
      "has_condition": true,
      "validity_periods": [
        {
          "id": "1YR",
          "name": "1 год",
          "quantity": 1,
          "cost": 1500,
          "comment": "Комментарий периода действия",
          "period": "year"
        }
      ]
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 19,
    "sm_version": "1.1.9.1",
    "sm_timezone": "Europe/Moscow"
  }
}
Пример запроса
{
"auth": {
"account": 1010
},
"general": {
   "type": "usr",
   "method": "tariff/list",
   "debug": true
  }
}

 Вверх

tariff/info

Метод возвращает информацию об указанном тарифе.

ПараметрТипОписаниеПример
Запрос
idСтрока переменная (9)Код тарифа000000001
Ответ: tariff
idСтрока переменная (9)Код тарифа000000001
nameСтрока переменная (150)Наименование тарифаОсновной тариф
start *Дата в строке формата ISO (без времени)Начало действия01.01.0001 0:00:00
expiration *Дата в строке формата ISO (без времени)Окончание действия01.01.0001 0:00:00
description *Строка неограниченной длиныОписание
prolongation_validity *Число (+10.0)Число дней действия продлевающей подписки3
extension_validity *Число (+10.0)Число дней действия расширяющей подписки3
prolongation_during *Число (+10.0)Число дней для создания продлевающей подписки после завершения основной7
is_extensionБулевоЭто расширение тарифаНет
is_payableБулевоЭто платный тарифДа
payment_by_periodsБулевоЭто тариф с периодической оплатойДа
periods_frequency *Строка неограниченной длиныПериодичность оплаты тарифаmonth
has_condition *БулевоЕсть условиеДа
condition *СтруктураУсловие использования
  - code *Число (+9.0)Код условия1
  - name *Строка переменная (120)Наименование условияПример наименования условия
  - description *Строка неограниченной длиныОписание условияПример описания условия
description_for_subscribers*
Информация для абонентов
  - html *Строка неограниченной длиныHTML-код описания для абонентов

<html><body><img src="image001?_=1695404209"/><p>Пример описания тарифа</p></body></html>

  - imagesСписок (0..*)Картинки описания
      - nameСтрока переменная (255)Имя картинкиimage001
      - dataДвоичные данные размером до 1048576 байт в строке Base64Данные картинки, размер до 1 Мб89 50 4E 47 0D 0A 1A 0A 00 00 00 0D 49 48 44 52 00 00 00 10 00 00 00 10 08 06 00 00 00 1F F3 FF 61 0...
servicesСписок (0..*)Предоставляемые услуги
  - idСтрока переменная (9)Код услуги000000001
  - nameСтрока переменная (100)Наименование услугиКоличество прав пользователей на запуск приложений
  - provider_nameСтрока переменная (150)Наименование поставщика услугиМенеджер сервиса
  - provider_idСтрока переменная (50)Идентификатор поставщика услугиsm
  - description *Строка неограниченной длиныОписание
  - amount *Число (+10.0)Количество предоставляемых лицензий10
  - extend_amount *Число (+10.0)Количество лицензий, которое может быть предоставлено расширяющей подпиской5
  - typeСтрока неограниченной длиныТип услугиlimited
extensionsСписок (0..*)Доступные тарифы расширения
  - idСтрока переменная (9)Код тарифа000000002
  - nameСтрока переменная (150)Наименование тарифаОсновной тариф
applicationsСписок (0..*)Виды приложений
  - nameСтрока переменная (64)Наименование вида приложенийРабота в модели сервиса
  - idСтрока переменная (22)Код вида приложенийmt
  - description *Строка неограниченной длиныОписание вида приложений
validity_periodsСписок (0..*)Периоды действия тарифа
  - idСтрока переменная (10)Код периода1YR
  - nameСтрока переменная (50)Наименование периода1 год
  - quantityЧисло (+10.0)Количество периодов1
  - cost *Число (+10.2)Стоимость1 500
  - comment *Строка переменная (1024)КомментарийКомментарий периода действия
  - periodСтрока неограниченной длиныТип периода действияyear

Возможные значения поля type:

  • unlimited - Безлимитная
  • limited - Лимитированная
  • unique - Уникальная

Пример запроса
{
"id": "000000001",
"auth": {
"account": 1010
},
"general": {
"version": 8,
"type": "usr",
"method": "tariff/info",
"debug": true
}
}


Пример ответа
{
"tariff": {
"id": "000000001",
"name": "Основной тариф",
"start": "0001-01-01T00:00:00",
"expiration": "0001-01-01T00:00:00",
"description": "",
"prolongation_validity": 3,
"extension_validity": 3,
"prolongation_during": 7,
"is_extension": false,
"is_payable": true,
"payment_by_periods": true,
"periods_frequency": "month",
"has_condition": true,
"condition": {
"code": 1,
"name": "Пример наименования условия",
"description": "Пример описания условия"
},
"description_for_subscribers": {
"html": "<html>\n<head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n<meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\" />\n<meta name=\"format-detection\" content=\"telephone=no\" />\n<style type=\"text/css\">\nbody{margin:0;padding:8px;}\np{line-height:1.15;margin:0;white-space:pre-wrap;}\nol,ul{margin-top:0;margin-bottom:0;}\nimg{border:none;}\nli>p{display:inline;}\n</style>\n</head>\n<body>\n</body>\n</html>"Пример описания тарифа",
"images": [
{
"name": "image001",
"data": ""
}
]
},
"services": [
{
"id": "000000001",
"name": "Количество прав пользователей на запуск приложений",
"provider_name": "Менеджер сервиса",
"provider_id": "sm",
"description": "",
"amount": 10,
"extend_amount": 5,
"type": "limited"
}
],
"extensions": [
{
"id": "000000002",
"name": "Расширение основного тарифа"
}
],
"applications": [
{
"name": "Работа в модели сервиса",
"id": "mt",
"description": ""
}
],
"validity_periods": [
{
"id": "1YR",
"name": "1 год",
"quantity": 1,
"cost": 1500,
"comment": "Комментарий периода действия",
"period": "year"
}
]
},
"general": {
"response": 10200,
"error": false,
"message": "",
"version": 8,
"sm_version": "1.0.94.2",
"sm_timezone": "Europe/Moscow"
}
}

 Вверх