Продление Подписки
Метод создает новый Заказ на продление Подписки и возвращает ID и тело созданного Заказа, а также происходит создание Платежа.
POST /api/vendor/v1/subscriptions/:id/renew.json?api_token={api_token}&plan_period_id={plan_period_id}&promo_code={promo_code}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ Опциональный | Описание |
---|---|---|---|---|
id | path | integer | Обязательный | ID существующей подписки |
api_token | query | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике в ActivePlatform. Панель управления Оператора). |
plan_period_id | query | integer | Обязательный | ID периода тарифного плана подписки |
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/2005882/renew?api_token=654321&plan_period_id=2001243
Пример ответа
{
"id": 2010311,
"document_id": "RN002935",
"status": "waiting_for_payment",
"account_id": 2000532,
"type": "RenewalOrder",
"created_at": "2016-08-12T16:21:52.055+03:00",
"updated_at": "2016-08-12T16:21:52.950+03:00",
"expiration_date": "2016-08-12",
"total": 230,
"promo_code": null,
"payment_id": 2006907,
"items": [
{
"id": 16559,
"target_id": 2005882,
"target_type": "Subscription",
"type": "ProvisioningItem::Renew",
"status": "waiting_for_payment",
"description": "Fusion Manager"
}
],
"charges": [
{
"id": 754065,
"subscription_id": 2005882,
"subscription_resource_id": null,
"subscription_resource_name": null,
"plan_resource_id": null,
"resource_id": null,
"quantity": 1,
"operate_from": "2017-07-15",
"operate_to": "2017-07-30",
"duration": 0.484,
"description": "Renewal subscription (recurring fee) #2005882 \"Fusion Manager\"",
"unit_price": 20,
"amount": 9.68,
"status": "new",
"type": "Charge::Recurring",
"order_id": 2010311,
"close_date": "2017-07-30",
"created_at": "2016-08-12T16:21:52.823103+0300",
"updated_at": "2016-08-12T16:21:52.823103+0300"
}
]
}