Получение списка наиболее доступных для заказа Тарифных планов

Метод позволяет получить Список тарифных планов, сгруппированных по категориям. При этом для каждого тарифного плана возвращается самый дешевый период тарифного плана с учетом стоимости установки. 

GET /api/v2/client/market.json


Метод не требует авторизации для его успешного выполнения.

Модель ответа

Название


Тип данных

Описание

all_plansarray of objectsИнформация о периодах Тарифных планов с наименьшей стоимостью

product_category_id

integer
ID Категории продукта, с которым связан Тарифный план
product_categorystringНазвание Категории продукта, с которым связан Тарифный план
product_idintegerID Продукта, с которым связан Тарифный план
productstringНазвание Продукта, с которым связан Тарифный план

plan_periods

array of objects

Параметры Тарифного плана








      

 		plan_idinteger

ID Тарифного плана

plan_period_idinteger

ID периода Тарифного плана

plan_namestring

Название Тарифного плана

plan_period_recurring_feefloat

Величина ежемесячной абонентской платы в рамках данного периода Тарифного плана

plan_period_setup_feefloat

Величину платежа за установку в рамках данного периода Тарифного плана

plan_period_durationfloat

Величина периода самого доступного для заказа Тарифного плана. Отображается в месяцах

plan_descriptionstring

Дополнительная информация о тарифном плане, которая отображается клиентам в Панели управления Клиента

sumstring

Стоимость самого доступного для заказа периода Тарифного плана с учетом стоимости установки (величина отображается вместе с валютой)

plan_custom_attributes array

Список публичных дополнительных параметров Тарифного плана (см. Настройка дополнительных параметров в ActivePlatform. Руководство по Панели управления Оператора):

plan_typestring

Тип Тарифного плана:

  • Application — Тарифный план, позволяющий заказать Подписку на Услугу.
  • Certificate — Тарифный план, позволяющий заказать Подписку на Сертификат.

plan_currency

stringКод валюты Тарифного плана

Пример запроса

GET http://billing.activeplatform.com:80/api/v2/client/market.json

Пример ответа

{
    "all_plans": [
        {
            "product_category_id": 551,
            "product_category": "default",
            "product_id": 521,
            "product": "Default",
            "plan_periods": [
                {
                    "plan_id": 1367,
                    "plan_period_id": 3062,
                    "plan_name": "Manual Provisioning",
                    "plan_period_recurring_fee": 10,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": 1,
                    "plan_description": "",
                    "sum": "$10.00",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "USD"
                },
                
                {
                    "plan_id": 1391,
                    "plan_period_id": 3119,
                    "plan_name": "CSP_annual",
                    "plan_period_recurring_fee": 0,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": 12,
                    "plan_description": "billing csp annual",
                    "sum": "0.00 бел. руб.",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "BYN"
                },
                {
                    "plan_id": 1401,
                    "plan_period_id": 3124,
                    "plan_name": "Dr.Web Free",
                    "plan_period_recurring_fee": 0,
                    "plan_period_setup_fee": 1,
                    "plan_period_duration": null,
                    "plan_description": "",
                    "sum": "1.00 руб.",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "RUB"
                },
                {
                    "plan_id": 1625,
                    "plan_period_id": 3419,
                    "plan_name": "New plan test product",
                    "plan_period_recurring_fee": 0,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": null,
                    "plan_description": "",
                    "sum": "0.00 руб.",
                    "plan_custom_attributes": [
                        {
                            "key": "product_line",
                            "value": ""
                        }
                    ],
                    "plan_type": "application",
                    "plan_currency": "RUB"
                }
            ]
        },
        {
            "product_category_id": 552,
            "product_category": "test",
            "product_id": 500,
            "product": "default",
            "plan_periods": [
                {
                    "plan_id": 1437,
                    "plan_period_id": 3208,
                    "plan_name": "Default product test category",
                    "plan_period_recurring_fee": 1,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": 1,
                    "plan_description": "",
                    "sum": "1.00 €",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "EUR"
                }
            ]
        }
    ]
}