This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Subscription Plans
You can get a collection resource representation of all subscription plans.
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 a representation of all subscription plans, send the GET HTTP request to the URL of the /subscriptionPlans collection.
HTTP Request
GET 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. |
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 |
|---|---|---|---|---|---|
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
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 collection resource representation based on the SubscriptionPlan schema.
Example 
The following request returns a representation of all subscription plans.
Request: GET https://localhost:1280/api/v3/subscriptionPlans
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 Success
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "0acd74e5-0234-4fb0-81f7-eccd094f6514", "name": "Advanced Subscription Plan", "organizationUid": "29d272e2-ab18-4614-af4b-741a6858e17e", "type": "Provider", "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" }, { "instanceUid": "c390b98b-bfe2-49e0-96c8-2fabd9e3b1e6", "name": "Standard Subscrition Plan", "organizationUid": "26330e42-8926-4c3f-b2c1-3bb39497c279", "type": "Provider", "description": null, "currency": "USD", "taxType": "VAT", "taxPercent": 10, "discountPercent": 5, "managedServicePrice": 0, "managedVmPrice": 0, "managedWorkstationPrice": 0, "managedServerAgentPrice": 0, "vmCloudBackupsPrice": 0, "serverCloudBackupsPrice": 0, "workstationCloudBackupsPrice": 0, "cloudRepositoryConsumedSpacePrice": 20, "cloudRepositoryConsumedSpaceUnits": "TB", "freeCloudRepositoryConsumedSpace": 1, "freeCloudRepositoryConsumedSpaceUnits": "Gb", "backupDataTransferOutPrice": 0, "backupDataTransferOutUnits": "GB", "replicatedVmPrice": 20, "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" } ] } |