Получение информации о реселлер-списании

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

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

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

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

GET {base_url}/api/v3/resellers/{reseller_id}/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

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

ID списания

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

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

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

Реселлер

reseller

Клиент

account

Подписка

subscription

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

plan

Скидка

discount

Ресурс тарифного плана

plan_resource

Налогиtaxes

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

Название

Тип данных

Описание

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


id

stringID списания

typestringТип данных

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


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


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


charge_idinteger

ID связанного списания. Возможные варианты:

  • ID клиентского списания, закрытие которого инициировало генерацию реселлер-списания.
  • ID реселлер-списания нижестоящего реселлера, создание которого инициировало генерацию реселлер-списания.


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


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


amountstringСумма списания в валюте реселлера с налогами


net_coststring

  • Для реселлер-списания, не связанного с реселлер-списанием вышестоящего реселлера — себестоимость списания в валюте вышестоящего реселлера, рассчитанная по формуле:

    net_cost = cost × duration × quantity × net_cost_currency_rate / net_cost_currency_unit

    где cost — себестоимость периода или ресурса, заданная в тарифном плане для соответствующего типа списания.

  • Для реселлер-списания, связанного с реселлер-списанием вышестоящего реселлера — себестоимость списания в валюте реселлера на 2 уровня выше, равная сумме связанного реселлер-списания вышестоящего реселлера (amount).


tax_is_calculated_usingstring

Значение параметра Налоги рассчитываются в системных настройках на момент создания списания (см. Настройки расчета налогов):

  • net_prices — Сверх цены плана — цены в тарифном плане указаны без налогов.
  • gross_prices — Внутри цены плана — цены в тарифном плане включают в себя налоги.


net_amountstringСумма списания в валюте реселлера без налогов


taxes_amountstringСумма всех налогов в валюте реселлера для списания


net_cost_originalstring

Cебестоимость списания в валюте тарифного плана:

  • Для реселлер-списания, не связанного с реселлер-списанием вышестоящего реселлера, рассчитывается по формуле:

    net_cost_original = cost × duration × quantity

    где cost — себестоимость периода или ресурса, заданная в тарифном плане для соответствующего типа списания.

  • Для реселлер-списания, связанного с реселлер-списанием вышестоящего реселлера, рассчитывается по формуле:

    net_cost_original = amount × net_cost_currency_unit / net_cost_currency_rate

    где amount — сумма связанного реселлер-списания вышестоящего реселлера в валюте реселлера на 2 уровня выше.



net_cost_currency_ratestring
  • Для реселлер-списания, не связанного с реселлер-списанием вышестоящего реселлера — курс валюты вышестоящего реселлера к валюте тарифного плана на уровне вышестоящего реселлера, использованный при расчете себестоимости списания.
  • Для реселлер-списания, связанного с реселлер-списанием вышестоящего реселлера — курс валюты реселлера на 2 уровня выше к валюте тарифного плана на уровне реселлера на 2 уровня выше, использованный при расчете себестоимости списания.


net_cost_currency_unitinteger
  • Для реселлер-списания, не связанного с реселлер-списанием вышестоящего реселлера — номинал валюты, использованный при расчете себестоимости списания с учетом курса на уровне вышестоящего реселлера.
  • Для реселлер-списания, связанного с реселлер-списанием вышестоящего реселлера — номинал валюты, использованный при расчете себестоимости списания с учетом курса на уровне реселлера на 2 уровня выше.


unit_price_currencystringКод валюты тарифного плана, в котором хранится информация о стоимости


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


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


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


resource_idintegerID ресурса


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


operate_from

stringДата начала периода, оплаченного списанием, в формате ГГГГ-ММ-ДД


operate_tostringДата окончания периода, оплаченного списанием, в формате ГГГГ-ММ-ДД


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


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


typestring

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

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


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


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


additional_params

array of objects

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

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

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

  • azure_plan — списание сформировано для основного потребления по подписке Microsoft Azure Plan.
  • azure_ri — списание сформировано для зарезервированных ресурсов (Azure RI).
  • 3rd_party — списание сформировано для сторонних ресурсов (third-party).
  • azure_savings — списание сформировано для услуги Azure Savings Plan.
effective_costnumberСебестоимость списания для реселлера с учетом скидки PEC от Microsoft. Только для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan)
azure_plan_idstringID "контейнера" Azure Plan на стороне Microsoft, в рамках которого создаются подписки клиента. Только для подписок на услугу Microsoft Azure Plan (см. Заказ подписки на услугу Microsoft Azure Plan через Панель управления Оператора)
  • Manual Provisioning Plugin (Ручной Провижининг):
НазваниеТип данныхОписание
tenant_namestringОсновное имя клиента, заказавшего подписку (см. Получение информации о клиенте)
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
attribute_typestring

Информация о назначении списания:

effective_costnumberСебестоимость финального списания для реселлера. Только для подписок Google Cloud Platform (см. Формирование записей о потребленных ресурсах для подписки на Услугу Google Cloud Platform). В остальных случаях параметр отсутствует

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



discountstringРазмер скидки для списания в валюте реселлера


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


original_amount_currencystringКод валюты тарифного плана для расчета суммы списания


currency_ratestringКурс валюты реселлера к валюте тарифного плана на уровне реселлера, использованный при расчете суммы списания


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


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


net_cost_original_currencystringКод валюты тарифного плана для расчета себестоимости списания

relationshipsobject

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

  • Реселлер-списания одновременно связаны с родительским тарифным планом и ресурсом тарифного плана подписки.
  • При переключении тарифного плана старые списания по подписке и новые списания за возврат средств остаются связаны со старым тарифным планом и его ресурсами. Все остальные новые списания будут связаны с новым тарифным планом и его ресурсами.



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



dataarray of objects

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

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


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



dataobject

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

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


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



dataobject

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

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


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



dataobject

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

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


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



dataobject

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

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


managerobjectИнформация о менеджере



dataobject

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

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


plan_resourceobjectИнформация о ресурсе тарифного плана



dataobject

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

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


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



dataobject

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

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

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

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

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

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

auto_renewalbool

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

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

billing_fromstringДата начала генерации списаний по подписке в формате ГГГГ-ММ-ДД

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

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

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

start_datestringДата активации подписки в формате ГГГГ-ММ-ДД

statusstring

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


payment_modelstring

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

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

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


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


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

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

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

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

statusstring

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

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

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

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

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

duration_tostringДата окончания периода действия скидки в формате ГГГГ-ММ-ДД
  • Для ресурса тарифного плана:
НазваниеТип данныхОписание
idstringID ресурса тарифного плана
typestringТип данных
attributesobjectИнформация о ресурсе тарифного плана

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

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

namestring

Название ресурса


measurablebool

Признак использования модели расчета стоимости за фактическое использование ресурса (недоступен, если функция не поддерживается внешними службами):

  • true — используется расчет за фактическое использование ресурса.
  • false — не используется расчет за фактическое использование ресурса.

unit_of_measurestring

Единица измерения ресурса:

  • unit — измеряемый ресурс, для которого указывается определенное количество.
  • boolean — неизмеряемый ресурс (для ресурсов, у которых не надо указывать количество), возможные значения:
    • true — ресурс включен в тарифный план.
    • false — ресурс не включен в тарифный план.

application_template_namestringНазвание услуги, которая предоставляется в рамках данного тарифного плана

includedinteger

Количество ресурса, которое включено в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки)


minimuminteger

Минимальное количество ресурса (с учетом величины included), которое доступно для заказа (см. Ресурсы тарифного плана)


limitinteger

Максимальное количество ресурса, доступное для заказа. Если ресурс безлимитный (признак unlimited_units = true), то limit = 0


setup_feestring

Величина платежа за установку ресурса


recurring_feestring

Величина ежемесячной абонентской платы за ресурс


overuse_feestring

Стоимость перерасхода ресурсов


renewal_feestring

Стоимость продления использования ресурса


unlimited_unitsbool

Признак отключения лимитов использования ресурса:

  • true — лимиты отключены.
  • false — лимиты активны.

publicbool

Возможные значения:

  • true — ресурс доступен клиентам для заказа.
  • false — ресурс недоступен клиентам для заказа.

statusstring

Статус ресурса:

  • active — активный.
  • inactive — неактивный.
  • deleted — удален.

resource_idinteger

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


priorityintegerПриоритет ресурса. У основного ресурса priority максимальный

net_costsobject

Значения себестоимостей указанных типов, заданные для ресурса тарифного плана



setup_feestring

Величина платежа за установку ресурса



recurring_feestring

Величина ежемесячной абонентской платы за ресурс



overuse_feestring

Стоимость перерасхода ресурсов



renewal_feestring

Стоимость продления использования ресурса


custom_attributesobject

Информация о дополнительных параметрах ресурса в виде пар "ключ-значение"

  • Для налогов — о каждом налоге, использованном при создании списания:

    НазваниеТип данныхОписание
    idstringID налога
    typestringТип данных
    attributesobjectИнформация о налоге

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

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

    		charge_idintegerID списания, для которого рассчитан налог

    		origin_idintegerID налога в налоговом модуле

    		namestringНазвание налога

    		codestringКод налога

    		ratenumberРазмер налога в процентах

    		amountstringСумма налога в валюте реселлера, рассчитанная для net_amount списания

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

GET /api/v3/resellers/357/reseller_charges/64
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "64",
        "type": "reseller_charges",
        "attributes": {
            "created_at": "2023-01-12T18:48:44.987789+0000",
            "updated_at": "2023-01-12T18:48:44.987789+0000",
            "charge_id": 5375,
            "subscription_id": 1258,
            "unit_price": "12.0",
            "amount": "114.55",
            "net_cost": "70.95",
            "tax_is_calculated_using": "net_prices",
            "net_cost_original": "70.95",
            "net_cost_currency_rate": "1.0",
            "net_cost_currency_unit": 1,
            "net_amount": "77.4",
            "subscription_resource_id": 1376,
            "subscription_resource_name": "Licenses",
            "plan_resource_id": 104,
            "resource_id": 1,
            "unit_price_currency": "USD",
            "quantity": 10.0,
            "operate_from": "2023-01-12",
            "operate_to": "2023-01-31",
            "duration": 0.645,
            "description": "Upgrade resource (recurring fee) \"Licenses\" for Subscription #1258 \"Office\"",
            "type": "Charge::Recurring",
            "order_id": 2847,
            "application_template_key": "",
            "additional_params": [
                {
                    "tenant_name": "XXXXX",
                    "tenant_id": 103,
                    "order_id": 2847,
                    "subscription_id": 1258,
                    "offer_id": ""
                }
            ],
            "discount": "0.00",
            "original_amount": "114.55",
            "original_amount_currency": "USD",
            "taxes_amount": "37.15",
            "currency_rate": "1.0",
            "currency_unit": 1,
            "billing_date": "2023-01-01",
            "net_cost_original_currency": "USD"
        },
        "relationships": {
            "reseller": {
                "data": {
                    "id": "14",
                    "type": "resellers"
                }
            },
            "account": {
                "data": {
                    "id": "103",
                    "type": "accounts"
                }
            },
            "subscription": {
                "data": {
                    "id": "1258",
                    "type": "subscriptions"
                }
            },
            "plan": {
                "data": {
                    "id": "18",
                    "type": "plans"
                }
            },
            "plan_resource": {
                "data": {
                    "id": "104",
                    "type": "plan_resources"
                }
            },
            "manager": {
                "data": {
                    "id": "5",
                    "type": "managers"
                }
            },
            "discount": {
                "data": null
            },
            "taxes": {
                "data": [
                    {
                        "id": "80",
                        "type": "taxes"
                    },
                    {
                        "id": "81",
                        "type": "taxes"
                    },
                    {
                        "id": "82",
                        "type": "taxes"
                    },
                    {
                        "id": "83",
                        "type": "taxes"
                    }
                ]
            }
        }
    }
}