This is an archive version of the document. To get the most up-to-date information, see the current version.

Create Subscription Plan

You can create a subscription plan.

Required Privileges

To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.

Request

To create a subscription plan, send the POST HTTP request to the URL of the /subscriptionPlans resource.

HTTP Request

POST https://<hostname>:1280/api/v3/subscriptionPlans

Request Headers

The request contains the following headers.

Header	Required/Optional	Value	Description
Authorization	Required	Bearer <Access-Token>	Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.
Content-Type	Required	application/json	Identifies a media type that is used in the body of the request.
Accept	Optional	application/json	Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Request parameters

A list of parameters that are applicable for this operation:

Name	In	Type	Required	Default	Description
Body	Body	SubscriptionPlanInput	Yes	—	Subscription plan model

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Service Provider Console returns a created resource representation based on the SubscriptionPlan schema.

Example Create Subscription Plan

The following request creates a new subscription plan.

Request:

POST https://localhost:1280/api/v3/organizations/locations

Request Header:

Content-type: application/json

Authorization: Bearer <Access-Token>

Request Body:

{

"name": "Gold subscription plan",

"description": "Subscription plan for premium clients",

"currency": "USD",

"taxType": "VAT",

"taxPercent": 9,

"discountPercent": 10,

"managedServicePrice": 20,

"managedVmPrice": 0,

"managedWorkstationPrice": 0,

"managedServerAgentPrice": 0,

"vmCloudBackupsPrice": 0,

"serverCloudBackupsPrice": 0,

"workstationCloudBackupsPrice": 0,

"cloudRepositoryConsumedSpacePrice": 15,

"cloudRepositoryConsumedSpaceUnits": "TB",

"freeCloudRepositoryConsumedSpace": 1,

"freeCloudRepositoryConsumedSpaceUnits": "Gb",

"backupDataTransferOutPrice": 0,

"backupDataTransferOutUnits": "GB",

"replicatedVmPrice": 10,

"cloudStorageConsumedSpacePrice": 0,

"cloudStorageConsumedSpaceUnits": "TB",

"freeCloudStorageConsumedSpace": 1,

"freeCloudStorageConsumedSpaceUnits": "Gb",

"computeResourcesPrice": 0,

"computeResourcesUnits": "Hours",

"freeComputeResources": 1,

"freeComputeResourcesUnits": "Hours",

"replicationDataTransferOutPrice": 0,

"replicationDataTransferOutUnits": "GB",

"fileShareBackupUsedSpacePrice": 20,

"fileShareBackupUsedSpaceUnits": "GB",

"freeFileShareBackupUsedSpace": 0,

"freeFileShareBackupUsedSpaceUnits": "GB",

"fileShareArchiveUsedSpacePrice": 10,

"fileShareArchiveUsedSpaceUnits": "GB",

"freeFileShareArchiveUsedSpace": 0,

"freeFileShareArchiveUsedSpaceUnits": "GB",

"sourceAmountOfDataPrice": 5,

"sourceAmountOfDataUnits": "GB",

"freeSourceAmountOfData": 0,

"freeSourceAmountOfDataUnits": "GB"

}

Response Code:

200 OK

Response Body:

{

"data": {

"instanceUid": "ca76b66d-abbd-4b06-8a2e-72bed641b116",