Get Subscription Plan Assigned to Company
You can get a resource representation of a subscription plan assigned to a company with the specified UID.
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, Company Owner, Company Administrator.
Request
To get a representation of a subscription plan assigned to a company, send the GET HTTP request to the URL of the /organizations/companies/{companyUid}/subscriptionPlan resource.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/subscriptionPlan |
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 |
|---|---|---|---|---|---|
companyUid | Path | String (uuid) | Yes | — | Company UID |
Response
If there is no subscription plan assigned to a company, the response will be empty. If there is a subscription plan assigned to a company, 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 resource representation based on the SubscriptionPlan schema.
Example 
The following request returns a representation of a subscription plan assigned to a company with UID 11483cd8-24f0-4745-8248-e428e6a5c7c1.
Request: GET https://localhost:1280/api/v3/organizations/companies/11483cd8-24f0-4745-8248-e428e6a5c7c1/subscriptionPlan
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 Success
Response Body: { "data": { "instanceUid": "17234e05-c5ef-4d92-a00e-72bd5fd914c1", "name": "Standard Subscription Plan", "organizationUid": "11483cd8-24f0-4745-8248-e428e6a5c7c1", "type": "provider", "description": null, "currency": "USD", "taxType": "vat", "taxPercent": 10.0, "discountPercent": 5.0, "managedServicePrice": 0.0, "managedVmPrice": 0.0, "managedWorkstationPrice": 0.0, "managedServerAgentPrice": 0.0, "vmCloudBackupsPrice": 0.0, "serverCloudBackupsPrice": 0.0, "workstationCloudBackupsPrice": 0.0, "cloudRepositoryConsumedSpacePrice": 0.0, "cloudRepositoryConsumedSpaceUnits": "tb", "freeCloudRepositoryConsumedSpace": null, "freeCloudRepositoryConsumedSpaceUnits": "gb", "backupDataTransferOutPrice": 0.0, "backupDataTransferOutUnits": "gb", "replicatedVmPrice": 0.0, "cloudStorageConsumedSpacePrice": 0.0, "cloudStorageConsumedSpaceUnits": "tb", "freeCloudStorageConsumedSpace": null, "freeCloudStorageConsumedSpaceUnits": "gb", "computeResourcesPrice": 0.0, "computeResourcesUnits": "hours", "freeComputeResources": 0, "freeComputeResourcesUnits": "hours", "replicationDataTransferOutPrice": 0.0, "replicationDataTransferOutUnits": "gb", "fileShareBackupUsedSpacePrice": 0.0, "fileShareBackupUsedSpaceUnits": "tb", "freeFileShareBackupUsedSpace": null, "freeFileShareBackupUsedSpaceUnits": "gb", "fileShareArchiveUsedSpacePrice": 0.0, "fileShareArchiveUsedSpaceUnits": "tb", "freeFileShareArchiveUsedSpace": null, "freeFileShareArchiveUsedSpaceUnits": "gb", "sourceAmountOfDataPrice": 0.0, "sourceAmountOfDataUnits": "tb", "freeSourceAmountOfData": null, "freeSourceAmountOfDataUnits": "gb" } } |
