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

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

Связанная категория продуктов опубликована (см. Получение списка категорий продуктов).
Связанный продукт опубликован (см. Получение списка продуктов).
Тарифный план опубликован.
Этот тарифный план имеет статус Активный.
Период тарифного плана опубликован.

Метод возвращает пустой массив, если у реселлера нет подходящих тарифных планов.

GET {reseller_domain}/internal_api/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	Обязательный	Доменное имя реселлера
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)
filter[name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части названия тарифного плана без учета регистра
filter[product_category_id]	query	integer	Опциональный	Предназначен для фильтрации списка по ID категории продуктов
filter[product_id]	query	integer	Опциональный	Предназначен для фильтрации списка по ID продукта
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

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

Название				Тип данных	Описание
data				array of objects	Данные ответа
	id			string	ID тарифного плана
	type			string	Тип данных
	attributes			object	Информация о тарифном плане
		created_at		string	Дата и время создания тарифного плана
		name		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`.
		product		object	Информация о связанном продукте
			id	integer	ID продукта
			name	string	Название продукта
			logo	string	Ссылка на логотип продукта
		product_category		object	Информация о связанной категории продуктов
			id	integer	ID категории продуктов
			name	string	Название категории продуктов
			logo	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' \
--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": "371",
            "type": "plans",
            "attributes": {
                "created_at": "2017-07-07T16:03:22.830040+0300",
                "name": "Plan Demo",
                "plan_periods": [
                    {
                        "id": 824,
                        "duration_type": "year",
                        "duration_value": 1,
                        "trial": false,
                        "endless": false
                    },
                    {
                        "id": 907,
                        "duration_type": "month",
                        "duration_value": 1,
                        "trial": false,
                        "endless": false
                    }
                ],
                "product": {
                    "id": 12,
                    "name": "Demo",
                    "logo": null
                },
                "product_category": {
                    "id": 5,
                    "name": "Microsoft Demo",
                    "logo": "https://storage.test.activeplatform.com/public/images/product_category/logo/5/Office-x3.png"
                }
            }
        },
        {
            "id": "401",
            "type": "plans",
            "attributes": {
                "created_at": "2017-08-18T12:10:34.230594+0300",
                "name": "Plan Trial",
                "plan_periods": [
                    {
                        "id": 919,
                        "duration_type": "day",
                        "duration_value": 14,
                        "trial": true,
                        "endless": false
                    }
                ],
                "product": {
                    "id": 12,
                    "name": "Demo",
                    "logo": null
                },
                "product_category": {
                    "id": 5,
                    "name": "Microsoft Demo",
                    "logo": "https://storage.test.activeplatform.com/public/images/product_category/logo/5/Office-x3.png"
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/plans?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/plans?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/plans?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}