Get a List of the Reseller's Plan provisioning attributes

The Get a List of the Reseller's Plan provisioning attributes method returns the list of additional attributes required for the Service provisioning by the given Plan ID 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.

The Get a List of the Reseller's Plan provisioning attributes method returns the list of additional attributes only for the following Services:

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

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 any of its downstream Resellers (see Viewing and updating reseller general information)
plan_id	path	integer	Required	ID of the Plan
account_id	query	integer	Optional	ID of an Account that has Subscriptions to the Microsoft Azure Service suitable for ordering reservation. Required if the specified Plan ID is linked to the Microsoft Azure RI Service

Response model

Name

Data type

Description

data

array of objects

Response data

id

integer

ID of the additional attribute. The value depends on the Service:

Service	ID of the additional attribute	Additional attribute
Microsoft 365 (Microsoft Office 365)	new_customer_domain	New Microsoft Customer Domain Name (Tenant name)
Microsoft 365 (Microsoft Office 365)	exist_customer_domain	Existing Microsoft Customer Domain Name (Tenant name)
Microsoft Azure	new_customer_domain	New Microsoft Customer Domain Name (Tenant name)
Microsoft Azure	exist_customer_domain	Existing Microsoft Customer Domain Name (Tenant name)
Microsoft Azure RI	exist_customer_domain	Existing Microsoft Customer Domain Name (Tenant name)
	reservation_scope	Reservations Scope
	azure_subscriptions	The list of the Microsoft Azure Subscriptions of the specified Account that can be used for purchasing the Microsoft Azure RI Service
Microsoft Software Subscriptions	new_customer_domain	New Microsoft Customer Domain Name (Tenant name)
Microsoft Software Subscriptions	exist_customer_domain	Existing Microsoft Customer Domain Name (Tenant name)
Google Workspace (G Suite)	domain_name	The name of the customer domain for purchasing the Service
	customer_alternate_email	The Alternative customer email that Google will use to contact the customer
	admin_login	The domain administrator's login

type

string

Data type

attributes

object

Information about the additional attribute

label

string

Name of the additional attribute

type

string

Data type of the additional attribute:

string
list

key

string

Key of the additional attribute

required

bool

Indicates whether the additional attribute is required:

true — the additional attribute is required.
false — the additional attribute is optional.

values

array

The list of valid values of the additional attribute

Service	ID of the additional attribute	The list of valid values of the additional attribute
Microsoft 365 (Microsoft Office 365)	—	—
Microsoft Azure	—	—
Microsoft Azure RI	reservation_scope	Current Subscription All Subscriptions
	azure_subscriptions	ID, name, and MS Subscription ID of the Microsoft Azure Subscriptions of the specified Account that can be used for purchasing the Microsoft Azure RI Service
	exist_customer_domain	Existing Microsoft Customer Domain Name (Tenant name) that can be used for purchasing the Microsoft Azure RI Service
Microsoft Software Subscriptions	—	—
Google Workspace (G Suite)	—	—

plugin_slug

string

Plugin used for the Service of the specified Plan:

office365 — the Office365 plugin.
microsoft_csp_products — the MicrosoftCspProducts plugin.
vendor_service — VSP (Vendor service plugin).

Errors

Status	Error text	Comment
403	The customer doesn't have subscription suitable for purchase the reservation. The customer must be the owner of a Microsoft Azure subscription	To order a Microsoft Azure RI Subscription, at least one existing Microsoft Azure Subscription is required for the specified Account (see azure_subscriptions)

Request example (Microsoft Azure RI)

GET /api/v3/resellers/1/plans/1770/provisioning_attributes?account_id=784
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Response example (Microsoft Azure RI)

{
    "data": [
        {
            "id": "exist_customer_domain",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Exist tenant name",
                "type": "string",
                "key": "exist_customer_domain",
                "required": false,
                "values": [
                    "example.onmicrosoft.com"
                ],
                "plugin_slug": "microsoft_csp_products"
            }
        },
        {
            "id": "reservation_scope",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Reservations Scope",
                "type": "list",
                "key": "reservation_scope",
                "required": true,
                "values": [
                    "Current Subscription",
                    "All Subscriptions"
                ],
                "plugin_slug": "microsoft_csp_products"
            }
        },
        {
            "id": "azure_subscriptions",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Microsoft Customer Azure Subscription",
                "type": "list",
                "key": "azure_subscriptions",
                "required": true,
                "values": [
                    "#3007774 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)",
                    "#3007831 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
                ],
                "plugin_slug": "microsoft_csp_products"
            }
        }
    ]
}

Request example (Google)

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

Response example (Google)

{
    "data": [
        {
            "id": "domain_name",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Domain name",
                "type": "string",
                "key": "domain_name",
                "required": true,
                "values": [],
                "plugin_slug": "vendor_service"
            }
        },
        {
            "id": "customer_alternate_email",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Alternate customer email",
                "type": "string",
                "key": "customer_alternate_email",
                "required": true,
                "values": [],
                "plugin_slug": "vendor_service"
            }
        },
        {
            "id": "admin_login",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Administrator's account username",
                "type": "string",
                "key": "admin_login",
                "required": true,
                "values": [],
                "plugin_slug": "vendor_service"
            }
        }
    ]
}