Get the downstream Reseller's Plan information by ID

The Get the Child Reseller's Plan by ID method returns Plan details by the given Plan ID of the downstream Reseller of the current Reseller or any of its downstream Resellers.

Access to the current Reseller and downstream Resellers is determined by the Manager's token in the API request.

GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_plans/{plan_id}

Arguments

Name	Parameter Type	Data type	Required/Optional	Description
X-Api-Token	header	string	Required	API token of the Manager that performs the operation (see Viewing and updating Manager's information)
Content-Type	header	string	Required	Indicates the media type (text/html or text/JSON) of the request that is sent to the server by the client (browser)
Accept	header	string	Required	Information about data types that the client (browser) supports
reseller_id	path	integer	Required	ID of the current Reseller or of any its downstream Resellers (see Viewing and updating reseller general information)
plan_id	path	integer	Required	ID of the Plan

Response model

Name							Data type	Description
data							array	Response data
	id						integer	ID of the Plan
	type						string	Data type
	attributes						object	Information about the Plan
		created_at					date	Date and time of the Plan creation
		updated_at					date	Date and time when the Plan was updated
		status					string	Status of the Plan (for the list of Plans statuses, see Viewing the list of plans)
		name					string	Name of the Plan
		description					string	Plan details description
		public					bool	Indication whether the Plan is available for sale: true — the Plan is available for sale false — the Plan is not available for sale
		plan_class_id					integer	ID of the Service Term (see Managing service terms)
		product_id					integer	ID of the Product of the Plan
		billing_type					string	Billing type of the Plan
		ancestry					string	For delegated Plans, consists of the list of all parent Plans starting from the root Plan (see Viewing the list of delegated plans). For plans created by the Reseller, is null.
		reseller_id					integer	ID of the Reseller
		plan_class					string	Name of the Service Term
		product_category_id					integer	ID of the Product Category of the Plan
		product_category					string	Name of the Product Category of the Plan
		product					string	Name of the Product of the Plan
		plan_resources					array of objects	Resources of the Plan
			data				array	Object data
				id			integer	ID of the Resource in the Plan
				type			string	Data type
				attributes			object	Information about the Resource
					created_at		date	Date and time of the Resource creation
					updated_at		date	Date and time when the Resource was updated
					name		string	Name the Resource
					measurable		bool	Displays whether the actual amount of the used Resource is supported: true — the actual amount of the used Resource is used for generating Charges false — the actual amount of the used Resource is not used for generating Charges
					unit_of_measure		string	Unit of measure of the Resource: unit — the Resource is measurable. The Resource amount is specified. boolean — the Resource is non-measurable. The Resource amount is not required and: true — the Resource is included in the Plan false — the Resource is not included in the Plan
					application_template_name		string	Name of the Application template
					included		integer	Amount of the Resource included in the Plan by default (included Resources are part of the Subscription price)
					minimum		integer	Minimum amount of the Resource (together with the included amount) available for ordering (see Plan Resources)
					limit		integer	Maximum amount of the Resource available for ordering. The limit value can be equal to 0 in the following cases: The Resource is unlimited (unlimited_units=true) The Resource is not unlimited (unlimited_units=false) but the minimum and limit amounts of the Resource equals to 0 (minimum=0 and limit=0)
					setup_fee		float	Setup fee of the Resource
					recurring_fee		float	Monthly recurring fee of the Resource
					overuse_fee		float	Overuse fee of the Resource
					renewal_fee		float	Renewal fee of the Resource
					unlimited_units		bool	Attribute of the unlimited Resource: true — the Resource is unlimited false — the Resource is not unlimited
					public		bool	Availability of the Resource: true — the Resource is available for ordering false — the Resource is not available for ordering
					status		string	Status of the Resource: active inactive deleted
					resource_id		integer	ID of the Resource in the Application template
					custom_attributes		array of objects	Information about custom attributes of the Resource
						plan_resources.custom_attributes.['custom-attribute-key']	string	Value of the custom attribute of the Resource
		plan_periods					array of objects	Plan Periods
			data				array	Object data
				id			integer	ID of the Plan Period
				type			string	Data type
				attributes			object	Information about the Plan Period
					created_at		date	Date and time of the Plan Period creation
					updated_at		date	Date and time when the Plan Period was updated
					duration_value		integer	Duration of the Plan Period
					duration_type		string	Unit of measure of the Plan Period duration
					setup_fee		float	Setup fee of the Plan for the Plan Period
					recurring_fee		float	Monthly recurring fee of the Plan for the Plan Period
					transfer_fee		float	Transfer fee of a domain for the Plan Period. The transfer fee is applied if domains are available as a Resource in the Service
					renewal_fee		float	Renewal fee of the Plan for the Plan Period
					trial		bool	Plan Period type: true — trial Plan Period false — commercial Plan Period
					public		bool	Availability of the Plan Period: true — the Plan Period is available for ordering false — the Plan Period is not available for ordering
					status		string	Status of the Plan Period: active deleted
					description		string	Plan Period details description
		available_account_types					array of objects	Information about Account Types
			id				integer	ID of the Account Type
			name				string	Name of the Account Types
			created_at				date	Date and time of the Account Type creation
			updated_at				date	Date and time when the Account Type was updated
			reseller_id				integer	ID of the Reseller linked to the Account Type
			name_pattern				string	Template of the Account Type name which is displayed in the platform
			primary_name				string	Name of the field with the primary name of the Account. For example, for the Business Account Type, the filed may be named as Company name
			key				string	Key that is used to refer to the Account Type by API or a Placeholder
			default_payment_method_id				integer	ID of the default Payment method (see Configuring payment methods)
			ancestry				integer	ID of the parent Account Type
			use_by_default				bool	Default Account Type: true — the Account Type is used by default false — the Account Type is not used by default
		plan_currency					string	Currency code of the Plan
		custom_attributes					object	Information about custom attributes of the Plan
			custom_attributes.['custom_attribute_key']				string	Value of the custom attribute of the Plan

Request example

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

Response example

{
    "data": {
        "id": "36",
        "type": "plans",
        "attributes": {
            "created_at": "2016-10-27T16:29:29.154+03:00",
            "updated_at": "2019-01-09T12:11:51.357+03:00",
            "status": "active",
            "name": "Office 365 Enterprise E1",
            "description": "",
            "public": true,
            "plan_class_id": 18,
            "product_id": 407,
            "billing_type": "reservation",
            "ancestry": "24/28",
            "reseller_id": 7,
            "plan_class": "Default1",
            "product_category_id": 293,
            "product_category": "Default",
            "product": "Default",
            "plan_resources": {
                "data": [
                    {
                        "id": "621",
                        "type": "plan_resources",
                        "attributes": {
                            "created_at": "2016-10-27T16:29:29.224+03:00",
                            "updated_at": "2016-10-27T16:29:29.224+03:00",
                            "name": "Licences count",
                            "measurable": false,
                            "unit_of_measure": "unit",
                            "application_template_name": "Office 365 Enterprise E1",
                            "included": 0,
                            "minimum": 1,
                            "limit": 0,
                            "setup_fee": "0.0",
                            "recurring_fee": "0.0",
                            "overuse_fee": "0.0",
                            "renewal_fee": "0.0",
                            "unlimited_units": true,
                            "public": true,
                            "status": "active",
                            "resource_id": 287,
                            "custom_attributes": {
                                "item_1c_for_resellers": ""
                            }
                        }
                    },
                    {
                        "id": "629",
                        "type": "plan_resources",
                        "attributes": {
                            "created_at": "2016-10-27T16:29:29.477+03:00",
                            "updated_at": "2016-10-27T16:29:29.477+03:00",
                            "name": "Customer Lockbox",
                            "measurable": false,
                            "unit_of_measure": "unit",
                            "application_template_name": "Office 365 Enterprise E1",
                            "included": 0,
                            "minimum": 0,
                            "limit": 0,
                            "setup_fee": "0.0",
                            "recurring_fee": "1.6",
                            "overuse_fee": "0.0",
                            "renewal_fee": "0.0",
                            "unlimited_units": true,
                            "public": true,
                            "status": "active",
                            "resource_id": 302,
                            "custom_attributes": {}
                        }
                    }
                ]
            },
            "plan_periods": {
                "data": [
                    {
                        "id": "179",
                        "type": "plan_periods",
                        "attributes": {
                            "created_at": "2016-10-27T16:29:29.192+03:00",
                            "updated_at": "2016-10-27T16:29:29.192+03:00",
                            "duration_value": 1,
                            "duration_type": "year",
                            "setup_fee": "45.0",
                            "recurring_fee": "30.0",
                            "transfer_fee": "0.0",
                            "renewal_fee": "30.0",
                            "trial": false,
                            "public": true,
                            "status": "active",
                            "description": ""
                        }
                    }
                ]
            },
            "available_account_types": [
                {
                    "id": 16,
                    "name": "Personal BLR",
                    "created_at": "2016-10-27T16:24:44.322+03:00",
                    "updated_at": "2017-08-08T15:55:36.439+03:00",
                    "reseller_id": 7,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personalblr",
                    "default_payment_method_id": null,
                    "ancestry": "1/68/9",
                    "use_by_default": false
                },
                {
                    "id": 17,
                    "name": "Business BLR",
                    "created_at": "2016-10-27T16:24:44.342+03:00",
                    "updated_at": "2017-05-10T19:28:56.330+03:00",
                    "reseller_id": 7,
                    "name_pattern": "%primary_name",
                    "primary_name": "Company name",
                    "key": "businessblr",
                    "default_payment_method_id": null,
                    "ancestry": "2/67/8",
                    "use_by_default": false
                }
            ],
            "plan_currency": "USD",
            "custom_attributes": {}
        }
    }
}