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

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

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

МетодНазначение
tariff/infoИнформация о тарифе провайдера
tariff/listСписок тарифов провайдера

tariff/info

Информация о тарифе провайдера

ПараметрТипОписаниеПример
Запрос
idСтрока переменная (9)Код тарифа000000001
Ответ: tariff (1)
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
typeСтрока (перечисление)Тип тарифа:
  • basic (Основной)
  • extension (Расширение)
  • upgrade (Апгрейд)
basic
is_payableБулевоЭто платный тарифtrue
is_trialБулевоЭто тестовый тарифfalse
payment_by_periodsБулевоЭто тариф с периодической оплатойfalse
periods_frequency *Строка неограниченной длиныПериодичность оплаты тарифаmonth
has_condition *БулевоЕсть условиеtrue
condition *
Условие использованияПример описания условия
  - code *Число (+9.0)Код условия1
  - name *Строка переменная (120)Наименование условияПример наименования условия
  - description *Строка неограниченной длиныОписание условияПример описания условия
description_for_subscribers *
Информация для абонентов
  - html *Строка неограниченной длиныHTML-код описания для абонентов

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

  - imagesСписок (0..*)Картинки описания
  - images.nameСтрока переменная (255)Имя картинкиimage001
  - images.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)Наименование услугиКоличество прав пользователей на запуск приложений
  - service_idСтрока переменная (50)Идентификатор услугиКоличествоПравПользователейНаЗапускПриложений
  - provider_nameСтрока переменная (150)Наименование поставщика услугиМенеджер сервиса
  - provider_idСтрока переменная (50)Идентификатор поставщика услугиsm
  - description *Строка неограниченной длиныОписание
  - typeСтрока (перечисление)Тип услуги:
  • limited (Лимитированная)
  • unique (Уникальная)
  • unlimited (Безлимитная)
limited
  - amount *Число (+10.0)Количество предоставляемых лицензий10
  - extend_amount *Число (+10.0)Количество лицензий, которое может быть предоставлено расширяющей подпиской5
applicationsСписок (1..*)Виды приложенийРабота в модели сервиса
  - nameСтрока переменная (150)Наименование вида приложенияРабота в модели сервиса
  - idСтрока переменная (22)Код вида приложенияmt
  - description *Строка неограниченной длиныОписание вида приложения
validity_periodsСписок (0..*)Периоды действия тарифа
  - idСтрока переменная (10)Код периода1YR
  - nameСтрока переменная (50)Наименование периода1 год
  - quantityЧисло (+10.0)Количество периодов1
  - cost *Число (+10.2)Стоимость1500
  - comment *Строка переменная (1024)КомментарийКомментарий периода действия
  - periodСтрока (перечисление)Тип периода действия:
  • day (День)
  • decade (Декада)
  • half_year (Полугодие)
  • month (Месяц)
  • quarter (Квартал)
  • week (Неделя)
  • year (Год)
year
extensionsСписок (0..*)Расширения тарифа
  - idСтрока переменная (9)Код тарифа000000002
  - nameСтрока переменная (150)Наименование тарифаРасширение тарифа
notification_periodsСписок (0..*)Периоды оповещений об окончании подписки7
  - days_quantity *Число (2.0)Количество дней7
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/tariff/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "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,
    "type": "basic",
    "is_payable": true,
    "is_trial": false,
    "payment_by_periods": false,
    "periods_frequency": "month",
    "has_condition": true,
    "condition": {
      "code": 1,
      "name": "Пример наименования условия",
      "description": "Пример описания условия"
    },
    "description_for_subscribers": {
      "html": "Пример описания тарифа",
      "images": [
        {
          "name": "image001",
          "data": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAACHUlEQVQ4jX2Tz2sT\r\ncRDFP9nvtt1N0qQ1m0aINTFSaCEtAa9tMf9DbvZkpXiw4EHw1Is9lYqHehAEPeUi\r\nFPofCJaePKgQocW2uFpLaZrVVJfspt3NeugPNpvowFzem/dmmGFCkTtPCEQKKAFT\r\nwPVzTAfWgVWgBmCWFwCQA+IHok+5N5gbSalaMi4rqgLgWI1Co1a9Xf+6e99t2q+A\r\n5xcCv8Hj/vTwXGIsn5GELPyuPZGoGo9E1di1zFBts/Lwz/5eGFgCkM5r5vvTw3PJ\r\nfCHnF0+mY0ymY5dGISFEMl/I9aeH56Izi/MXBproU2a10fEMHvjz6XSW5aksQVwb\r\nHc/IfcpsdGYxJQOlgRs3hxBCeIGFPHqnw7muLYQQ8dxIytislGRgWk0kB7qU4V1i\r\nnZya0OLAlAxkZSWsdKlhpZjD8+BW+VMHJythBcgEz9gWPVLo32Sr5QGnEqA7VsMO\r\nLqptoi6cY9tNYF8C1q3aUf1/k3QLyzg6BjYkYLX+bbfachzX8zz8+eHQ5GPVJIi3\r\nHMet6zuHwKronSg2PNfpcZv2WDh5ddDfZW3bYG3b6OhubFX0Zv3nC7O88Fb0ThQB\r\n3p+Yv1XHtnPqFS0WkiSpQwV4rusaWxXdPPjx0iwvPIP2X1gyD/Ysy6jeHciOpJSE\r\nFj87b8tzLMu2ftWOj/WdqnvSfA2sXIiCZ1xxT5pvjC+fS8A0kAFOge/ABmfvfOQX\r\n/AXZ2ePwCmgSWAAAAABJRU5ErkJggg=="
        }
      ]
    },
    "services": [
      {
        "id": "000000001",
        "name": "Количество прав пользователей на запуск приложений",
        "service_id": "КоличествоПравПользователейНаЗапускПриложений",
        "provider_name": "Менеджер сервиса",
        "provider_id": "sm",
        "description": "",
        "type": "limited",
        "amount": 10,
        "extend_amount": 5
      }
    ],
    "applications": [
      {
        "name": "Работа в модели сервиса",
        "id": "mt",
        "description": ""
      }
    ],
    "validity_periods": [
      {
        "id": "1YR",
        "name": "1 год",
        "quantity": 1,
        "cost": 1500,
        "comment": "Комментарий периода действия",
        "period": "year"
      }
    ],
    "extensions": [
      {
        "id": "000000002",
        "name": "Расширение тарифа"
      }
    ],
    "notification_periods": [
      {
        "days_quantity": 7
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

tariff/list

Список тарифов провайдера

ПараметрТипОписаниеПример
Запрос
name *Строка переменная (150)Фильтр по наименованию тарифаОсновной
scope *Массив из Строка (перечисление)Параметры получения данных:
  • is_extension (Только тарифы с типом "Расширение")
  • is_payable (Только платные тарифы)
  • services (Включать услуги)
  • validity_periods (Включать периоды действия)
["is_payable","validity_periods","services","is_extension"]
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
typeСтрока (перечисление)Тип тарифа:
  • basic (Основной)
  • extension (Расширение)
  • upgrade (Апгрейд)
basic
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Строка (перечисление)Тип периода действия:
  • day (День)
  • decade (Декада)
  • half_year (Полугодие)
  • month (Месяц)
  • quarter (Квартал)
  • week (Неделя)
  • year (Год)
year
servicesСписок (0..*)Предоставляемые услуги
  - idСтрока переменная (9)Код услуги000000001
  - nameСтрока переменная (100)Наименование услугиКоличество прав пользователей на запуск приложений
  - service_idСтрока переменная (50)Идентификатор услугиКоличествоПравПользователейНаЗапускПриложений
  - provider_nameСтрока переменная (150)Наименование поставщика услугиМенеджер сервиса
  - provider_idСтрока переменная (50)Идентификатор поставщика услугиsm
  - description *Строка неограниченной длиныОписание
  - typeСтрока (перечисление)Тип услуги:
  • limited (Лимитированная)
  • unique (Уникальная)
  • unlimited (Безлимитная)
limited
  - amount *Число (+10.0)Количество предоставляемых лицензий10
  - extend_amount *Число (+10.0)Количество лицензий, которое может быть предоставлено расширяющей подпиской5
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/tariff/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "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,
      "type": "basic",
      "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"
        }
      ],
      "services": [
        {
          "id": "000000001",
          "name": "Количество прав пользователей на запуск приложений",
          "service_id": "КоличествоПравПользователейНаЗапускПриложений",
          "provider_name": "Менеджер сервиса",
          "provider_id": "sm",
          "description": "",
          "type": "limited",
          "amount": 10,
          "extend_amount": 5
        }
      ]
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх