Breadcrumbs

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

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

  1. Категория продукта переключаемого тарифного плана опубликована.

  2. Продукт переключаемого тарифного плана опубликован.

  3. Переключаемый тарифный план опубликован.

  4. Период переключаемого тарифного плана опубликован.

  5. Ресурс переключаемого тарифного плана опубликован.

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

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

Авторизация

Требуется авторизация с помощью 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 тарифного плана

page[size]

query

integer

Опциональный

Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number]

query

integer

Опциональный

Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)

sort

query

string

Опциональный

Предназначен для сортировки элементов списка по указанному параметру. Доступные значения:

  • sort=created_at — сортировка по возрастанию значений created_at.

  • sort=-created_at — сортировка по убыванию значений created_at.

filter[switch_type]

query

string

Обязательный

Предназначен для фильтрации списка переключаемых тарифных планов по типу переключения. Доступные значения:

  • immediate_switch — тарифные планы, доступные для немедленного переключения.

  • delayed_switch — тарифные планы, доступные для отложенного переключения.

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

Название

Тип данных

Описание

data

array of objects

Данные ответа


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

Признак типа клиентов по умолчанию



product

object

Информация о связанном продукте (см.

)




id

integer

ID продукта




name

string

Название продукта




description

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 родительских тарифных планов, начиная от корневого




subscription_name_mask

string

Шаблон названия подписки




vendor_id

integer

ID вендора




product_line_id

integer

ID связанной продуктовой линейки




priority

integer

Приоритет продукта




product_recommendations_count

integer

Число связанных рекомендованных продуктов




market_setting

object

Маркетинговая информация о продукте





name

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 — действие недоступно.



addon

bool

Признак того, что это тарифный план-аддон:

  • true — план-аддон.

  • false — основной план.



public

bool

Признак того, что тарифный опубликован:

  • true — тарифный опубликован.

  • false — тарифный не опубликован.



status

string

Статус тарифного плана

links

object

Ссылки для постраничной навигации


self

string

Текущая страница


first

string

Первая страница


prev

string

Предыдущая страница (при наличии)


next

string

Следующая страница (при наличии)


last

string

Последняя страница

meta

object

Дополнительная информация


current_page

integer

Номер текущей страницы


page_count

integer

Общее число страниц


server_current_time

string

Текущие дата и время сервера

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

Bash
curl --location --request GET 'https://test.activeplatform.com/internal_api/plans/15667/switchable_plans?filter[switch_type]=immediate_switch' \
--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": "15689",
            "type": "plans",
            "attributes": {
                "created_at": "2024-02-27T15:57:05.869358+0300",
                "name": "Plan_30",
                "sku": "",
                "plan_currency_iso_code": "USD",
                "singleton": false,
                "fixed_price": false,
                "product": {
                    "id": 1363,
                    "name": "Product_3",
                    "description": "",
                    "reseller_id": 1,
                    "product_category_id": 6,
                    "created_at": "2024-02-27T15:55:54.820+03:00",
                    "updated_at": "2024-06-14T15:25:44.603+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": 3,
                    "product_line_id": null,
                    "priority": 0,
                    "product_recommendations_count": 0,
                    "market_setting": {
                        "name": "Product marketing name"
                    }
                },
                "description": "",
                "icon_url": null,
                "billing_type": "csp_monthly",
                "plan_periods": [
                    {
                        "id": 17860,
                        "duration_value": 30,
                        "duration_type": "day",
                        "endless": false,
                        "trial": false,
                        "setup_fee": 0.0,
                        "recurring_fee": 0.0,
                        "renewal_fee": 0.0,
                        "overuse_fee": 0.0
                    }
                ],
                "plan_resources": [
                    {
                        "id": 21603,
                        "resource_id": 275,
                        "name": "Resource 2",
                        "unit_of_measure": "unit",
                        "setup_fee": 0.0,
                        "recurring_fee": 1.0,
                        "renewal_fee": 0.0,
                        "overuse_fee": 0.0,
                        "included": 0,
                        "minimum": 0,
                        "limit": 1500,
                        "priority": 0,
                        "unlimited_units": false
                    }
                ],
                "plan_class_data": {
                    "id": 4834,
                    "key": "csp_annual",
                    "name": "CSP Annual",
                    "billing_day": 1,
                    "deletion_client_period": 0,
                    "change_resources_for_trial_subscription_by_manager": false,
                    "change_resources_for_trial_subscription_by_customer": false,
                    "increase_resources_immediate_switch_plan_order": true,
                    "decrease_resources_immediate_switch_plan_order": true
                },
                "available_account_types": [
                    {
                        "id": 1,
                        "key": "personalised",
                        "name": "Personal",
                        "use_by_default": true
                    }
                ],
                "available_operations": {
                    "sale_by_manager": false,
                    "sale_by_account": false,
                    "renew_by_manager": false,
                    "renew_by_account": false
                },
                "addon": false,
                "public": true,
                "status": "active"
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/plans/15667/switchable_plans?filter%5Bswitch_type%5D=immediate_switch&page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/plans/15667/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/internal_api/plans/15667/switchable_plans?filter%5Bswitch_type%5D=immediate_switch&page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "server_current_time": "2024-06-18T10:14:52.597958+0300"
    }
}