Overview of the service plan object
The standard information about a service plan sent to the service is described in the table below.
Name | Data type | Description | ||
|---|---|---|---|---|
| plan | object | General information about the service plan ordered by an account. The service plan information is stored and managed in Vendor Portal | ||
| name | string | Service plan name entered via Vendor Portal | ||
| description | string | Service plan description entered via Vendor Portal | ||
| resources | object | Information about ordered service plan resources | ||
| resource | string | Auto-generated resource GUID (Globally Unique Identifier) | ||
| key | string | Resource key entered via Vendor Portal | ||
| quantity | integer | Quantity of the resource | ||
| period | object | Service plan duration | ||
| value | integer | Service plan duration in the specified units | ||
| type | string | Unit of measure of the period:
| ||
| sku | string | Stock Keeping Unit of the service plan entered via Vendor Portal | ||
The current version of Vendor Portal does not support additional service plan attributes. Contact the ActivePlatform team if your service requires this function (see Support contacts).
Service plan attributes are used if a vendor wants to add additional information to a service plan. The diagram bellow shows the flow of data with service plan attributes. You can add the attributes in the Attributes section of Vendor Portal if you need to receive additional information during subscription provisioning.
After creation service plan attributes in Vendor Portal (see Product attributes), an additional field is displayed on the service plan page in Vendor Panel and can be filled by the vendor. During subscription creation, additional service plan information is sent by ActivePlatform to the service for successful subscription creation.
