Изменение опции Автопродление для Подписки Реселлера

Метод Change the Auto-renew option of the Reseller's Subscription позволяет изменить значение опции Автопродление для Подписки по ее ID для текущего Реселлера или любого из его нижестоящих Реселлеров (см. Автоматическое продление подписки).

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

PATCH {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}

Аргументы

Название			Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token			header	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type			header	string	Обязательный	Предназначен для идентификации формата и способа представления сущности
Accept			header	string	Обязательный	Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_id			path	integer	Обязательный	ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)
subscription_id			path	integer	Обязательный	ID Подписки
data			form	object	Обязательный	Информация об атрибутах операции
	attributes		form	object	Обязательный	Атрибуты операции
		autorenew	form	bool	Обязательный	Задает целевое состояние опции Автопродление Подписки: true — включить опцию Автопродление. false — отключить опцию Автопродление.

Модель ответа

В случае отсутствия ошибок метод возвращает информацию о Подписке (см. Получение информации о Подписке Реселлера).

Ошибки

Статус ошибки	Текст ошибки	Комментарий
403	Выполнение действия запрещено	Список доступных действий над Подпиской см. в Получение информации о Подписке Реселлера
422	Вы пытаетесь изменить текущее значение автопродления на такое же	Целевое состояние опции Автопродление уже установлено для Подписки

Пример запроса

PATCH /api/v3/resellers/1/subscriptions/3007381
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "data": {
        "attributes": {
            "autorenew": true
        }
    }
}

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

{
    "data": {
        "id": "3007381",
        "type": "subscriptions",
        "attributes": {
            "created_at": "2021-03-06T03:05:29.717+03:00",
            "updated_at": "2021-03-06T04:44:10.185+03:00",
            "plan_id": 5,
            "account_id": 710,
            "name": "Auto provisioning with resources",
            "trial": false,
            "status": "active",
            "start_date": "2021-03-06",
            "expiration_date": "2021-04-06",
            "plan_period_id": 4,
            "promo_code": "",
            "payment_model": "postpay",
            "payment_model_parameters": {
                "credit_limit": 5000.0,
                "current_debt": 123.89
            },
            "renewal_settings": {
                "autorenew": true,
                "disable_autorenew": false,
                "autorenew_point": 0,
                "manual_renew_point": -1
            },
            "fixed_price": false,
            "ability": {
                "stop": true,
                "activate": false,
                "destroy": true,
                "adjust": true,
                "switch_plan": false,
                "renew": true,
                "change_auto_renew_option": true,
                "prolong": false,
                "change_resources_renewal_order": false,
                "decrease_resources_change_order": true
            },
            "custom_price": false
        },
        "relationships": {
            "account": {
                "data": {
                    "id": "710",
                    "type": "accounts"
                }
            },
            "subscription_resources": {
                "data": [
                    {
                        "id": "35882",
                        "type": "subscription_resources"
                    },
                    {
                        "id": "35883",
                        "type": "subscription_resources"
                    },
                    {
                        "id": "35884",
                        "type": "subscription_resources"
                    }
                ]
            },
            "subscription_period": {
                "data": {
                    "id": "6486",
                    "type": "subscription_periods"
                }
            },
            "plan": {
                "data": {
                    "id": "5",
                    "type": "plans"
                }
            }
        }
    }
}