Остановка подписки
Метод Stop subscription позволяет запустить процесс остановки подписки для текущего реселлера или любого из его нижестоящих реселлеров.
Так как процесс остановки подписки выполняется в соответствии со стандартной логикой платформы, то если с подпиской связан заказ на продление или заказ на пролонгацию в статусе Ожидает оплаты или Ожидает предоставления, то этот заказ и связанный с ним незавершенный или оплаченный с баланса платеж (при наличии) будут автоматически отменены вместе с остановкой подписки (см. Остановка подписки).
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/stop_operationАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||
|---|---|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||
| Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json | ||
| Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json | ||
| base_url | path | string | Обязательный | URL ActivePlatform | ||
| reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) | ||
| subscription_id | path | integer | Обязательный | ID подписки | ||
| data | form | object | Обязательный | Информация об атрибутах операции | ||
| attributes | form | object | Обязательный | Атрибуты операции | ||
| reason | form | string | Обязательный | Причина остановки подписки | ||
| comment | form | string | Обязательный | Комментарий | ||
Модель ответа
В случае отсутствия ошибок метод возвращает пустой ответ со статусом 200 OK.
Ошибки
| Статус ошибки | Текст ошибки | Комментарий |
|---|---|---|
| 403 | Выполнение действия запрещено | Список доступных действий над подпиской см. в Получение информации о подписке |
Пример запроса
POST /api/v3/resellers/1/subscriptions/3007255/stop_operation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json{
"data":
{
"attributes":
{
"reason" : "reason",
"comment" : "comment"
}
}
}Пример ответа