Получение списка списаний конечных клиентов реселлера

Метод Get list of end-customer charges используется для получения списка списаний конечных клиентов для текущего реселлера или любого из его нижестоящих реселлеров.

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

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

GET {base_url}/api/v3/resellers/{reseller_id}/charges

Аргументы

Название

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

Тип данных

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

Описание

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

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

  • filter[close_date][gt] — дата закрытия более, чем указанная дата.
  • filter[close_date][lt] — дата закрытия менее, чем указанная дата.

filter[subscription_id]

query

integer

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

Фильтрация списка по ID подписки

filter[status]

query

string

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

Фильтрация списка по статусу списания (список статусов см. в Атрибуты списаний)

filter[created_at]

query

string

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

Предназначен для фильтрации списаний по дате и времени создания в формате RFC 3339 (например, 2019-05-29T15:12:01.558009+03:00 или 2019-05-29). Для указания диапазона используются следующие фильтры:
  • filter[created_at][gt] — дата и время более, чем указанные.
  • filter[created_at][lt] — дата и время менее, чем указанные.
filter[updated_at]

query

string

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

Предназначен для фильтрации списаний по дате дате и времени последнего обновления в формате RFC 3339 (например, 2019-05-29T15:12:01.558009+03:00 или 2019-05-29). Для указания диапазона используются следующие фильтры:
  • filter[updated_at][gt] — дата и время более, чем указанные.
  • filter[updated_at][lt] — дата и время менее, чем указанные.
filter[plan_class_ids]

query

string

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

Предназначен для фильтрации списаний по ID правила предоставления (см. Просмотр списка правил предоставления). Поддерживается указание списка из нескольких ID правил предоставления, разделенных запятыми
includequerystringОпциональный

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

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

Реселлер

reseller
Клиентaccount
Подпискаsubscription

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

plan

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

Название

Тип данных

Описание

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


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
linksobjectСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

selfstringСсылка на текущую страницу

firststringСсылка на первую страницу

prevstringСсылка на предыдущую страницу

nextstringСсылка на следующую страницу

laststringСсылка на последнюю страницу
metaobjectДополнительная информация о списании

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

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

GET /api/v3/resellers/1/charges?page[size]=2&page[number]=70&filter[close_date][gte]=2019-10-01&filter[close_date][lte]=2019-10-31&filter[status]=closed&filter[plan_class_ids]=1,5&include=reseller,account,subscription,plan
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "73083",
            "type": "charges",
            "attributes": {
                "created_at": "2019-08-21T11:50:21.263342+0300",
                "updated_at": "2019-11-16T01:18:26.253966+0300",
                "subscription_id": 3005638,
                "subscription_resource_id": 30146,
                "quantity": 1,
                "operate_from": "2019-09-01",
                "duration": 0.667,
                "description": "Upgrade resource (recurring fee) \"res3\" for Subscription #3005638 \"Auto provisioning with resources\"",
                "unit_price": "2.0",
                "amount": "1.27",
                "status": "closed",
                "type": "Charge::Recurring",
                "net_cost": null,
                "taxes_amount": 0,
                "subscription_resource_name": "res3",
                "plan_resource_id": 2158,
                "resource_id": 10,
                "order_id": 8025,
                "operate_to": "2019-09-20",
                "close_date": "2019-09-30",
				"billing_date": "2019-09-01",
				"application_template_key": "",
                "additional_params": [],
                "discount": "0.06",
                "original_amount": "1.27",
                "original_amount_currency": "BYN",
                "currency_rate": "1.0",
                "currency_unit": 1
            },
            "relationships": {
                "taxes": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "494",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3005638",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "5",
                        "type": "plans"
                    }
                },
                "plan_resource": {
                    "data": null
                },
                "discount": {
                    "data": {
                        "id": "89",
                        "type": "discounts"
                    }
                }
            }
        },
        {
            "id": "73109",
            "type": "charges",
            "attributes": {
                "created_at": "2019-08-22T15:59:54.376771+0300",
                "updated_at": "2019-10-12T01:15:30.459665+0300",
                "subscription_id": 3005649,
                "subscription_resource_id": null,
                "quantity": 1,
                "operate_from": "2019-09-01",
                "duration": 1,
                "description": "Switch resource (recurring fee) #3005649 \"Auto provisioning with resources\"",
                "unit_price": "1.0",
                "amount": "1.0",
                "status": "closed",
                "type": "Charge::Recurring",
                "net_cost": null,
                "taxes_amount": 0,
                "subscription_resource_name": null,
                "plan_resource_id": null,
                "resource_id": null,
                "order_id": 8036,
                "operate_to": "2019-09-30",
                "close_date": "2019-09-30",
				"billing_date": "2019-09-01",
				"application_template_key": "",
                "additional_params": [],
                "discount": "0.00",
                "original_amount": "1.0",
                "original_amount_currency": "BYN",
                "currency_rate": "1.0",
                "currency_unit": 1
            },
            "relationships": {
                "taxes": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "503",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3005649",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "5",
                        "type": "plans"
                    }
                },
                "plan_resource": {
                    "data": null
                },
                "discount": {
                    "data": null
                }
            }
        }
    ],
    "included": [
        {
            "id": "1",
            "type": "resellers",
            "attributes": {...
            }
        },
        {
            "id": "494",
            "type": "accounts",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "3005638",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2019-08-21T11:50:21.083490+0300",
                "updated_at": "2019-11-16T01:18:26.153891+0300",
                "auto_renewal": false,
                "billing_from": "2019-08-21",
                "expiration_date": "2019-09-21",
                "name": "Auto provisioning with resources",
                "auto_renew_point_days": 1,
                "start_date": "2019-08-21",
                "status": "deleted",
                "payment_model": "postpay",
                "payment_model_parameters": {
                    "credit_limit": 100,
                    "current_debt": 0
                }
            }
        },
        {
            "id": "5",
            "type": "plans",
            "attributes": {...
            }
        },
        {
            "id": "503",
            "type": "accounts",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "3005649",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2019-08-22T15:59:54.138703+0300",
                "updated_at": "2019-09-20T10:47:07.896382+0300",
                "auto_renewal": false,
                "billing_from": "2019-08-22",
                "expiration_date": "2019-12-22",
                "name": "Auto provisioning with resources",
                "auto_renew_point_days": 1,
                "start_date": "2019-08-22",
                "status": "waiting_for_manual_approve",
                "payment_model": "postpay",
                "payment_model_parameters": {
                    "credit_limit": 0,
                    "current_debt": 0
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=70&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=69&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=71&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=79&page%5Bsize%5D=2"
    },
    "meta": {
        "currency": "BYN"
    }
}