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

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

GET {reseller_domain}/internal_api/plans/{plan_id}

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

Авторизация

Требуется авторизация с помощью 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	Обязательный	Доменное имя реселлера
plan_id	path	integer	Обязательный	ID тарифного плана

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

Название					Тип данных	Описание
data					object	Данные ответа
	id				string	ID тарифного плана
	type				string	Тип данных
	attributes				object	Информация о тарифном плане (см. )
		created_at			string	Дата и время создания тарифного плана
		name			string	Название тарифного плана
		sku			string	SKU тарифного плана
		plan_currency_iso_code			string	Код валюты тарифного плана, в которой также указаны все суммы в ответе
		singleton			bool	Признак Единичный тарифного плана: true — аккаунт может иметь только одну подписку на этот тарифный план. false — аккаунт может иметь неограниченное количество подписок на этот тарифный план.
		fixed_price			bool	Признак Фиксированная цена тарифного плана: true — аккаунт получает возможность оплачивать подписку и заказывать дополнительные ресурсы по фиксированной цене, которая была установлена в тарифном плане на момент заказа подписки. Новая стоимость будет применена к подписке только после ее продления. false — цены тарифного плана не фиксируются.
		description			string	Дополнительная информация о тарифном плане
		icon_url			string	Ссылка на логотип тарифного плана
		billing_type			string	Тип биллинга тарифного плана. Подробно о типах биллинга см. и
		plan_periods			array of objects	Информация о периодах тарифного плана (см. )
			id		integer	ID периода тарифного плана
			duration_type		string	Единица измерения периода тарифного плана: day — день. month — месяц. year — год. Если период бессрочный, то `duration_type = null`
			duration_value		integer	Длительность периода тарифного плана. Если период бессрочный, то `duration_value = null`
			trial		bool	Признак того, является ли период тарифного плана пробным: true — период является пробным. false — период является коммерческим.
			endless		bool	Признак того, является ли период тарифного плана бессрочным: true — период является бессрочным. false — продолжительность периода ограничена и указана в `duration_value` и `duration_type`.
			setup_fee		number	Стоимость установки
			recurring_fee		number	Ежемесячная стоимость
			renewal_fee		number	Стоимость продления
			overuse_fee		number	Не используется
		plan_resources			array of objects	Информация о ресурсах тарифного плана (см. )
			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_class_data			object	Информация о связанном правиле предоставления услуги (см. )
			id		integer	ID правила предоставления услуги
			key		string	Ключ правила предоставления услуги
			name		string	Название правила предоставления услуги
			billing_day		integer	Финансовый день
			deletion_client_period		integer	Период удаления подписки для клиента (в сутках)
			change_resources_for_trial_subscription_by_manager		bool	Доступность изменения количества ресурсов в пробной подписке через Панель управления Оператора: true — изменение количества ресурсов доступно. false — изменение количества ресурсов недоступно.
			change_resources_for_trial_subscription_by_customer		bool	Доступность изменения количества ресурсов в пробной подписке через Панель управления Клиента: true — изменение количества ресурсов доступно. false — изменение количества ресурсов недоступно.
			increase_resources_immediate_switch_plan_order		bool	Доступность увеличения количества ресурсов в заказе при немедленном переключении тарифного плана: true — увеличение количества ресурсов доступно. false — увеличение количества ресурсов недоступно.
			decrease_resources_immediate_switch_plan_order		bool	Доступность уменьшения количества ресурсов в заказе при немедленном переключении тарифного плана: true — уменьшение количества ресурсов доступно. false — уменьшение количества ресурсов недоступно.
		available_account_types			array of objects	Список типов клиента, для которых доступен заказ подписки в рамках тарифного плана
			id		integer	ID типа клиента
			key		string	Ключ типа клиента
			name		string	Название типа клиента
			use_by_default		bool	Признак типа клиента, используемого по умолчанию для новых аккаунтов: true — тип клиента используется по умолчанию для новых аккаунтов. false — тип клиента не используется по умолчанию для новых аккаунтов. Только один тип клиента используется по умолчанию
		product			object	Информация о связанном продукте (см. )
			id		integer	ID продукта
			name		string	Название продукта
			product_type		string	Тип продукта
			description		string	Дополнительная информация о продукте
			vendor_name		string	Название вендора
			vendor_logo		object	Логотип вендора
				url	string	Ссылка на логотип вендора
			reseller_id		integer	ID реселлера
			product_category_id		integer	ID связанной категории продуктов (см. Получение списка категорий продуктов )
			created_at		string	Дата создания продукта
			updated_at		string	Дата последнего изменения продукта
			license_agreement		object	Лицензионное соглашение
				url	string	Ссылка на файл лицензионного соглашения
			privacy_policy		object	Политика конфиденциальности
				url	string	Ссылка на файл политики конфиденциальности
			public		bool	Признак того, что продукт опубликован и доступен для заказа: true — продукт опубликован и доступен для заказа. false — продукт не опубликован и недоступен для заказа.
			wizard_status		string	Статус оформления заказа
			wizard_step		string	Шаг оформления заказа
			ancestry		string	Для делегированных тарифных планов содержит список ID родительских тарифных планов, начиная от корневого
			external		bool	Признак того, что тарифный план получен из Vendor Portal: true — тарифный план получен из Vendor Portal. false — тарифный план создан в платформе.
			subscription_name_mask		string	Шаблон названия подписки
		addon			bool	Признак того, что это тарифный план-аддон: true — план-аддон. false — основной план.
		public			bool	Признак того, что тарифный опубликован: true — тарифный опубликован. false — тарифный не опубликован.
		status			string	Статус тарифного плана
		available_operations			object	Доступные действия для тарифного плана (см. )
			sale_by_manager		bool	Признак доступности создания заказа на покупку в Панели управления Оператора: true — действие доступно. false — действие недоступно.
			sale_by_account		bool	Признак доступности создания заказа на покупку в Панели управления Клиента: true — действие доступно. false — действие недоступно.
			renew_by_manager		bool	Признак доступности создания заказа на продление в Панели управления Оператора: true — действие доступно. false — действие недоступно.
			renew_by_account		bool	Признак доступности создания заказа на продление в Панели управления Клиента: true — действие доступно. false — действие недоступно.
meta					object	Дополнительная информация
	server_current_time				string	Текущие дата и время сервера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/plans/8217' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": {
        "id": "8217",
        "type": "plans",
        "attributes": {
            "created_at": "2024-11-18T12:59:25.255869+0300",
            "name": "Plan MIX",
            "sku": "",
            "plan_currency_iso_code": "USD",
            "singleton": false,
            "fixed_price": false,
            "product": {
                "id": 106,
                "name": "Product MIX",
                "description": "",
                "reseller_id": 1,
                "product_category_id": 61,
                "created_at": "2023-06-26T11:39:45.332+03:00",
                "updated_at": "2024-01-05T12:56:18.702+03:00",
                "license_agreement": {
                    "url": null
                },
                "privacy_policy": {
                    "url": null
                },
                "public": true,
                "wizard_status": "active",
                "wizard_step": "wicked_finish",
                "ancestry": null,
                "subscription_name_mask": "{{ plan.name }}",
                "vendor_id": 2,
                "product_line_id": null,
                "priority": 65535,
                "product_recommendations_count": 0,
                "market_setting": {
                    "name": "MIX"
                }
            },
            "product_category": {
                "key": "4565",
                "name": "Category MIX",
                "priority": 0,
                "public": false,
                "logo": null
            },
            "description": "",
            "icon_url": null,
            "billing_type": "csp_annual",
            "plan_periods": [
                {
                    "id": 8464,
                    "duration_value": 1,
                    "duration_type": "month",
                    "endless": false,
                    "trial": false,
                    "setup_fee": 0,
                    "recurring_fee": 0,
                    "renewal_fee": 0,
                    "overuse_fee": 0
                }
            ],
            "plan_resources": [
                {
                    "id": 8725,
                    "resource_id": 1,
                    "name": "res1",
                    "unit_of_measure": "unit",
                    "setup_fee": 0,
                    "recurring_fee": 22.46,
                    "renewal_fee": 0,
                    "overuse_fee": 0,
                    "included": 0,
                    "minimum": 1,
                    "limit": 1500,
                    "priority": 0,
                    "unlimited_units": false
                },
                {
                    "id": 8726,
                    "resource_id": 7197,
                    "name": "res4",
                    "unit_of_measure": "unit",
                    "setup_fee": 0,
                    "recurring_fee": 10,
                    "renewal_fee": 0,
                    "overuse_fee": 0,
                    "included": 0,
                    "minimum": 0,
                    "limit": 1500,
                    "priority": 0,
                    "unlimited_units": false
                }
            ],
            "plan_class_data": {
                "id": 1,
                "key": "default",
                "name": "Default",
                "billing_day": 1,
                "deletion_client_period": -1,
                "change_resources_for_trial_subscription_by_manager": true,
                "change_resources_for_trial_subscription_by_customer": true,
                "increase_resources_immediate_switch_plan_order": true,
                "decrease_resources_immediate_switch_plan_order": true
            },
            "available_account_types": [
                {
                    "id": 27,
                    "key": "33545",
                    "name": "inactive",
                    "use_by_default": false
                },
                {
                    "id": 2,
                    "key": "business",
                    "name": "Business",
                    "use_by_default": false
                },
                {
                    "id": 1,
                    "key": "personal",
                    "name": "Personal",
                    "use_by_default": true
                }
            ],
            "addon": false,
            "public": true,
            "status": "active",
            "available_operations": {
                "sale_by_manager": false,
                "sale_by_account": false,
                "renew_by_manager": true,
                "renew_by_account": true
            }
        }
    },
    "meta": {
        "server_current_time": "2024-11-18T17:08:53.426322+0300"
    }
}