# Список подписок

Выводит список всех повторяющихся подписок.ВниманиеЭтот метод API нельзя использовать при высокой нагрузке. Максимальная нагрузка составляет 20 запросов в минуту. 

  Внимание Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

Endpoint: GET /merchants/{merchant_id}/subscriptions
Version: 2.0
Security: basicAuth

## Path parameters:

  - `merchant_id` (integer, required)
    ID продавца.

## Query parameters:

  - `offset` (integer)
    Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

  - `limit` (integer, required)
    Лимит количества элементов на странице.

  - `user_id` (string)
    ID пользователя.

  - `project_id[]` (array)
    Список ID проектов.

  - `plan_id[]` (array)
    Список ID подписочных планов.

  - `product_id[]` (array)
    Список ID продуктов, к которым привязаны планы.

  - `group_id[]` (array)
    Список ID групп, к которым привязаны планы.

  - `status[]` (array)
    Статус.
    Enum: "active", "canceled", "non_renewing"

  - `datetime_from` (string)
    Дата выборки. Позволяет найти подписки, созданные позднее даты запроса.

  - `datetime_to` (string)
    Дата выборки. Позволяет найти подписки, созданные позднее даты запроса.

## Response 200 fields (application/json):

  - `charge_amount` (number)
    Сумма рекуррентного списания.

  - `comment` (string)
    Причина изменения статуса подписки

  - `currency` (string)
    Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

  - `date_create` (string)
    Дата создания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).

  - `date_end` (string)
    Дата окончания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).

  - `date_last_charge` (string,null)
    Последняя дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).

  - `date_next_charge` (string,null)
    Следующая дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).

  - `id` (integer)
    ID подписки

  - `plan` (object)

  - `plan.billing_retry` (object)
    Данные о попытках списания средств.

  - `plan.billing_retry.value` (integer, required)
    Количество попыток списания.

  - `plan.charge` (object)
    Объект с данными о рекуррентном списании.

  - `plan.charge.amount` (number)
    Сумма рекуррентного списания.

  - `plan.charge.currency` (string)
    Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `plan.charge.period` (object, required)
    Расчетный период.

  - `plan.charge.period.type` (string, required)
    Единица времени. Может принимать значения day, month или lifetime.
    Enum: "day", "month", "lifetime"

  - `plan.charge.period.value` (integer, required)
    Количество временных единиц. Значение зависит от типа параметра и может быть: - от 1 до 366, если параметр type принимает значение day;- от 1 до 12, если параметр type принимает значение month;- 0 если параметр type принимает значение lifetime.

  - `plan.charge.prices` (array)
    Список цен в различных валютах.

  - `plan.charge.prices.setup_fee` (number)
    Дополнительная плата взимаемая единовременно в первом платеже.

  - `plan.description` (object)
    Описание плана. Значение состоит из пар "localization":"plan description".

  - `plan.description.ar` (string)
    Арабский.

  - `plan.description.bg` (string)
    Болгарский.

  - `plan.description.cn` (string)
    Китайский упрощенный.

  - `plan.description.cs` (string)
    Чешский.

  - `plan.description.de` (string)
    Немецкий.

  - `plan.description.en` (string)
    Английский.

  - `plan.description.es` (string)
    Испанский.

  - `plan.description.fr` (string)
    Французский.

  - `plan.description.he` (string)
    Иврит.

  - `plan.description.it` (string)
    Итальянский.

  - `plan.description.ja` (string)
    Японский.

  - `plan.description.ko` (string)
    Корейский.

  - `plan.description.pl` (string)
    Польский.

  - `plan.description.pt` (string)
    Португальский.

  - `plan.description.ro` (string)
    Румынский.

  - `plan.description.ru` (string)
    Русский.

  - `plan.description.th` (string)
    Тайский.

  - `plan.description.tr` (string)
    Турецкий.

  - `plan.description.tw` (string)
    Китайский традиционный.

  - `plan.description.vi` (string)
    Вьетнамский.

  - `plan.expiration` (object)
    Информация об истечении срока подписки.

  - `plan.expiration.type` (string, required)
    Единица времени. Может принимать значения dayили month.
    Enum: "day", "month"

  - `plan.expiration.value` (integer,null, required)
    Время до окончания срока подписки.

  - `plan.external_id` (string)
    Внешний идентификатор плана.

  - `plan.grace_period` (object)
    Время периода отсрочки.

  - `plan.grace_period.type` (string, required)
    Единица времени. Может принимать значение day.
    Enum: "day"

  - `plan.grace_period.value` (integer, required)
    Платежный цикл.

  - `plan.group_id` (string,null)
    ID группы, к которой привязан план.

  - `plan.id` (integer)
    ID плана подписки.

  - `plan.name` (object)
    Название плана. Значение состоит из пар "localization":"plan name".

  - `plan.project_id` (integer)
    ID проекта.

  - `plan.refund_period` (integer,null)
    Период, в течение которого пользователь может вернуть средства, потраченные на план подписки (в днях).

  - `plan.status` (object)

  - `plan.status.value` (string)
    Статус плана подписки.
    Enum: "active", "disabled"

  - `plan.tags` (array)
    Теги плана.

  - `plan.trial` (object)
    Информация о пробном (триальном) периоде.

  - `product` (object,null)

  - `product.id` (integer,null)
    ID продукта, к которому привязаны планы.

  - `product.description` (object)
    Локализованные описания предметов.

  - `product.name` (string)
    Название продукта.

  - `status` (string)
    Статус
    Enum: "new", "active", "canceled", "non_renewing", "freeze"

  - `user` (object)

  - `user.id` (string)
    ID пользователя

  - `user.name` (string)
    Имя пользователя