Закрытие списаний по годовым подпискам для партнерских продаж

Метод Close Charges инициирует закрытие Списаний по Подписке в статусах Заблокировано и Открыто и возвращает статус запроса.

Если в момент закрытия Cписаний с Подпиской связан Заказ со статусом Ожидает оплаты, то, в зависимости от типа Заказа:

Заказ на увеличение количества Ресурсов Подписки остается в статусе Ожидает оплаты. После оплаты Заказа Списания за Ресурсы ведут себя так же, как в случае закрытия Списаний вручную (см. Ручное закрытие всех списаний по подписке).
Заказ на одновременное увеличение одного типа Ресурса и уменьшение другого остается в статусе Ожидает оплаты. После оплаты Заказа Списания со статусом Новое за увеличение количества Ресурсов ведут себя так же, как в случае закрытия Списаний вручную. Списания со статусом Ожидает возврата переходят в статус Возвращено.
Заказ на изменение Тарифного плана Подписки остается в статусе Ожидает оплаты. После оплаты Заказа происходит следующее:
- Списания со статусом Новое переходят в статус Заблокировано.
- Клиенту не возвращаются средства за неиспользованный период Подписки, так как все Списания по ней уже закрыты.
- Если Клиент после этого создает Заказ на изменение количества Ресурсов, то все Списания, как связанные с Заказом на изменение Тарифного плана Подписки, так и с Заказом на изменение количества Ресурсов, ведут себя так же, как в случае закрытия Списаний вручную.

PATCH {base_url}/api/v3/vendor/subscriptions/{subscription_id}/close_charges

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
subscription_id	path	integer	Обязательный	ID Подписки, по которой нужно закрыть Списания
X-Api-Token	header	string	Обязательный	API токен Сотрудника, от имени которого производится операция (см. Просмотр и обновление информации о сотруднике)
Accept	header	string	Обязательный	Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
Content-Type	header	string	Обязательный	Предназначен для идентификации формата и способа представления сущности

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

Название				Тип	Описание
data				object	Данные ответа
	id			string	ID Подписки
	type			string	Тип модели ответа
	attributes			object	Модель информации о Подписке
		created_at		string	Дата и время создания Подписки
		updated_at		string	Дата и время обновления Подписки
		auto_renewal		boolean	Статус автопродления Подписки
		billing_from		string	Дата начала платного периода Подписки
		expiration_date		string	Дата истечения срока действия Подписки
		name		string	Название Подписки
		renew_point_days		number	Период в днях до даты истечения Подписки, когда становится доступна возможность продлить данную Подписку
		start_date		string	Дата активации Подписки
		status		string	Статус Подписки (список статусов см. в Просмотр списка подписок)
		payment_model		string	Модель оплаты Подписки. Возможные значения: prepay – Предоплата postpay – Постоплата
		payment_model_parameters		string	Параметры модели оплаты Подписки
			credit_limit	number	Величина кредитного лимита, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента или Подписки. Возвращается только для payment_model = postpay
			current_debt	number	Величина текущей задолженности по Подписке. Возвращается только для payment_model = postpay

Коды состояния:

200 — Запрос успешно обработан. Списания по Подписке закрыты.
401 — Ошибка авторизации.
404 — Запрашиваемая Подписка не найдена.
422 — Ошибка обработки запроса. Списания по Подписке не удалось закрыть. В случае 422 ошибки в Журнале будет приведена более подробная информация.

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

PATCH /api/v3/vendor/subscriptions/3006017/close_charges
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetest3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "3006017",
        "type": "subscriptions",
        "attributes": {
            "created_at": "2020-07-27T05:01:39.591935+0300",
            "updated_at": "2020-07-27T06:11:27.466827+0300",
            "auto_renewal": false,
            "billing_from": "2020-07-27",
            "expiration_date": "2020-08-27",
            "name": "auto provisioning with only one period",
            "renew_point_days": 0,
            "start_date": "2020-07-27",
            "status": "active",
            "payment_model": "postpay",
            "payment_model_parameters": {
                "credit_limit": 11000.0,
                "current_debt": 0.0
            }
        }
    }
}