Закрытие списаний

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

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

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

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

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

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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
subscription_id	path	integer	Обязательный	ID подписки, по которой нужно закрыть списания

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

Название				Тип	Описание
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/reseller/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
            }
        }
    }
}