Получение списка переключаемых тарифных планов

Метод Get list of switchable plans используется для получения cписка переключаемых тарифных планов по указанному ID тарифного плана текущего реселлера или любого из его нижестоящих реселлеров (см. Настройка переключаемых тарифных планов).

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/switchable_plans

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url	path	string	Обязательный	URL ActivePlatform
reseller_id	path	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
plan_id	path	integer	Обязательный	ID тарифного плана, для которого запрашивается список доступных переключаемых тарифных планов
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа
filter[switch_type]	query	string	Обязательный	Предназначен для фильтрации списка переключаемых тарифных планов по типу переключения. Доступные значения: immediate_switch — тарифные планы, доступные для немедленного переключения. delayed_switch — тарифные планы, доступные для отложенного переключения.

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

Название							Тип данных	Описание
data							array of objects	Данные ответа
	id						integer	ID тарифного плана
	type						string	Тип данных
	attributes						object	Информация о тарифном плане
		created_at					string	Дата и время создания тарифного плана
		updated_at					string	Дата и время последнего изменения тарифного плана
		status					string	Статус тарифного плана (список статусов см. в Просмотр списка тарифных планов)
		name					string	Название тарифного плана
		description					string	Дополнительная информация о тарифном плане, которая отображается клиентам в Панели управления Клиента
		public					bool	Признак доступности тарифного плана: true — тарифный план доступен для заказа. false — тарифный план недоступен для заказа.
		plan_class_id					integer	ID правила предоставления (см. Управление правилами предоставления тарифных планов)
		product_id					integer	ID продукта, с которым связан тарифный план
		billing_type					string	Тип биллинга тарифного плана (см. Списания по подпискам с различными типами биллинга)
		ancestry					string	Для делегированных тарифных планов содержит список ID родительских тарифных планов, начиная от корневого (см. Просмотр списка делегированных тарифных планов). Для тарифных планов, созданных сотрудником выбранного реселлера, равен null
		reseller_id					integer	ID реселлера, которому принадлежит тарифный план
		fixed_price					bool	Признак Фиксированная цена тарифного плана: true — клиент получает возможность оплачивать подписку и заказывать дополнительные ресурсы по фиксированной цене, которая была установлена в тарифном плане на момент заказа подписки. Новая стоимость будет применена к подписке только после ее продления. false — цены тарифного плана не фиксируются.
		sku					string	SKU тарифного плана
		singleton					bool	Признак Единичный тарифного плана: true — клиент может иметь только одну подписку на этот тарифный план. false — клиент может иметь неограниченное количество подписок на этот тарифный план.
		auto_renewal					bool	Состояние опции Автопродление по умолчанию для подписок на этот тарифный план: true — опция Автопродление включена. false — опция Автопродление выключена.
		auto_renewal_disabled					bool	Состояние опции Блокировать опцию Автопродление по умолчанию для подписок на этот тарифный план: true — опция Блокировать опцию Автопродление включена. false — опция Блокировать опцию Автопродление выключена.
		plan_class					string	Название правила предоставления
		product_category_id					integer	ID категории продукта, с которой связан тарифный план
		product_category					string	Название категории продукта, с которой связан тарифный план
		product_category_public					bool	Признак Опубликована категории продукта: true — категория продукта доступна для продажи. false — категория продукта недоступна для продажи.
		product					string	Название продукта, с которым связан тарифный план
		plan_resources					object	Информация о ресурсах тарифного плана
			data				array of objects	Данные объекта
				id			integer	ID ресурса тарифного плана
				type			string	Тип данных
				attributes			object	Информация о ресурсах тарифного плана
					created_at		string	Дата и время создания ресурса
					updated_at		string	Дата и время последнего обновления ресурса
					name		string	Название ресурса
					measurable		bool	Признак использования модели расчета стоимости за фактическое использование ресурса (недоступен, если функция не поддерживается внешними службами): true — используется расчет за фактическое использование ресурса. false — не используется расчет за фактическое использование ресурса.
					unit_of_measure		string	Единица измерения ресурса: unit — измеряемый ресурс, для которого указывается определенное количество. boolean — неизмеряемый ресурс (для ресурсов, у которых не надо указывать количество), возможные значения: true — ресурс включен в тарифный план. false — ресурс не включен в тарифный план.
					application_template_name		string	Название услуги, которая предоставляется в рамках данного тарифного плана
					included		integer	Количество ресурса, которое включено в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки)
					minimum		integer	Минимальное количество ресурса (с учетом величины `included`), которое доступно для заказа (см. Ресурсы тарифного плана)
					limit		integer	Максимальное количество ресурса, доступное для заказа. Если ресурс безлимитный (признак `unlimited_units = true`), то `limit = 0`
					setup_fee		string	Величина платежа за установку ресурса
					recurring_fee		string	Величина ежемесячной абонентской платы за ресурс
					overuse_fee		string	Стоимость перерасхода ресурсов
					renewal_fee		string	Стоимость продления использования ресурса
					unlimited_units		bool	Признак отключения лимитов использования ресурса: true — лимиты отключены. false — лимиты активны.
					public		bool	Возможные значения: true — ресурс доступен клиентам для заказа. false — ресурс недоступен клиентам для заказа.
					status		string	Статус ресурса: active — активный. inactive — неактивный. deleted — удален.
					resource_id		integer	ID ресурса в шаблоне услуги
					priority		integer	Приоритет ресурса. У основного ресурса `priority` максимальный
					net_costs		object	Значения себестоимостей указанных типов для ресурса
						setup_fee	string	Величина платежа за установку ресурса
						recurring_fee	string	Величина ежемесячной абонентской платы за ресурс
						overuse_fee	string	Стоимость перерасхода ресурсов
						renewal_fee	string	Стоимость продления использования ресурса
					erp		object	Цена рекомендованная (ERP) ресурса
						setup_fee	string	Величина платежа за установку ресурса
						recurring_fee	string	Величина ежемесячной абонентской платы за ресурс
						overuse_fee	string	Стоимость перерасхода ресурсов
						renewal_fee	string	Стоимость продления использования ресурса
					custom_attributes		object	Информация о дополнительных параметрах ресурса
						plan_resources.custom_attributes.['custom-attribute-key']	string	Значение дополнительного параметра ресурса
		plan_periods					object	Информация о периодах тарифного плана
			data				array of objects	Данные объекта
				id			integer	ID периода тарифного плана
				type			string	Тип данных
				attributes			object	Информация о периодах тарифного плана
					created_at		string	Дата и время создания периода тарифного плана
					updated_at		string	Дата и время последнего обновления периода тарифного плана
					duration_value		integer	Длительность периода тарифного плана. Если период бессрочный, то `duration_value = null`
					duration_type		string	Единица измерения периода тарифного плана. Если период бессрочный, то `duration_type = null`
					setup_fee		float	Стоимость установки тарифного плана для данного периода
					recurring_fee		float	Ежемесячная стоимость тарифного плана для данного периода
					transfer_fee		float	Стоимость переноса домена, если услуги включает в себя возможность использования доменов
					renewal_fee		float	Стоимость продления тарифного плана для данного периода
					trial		bool	Признак того, является ли период тарифного плана пробным: true — период является пробным. false — период не является пробным.
					public		bool	Признак доступности периода для заказа в рамках данного тарифного плана: true — период доступен для заказа. false — период недоступен для заказа.
					status		string	Статус периода тарифного плана: active — активный. deleted — удален.
					description		string	Описание периода тарифного плана
					endless		bool	Признак того, является ли период тарифного плана бессрочным: true — период является бессрочным. false — период не является бессрочным. Продолжительность периода указана в `duration_value` и `duration_type`.
					net_costs		object	Значения себестоимостей указанных типов для периода
						setup_fee	string	Стоимость установки тарифного плана для данного периода
						recurring_fee	string	Ежемесячная стоимость тарифного плана для данного периода
						transfer_fee	string	Стоимость переноса домена, если услуга включает в себя возможность использования доменов
						renewal_fee	string	Стоимость продления тарифного плана для данного периода
					erp		object	Цена рекомендованная (ERP) периода
						setup_fee	string	Стоимость установки тарифного плана для данного периода
						recurring_fee	string	Ежемесячная стоимость тарифного плана для данного периода
						transfer_fee	string	Стоимость переноса домена, если услуга включает в себя возможность использования доменов
						renewal_fee	string	Стоимость продления тарифного плана для данного периода
		plan_currency					string	Код валюты тарифного плана
		available_account_types					object	Информация о типах клиентов, для которых доступен тарифный план
			data				array of objects	Данные объекта
				id			integer	ID типа клиента
				type			string	Тип данных
				attributes			object	Информация о типе клиента
					created_at		string	Дата и время создания типа клиента
					updated_at		string	Дата и время последнего обновления типа клиента
					reseller_id		integer	ID реселлера, к которому относится тип клиента
					name		string	Имя типа клиента
					ancestry		string	ID родительского типа клиента
					default_payment_method_id		integer	ID способа оплаты (см. Способы оплаты), который используется по умолчанию для данного типа клиентов
					key		string	Ключ типа клиента
					name_pattern		string	Шаблон отображения имени клиента в платформе
					use_by_default		bool	Признак типа клиента по умолчанию: true — типа клиента используется по умолчанию. false — типа клиента не используется по умолчанию.
					primary_name		string	Название поля с основным именем клиента. Например, для типа клиента Юридическое лицо это может быть Название компании
		custom_attributes					object	Информация о дополнительных параметрах тарифного плана
			custom_attributes.['custom_attribute_key']				string	Значение дополнительного параметра тарифного плана
		plan_class_data					object	Информация о параметрах переключения из связанного правила предоставления (см. Управление правилами предоставления тарифных планов)
			increase_resources_immediate_switch_plan_order				bool	Доступность увеличения количества ресурсов в заказе при немедленном переключении тарифного плана: true — увеличение количества ресурсов доступно. false — увеличение количества ресурсов недоступно.
			decrease_resources_immediate_switch_plan_order				bool	Доступность уменьшения количества ресурсов в заказе при немедленном переключении тарифного плана: true — уменьшение количества ресурсов доступно. false — уменьшение количества ресурсов недоступно.
	relationships						object	Информация о связанных объектах
		plan_category					object	Информация о связанной категории тарифных планов
			data				object	Информация о категории тарифных планов
				id			string	ID категории тарифных планов
				type			string	Тип данных
links							array	Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации
	self						string	Ссылка на текущую страницу
	first						string	Ссылка на первую страницу
	prev						string	Ссылка на предыдущую страницу
	next						string	Ссылка на следующую страницу
	last						string	Ссылка на последнюю страницу

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

GET /api/v3/resellers/1/plans/34533/switchable_plans?filter[switch_type]=immediate_switch
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "34232",
            "type": "plans",
            "attributes": {
                "created_at": "2022-12-12T15:59:18.077871+0300",
                "updated_at": "2022-12-12T15:59:43.218917+0300",
                "status": "active",
                "name": "CSP monthly",
                "description": "",
                "public": true,
                "plan_class_id": 1,
                "product_id": 1143,
                "billing_type": "csp_monthly",
                "ancestry": null,
                "reseller_id": 1,
                "fixed_price": false,
                "sku": "",
                "singleton": false,
                "auto_renewal": false,
                "auto_renewal_disabled": false,
                "plan_class": "default",
                "product_category_id": 196,
                "product_category": "default",
                "product_category_public": false,
                "product": "Default",
                "plan_resources": {
                    "data": [
                        {
                            "id": "56959",
                            "type": "plan_resources",
                            "attributes": {
                                "created_at": "2022-12-12T15:59:43.199689+0300",
                                "updated_at": "2023-04-06T11:47:38.323993+0300",
                                "name": "License",
                                "measurable": false,
                                "unit_of_measure": "unit",
                                "application_template_name": "Manual provisioning",
                                "included": 0,
                                "minimum": 0,
                                "limit": 1500,
                                "setup_fee": "0.0",
                                "recurring_fee": "10.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0",
                                "unlimited_units": false,
                                "public": true,
                                "status": "active",
                                "resource_id": 276,
                                "priority": 0,
                                "net_costs": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "10.0",
                                    "overuse_fee": "0.0",
                                    "renewal_fee": "0.0"
                                },
                                "erp": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "10.0",
                                    "overuse_fee": "0.0",
                                    "renewal_fee": "0.0"
                                }, 
                                "custom_attributes": {
                                    "item_id": ""
                                }
                            }
                        }
                    ]
                },
                "plan_periods": {
                    "data": [
                        {
                            "id": "43361",
                            "type": "plan_periods",
                            "attributes": {
                                "created_at": "2023-04-04T11:09:29.290425+0300",
                                "updated_at": "2023-04-04T11:09:29.290425+0300",
                                "duration_value": null,
                                "duration_type": null,
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "transfer_fee": "0.0",
                                "renewal_fee": "0.0",
                                "trial": false,
                                "public": true,
                                "status": "active",
                                "description": "",
                                "endless": true,
                                "net_costs": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "transfer_fee": "0.0",
                                    "renewal_fee": "0.0"
                                },
                                "erp": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "transfer_fee": "0.0",
                                    "renewal_fee": "0.0"
                                } 
                            }
                        },
                        {
                            "id": "43013",
                            "type": "plan_periods",
                            "attributes": {
                                "created_at": "2022-12-12T15:59:43.211786+0300",
                                "updated_at": "2022-12-12T15:59:43.211786+0300",
                                "duration_value": 1,
                                "duration_type": "month",
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "transfer_fee": "0.0",
                                "renewal_fee": "0.0",
                                "trial": true,
                                "public": true,
                                "status": "active",
                                "description": null,
                                "endless": false,
                                "net_costs": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "transfer_fee": "0.0",
                                    "renewal_fee": "0.0"
                                },
                                "erp": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "transfer_fee": "0.0",
                                    "renewal_fee": "0.0"
                                }
                            }
                        }
                    ]
                },
                "plan_currency": "USD",
                "available_account_types": {
                    "data": [
                        {
                            "id": "1",
                            "type": "account_types",
                            "attributes": {
                                "created_at": "2016-08-25T09:26:12.658176+0300",
                                "updated_at": "2023-03-22T13:53:30.437450+0300",
                                "reseller_id": 1,
                                "name": "Personal",
                                "ancestry": null,
                                "default_payment_method_id": 1548,
                                "key": "personal",
                                "name_pattern": "%first_name %middle_name %last_name",
                                "use_by_default": true,
                                "primary_name": ""
                            }
                        },
                        {
                            "id": "2",
                            "type": "account_types",
                            "attributes": {
                                "created_at": "2016-08-25T09:26:12.674666+0300",
                                "updated_at": "2023-03-21T10:22:46.331102+0300",
                                "reseller_id": 1,
                                "name": "Business",
                                "ancestry": null,
                                "default_payment_method_id": 197,
                                "key": "business",
                                "name_pattern": "%primary_name",
                                "use_by_default": false,
                                "primary_name": "Company name"
                            }
                        }
                    ]
                },
                "custom_attributes": {
                    "23234": ""
                },
                "plan_class_data": {
                    "increase_resources_immediate_switch_plan_order": false,
                    "decrease_resources_immediate_switch_plan_order": true
                }
            },
            "relationships": {
                "plan_category": {
                    "data": {
                        "id": "1",
                        "type": "plan_categories"
                    }
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/plans/34533/switchable_plans?filter%5Bswitch_type%5D=immediate_switch&page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/plans/34533/switchable_plans?filter%5Bswitch_type%5D=immediate_switch&page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/plans/34533/switchable_plans?filter%5Bswitch_type%5D=immediate_switch&page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}