REST Resource: customerLicense
Stay organized with collections
Save and categorize content based on your preferences.
Resource: CustomerLicense
| JSON representation |
{
"kind": string,
"state": string,
"applicationId": string,
"editions": [
{
object (Editions)
}
],
"id": string,
"customerId": string
} |
| Fields |
kind |
string
The type of API resource. This is always appsmarket#customerLicense.
|
state |
string
The customer's license status. One of:
ACTIVE: The customer has a valid license.UNLICENSED: There is no license: either this customer has never installed your application, or else has deleted it.
|
applicationId |
string
The ID of the application corresponding to this license query.
|
editions[]
(deprecated) |
object (Editions)
(Deprecated)
|
id |
string
The ID of the customer license.
|
customerId |
string
The domain name of the customer.
|
Editions
| JSON representation |
{
"editionId": string,
"seatCount": integer,
"assignedSeats": integer
} |
| Fields |
editionId
(deprecated) |
string
(Deprecated)
|
seatCount
(deprecated) |
integer
(Deprecated)
|
assignedSeats
(deprecated) |
integer
(Deprecated)
|
Methods |
|
|
Gets the status of a license for a customer to determine if they have access for a given app. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[null,null,["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eThe CustomerLicense resource provides information about a customer's license status for a specific application.\u003c/p\u003e\n"],["\u003cp\u003eIt includes details such as the license state (ACTIVE or UNLICENSED), application ID, customer ID, and license ID.\u003c/p\u003e\n"],["\u003cp\u003eThe Editions section within the resource, containing editionId, seatCount, and assignedSeats, is deprecated.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve the license status for a customer using the \u003ccode\u003eget\u003c/code\u003e method.\u003c/p\u003e\n"]]],["The `CustomerLicense` resource represents a customer's license for an application. Key information includes the license `state` (ACTIVE or UNLICENSED), the associated `applicationId`, and the customer's `customerId`. It contains a unique `id` for the license. The `kind` always indicates `appsmarket#customerLicense`. The `get` method retrieves the license status, indicating whether the customer has access to the application. Several fields regarding `editions`, such as `editionId`, `seatCount`, and `assignedSeats` are deprecated.\n"],null,["# REST Resource: customerLicense\n\nResource: CustomerLicense\n-------------------------\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"state\": string, \"applicationId\": string, \"editions\": [ { object (/workspace/marketplace/reference/rest/v2/customerLicense#Editions) } ], \"id\": string, \"customerId\": string } ``` |\n\n| Fields ||\n|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of API resource. This is always appsmarket#customerLicense. |\n| `state` | `string` The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license: either this customer has never installed your application, or else has deleted it. |\n| `applicationId` | `string` The ID of the application corresponding to this license query. |\n| `editions[]` **(deprecated)** | `object (`[Editions](/workspace/marketplace/reference/rest/v2/customerLicense#Editions)`)` | This item is deprecated! (Deprecated) |\n| `id` | `string` The ID of the customer license. |\n| `customerId` | `string` The domain name of the customer. |\n\nEditions\n--------\n\n| JSON representation |\n|---------------------------------------------------------------------------------|\n| ``` { \"editionId\": string, \"seatCount\": integer, \"assignedSeats\": integer } ``` |\n\n| Fields ||\n|----------------------------------|---------------------------------------------------|\n| `editionId` **(deprecated)** | `string` | This item is deprecated! (Deprecated) |\n| `seatCount` **(deprecated)** | `integer` | This item is deprecated! (Deprecated) |\n| `assignedSeats` **(deprecated)** | `integer` | This item is deprecated! (Deprecated) |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|\n| ### [get](/workspace/marketplace/reference/rest/v2/customerLicense/get) | Gets the status of a license for a customer to determine if they have access for a given app. |"]]
