Получение информации о ценах

Метод используется для получения информации о ценах периодов и ресурсов, которые будут применяться к заказу. В зависимости от типа заказа order_type могут применяться цены тарифного плана или цены подписки:

SalesOrder — заказ на покупку: цены тарифного плана.
SwitchPlanOrder — заказ на переключение тарифного плана: цены тарифного плана.
RenewalOrder — заказ на продление:
- Если указана подписка, заказанная по индивидуальный ценам — индивидуальные цены подписки или цены тарифного плана в зависимости от параметров продления подписки (см. ).
- Если указана подписка, заказанная по ценам тарифного плана — цены тарифного плана.
ProlongOrder — заказ на пролонгацию: цены подписки.
ChangeOrder — заказ на изменение количества ресурсов: цены подписки.

GET {reseller_domain}/internal_api/prices

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
order_type	query	string	Обязательный	Тип заказа. Доступные значения: SalesOrder — заказ на покупку. SwitchPlanOrder — заказ на переключение тарифного плана. RenewalOrder — заказ на продление. ProlongOrder — заказ на пролонгацию. ChangeOrder — заказ на изменение количества ресурсов. В зависимости от типа заказа нужно также указать `plan_id` или `subscription_id`
plan_id	query	integer	Опциональный	ID тарифного плана, на который оформляется заказ. Обязательный для следующих типов заказа (`order_type`): SalesOrder — заказ на покупку. SwitchPlanOrder — заказ на переключение тарифного плана.
subscription_id	query	integer	Опциональный	ID подписки, для которой оформляется заказ. Обязательный для следующих типов заказа (`order_type`): SwitchPlanOrder — заказ на переключение тарифного плана. RenewalOrder — заказ на продление. ProlongOrder — заказ на пролонгацию. ChangeOrder — заказ на изменение количества ресурсов.

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

Название				Тип данных	Описание
data				object	Данные ответа
	attributes			object	Информация о периодах, ресурсах и ценах, которые будут применяться к заказу
		periods		array of objects	Информация о периодах тарифного плана и ценах, которые будут применяться к заказу
			id	integer	ID периода тарифного плана
			duration_value	integer	Длительность периода тарифного плана. Если период бессрочный, то `duration_value = null`
			duration_type	string	Единица измерения периода тарифного плана: day — день. month — месяц. year — год. Если период бессрочный, то `duration_type = null`
			endless	bool	Признак того, является ли период тарифного плана бессрочным: true — период является бессрочным. false — продолжительность периода ограничена и указана в `duration_value` и `duration_type`.
			trial	bool	Признак того, является ли период тарифного плана пробным: true — период является пробным. false — период является коммерческим.
			setup_fee	number	Стоимость установки
			recurring_fee	number	Ежемесячная стоимость
			renewal_fee	number	Стоимость продления
			transfer_fee	number	Стоимость переноса
			plan_currency_iso_code	string	Код валюты тарифного плана, в которой также указаны цены периода
		resources		array of objects	Информация о ресурсах тарифного плана и ценах, которые будут применяться к заказу
			plan_resource_id	integer	ID ресурса тарифного плана
			resource_id	integer	ID ресурса в шаблоне услуги
			name	string	Название ресурса
			unit_of_measure	string	Единица измерения ресурса: unit — измеряемый ресурс, для которого указывается определенное количество. boolean — неизмеряемый ресурс (для ресурсов, у которых не надо указывать количество), возможные значения: true — ресурс включен в тарифный план. false — ресурс не включен в тарифный план.
			setup_fee	number	Стоимость установки
			recurring_fee	number	Ежемесячная стоимость
			renewal_fee	number	Стоимость продления
			overuse_fee	number	Стоимость перерасхода
			included	integer	Количество ресурса, включенное в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки)
			minimum	integer	Минимальное количество ресурса (с учетом `included`), обязательное для заказа
			limit	integer	Максимальное количество ресурса, доступное для заказа. Если максимальное количество ресурса не ограничено (`unlimited_units = true`), то `limit = 0`
			priority	integer	Приоритет ресурса. У основного ресурса `priority` максимальный
			unlimited_units	bool	Признак безлимитного ресурса: true — максимальное количество ресурса не ограничено. false — максимальное количество ресурса указано в `limit`.
			plan_currency_iso_code	string	Код валюты тарифного плана, в которой также указаны цены ресурса

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/prices?plan_id=5851&subscription_id=3010623&order_type=SwitchPlanOrder' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": {
        "attributes": {
            "periods": [
                {
                    "id": 10309,
                    "duration_value": 1,
                    "duration_type": "month",
                    "endless": false,
                    "trial": false,
                    "setup_fee": 0,
                    "recurring_fee": 0,
                    "renewal_fee": 0,
                    "transfer_fee": 0,
                    "plan_currency_iso_code": "USD"
                }
            ],
            "resources": [
                {
                    "resource_id": 273,
                    "plan_resource_id": 22722,
                    "name": "License",
                    "unit_of_measure": "unit",
                    "included": 0,
                    "minimum": 0,
                    "limit": 1500,
                    "priority": 0,
                    "unlimited_units": false,
                    "plan_currency_iso_code": "USD",
                    "setup_fee": 0,
                    "recurring_fee": 543,
                    "renewal_fee": 0,
                    "overuse_fee": 0
                }
            ]
        }
    }
}