Внутреннее служебное имя. Используется для получения значений по умолчанию из обработчика.
project
Положительное целое число
нет
Провайдер тарифного плана.
processingmodule
Положительное целое число
нет
Обработчик услуг, подключённый к тарифному плану.
billdaily
Флаг
нет
Ежедневное списание. При включении оплата снимается ежедневно пропорционально стоимости дня.
billhourly
Флаг
нет
Почасовое списание. Клиент получает права на запуск и остановку услуг.
billprorata
Флаг
нет
Календарное списание средств. Выравнивает срок действия услуги по календарному месяцу.
prorataday
Положительное целое число
нет
Переходный день для календарного списания средств.
autocalcday
Флаг
нет
Автоматический расчёт стоимости дня из стоимости месяца.
chargestoped
Флаг
нет
Списывать средства при остановке. При выключении клиент получает компенсацию за часы простоя.
quickorder
Флаг
нет
Быстрый заказ. Включает возможность заказа услуги без указания параметров.
access
Положительное целое число
нет
Группа доступа. Выбор группы клиентов, для которой тариф доступен для заказа.
minperiodtype
Положительное целое число
нет
Тип минимального периода заказа.
minperiodlen
Положительное целое число
нет
Длина минимального периода.
trial
Положительное целое число
нет
Длина триального периода в днях.
trial_itemmax
Положительное целое число
нет
Максимальное количество триальных услуг для одного клиента.
itemmax
Положительное целое число
нет
Максимальное количество активных услуг для одного клиента.
suspendperiod
Положительное целое число
нет
Период автоудаления (дней).
suspendpenaltytype
Положительное целое число
нет
Тип штрафа за просрочку продления услуги. Принимает значения:
0 — без штрафа;
1 — фиксированная сумма;
2 — процент от стоимости периода просрочки;
3 — продление с даты остановки.
suspendpenaltypercent
Строка
нет
Процент стоимости услуги, взимаемый как штраф.
changepolicy
Положительное целое число
нет
Политика смены тарифа. Принимает значения:
0 — изменение периода действия;
1 — доплата или возврат средств;
2 — смена тарифа запрещена;
3 — только доплата, при понижении нет возврата;
4 — полная оплата нового тарифа.
changeprolongpolicy
Положительное целое число
нет
Политика продления услуги на новый тарифный план. Принимает значения:
0 — с текущей даты;
1 — с даты, когда закончится срок действия услуги.
orderpolicy
Положительное целое число
нет
Политика заказа дополнительных ресурсов. Принимает значения:
0 — стоимость до окончания срока действия услуги;
1 — полная стоимость за период.
returnpolicy
Положительное целое число
нет
Политика отказа от дополнительных ресурсов. Принимает значения:
0 — возврат средств;
1 — без возврата средств;
2 — изменение при продлении.
opennotify
Положительное целое число
нет
Шаблон уведомления об открытии услуги. Принимает значение в зависимости от настроенных шаблонов.
license
Положительное целое число
нет
Шаблон условий предоставления услуг. Принимает значение в зависимости от настроенных шаблонов.
pricelist_group
Положительное целое число
нет
Группа тарифа. Принимает значение в зависимости от настроенных групп.
orderpriority
Положительное целое число
нет
Приоритет тарифа при сортировке (по возрастанию).
show_addon_image
Флаг
нет
Отображать иконки ресурсов. Принимает значения:
no — использовать настройки типа продукта;
off — не отображать иконки;
on — отображать иконки.
description
Строка
нет
HTML-описание тарифного плана.
description_markdown
Строка
нет
Markdown-описание тарифного плана.
siteinfo
Строка
нет
Служебная информация для интеграции с внешним сайтом (витриной).
label
Строка
нет
Метки тарифа для фильтрации. Каждая метка указывается с новой строки.
allownosuitable
Флаг
нет
Разрешить заказ при отсутствии свободных ресурсов. Принимает значения on и off.
nostopholidays
Флаг
нет
Переопределить политику остановки услуг в выходные. Принимает значения:
no — использовать настройки типа продукта;
off — останавливать услуги;
on — не останавливать услуги.
allowpostpaid
Флаг
нет
Разрешить списание средств за перерасход без учёта баланса. Принимает значения on и off.
restrictclientchange
Флаг
нет
Может ли клиент изменять ресурс после заказа. Принимает значения on и off.
create_addon
Флаг
нет
Автоматически создать все доступные дополнения при создании тарифа. Принимает значения on и off.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Удалить тарифный план
Функция: pricelist.delete
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Удалить.
Поддерживает удаление нескольких тарифных планов через запятую.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id тарифных планов через запятую. Например, 12,34,56.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Скопировать выделенный тариф
Функция: pricelist.clone
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Клон.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
да
id тарифного плана для копирования.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Импортировать тариф со стороннего сервера
Функция: pricelist.import
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Импорт.
Загрузка конфигурации тарифного плана с внешнего сервера.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
url
Строка
да
URL-адрес удалённого сервера для импорта.
auth
Строка
нет
Данные авторизации на удалённом сервере.
Экспортировать тарифные планы
Функция: pricelist.export
Результат: данные о тарифных планах, их стоимости, дополнениях и параметрах в формате JSON или XML
Функция недоступна в веб-интерфейсе платформы. Платформа использует этот запрос для автоматической выгрузки информации о тарифах на витрину провайдера. По умолчанию функцию можно вызвать без авторизации, поэтому витрина получает данные без логина и пароля.
Функция возвращает:
основные характеристики тарифного плана: идентификатор, наименование и описание;
стоимость услуги для разных периодов оплаты и прямые ссылки для заказа;
стоимость продления и платы за установку, если они заданы в тарифе;
ссылки для быстрого заказа через корзину или оплату, если эта функция включена;
дата окончания пробного периода, если тариф его предусматривает;
дата-центры для создания услуги;
список доступных дополнений и их параметры;
параметры типа продукта для выбора при оформлении заказа;
ссылки на политику конфиденциальности и пользовательское соглашение провайдера.
Уровень доступа: без авторизации, user, admin. Если включена опция PricelistsAccessOnlyRegistered — user, admin.
Состав выгрузки зависит от уровня доступа:
без авторизации — тарифы одного провайдера. Платформа определяет провайдера по параметру project или домену запроса. Домен сравнивается с полем URL биллинга в настройках провайдера. Если провайдер не определён, функция возвращает пустой список. Тарифы с ограниченным доступом по группам клиентов в выгрузку не попадают;
user — тарифы провайдеров, к которым относится клиент. Тарифы с ограниченным доступом по группам клиентов выгружаются с учётом групп клиента;
admin — тарифы всех провайдеров платформы или провайдера из параметра elid.
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
нет
Идентификатор провайдера в платформе. В запросе без авторизации не учитывается.
project
Положительное целое число
нет
Идентификатор провайдера для запроса без авторизации. Если параметр не указан, платформа определяет провайдера по домену запроса.
onlyavailable
Флаг
нет
Значение on ограничивает вывод активными тарифами, доступными для заказа текущему пользователю. Тарифы без подходящего обработчика в вывод не попадают.
pricelist
Строка (список)
нет
Идентификаторы тарифных планов через запятую. Платформа вернёт данные только по указанным тарифам.
itemtype
Строка
нет
Идентификатор или внутреннее имя типа продукта. Например, vds. Платформа вернёт тарифы только этого типа. Не учитывается, если указан параметр pricelist.
exclude_pricelist
Строка (список)
нет
Идентификаторы тарифных планов через запятую для исключения из вывода.
addonitemtype
Строка (список)
нет
Идентификаторы типов продуктов дополнений через запятую. Платформа выведет только дополнения указанных типов.
compound_child
Флаг
нет
Значение on выводит дополнения, входящие в составное дополнение, только внутри него. Без флага такие дополнения выводятся и в общем списке дополнений тарифа.
othercurrency
Строка (список)
нет
Коды валют ISO через пробел. Например, USD EUR. Платформа пересчитает цены в эти валюты по текущему курсу. Если у тарифа уже задана цена в указанной валюте, она выводится без пересчёта.
show_tax
Флаг
нет
Значение on выводит стоимость с учётом налога и добавляет к ценам ставку, сумму и признак начисления налога сверх цены.
out
Строка
да
Формат вывода данных. Возможные значения: json или xml.
Добавьте в конфигурационный файл платформы /usr/local/mgr5/etc/billmgr.conf строку Option PricelistsAccessOnlyRegistered;
Перезапустите платформу:
/usr/local/mgr5/sbin/mgrctl -m billmgr exit.
После перезапуска платформа отклоняет запросы без авторизации. Опция также закрывает функцию расчёта стоимости pricelist.calculate.
Если витрина провайдера выгружает тарифы через pricelist.export, после включения опции она должна передавать в запросе данные авторизации, например параметр authinfo с логином и паролем клиента. Выгрузка в этом случае учитывает провайдеров и группы этого клиента. Не используйте для витрины учётную запись администратора.
Ошибки
если в параметре pricelist указан несуществующий тариф или тариф другого провайдера, платформа возвращает ошибку в значении параметра pricelist;
если указан onlyavailable=on, а тариф из параметра pricelist неактивен или недоступен для заказа, платформа возвращает ошибку;
если клиенту заблокирован заказ услуг из-за задолженности, функция возвращает ошибку "Сначала необходимо погасить задолженность".
Включить тарифный план
Функция: pricelist.resume
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Вкл.
Активирует тарифный план для заказа. Поддерживает групповую операцию.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id тарифных планов через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Выключить тарифный план
Функция: pricelist.suspend
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Выкл.
Деактивирует тарифный план. Поддерживает групповую операцию.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id тарифных планов через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Содержание тарифного плана
Функция: pricelist.detail
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг.
Возвращает список конфигурируемых дополнений (ресурсов), привязанных к тарифному плану.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор дополнения.
name
Строка
нет
Наименование дополнения.
price
Строка
нет
Цены дополнения.
orderpriority
Положительное целое число
нет
Приоритет дополнения при сортировке (по возрастанию).
status
Строка (перечисление)
нет
Состояние дополнения.
Редактирование ресурса
Функция: pricelist.detail.edit
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → список дополнений → кнопка Изменить.
Позволяет просмотреть, изменить или создать объект.
Уникальный идентификатор дополнения для редактирования.
billtype
Положительное целое число
нет
Тип учёта. Способ списания средств с клиента за дополнение. Принимает значения:
1 — не учитывать;
2 — на основе заказанных значений;
3 — на основе статистики;
5 — на основе значения других ресурсов.
chargestoped
Флаг
нет
При выключенном флаге клиент получает компенсацию за часы простоя остановленной услуги. Принимает значения on и off.
itemtype
Положительное целое число
нет
Тип дополнения. Определяет ресурс, который регулируется данным дополнением. Принимает значение в зависимости от настроек платформы.
addontype
Положительное целое число
нет
Тип значения. Способ задать значение дополнения к тарифу.Принимает значение в зависимости от настроек платформы.
scaletype
Положительное целое число
нет
Тип шкалы значений. Параметр используется при расчёте стоимости дополнения. Принимает значения:
0 — по ближайшему значению;
1 — за каждый шаг шкалы;
2 — по пакетам значений;
3 — по вариантам значений.
restrictclientchange
Строка (перечисление)
нет
Политика изменения клиентом ресурса после заказа. Принимает значения:
on — изменение запрещено;
off — изменение разрешено;
uponly — только повышение;
downonly —только понижение.
minperiodtype
Положительное целое число
нет
Минимальный период, по истечении которого клиент сможет изменить дополнение в сторону уменьшения.
minperiodlen
Положительное целое число
нет
Длительность минимального периода заказа дополнения.
manualprocessing
Флаг
нет
Для обработки ресурса будет создана задача для технического отдела. Принимает значения on и off.
manualprocessing_skipdefault
Флаг
нет
Если данная опция включена и для дополнения выбрано значение по умолчанию, то это дополнение не будет добавлено в задачу на ручную обработку. Принимает значения on и off.
manualname
Флаг
нет
При включённой опции в качестве наименования дополнения будет использовано значение, указанное в параметре name. Принимает значения on и off.
name
Строка
нет
Наименование тарифного плана или дополнения.
intname
Строка
нет
Служебное имя. Указывается при необходимости переопределить стандартное служебное имя для дополнения.
processing_feature
Строка
нет
Проверять возможность. При выборе дополнения с указанной возможностью будет выбран обработчик, у которого есть данная возможность.
roundtype
Положительное целое число
нет
Способ округления рассчитанного значения.
addonstattype
Положительное целое число
нет
Выберите, за какой период считать превышение.
addonstatcomparison
Положительное целое число
нет
Выберите, как считать, если параметров одного типа несколько. Принимает значения:
1 — суммировать;
2 — наибольшее значение.
addonstatcalculation
Положительное целое число
нет
Укажите, за что указана цена. Принимает значения:
0 — за каждую единицу;
1 — за единицу в месяц.
addonstatchargestoped
Флаг
нет
При включённой опции списания по данному дополнению будут идти и на остановленной услуге. Принимает значения on и off.
allowpostpaid
Флаг
нет
Опция разрешает списание средств за перерасход ресурса без учета баланса клиента. Принимает значения on и off.
summarizeinvoice
Флаг
нет
Суммировать значение параметра за весь период при генерации акта выполненных работ. Принимает значения on и off.
measure
Положительное целое число
нет
Единица измерения, в которой задается дополнение. Значения зависят от типа дополнения.
addonlimit
Положительное целое число
нет
Включено в тариф. Значение по умолчанию для дополнения.
addonstep
Положительное целое число
нет
Шаг заказа дополнения.
addonmin
Положительное целое число
нет
Минимальное значение для заказа. Не может быть меньше, чем включено в тариф.
addonmax
Положительное целое число
нет
Максимальное доступное для заказа значение ресурса.
addonlimittrial
Положительное целое число
нет
Включено в тариф на триальном периоде. Значение по умолчанию для дополнения на триальном периоде.
addonmaxtrial
Положительное целое число
нет
Максимальное доступное для заказа значение ресурса на триальном периоде.
enumeration
Положительное целое число
нет
Перечисление, из которого будут браться значения для дополнений к услугам.
enumerationitem
Положительное целое число
нет
Элемент перечисления, по умолчанию включённый при заказе услуги.
orderpolicy
Положительное целое число
нет
Стоимость при изменении. Определяет, как система рассчитывает новую стоимость после изменения дополнения.
addonbool
Флаг
нет
Значение по умолчанию для дополнения. Принимает значения on и off.
orderpriority
Положительное целое число
нет
Приоритет дополнения при сортировке (по возрастанию).
description
Строка
нет
HTML-описание дополнения.
description_markdown
Строка
нет
Markdown-описание дополнения.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Удалить дополнение
Функция: pricelist.detail.delete
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Удалить.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id дополнений через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Включить дополнение
Функция: pricelist.detail.resume
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Вкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id дополнений через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Выключить дополнение
Функция: pricelist.detail.suspend
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Выкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id дополнений через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Переместить дополнение вверх
Функция: pricelist.detail.up
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Вверх.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
да
id дополнения для перемещения.
Переместить дополнение вниз
Функция: pricelist.detail.down
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Вниз.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
да
id дополнения для перемещения.
Цены на дополнения
Цены при разных количествах
Функция: pricelist.detail.integer
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор записи цены.
value
Положительное целое число
нет
Количество ресурсов.
price
Строка
нет
Стоимость.
Специальная цена
Функция: pricelist.detail.integer.edit
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → кнопка Создать или кнопка Изменить.
Позволяет просмотреть, изменить или создать объект.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
plid
Положительное целое число
да
Уникальный идентификатор родительского дополнения (элемент id из функции pricelist.detail).
elid
Положительное целое число
нет
Уникальный идентификатор записи цены (элемент id из функции pricelist.detail.integer).
value
Положительное целое число
нет
Количество ресурсов, при достижении которого применяется специальная цена.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Удалить специальную цену
Функция: pricelist.detail.integer.delete
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → кнопка Удалить.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id записей цен через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Цены (для дополнений с типом "Перечисление")
Функция: pricelist.detail.enum
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор элемента.
name
Строка
нет
Наименование элемента.
price
Строка
нет
Цена элемента.
orderpriority
Положительное целое число
нет
Приоритет дополнения при сортировке (по возрастанию).
status
Строка (перечисление)
нет
Состояние элемента.
Включить элемент перечисления
Функция: pricelist.detail.enum.resume
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Вкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id элементов через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Выключить элемент перечисления
Функция: pricelist.detail.enum.suspend
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Выкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id элементов через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Переместить элемент перечисления вверх
Функция: pricelist.detail.enum.up
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Вверх.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
да
id элемента перечисления.
Переместить элемент перечисления вниз
Функция: pricelist.detail.enum.down
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Вниз.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
да
id элемента для перемещения.
Редактировать цену перечисления
Функция: pricelist.detail.enum.edit
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Изменить.
Управление стоимостью и приоритетом элементов перечисления.
Основное дополнение тарифного плана. При изменении параметра будет изменено значение зависимого дополнения.
base_value
Строка
нет
Значение основного дополнения, при котором будет изменено зависимое дополнение.
enumerationitem_base
Положительное целое число
нет
Значения, при выборе одного из которых будет изменено зависимое дополнение.
pricelist_reference
Положительное целое число
нет
Зависимое дополнение. Будет изменено при изменении основного дополнения.
reference_value
Строка
нет
Значение, которое будет выставлено для зависимого дополнения.
enumerationitem_reference
Положительное целое число
нет
Значения, которые будут доступны при изменении основного дополнения.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Копировать зависимость
Функция: pricelist.reference.clone
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Зависимости → кнопка Клон.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
да
id зависимости для клонирования.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Удалить зависимость
Функция: pricelist.reference.delete
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Зависимости → кнопка Удалить.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id зависимостей через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Правила смены тарифа
Функция: pricelist.change
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Смена тарифа.
Возвращает список тарифов, на которые возможен переход с текущего.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор правила.
name
Строка
нет
Наименование правила.
status
Строка (перечисление)
нет
Состояние правила.
Включить правило смены
Функция: pricelist.change.resume
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Смена тарифа → выберите новый тарифный план → кнопка Вкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id правил смены через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Выключить правило смены
Функция: pricelist.change.suspend
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Смена тарифа → выберите новый тарифный план → кнопка Выкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id правил смены через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Особые правила смены тарифа
Функция: pricelist.change.rule
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Смена тарифа → раздел Правила.
Возвращает список специальных условий для перехода на другой тариф.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор особого правила.
fromdate
Дата и время
нет
Дата начала действия правила.
todate
Дата и время
нет
Дата окончания действия правила.
period
Строка (перечисление)
нет
Период заказа.
discount
Положительное целое число
нет
Скидка, %.
Особое правило на смену тарифа
Функция: pricelist.change.rule.edit
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Смена тарифа → раздел Правила → кнопка Создать или кнопка Изменить.
Настройка временных рамок, периодов заказа и скидок для перехода.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
plid
Положительное целое число
да
Уникальный идентификатор родительского правила смены тарифа.
elid
Положительное целое число
нет
Уникальный идентификатор особого правила.
fromdate
Дата и время
нет
Дата начала периода, в течение которого правило действует для заказов.
todate
Дата и время
нет
Дата окончания периода, в течение которого правило действует для заказов.
period
Строка (перечисление)
нет
Период заказа. На разных периодах заказа (вечный, месяц и т.д.) можно настроить разные правила.
discount
Положительное целое число
нет
Размер скидки на новый тариф в процентах.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Удалить особое правило
Функция: pricelist.change.rule.delete
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Смена тарифа → раздел Правила → кнопка Удалить.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id особых правил через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Настройка правил заказа тарифа
Правила заказа тарифа
Функция: pricelist.orderreference
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Доступ.
Возвращает локальные правила заказа для конкретного тарифа.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор правила.
name
Строка
нет
Наименование правила.
status
Строка (перечисление)
нет
Состояние правила.
Включить правило заказа
Функция: pricelist.orderreference.resume
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Вкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id правил заказа через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Выключить правило заказа
Функция: pricelist.orderreference.suspend
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Выкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id правил заказа через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Правила заказа тарифа (тип продукта)
Функция: itemtype.orderreference
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы →выберите тарифный план → кнопка Доступ → выберите правило → кнопка Тарифы.
Позволяет ограничить заказ выбранного тарифного плана только для тех клиентов, которые уже имеют активные услуги других тарифов.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор правила.
name
Строка
нет
Наименование правила.
status
Строка (перечисление)
нет
Состояние правила.
Включить правило доступа
Функция: itemtype.orderreference.resume
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Тарифы → выберите правило → кнопка Вкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id правил доступа через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Выключить правило доступа
Функция: itemtype.orderreference.suspend
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Тарифы→ выберите правило → кнопка Выкл.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
да
Один или несколько id правил доступа через запятую.
sok
Строка
да
Значение ok подтверждает выполнение операции.
Обработчики
Подключение к обработчикам тарифного плана
Функция: pricelist.processing
Результат: список элементов
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Обработчики.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
нет
Уникальный идентификатор подключения.
name
Строка
нет
Наименование обработчика.
orderpriority
Положительное целое число
нет
Приоритет обработчика при сортировке (по возрастанию).
status
Строка (перечисление)
нет
Состояние обработчика.
Включить обработчик
Функция: pricelist.processing.resume
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Продукты → Тарифные планы → выберите тарифный план → кнопка Обработчики → выберите обработчик → кнопка Вкл.