Получение списка подписок из продуктового каталога

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

подсказка

Если не знаете с чего начать, прочтите инструкцию в сценариях использования.

Параметры взаимодействия

GET

https://public-api.rustore.ru/public/applications/{appId}/catalog/subscriptions

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
`Public-Token`	string	Jwe-токен авторизации в Public API Rustore. Как получить токен авторизации.	Да	header	N/A
`appId`	int	Идентификатор приложения.	Да	path	`385727`
`productId`	string	Идентификатор продукта из консоли RuStore. Если задан, то возвращается информация только по продукту с указанным идентификатором.	Нет	query	`full_access_1_month`
`status`	array	Статус публикации продукта: `active` — опубликован в консоли RuStore; `inactive` — не опуликован в консоли RuStore.	Нет	query	`active`
`continuationToken`	string	Токен для получения следующей части результата.	Нет	query	`MSxiYTBmZDA...4ZDMyOWNlOTY=`
`limit`	int	Количество элементов на странице. Максимальное значение `500`.	Нет	query	`20`

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

Атрибут	Тип	Описание	Обязательность	Пример
`code`	string	Да	Код ответа.	• `ОК`; • `ERROR`; • `BAD_REQUEST`; • `NOT_FOUND`.
`message`	string	Нет	Расшифровка кода ответа.	N/A
`body{}`	object	Да	Тело ответа.	N/A
`timestamp`	string	Да	Время ответа.	`2024-11-01T11:10:54.994306Z`

`body{}`

Атрибут	Тип	Описание	Обязательность	Пример
`totalElementsCount`	int	Общее количество элементов. Если элементы отсутствуют, вернётся значение `0`.	Нет	`500`
`elementsCount`	int	Количество возвращенных элементов.	Нет	`20`
`continuationToken`	string	Токен для получения следующей части результата.	Нет, может вернуться `null`	`null`
`elements[]`	array	Содержимое ответа	Нет	N/A

`elements[]`

Атрибут	Тип	Описание	Обязательность	Пример
`productId`	string	Код продукта.	Нет, если нет возвращаемых элементов	`full_access_1_month`
`productType`	string	Тип продукта: `subscription`.	Нет, если нет возвращаемых элементов	`subscription`
`image`	string	Ссылка на картинку продукта.	Нет, если нет возвращаемых элементов	`https://platform...c8e1b74.png`
`name`	string	Наименование продукта.	Нет, если нет возвращаемых элементов	`Полный доступ ко всем функциям приложения`
`description`	string	Описание продукта.	Нет, если нет возвращаемых элементов	`Полный доступ ко всем функциям приложения без рекламы`
`status`	string	Статус публикации продукта: `active` — опубликован в консоли RuStore; `inactive` — не опуликован в консоли RuStore.	Нет, если нет возвращаемых элементов	`active`
`tariffs[]`	array	Тарифы.	Нет, если нет возвращаемых элементов	N/A

`tariffs[]`

Атрибут	Тип	Описание	Обязательность	Пример
`tariffCode`	string	Код тарифа приложения. Доступные следующие значения: `promo` — бесплатный период; `start` — период со сниженной относительно базового ценой; `grace` — grace период; `hold` — hold-период. Подробнее см. здесь.	Нет	`promo`
`priceCurrency`	string	Код валюты ISO 4217.	Нет	`RUB`
`priceValue`	string	Стоимость в минимальных единицах валюты (в копейках).	Нет	`15000`
`periodType`	string	`day` — день; `month` — месяц; `year` — год;	Нет	`day`
`duration`	int	Количество `periodType` в указанном периоде подписки.	Нет	`1`

Пример успешного ответа

{
    "code": "OK",
    "message": null,
    "body": {
        "totalElementsCount": 1,
        "elementsCount": 1,
        "continuationToken": null,
        "elements": [
            {
                "productId": "full_access_1_month",
                "productType": "subscription",
                "image": "",
                "name": "Полный доступ ко всем функциям приложения",
                "description": "Полный доступ ко всем функциям приложения без рекламы",
                "status": "active",
                "tariffs": [
                    {
                        "tariffCode": "grace",
                        "priceCurrency": "RUB",
                        "priceValue": 0,
                        "periodType": "day",
                        "duration": 14
                    },
                    {
                        "tariffCode": "hold",
                        "priceCurrency": "RUB",
                        "priceValue": 0,
                        "periodType": "day",
                        "duration": 14
                    },
                    {
                        "tariffCode": "start",
                        "priceCurrency": "RUB",
                        "priceValue": 1000,
                        "periodType": "month",
                        "duration": 1
                    },
                    {
                        "tariffCode": "standard",
                        "priceCurrency": "RUB",
                        "priceValue": 10000,
                        "periodType": "month",
                        "duration": 1
                    },
                    {
                        "tariffCode": "promo",
                        "priceCurrency": "RUB",
                        "priceValue": 0,
                        "periodType": "month",
                        "duration": 1
                    }
                ]
            }
        ]
    },
    "timestamp": "2024-11-07T09:49:28.476738105Z"
}

Пример ответа с ошибкой

{
    "code": "ERROR",
    "message": "Invalid type specified for request parameter 'status'. Required type 'Set'",
    "body": null,
    "timestamp": "2024-11-07T09:49:59.787412185Z"
}

Получение списка подписок из продуктового каталога

Параметры взаимодействия​

Параметры ответа​

body{}​

elements[]​

tariffs[]​

Пример успешного ответа​

Пример ответа с ошибкой​