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

Отмена подписки

Важно

Метод работает только с подписками, оформленными через Pay SDK.

Метод позволяет отменить подписку по идентификатору покупки. Отмененная подписка завершится в дату окончания оплаченного периода без дальнейших списаний.

подсказка

Управлять подписками можно в RuStore Консоли. Подробнее см. в разделе по управлению подписками.

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

PATCH
https://public-api.rustore.ru/public/v1/applications/{appId}/subscriptions/{purchaseId}:cancel
АтрибутТипОписаниеОбязательностьРасположениеПример
appId numberИдентификатор приложения из RuStore консоли, в котором совершается возврат.
1.Перейдите на вкладку Приложения и выберите нужное приложение.
2.Скопируйте идентификатор из URL-адреса страницы приложения — это набор цифр между apps/ и /versions.
Например, для URL-адреса https://console.rustore.ru/apps/123456/versions ID приложения — 123456.
Даpath5135162
purchaseIdstringИдентификатор покупки в формате UUID. Можно получить из результата покупки через SDK, из уведомления на сервер или запросом информации о покупке. Подробнее см. в разделе Управление подпискамиДаpath19b873b0-a3a9-4578-be99-1ed0fc8a73d0

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

АтрибутТипОписаниеОбязательностьРасположениеПример
codestringКод ответа.ДаbodyOK
message stringСообщение о результате операции.НетbodySuccessful result
bodyobjectТело ответа.Нетbody{}
timestampstringВремя ответа сервера.Даbody2025-07-22T07:59:53.211Z

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

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

{
"code": "OK",
"message": null,
"body": null,
"timestamp": "2025-07-28T16:09:03.831Z"
}

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

{
"code": "ERROR",
"message": "Subscription not found for given purchaseId",
"body": null,
"timestamp": "2025-07-22T07:59:53.216Z"
}

Список ошибок

MessageРасшифровка
Subscription not foundПодписка не найдена. Проверьте идентификатор покупки.
Incorrect parameter appId / Incorrect parameter purchaseIdНекорректные параметры запроса. Проверьте идентификатор приложения и идентификатор покупки.
ForbiddenДоступ запрещён. Проверьте токен авторизации и права доступа.
Something went wrongЧто-то пошло не так. Попробуйте позже или обратитесь в поддержку.
Too Many RequestsПревышено количество запросов. Повторите попытку позже.
Internal Server ErrorВнутренняя ошибка сервера. Повторите попытку позже.