Получение информации о списании конечного клиента нижестоящего реселлера по ID

Метод Get end-customer charge of downstream reseller позволяет получить информацию о списании конечного клиента для нижестоящего реселлера по отношению к текущему реселлеру.

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

По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_charges/{charge_id}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

charge_id

path

string

Обязательный

ID списания

includequerystringОпциональный

Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:

ОбъектЗначение параметра

Реселлер

reseller

Клиент

account

Подписка

subscription

Тарифный план

plan

Скидка

discount

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

Название

Тип данных

Описание

dataobjectДанные ответа


id

integerID списания

typestringТип данных

attributesobjectИнформация о списании


created_atdateДата и время создания списания


updated_atdateДата и время последнего изменения списания


subscription_idintegerID клиентской подписки


subscription_resource_idintegerID ресурса в клиентской подписке


quantityintegerКоличество заказанных единиц услуги или ресурса


operate_from

dateДата начала периода, оплаченного списанием


durationfloatПериод списания, измеряемый в месяцах. Например, период 1 день = 0.033, 2 года = 24


descriptionstringПодробное описание списания


unit_pricefloatСтоимость единицы ресурса или услуги у выбранного реселлера в валюте тарифного плана


amountfloatОбщая сумма списания (с учетом скидки) в валюте выбранного реселлера


statusstringСтатус списания (список статусов см. в Атрибуты списаний)


typestring

Тип списания (см. также Атрибуты списаний):

  • Charge::Setup — списание за установку подписки.
  • Charge::Recurring — списание за абонентскую плату подписки.
  • Charge::RecurringResource — списание за абонентскую плату ресурса подписки.
  • Charge::Renewal — списание за продление подписки.
  • Charge::RenewalResource — списание за продление ресурса.
  • Charge::ExternalResource — списание за использование внешнего ресурса.
  • Charge::SetupResource — списание за установку ресурсов подписки.
  • Charge::Transfer — списание за перенос домена.


net_costfloatСебестоимость списания для выбранного реселлера в валюте тарифного плана. Величина рассчитывается только для делегированных тарифных планов


taxes_amountfloatСумма налогов для данного списания в валюте выбранного реселлера


subscription_resource_namestringИмя ресурса в подписке, которая была заказана клиентом


plan_resource_idintegerID ресурса в тарифном плане, который был заказан клиентом


resource_idintegerID ресурса в шаблоне услуги


order_idintegerID заказа, по которому произведено списание


operate_todateДата окончания периода, оплаченного списанием


close_datedate

Дата, когда списание должно быть закрыто



billing_datedateДата начала финансового периода, к которому относится списание


application_template_keystringКлюч шаблона услуги, на основе которого создано приложение для подписки (см. Просмотр и обновление информации о коннекторе)


additional_params

array of objects

Дополнительные параметры списания для услуг на основе следующих модулей:

  • MicrosoftCspProducts:
НазваниеТип данныхОписание
tenant_idstringID тенанта в Microsoft Partner Center
tenant_namestringИмя тенанта (домен) в Microsoft Partner Center
subscription_idstringID подписки на стороне Microsoft (внешний ID)
order_idstringID заказа на стороне Microsoft
alternate_idstringАльтернативный ID заказа на стороне Microsoft
product_idstringID продукта на стороне Microsoft, к которому относится ресурс, связанный со списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
sku_idstringSKU ресурса на стороне Microsoft, связанного со списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
attribute_typestring

Информация о назначении списания для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan):

  • azure_plan — списание сформировано для основного потребления по подписке Microsoft Azure Plan.
  • azure_ri — списание сформировано для зарезервированных ресурсов (Azure RI).
  • 3rd_party — списание сформировано для сторонних ресурсов (third-party).
effective_costfloatСебестоимость списания для реселлера с учетом скидки PEC от Microsoft. Только для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan)
  • Manual Provisioning Plugin (Ручной Провижининг):
НазваниеТип данныхОписание
tenant_namestringОсновное имя клиента, заказавшего подписку (см. Получение информации о клиенте реселлера по ID)
tenant_idstringID клиента, заказавшего подписку
order_idstringID заказа на покупку, связанного с подпиской
subscription_idstringID подписки
offer_idstringSKU тарифного плана, на основе которого создана подписка (см. Получение информации о тарифном плане реселлера)
  • Office365:
НазваниеТип данныхОписание
tenant_namestringИмя тенанта (домен) в Microsoft Partner Center
tenant_idstringИдентификатор тенанта в Microsoft Partner Center
order_idstringНомер заказа на стороне Microsoft
subscription_idstringID подписки на стороне Microsoft
offer_idstringУникальный идентификатор (SKU) плана или дополнения в Microsoft Partner Center
  • Vendor Service Plugin (VSP):
НазваниеТип данныхОписание
external_idstringApplication External ID (внешний ID)
plan_skustringPlan SKU
subscription_attributesobjectДополнительные атрибуты подписки, созданные в Vendor Portal, кроме атрибута, содержащего пароль
resource_keystringApplication Resource Key

В остальных случаях возвращается пустой массив



discountfloatРазмер скидки для данного списания в валюте выбранного реселлера


original_amountstringРазмер списания в валюте тарифного плана


original_amount_currencystringКод валюты тарифного плана


currency_ratestringКурс, по которому сформировано списание


currency_unitintegerНоминал валюты, который использовался при расчете величины списания

relationshipsobjectПеречень объектов, связанных со списанием


taxesobjectИнформация о налогах



dataarray

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


resellerobjectИнформация о реселлере



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


accountobjectИнформация о клиенте



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


subscriptionobjectИнформация о подписке



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


planobjectИнформация о тарифном плане



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


plan_resourceobjectИнформация о ресурсе



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


discountobjectИнформация о скидке



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных
includedarray

Дополнительная информация о связанных объектах, указанных в запросе:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных
attributesobjectАтрибуты (см. ниже)
НазваниеТип данныхОписание
idintegerID подписки
typestringТип данных
attributesobjectИнформация о подписке

created_atdateДата и время создания подписки

updated_atdateДата и время последнего изменения подписки

auto_renewalbool

Признак автоматического продления подписки:

  • true — автоматическое продление включено.
  • false — автоматическое продление отключено.

billing_fromdateДата начала генерации списаний по подписке

expiration_datedateДата истечения срока действия подписки

namestringНазвание подписки

auto_renew_point_daysintegerТочка автоматического продления подписки (в днях)

start_datedateДата активации подписки

statusstring

Статус подписки (список статусов см. в Просмотр списка подписок)


payment_modelstring

Модель оплаты подписки. Возможные значения:

  • prepay — Предоплата.
  • postpay — Постоплата.

payment_model_parametersobjectПараметры модели оплаты подписки


credit_limitfloatВеличина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay


current_debtfloatВеличина текущей задолженности по подписке. Возвращается только для payment_model = postpay
НазваниеТип данныхОписание
idstringID скидки
typestringТип данных
attributesobjectИнформация о скидке

created_atstringДата и время создания скидки

updated_atstringДата и время последнего изменения скидки

namestringНазвание скидки

statusstring

Статус скидки:

  • active — скидка доступна для применения при создании заказов.
  • inactive — скидка недоступна для применения при создании заказов.

typestringТип скидки (подробнее о типах скидки см. Управление скидками)

percentagestringРазмер скидки в процентах

duration_fromstringДата начала периода действия скидки (в формате ГГГГ-ММ-ДД)

duration_tostringДата окончания периода действия скидки (в формате ГГГГ-ММ-ДД)
metaarrayДополнительная информация о списании

currencystringКод валюты реселлера

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

GET /api/v3/resellers/1/child_reseller_charges/6118?include=reseller,account,subscription,plan,discount
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "6118",
        "type": "charges",
        "attributes": {
            "created_at": "2016-11-30T12:35:53.737502+0300",
            "updated_at": "2017-01-19T17:35:29.198370+0300",
            "subscription_id": 315,
            "subscription_resource_id": null,
            "quantity": 1,
            "operate_from": "2017-01-01",
            "duration": 1,
            "description": "Upgrade resource (recurring fee) \"HDD\" for Subscription #315 \"Auto provisioning w/o resources \"",
            "unit_price": "0.0",
            "amount": "0.5",
            "status": "deleted",
            "type": "Charge::Recurring",
            "net_cost": null,
            "taxes_amount": 0,
            "subscription_resource_name": null,
            "plan_resource_id": null,
            "resource_id": null,
            "order_id": 404,
            "operate_to": "2017-01-31",
            "close_date": "2017-01-31",
			"billing_date": "2017-01-01",
			"application_template_key": "",
            "additional_params": [],
            "discount": "0.50",
            "original_amount": "0.5",
            "original_amount_currency": "BYN",
            "currency_rate": "1.0",
            "currency_unit": 1
        },
        "relationships": {
            "taxes": {
                "data": []
            },
            "reseller": {
                "data": {
                    "id": "1",
                    "type": "resellers"
                }
            },
            "account": {
                "data": {
                    "id": "10",
                    "type": "accounts"
                }
            },
            "subscription": {
                "data": {
                    "id": "315",
                    "type": "subscriptions"
                }
            },
            "plan": {
                "data": {
                    "id": "9",
                    "type": "plans"
                }
            },
            "plan_resource": {
                "data": null
            },
            "discount": {
                "data": {
                    "id": "17",
                    "type": "discounts"
                }
            }
        }
    },
    "included": [
        {
            "id": "1",
            "type": "resellers",
            "attributes": {...
            }
        },
        {
            "id": "10",
            "type": "accounts",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "315",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2016-11-30T12:35:53.369910+0300",
                "updated_at": "2017-05-14T01:02:45.402943+0300",
                "auto_renewal": false,
                "billing_from": "2016-11-30",
                "expiration_date": "2017-04-30",
                "name": "Auto provisioning w/o resources ",
                "auto_renew_point_days": 0,
                "start_date": "2016-11-30",
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        },
        {
            "id": "9",
            "type": "plans",
            "attributes": {...
            }
        },
        {
            "id": "17",
            "type": "discounts",
            "attributes": {
                "created_at": "2016-11-30T12:34:35.246+03:00",
                "updated_at": "2016-11-30T16:39:35.514+03:00",
                "name": "sale50",
                "status": "inactive",
                "type": "promo_code",
                "percentage": "50.0",
                "duration_from": null,
                "duration_to": null
            }
        }
    ],
    "meta": {
        "currency": "BYN"
    }
}