Get a List of Plans for Marketplace

This method allows to get the List of Plans for the marketplace, which is displayed on the Customer Control Panel. For each Plan, the method returns the cheapest Plan Period considering the Setup fee.

GET /api/v2/client/market.json

The method does not require authorization.

Response model

Name		Data type	Description
all_plans		array of objects	Information about Plans periods with the lowest price
product_category_id		integer	ID of a Products category that is related to a Plan
product_category		string	Name of a Products category that is related to a Plan
product_id		integer	ID of a Product that is related to a Plan
product		string	Name of a Product that is related to a Plan
plan_periods	plan_id	integer	Plan ID
	plan_period_id	integer	Plan period ID
	plan_name	string	Plan name
	plan_period_recurring_fee	float	Monthly recurring fee for the Resource
	plan_period_setup_fee	float	Fee for the Resource installation
	plan_period_duration	float	Duration of the cheapest Plan period (in months)
	plan_description	string	Detailed information about Plan, which is displayed in Customer Control Panel.
	sum	string	Price for the cheapest Plan taking into account all applicable fees. Price is displayed with a currency symbol
	plan_custom_attributes	array	A list of Plan additional attributes (see Managing attributes in the ActivePlatform. Operator Control Panel): key — a key that is used to refer to the element by API or placeholder. value — a value of the attribute.
	plan_type	string	Тип Тарифного плана: Application — Plan for ordering a Service. Certificate — Plan for ordering a Certificate.
	plan_currency	string	Currency code of the Plan

Request example

GET http://billing.activeplatform.com:80/api/v2/client/market.json

Response example

{
    "all_plans": [
        {
            "product_category_id": 551,
            "product_category": "default",
            "product_id": 521,
            "product": "Default",
            "plan_periods": [
                {
                    "plan_id": 1367,
                    "plan_period_id": 3062,
                    "plan_name": "Manual Provisioning",
                    "plan_period_recurring_fee": 10,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": 1,
                    "plan_description": "",
                    "sum": "$10.00",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "USD"
                },
                 
                {
                    "plan_id": 1391,
                    "plan_period_id": 3119,
                    "plan_name": "CSP_annual",
                    "plan_period_recurring_fee": 0,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": 12,
                    "plan_description": "billing csp annual",
                    "sum": "0.00 бел. руб.",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "BYN"
                },
                {
                    "plan_id": 1401,
                    "plan_period_id": 3124,
                    "plan_name": "Dr.Web Free",
                    "plan_period_recurring_fee": 0,
                    "plan_period_setup_fee": 1,
                    "plan_period_duration": null,
                    "plan_description": "",
                    "sum": "1.00 руб.",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "RUB"
                },
                {
                    "plan_id": 1625,
                    "plan_period_id": 3419,
                    "plan_name": "New plan test product",
                    "plan_period_recurring_fee": 0,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": null,
                    "plan_description": "",
                    "sum": "0.00 руб.",
                    "plan_custom_attributes": [
                        {
                            "key": "product_line",
                            "value": ""
                        }
                    ],
                    "plan_type": "application",
                    "plan_currency": "RUB"
                }
            ]
        },
        {
            "product_category_id": 552,
            "product_category": "test",
            "product_id": 500,
            "product": "default",
            "plan_periods": [
                {
                    "plan_id": 1437,
                    "plan_period_id": 3208,
                    "plan_name": "Default product test category",
                    "plan_period_recurring_fee": 1,
                    "plan_period_setup_fee": 0,
                    "plan_period_duration": 1,
                    "plan_description": "",
                    "sum": "1.00 €",
                    "plan_custom_attributes": [],
                    "plan_type": "application",
                    "plan_currency": "EUR"
                }
            ]
        }
    ]
}