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

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

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

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

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

Аргументы

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

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

Название	Тип	Описание
error	integer	Код состояния: 200 - Запрос успешно обработан. Списания по Подписке закрыты. 401 - Ошибка авторизации. 404 - Запрашиваемая Подписка не найдена. 422 - Ошибка обработки запроса. Списания по Подписке не удалось закрыть. В случае 422 ошибки в Журнале будет приведена более подробная информация.
data	array of objects	Данные ответа.
data.id	string	ID Подписки.
data.type	string	Тип модели ответа.
data.attributes	object	Модель информации о Подписке.
data.attributes.created-at	date	Дата и время создания Подписки.
data.attributes.updated-at	date	Дата и время обновления Подписки.
data.attributes.auto-renewal	string	Статус автопродления Подписки
data.attributes.billing-from	date	Дата начала платного периода Подписки.
data.attributes.expiration-date	date	Дата истечения срока действия Подписки.
data.attributes.name	string	Название Подписки.
data.attributes.renew-point-days	integer	Период в днях до даты истечения Подписки, когда становится доступна возможность продлить данную Подписку.
data.attributes.start-date	date	Дата активации Подписки.
data.attributes.status	string	Статус Подписки (список статусов см. в Просмотр списка подписок)

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

Запрос

PATCH http://billing.activeplatform.com/api/v3/vendor/subscriptions/79/close_charges

Заголовки

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
X-Api-Token: aaa000a1a2a1

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

Заголовки

Cache-Control →max-age=0, private, must-revalidate
Content-Type →application/vnd.api+json; charset=utf-8
ETag →W/"90bc4650aeb2f71ec4436c41cb380af7"
X-Request-Id →bff17525-12ab-4b17-b277-b01ae050b66a
X-Runtime →2.508313

Тело

{
    "data": {
        "id": "3003699",
        "type": "subscriptions",
        "attributes": {
            "created-at": "2018-04-10T09:33:25.359+03:00",
            "updated-at": "2018-04-10T09:42:16.751+03:00",
            "auto-renewal": false,
            "billing-from": "2018-04-10",
            "expiration-date": "2018-07-10",
            "name": "CSP plan with resources",
            "renew-point-days": 0,
            "start-date": "2018-04-10",
            "status": "active"
        }
    }
}