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


Response model

Name


Data type

Description

category_name

stringA plan category name (see Managing plan categories in the ActivePlatform. Operator Control Panel).
plan_periods






      

 
plan_idinteger

A plan ID.

plan_period_idinteger

A plan period ID.

plan_namestring

A plan name.

plan_period_recurring_feefloat

A value of monthly fee for the resource; this type of fee is used if the customer has to pay for the resource each month to renew the subscription.

plan_period_setup_feefloat

A price of the resource installation.

plan_period_durationfloat

A duration of the cheapest plan period (in months).

plan_descriptionstring

Detailed information about plan, which is displayed on the Customer Control Panel. 

sumstring

A price of the cheapest plan considering setup fee (the price is displayed with a currency symbol).

plan_custom_attributesarray

A list of 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.

Request example

GET http://billing.activeplatform.com:80/api/v2/client/market.json?api_token=Dk74cdo4Qib2IsHmO7RjOQ

Response example

{
  "all_plans": [
    {
      "category_name": "RealServices",
      "plan_periods": [
        {
          "plan_id": 2000396,
          "plan_period_id": 2000590,
          "plan_name": "Office 365",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": 0.167,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000397,
          "plan_period_id": 2000592,
          "plan_name": "Plan for AS account",
          "plan_period_recurring_fee": 2,
          "plan_period_setup_fee": 1,
          "plan_period_duration": 0.067,
          "plan_description": "",
          "sum": "$1.13",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000359,
          "plan_period_id": 2000540,
          "plan_name": "Domain registration.ru",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": 36,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000358,
          "plan_period_id": 2000537,
          "plan_name": "Domain registration.net",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": 24,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000132,
          "plan_period_id": 2000238,
          "plan_name": "Domain registration.com",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": 24,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000578,
          "plan_period_id": 2000827,
          "plan_name": "17",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": 0.233,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000390,
          "plan_period_id": 2000587,
          "plan_name": "Domain registration.info",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": 24,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000400,
          "plan_period_id": 2000596,
          "plan_name": "Plan for AS account2",
          "plan_period_recurring_fee": 1,
          "plan_period_setup_fee": 0.25,
          "plan_period_duration": 0.033,
          "plan_description": "",
          "sum": "$0.28",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000403,
          "plan_period_id": 2000600,
          "plan_name": "Plan for AS account4",
          "plan_period_recurring_fee": 0.15,
          "plan_period_setup_fee": 0.2,
          "plan_period_duration": 0.033,
          "plan_description": "",
          "sum": "$0.20",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000383,
          "plan_period_id": 2000574,
          "plan_name": "Domain registration.org",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": 24,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        },
        {
          "plan_id": 2000289,
          "plan_period_id": 2000742,
          "plan_name": "exchange",
          "plan_period_recurring_fee": 0,
          "plan_period_setup_fee": 0,
          "plan_period_duration": null,
          "plan_description": "",
          "sum": "$0.00",
          "plan_custom_attributes": []
        }
      ]
    }
}