Get License Details

Shows details for a license, by ID.

Specify the license ID in the licenseId parameter in the URI.

Response properties that are not applicable to the license will not be present in the response.

GET/v1/licenses/{licenseId}
URI Parameters
licenseId
stringrequired

The unique identifier for the license.

Response Properties
id
string

A unique identifier for the license.

name
string

Name of the licensed feature.

totalUnits
number

Total number of license units allocated.

consumedUnits
number

Total number of license units consumed.

subscriptionId
string

The subscription ID associated with this license. This ID is used in other systems, such as Webex Control Hub.

siteUrl
string

The Webex Meetings site associated with this license.

siteType
enum

The type of site associated with this license.

Control Hub managed site

the site is managed by Webex Control Hub

Linked site

the site is a linked site

Site Admin managed site

the site is managed by Site Administration

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/licenses/
Log in to try the API.
Header
https://webexapis.com/v1/licenses/Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh
200 / OK
{
  "id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
  "name": "Meeting - Webex Meeting Center",
  "totalUnits": 50,
  "consumedUnits": 5,
  "subscriptionId": "Sub-hydraOct26a",
  "siteUrl": "site1-example.webex.com",
  "siteType": "Control Hub managed site"
}