Getting License Information

You can get licensing information for an organization with the specified ID.

Request

GET https://<hostname>:4443/v6/Organizations/{organizationId}/LicensingInformation

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

organizationId

string

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

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

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property

Type

Description

licensedUsers

integer

Specifies the number of Veeam licenses that users consume at the moment.

Veeam Backup for Microsoft 365 can temporarily provide you with extra licenses if the number of used licenses exceeds the limit. For more information about licensing in Veeam Backup for Microsoft 365, see the Licensing and License Types section of the Veeam Backup for Microsoft 365 User Guide.

This property value shows the total number of the licensed users and users that exceed the license limit.

newUsers

integer

Specifies the number of the Veeam licenses that remain unconsumed at the moment.

If you have Subscription License, this property value is 0.

If you have Rental License, this property value shows the number of users who are processed by Veeam Backup for Microsoft 365 during the trial period. For more information about the rental license trial state, see the Rental License section of the Veeam Backup for Microsoft 365 User Guide.

Example

The example returns a resource representation of the licensing information about Subscription License for an organization with the specified ID.

Request:

GET https://abc.tech.local:4443/v6/Organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/LicensingInformation

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "licensedUsers": 100,

 "newUsers": 0

}