Перейти к содержимому

Список тарифов

GET
/plans
curl --request GET \
--url 'https://app.mybi.ru/api/v2/plans?page=1&length=10&token=<token>'

Возвращает тарифы, доступные для подключения. Результат разбит на страницы (поле pagination).

page
integer
по умолчанию: 1 >= 1

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

Пример

1
length
integer
по умолчанию: 100 >= 1 <= 500

Количество записей на странице

Пример

10

Список тарифов успешно получен

MIME-типapplication/json
object
plans

Список тарифов

Array<object>

Тариф

object
id

Идентификатор тарифа

integer
name

Название

string
rows

Количество строк

integer
cost

Стоимость

number формат: double
duration

Продолжительность загрузок

integer
pagination

Параметры постраничной выдачи

object
page
обязательный

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

integer
has_next

Есть ли следующая страница

boolean
has_prev

Есть ли предыдущая страница

boolean
fact_length

Сколько записей возвращено на этой странице

integer
length
обязательный

Запрошенный размер страницы

integer
total
обязательный

Всего записей по заданному фильтру

integer

Пример

{
"pagination": {
"page": 1,
"has_next": true,
"has_prev": true,
"fact_length": 10,
"length": 10,
"total": 5000
}
}

Ошибка авторизации

MIME-типapplication/json
object
status

Код ошибки

integer
error

Текст ошибки

string

Пример сгенерировано

{
"status": 1,
"error": "example"
}