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

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

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

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

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

GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_plans/{plan_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 любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
plan_idpathintegerОбязательный

ID тарифного плана

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

Модель ответа аналогична методу Get plan, за исключением дополнительной информации о связанных объектах (см. Получение информации о тарифном плане).

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

GET /api/v3/resellers/1/child_reseller_plans/368
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "368",
        "type": "plans",
        "attributes": {
            "created_at": "2017-07-07T11:28:07.244+03:00",
            "updated_at": "2017-07-07T11:28:07.404+03:00",
            "status": "active",
            "name": "Plan VSP billing info 7/1",
            "description": "The best Plan",
            "public": true,
            "plan_class_id": 1366,
            "product_id": 403,
            "billing_type": "reservation",
            "ancestry": "24/28",
            "reseller_id": 7,
            "fixed_price": true,
            "sku": "f54f74e9a239",
            "singleton": false,
            "auto_renewal": true,
            "auto_renewal_disabled": false,
            "plan_class": "Plan VSP billing info 7-Reservation",
            "product_category_id": 190,
            "product_category": "default",
            "product_category_public": false,
            "product": "Default",
            "plan_resources": {
                "data": [
                    {
                        "id": "2005",
                        "type": "plan_resources",
                        "attributes": {
                            "created_at": "2017-07-07T11:28:07.320+03:00",
                            "updated_at": "2017-07-07T11:28:07.320+03:00",
                            "name": "Users",
                            "measurable": null,
                            "unit_of_measure": "unit",
                            "application_template_name": "Plan VSP billing info 7",
                            "included": 1,
                            "minimum": 1,
                            "limit": 300,
                            "setup_fee": "0.0",
                            "recurring_fee": "249.93",
                            "overuse_fee": "0.0",
                            "renewal_fee": "0.0",
                            "unlimited_units": false,
                            "public": true,
                            "status": "active",
                            "resource_id": 997,
                            "priority": 0,
                            "net_costs": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0"
                            },
                            "erp": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0"
                            }, 
                            "custom_attributes": {}
                        }
                    },
                    {
                        "id": "2006",
                        "type": "plan_resources",
                        "attributes": {
                            "created_at": "2017-07-07T11:28:07.349+03:00",
                            "updated_at": "2017-07-07T11:28:07.349+03:00",
                            "name": "Licenses",
                            "measurable": null,
                            "unit_of_measure": "unit",
                            "application_template_name": "Plan VSP billing info 7",
                            "included": 0,
                            "minimum": 0,
                            "limit": 300,
                            "setup_fee": "0.0",
                            "recurring_fee": "249.93",
                            "overuse_fee": "0.0",
                            "renewal_fee": "0.0",
                            "unlimited_units": false,
                            "public": true,
                            "status": "active",
                            "resource_id": 998,
                            "priority": 1,
                            "net_costs": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0"
                            },
                            "erp": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0"
                            }, 
                            "custom_attributes": {}
                        }
                    }
                ]
            },
            "plan_periods": {
                "data": [
                    {
                        "id": "819",
                        "type": "plan_periods",
                        "attributes": {
                            "created_at": "2017-07-07T11:28:07.366+03:00",
                            "updated_at": "2017-07-07T11:28:07.366+03:00",
                            "duration_value": 1,
                            "duration_type": "year",
                            "setup_fee": "4.0",
                            "recurring_fee": "4.0",
                            "transfer_fee": "0.4",
                            "renewal_fee": "5.54",
                            "trial": false,
                            "public": true,
                            "status": "active",
                            "description": null,
                            "endless": false,
                            "net_costs": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "transfer_fee": "0.0",
                                "renewal_fee": "0.0"
                            },
                            "erp": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "transfer_fee": "0.0",
                                "renewal_fee": "0.0"
                            } 
                        }
                    }
                ]
            },
            "available_account_types": {
                "data": [
                    {
                        "id": "12",
                        "type": "account_types",
                        "attributes": {
                            "created_at": "2016-10-25T05:16:28.789779+0000",
                            "updated_at": "2017-02-01T12:04:39.227805+0000",
                            "reseller_id": 1,
                            "name": "Business",
                            "ancestry": null,
                            "default_payment_method_id": 197,
                            "key": "business",
                            "name_pattern": "%primary_name",
                            "use_by_default": false,
                            "primary_name": "Company name"
                        }
                    },
                    {
                        "id": "1564",
                        "type": "account_types",
                        "attributes": {
                            "created_at": "2017-03-20T13:34:28.163302+0000",
                            "updated_at": "2022-09-15T08:33:31.943006+0000",
                            "reseller_id": 1,
                            "name": "Personal",
                            "ancestry": "1562",
                            "default_payment_method_id": 2,
                            "key": "personal",
                            "name_pattern": "%first_name %middle_name %last_name",
                            "use_by_default": false,
                            "primary_name": ""
                        }
                    }
                ]
            },
            "plan_currency": "RUB",
            "custom_attributes": {
                "item_1c_id": "123456"
            }
        },
        "relationships": {
            "plan_category": {
                "data": {
                    "id": "190",
                    "type": "plan_categories"
                }
            }
        }
    }
}