Get plan

The Get plan method returns plan details for the current reseller or any of its downstream resellers.

An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating Manager's information

The manager's API token specified in an API request determines the current reseller and downstream resellers accessible within a method.

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

Arguments

Name

Parameter Type

Data type

Required/Optional

Description

X-Api-TokenheaderstringRequiredAPI token of a manager that performs the operation (see Viewing and updating Manager's information)
Content-TypeheaderstringRequiredMedia type of the request. Specify the following: application/vnd.api+json
AcceptheaderstringRequired

Supported media types of the answer. Specify the following: application/vnd.api+json

base_urlpathstringRequiredActivePlatform URL
reseller_idpathintegerRequiredID of the current reseller or any of its downstream resellers (see Viewing and updating Reseller general information)
plan_idpathintegerRequiredID of the plan
includequerystringOptional

Returns additional information about objects related to a plan. The following objects and possible values are supported:

ObjectParameter value
Plan categoryplan_category

Response model

Name

Data type

Description

dataarrayResponse data


id

integer

ID of the plan


typestringData type

attributesobjectInformation about the plan


created_at

string

Date and time of the plan creation



updated_at

string

Date and time when the plan was updated



statusstringStatus 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_typestringBilling type of the plan


ancestrystringFor 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_idintegerID of the reseller


fixed_pricebool

The Fixed price option of the plan:

  • true — a customer pays for the subscription and ordering additional resources the same price as it was set at the moment of the subscription order. The new price will be applied only after the subscription is renewed.
  • false — the plan prices are not fixed for customers.


skustringSKU of the plan


singletonbool

The Singleton option of the plan:

  • true — a customer can have only one subscription to the plan.
  • false — a customer can have several subscriptions to the plan.


auto_renewalbool

Indicates the status of the Auto-renew option of the plan:

  • true — the Auto-renew option is activated.
  • false — the Auto-renew option is not activated.


auto_renewal_disabledbool

Indicates the status of the Disable the Auto-renew option option of the plan:

  • true — the Disable the Auto-renew option option is activated.
  • false — the Disable the Auto-renew option option is not activated.


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




dataarrayObject data




idintegerID of the resource in the plan




typestringData type




attributesobjectInformation about the resource





created_atstringDate and time of the resource creation





updated_atstringDate and time when the resource was updated





namestring

Name of the resource






measurablebool

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_measurestring

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_namestringName of the application template





includedinteger

Amount of the resource included in the plan by default (included resources are part of the subscription price)






minimuminteger

Minimum amount of the resource (together with the included amount) available for ordering (see Plan Resources)






limitinteger

Maximum amount of the resource available for ordering. For an unlimited resource (unlimited_units = true), limit = 0






setup_feefloat

Setup fee of the resource






recurring_feefloat

Monthly recurring fee of the resource






overuse_feefloat

Overuse fee of the resource






renewal_feefloat

Renewal fee of the resource






unlimited_unitsbool

Attribute of the unlimited resource:

  • true — the resource is unlimited.
  • false — the resource is not unlimited.





publicbool

Availability of the resource:

  • true — the resource is available for ordering.
  • false — the resource is not available for ordering.





statusstring

Status of the resource:

  • active
  • inactive
  • deleted





resource_idinteger

ID of the resource in the application template






priorityintegerPriority of the resource. For the main resource, priority is maximal





net_costsobject

The resource net costs







setup_feefloat

Setup fee of the resource







recurring_feefloat

Monthly recurring fee of the resource







overuse_feefloat

Overuse fee of the resource







renewal_feefloat

Renewal fee of the resource






custom_attributesobjectInformation about custom attributes of the resource






plan_resources.custom_attributes.['custom_attribute_key']stringValue of the custom attribute of the resource


plan_periodsarray of objectsPlan periods



data
arrayObject data




idintegerID of the plan period




typestringData type




attributesobjectInformation about the plan period





created_atstring

Date and time of the plan period creation






updated_atstring

Date and time when the plan period was updated






duration_valueintegerDuration of the plan period. For the endless plan period, duration_value = null





duration_typestringUnit of measure of the plan period duration. For the endless plan period, duration_type = null





setup_feefloatSetup fee of the plan for the plan period





recurring_feefloatMonthly recurring fee of the plan for the plan period





transfer_feefloatTransfer fee of a domain for the plan period. The transfer fee is applied if domains are available as a resource in the service





renewal_feefloatRenewal fee of the plan for the plan period





trialbool

Plan period type:

  • true — trial plan period.
  • false — commercial plan period.





publicbool

Availability of the plan period:

  • true — the plan period is available for ordering.
  • false — the plan period is not available for ordering.





statusstring

Status of the plan period:

  • active
  • deleted





descriptionstringPlan period details description





endlessbool

Indicator of the endless plan period:

  • true — the plan period is endless (perpetual).
  • false — the plan period is not endless. For the plan period duration, see duration_value and duration_type.





net_costsobject

The period net costs







setup_feefloatSetup fee of the plan for the plan period






recurring_feefloatMonthly recurring fee of the plan for the plan period






transfer_feefloatTransfer fee of a domain for the plan period. The transfer fee is applied if domains are available as a resource in the service






renewal_feefloatRenewal fee of the plan for the plan period


available_account_types

array of objectsInformation about account types



id

integer

ID of the account type



namestringName of the account types



created_at

string

Date and time of the account type creation



updated_at

string

Date and time when the account type was updated



reseller_idintegerID of the reseller linked to the account type



name_patternstringTemplate of the account type name which is displayed in the platform



primary_namestringName 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



keystringKey that is used to refer to the account type by API or a placeholder



default_payment_method_idinteger

ID of the default payment method (see Configuring Payment Methods)




ancestryintegerID of the parent account type



use_by_defaultbool

Default account type:

  • true — the account type is used by default.
  • false — the account type is not used by default.


plan_currency

stringCurrency code of the plan


custom_attributesobjectInformation about custom attributes of the plan



custom_attributes.['custom_attribute_key']stringValue of the custom attribute of the plan

relationshipsobjectInformation about the related objects


plan_categoryobjectInformation about the related plan category



dataobjectInformation about the plan category




idstringID of the plan category




typestringData type
includedarray

Additional information about objects listed in the request:

NameData typeDescription
idstringID of the object
typestringdata type
attributesobjectAttributes of the object (see details below)

For the plan category (see Creating a Plan Category):

NameData typeDescription
created_atstringDate and time of the plan category creation

updated_at

stringDate and time of the plan category last update
keystringUnique key of the plan category
namestringName of the plan category
descriptionstringDescription of the plan category
priorityintegerDisplaying priority of the plan category

Request example

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

Response example

{
    "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": null,
            "reseller_id": 1,
            "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": "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"
                            },
                            "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"
                            },
                            "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"
                            }
                        }
                    }
                ]
            },
            "available_account_types": [
                {
                    "id": 1,
                    "name": "Personal BLR",
                    "created_at": "2016-08-25T09:26:12.658+03:00",
                    "updated_at": "2019-05-08T07:21:42.843+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personalblr",
                    "default_payment_method_id": 2,
                    "ancestry": null,
                    "use_by_default": false
                },
                {
                    "id": 2,
                    "name": "Business BLR",
                    "created_at": "2016-08-25T09:26:12.674+03:00",
                    "updated_at": "2019-05-08T03:11:31.082+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%primary_name",
                    "primary_name": "Company name",
                    "key": "businessblr",
                    "default_payment_method_id": 197,
                    "ancestry": null,
                    "use_by_default": false
                }
            ],
            "plan_currency": "RUB",
            "custom_attributes": {
                "item_1c_id": "123456"
            }
        },
        "relationships": {
            "plan_category": {
                "data": {
                    "id": "190",
                    "type": "plan_categories"
                }
            }
        }
    }
}

Отзыв | Feedback