This is an archive version of the document. To get the most up-to-date information, see the current version.Get Companies by Subscription Plan
You can get a collection resource representation of all companies to which a subscription plan with the specified UID is assigned.
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 a representation of all companies to which a specific subscription plan is assigned, send the GET HTTP request to the URL of the /subscriptionPlans/{subscriptionPlanUid}/companies collection.
HTTP Request
GET https://<hostname>:1280/api/v3/subscriptionPlans/{subscriptionPlanUid}/companies |
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 |
|---|---|---|---|---|---|
subscriptionPlanUid | Path | String (uuid) | Yes | — | Subscription plan UID |
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 Company schema.
Example 
The following request returns a representation of all companies to which a subscription plan with UID 304c08c2-0d13-4e9d-b26b-0bd5add83b3b is assigned.
Request: GET https://localhost:1280/api/v3/subscriptionPlans/304c08c2-0d13-4e9d-b26b-0bd5add83b3b/companies
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "93edf541-7758-4e3a-9719-042171dcc544", "name": "Gamma", "status": "active", "resellerUid": null, "subscriptionPlanUid": "304c08c2-0d13-4e9d-b26b-0bd5add83b3b", "permissions": [] }, { "instanceUid": "20c8486b-8c20-4b24-86a5-7cf24351c504", "name": "Delta", "status": "active", "resellerUid": "e409d3a1-9cf7-4775-9cd9-575af73d9427", "subscriptionPlanUid": "304c08c2-0d13-4e9d-b26b-0bd5add83b3b", "permissions": [ "rest" ] } ] } |