Изменение Ресурсов подписки
Метод создает новые Заказы на увеличение и/или уменьшение Ресурсов подписки. Метод возвращает ID и тело созданного Заказа.
В зависимости от переданного количества ресурсов:
- создается заказ на увеличение ресурсов подписки, если количество переданного ресурса больше, чем количество ресурса в подписке;
- создается заказ на уменьшение количества ресурсов, если количество переданного ресурса меньше, чем количество ресурса в подписке.
POST /api/vendor/v1/subscriptions/{id}/change.json?api_token={api_token}&resources[][id]={resourece_id}&resources[][quantity]={quantity}&promo_code={promo_code}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ Опциональный | Описание |
---|---|---|---|---|
id | path | integer | Обязательный | ID существующий подписки |
api_token | query | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике в ActivePlatform. Руководство по Панели управления Оператора). |
resources[][id] | query | integer | Обязательный | ID ресурса подписки. |
resources[][quantity] | query | integer | Обязательный | Количество дополнительных ресурсов. Для уменьшения ресурсов используются отрицательные значения. |
promo_code | query | string | Опциональный | Код для получения скидки. |
Модель ответа
Название | Тип данных | Описание |
---|---|---|
id | integer | ID заказа. |
document_id | string | Номер заказа |
status | string | Статус заказа. Может иметь следующие значения:
|
account_id | integer | ID аккаунта, с которого произведена оплата. |
type | string | Тип заказа. Может иметь следующие значения:
|
created_at | date | Дата и время создания заказа. |
updated_at | date | Дата и время последнего изменения заказа. |
expiration_date | date | Дата окончания, до которой заказ должен быть оплачен (заказ должен получить статус "Подтвержден"). Дата окончания рассчитывается исходя из установленного значения "Период отсрочки платежа" в "Правиле предоставления" (см. Создание правила предоставления в ActivePlatform. Руководство по Панели управления Оператора). |
total | float | Общая сумма заказа. |
promo_code | string | Промо-код, если данный код применялся при создании заказа (см. Создание Скидки по Промо-коду в ActivePlatform. Руководство по Панели управления Оператора). |
payment_id | integer | ID платежа, который связан с заказом. |
items | array | Перечень позиций в заказе:
|
charges | array | Список списаний, сформированных по данному заказу:
|
Пример запроса
POST http://billing.activeplatform.com:80/api/vendor/v1/subscriptions/2005786/change?api_token=654321&resources[][id]=132341&resources[][quantity]=3
Пример ответа
{
"id": 2010322,
"document_id": "CO000157",
"status": "waiting_for_payment",
"account_id": 2000532,
"type": "ChangeOrder",
"created_at": "2016-09-01T12:44:54.222+03:00",
"updated_at": "2016-09-01T12:44:54.538+03:00",
"expiration_date": "2016-09-01",
"total": 0.02,
"promo_code": null,
"payment_id": 2006917,
"items": [
{
"id": 16577,
"target_id": 132341,
"target_type": "SubscriptionResource",
"type": "ProvisioningItem::Upgrade",
"status": "waiting_for_payment",
"description": "Users"
}
],
"charges": [
{
"id": 754132,
"subscription_id": 2005786,
"subscription_resource_id": 132341,
"subscription_resource_name": "Users",
"plan_resource_id": 2000854,
"resource_id": 2002273,
"quantity": 3,
"operate_from": "2016-09-15",
"operate_to": "2016-09-26",
"duration": 0.367,
"description": "Увеличение ресурса (абонентская плата) \"Users\" подписки #2005786 \"Microsoft Exchange 2013 Базовый\"",
"unit_price": 0.01,
"amount": 0.01,
"status": "new",
"type": "Charge::Recurring",
"order_id": 2010322,
"close_date": "2016-09-26",
"created_at": "2016-09-01T12:44:54.434384+0300",
"updated_at": "2016-09-01T12:44:54.434384+0300"
}
]
}