Entitlement

An entitlement represents an entity which provides a customer means to start using a service.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "channelPartnerId": string,
  "offer": string,
  "numUnits": integer,
  "maxUnits": integer,
  "assignedUnits": integer,
  "commitmentSettings": {
    object (CommitmentSettings)
  },
  "provisioningState": enum (ProvisioningState),
  "provisionedService": {
    object (ProvisionedService)
  },
  "suspensionReasons": [
    enum (SuspensionReason)
  ],
  "purchaseOrderId": string,
  "trialSettings": {
    object (TrialSettings)
  },
  "associationInfo": {
    object (AssociationInfo)
  },
  "parameters": [
    {
      object (Parameter)
    }
  ]
}
Fields
name

string

Resource name of an entitlement of the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} Read-only.
createTime

string (Timestamp format)

The time at which the entitlement is created. Read-only.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

The time at which the entitlement is updated. Read-only.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
channelPartnerId

string

Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is generally used in 2-tier ordering, where the order is placed by a top-level distributor on behalf of their channel partner or reseller. Required for distributors.
offer

string

The offer ID or offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. Required.
numUnits
(deprecated)

integer

Number of units for a commitment-based Offer. For example, for seat-based Offers, this would be the number of seats; for license-based Offers, this would be the number of licenses. Required for creating commitment-based Offers. Deprecated: Use parameters instead.
maxUnits
(deprecated)

integer

Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements. For commitment-based entitlements, this is a read-only field, which only the internal support team can update. Deprecated: Use parameters instead.
assignedUnits
(deprecated)

integer

The current number of users that are assigned a license for the product defined in provisionedService.skuId. Read-only. Deprecated: Use parameters instead.
commitmentSettings

object (CommitmentSettings)

Commitment settings for a commitment-based Offer. Required for commitment based offers.
provisioningState

enum (ProvisioningState)

Current provisioning state of the entitlement. Read-only.
provisionedService

object (ProvisionedService)

Service provisioning details for the entitlement. Read-only
suspensionReasons[]

enum (SuspensionReason)

Enumerable of all current suspension reasons for an entitlement Read-only.
purchaseOrderId

string

This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. Optional
trialSettings

object (TrialSettings)

Settings for trial offers. Read-only.
associationInfo

object (AssociationInfo)

Association information to other entitlements.
parameters[]

object (Parameter)

Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in specified offer's parameter definitions.

ProvisionedService

Service provisioned for an entitlement.

JSON representation 
{
  "provisioningId": string,
  "productId": string,
  "skuId": string
}
Fields
provisioningId

string

Provisioning ID of the entitlement. For G Suite, this would be the underlying Subscription ID. Read-only.
productId

string

The product pertaining to the provisioning resource as specified in the Offer. Read-only.
skuId

string

The SKU pertaining to the provisioning resource as specified in the Offer. Read-only.

TrialSettings

Settings for trial offers.

JSON representation 
{
  "trial": boolean,
  "endTime": string
}
Fields
trial

boolean

Determines if the entitlement is in a trial or not: * true - The entitlement is in trial. * false - The entitlement is not in trial.
endTime

string (Timestamp format)

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Parameter

Definition for extended entitlement parameters.

JSON representation 
{
  "name": string,
  "value": {
    object (Value)
  },
  "editable": boolean
}
Fields
name

string

Name of the parameter.
value

object (Value)

Value of the parameter.
editable

boolean

Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, numUnits is editable when entitlement is active.

Value

Data type and value of a parameter.

JSON representation 
{

  // Union field kind can be only one of the following:
  "int64Value": string,
  "stringValue": string,
  "doubleValue": number,
  "protoValue": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field kind.
}
Fields
Union field kind. The kind of value. kind can be only one of the following:
int64Value

string (int64 format)

Represents an int64 value.
stringValue

string

Represents a string value.
doubleValue

number

Represents a double value.
protoValue

object

Represents an 'Any' proto value.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.