Get Subscription Plans

In this article

    You can get a representation of a collection of subscription plans configured in Veeam Service Provider Console.

    Request

    To get a representation of all Veeam Service Provider Console subscription plans, send the GET HTTPS request to the URL of the /subscriptionPlans collection.

    HTTPS Request

    GET https://<hostname>:1281/v2/subscriptionPlans

    Request Headers

    The request header must contain the authorization token for the current logon session.

    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 representation of the /subscriptionPlans collection.

    Example Get Subscription Plans

    The following request returns a representation of all subscription plans configured in Veeam Service Provider Console.

    Request:

    GET https://localhost:1281/v2/subscriptionPlans

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    [

     {

       "id": 0,

       "name": "Gold subscription plan",

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

       "currency": "USD",

       "taxType": "VAT",

       "vatPercent": 9,

       "discountPercent": 10,

       "managedServices": 20,

       "managedVms": 0,

       "managedWorkstations": 0,

       "managedServers": 0,

       "managedCloudAgents": 3,

       "storedVMBackups": 0,

       "storedServerBackups": 0,

       "storedWorkstationBackups": 0,

       "cloudRepositoryValue": 15,

       "cloudRepositoryValueUnits": "TB",

       "freeSpaceEnabled": true,

       "freeSpaceValue": 20,

       "freeSpaceValueUnits": "GB",

       "backupDataTransferValue": 0,

       "backupDataTransferValueUnits": "GB",

       "replicationDataTransferValue": 0,

       "replicationDataTransferValueUnits": "GB",

       "replicatedVMs": 10,

       "cloudStorageQuota": 0,

       "cloudStorageQuotaUnits": "TB",

       "freeCloudStorageEnabled": false,

       "freeCloudStorageValue": 0,

       "freeCloudStorageValueUnits": "B",

       "freeComputeResourcesEnabled": false,

       "freeComputeResourcesValue": 0,

       "freeComputeResourcesValueUnits": "hour",

       "computeResourcesQuota": 5,

       "computeResourcesQuotaUnits": "Hour",

       "_links": {

         "self": {

           "href": "https://vac.tech.local:1281/v2/subscriptionPlans/0"

         }

       }

     },

     {

       "id": 1,

       "name": "Default subscription plan",

       "description": "This plan does not include any price for provided services and can be used for trialing purposes.",

       "currency": "USD",

       "taxType": "VAT",

       "vatPercent": 0,

       "discountPercent": 0,

       "managedServices": 0,

       "managedVms": 0,

       "managedWorkstations": 0,

       "managedServers": 0,

       "managedCloudAgents": 0,

       "storedVMBackups": 0,

       "storedServerBackups": 0,

       "storedWorkstationBackups": 0,

       "cloudRepositoryValue": 0,

       "cloudRepositoryValueUnits": "TB",

       "freeSpaceEnabled": false,

       "freeSpaceValue": 0,

       "freeSpaceValueUnits": "B",

       "backupDataTransferValue": 0,

       "backupDataTransferValueUnits": "GB",

       "replicationDataTransferValue": 0,

       "replicationDataTransferValueUnits": "GB",

       "replicatedVMs": 0,

       "cloudStorageQuota": 0,

       "cloudStorageQuotaUnits": "TB",

       "freeCloudStorageEnabled": false,

       "freeCloudStorageValue": 0,

       "freeCloudStorageValueUnits": "B",

       "freeComputeResourcesEnabled": false,

       "freeComputeResourcesValue": 0,

       "freeComputeResourcesValueUnits": "sec",

       "computeResourcesQuota": 0,

       "computeResourcesQuotaUnits": "Hour",

       "_links": {

         "self": {

           "href": "https://vac.tech.local:1281/v2/subscriptionPlans/1"

         }

       }

     }

    ]