- Resource: Entitlement
- CommitmentSettings
- RenewalSettings
- PaymentPlan
- Period
- PeriodType
- ProvisioningState
- ProvisionedService
- SuspensionReason
- TrialSettings
- AssociationInfo
- Parameter
- Value
- Methods
Resource: Entitlement
An entitlement is a representation of a customer's ability to use a service.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "offer": string, "commitmentSettings": { object ( |
Fields | |
---|---|
name |
Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. |
create |
Output only. The time at which the entitlement is created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. The time at which the entitlement is updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
offer |
Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. |
commitment |
Commitment settings for a commitment-based Offer. Required for commitment based offers. |
provisioning |
Output only. Current provisioning state of the entitlement. |
provisioned |
Output only. Service provisioning details for the entitlement. |
suspension |
Output only. Enumerable of all current suspension reasons for an entitlement. |
purchase |
Optional. 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. This is only supported for Google Workspace entitlements. |
trial |
Output only. Settings for trial offers. |
association |
Association information to other entitlements. |
parameters[] |
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the For Google Workspace, the following Parameters may be accepted as input:
OR
The response may additionally include the following output-only Parameters:
For Google Cloud billing subaccounts, the following Parameter may be accepted as input:
|
billing |
Optional. The billing account resource name that is used to pay for this entitlement. |
CommitmentSettings
Commitment settings for commitment-based offers.
JSON representation |
---|
{
"startTime": string,
"endTime": string,
"renewalSettings": {
object ( |
Fields | |
---|---|
start |
Output only. Commitment start timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
end |
Output only. Commitment end timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
renewal |
Optional. Renewal settings applicable for a commitment-based Offer. |
RenewalSettings
Renewal settings for renewable Offers.
JSON representation |
---|
{ "enableRenewal": boolean, "resizeUnitCount": boolean, "paymentPlan": enum ( |
Fields | |
---|---|
enable |
If false, the plan will be completed at the end date. |
resize |
If true and enableRenewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time. |
payment |
Describes how a reseller will be billed. |
payment |
Describes how frequently the reseller will be billed, such as once per month. |
PaymentPlan
Describes how the reseller will be billed.
Enums | |
---|---|
PAYMENT_PLAN_UNSPECIFIED |
Not used. |
COMMITMENT |
Commitment. |
FLEXIBLE |
No commitment. |
FREE |
Free. |
TRIAL |
Trial. |
OFFLINE |
Price and ordering not available through API. |
Period
Represents period in days/months/years.
JSON representation |
---|
{
"duration": integer,
"periodType": enum ( |
Fields | |
---|---|
duration |
Total duration of Period Type defined. |
period |
Period Type. |
PeriodType
Period Type.
Enums | |
---|---|
PERIOD_TYPE_UNSPECIFIED |
Not used. |
DAY |
Day. |
MONTH |
Month. |
YEAR |
Year. |
ProvisioningState
Indicates the current provisioning state of the entitlement.
Enums | |
---|---|
PROVISIONING_STATE_UNSPECIFIED |
Not used. |
ACTIVE |
The entitlement is currently active. |
SUSPENDED |
The entitlement is currently suspended. |
ProvisionedService
Service provisioned for an entitlement.
JSON representation |
---|
{ "provisioningId": string, "productId": string, "skuId": string } |
Fields | |
---|---|
provisioning |
Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. |
product |
Output only. The product pertaining to the provisioning resource as specified in the Offer. |
sku |
Output only. The SKU pertaining to the provisioning resource as specified in the Offer. |
SuspensionReason
Suspension reason for an entitlement if provisioningState
= SUSPENDED.
Enums | |
---|---|
SUSPENSION_REASON_UNSPECIFIED |
Not used. |
RESELLER_INITIATED |
Entitlement was manually suspended by the Reseller. |
TRIAL_ENDED |
Trial ended. |
RENEWAL_WITH_TYPE_CANCEL |
Entitlement renewal was canceled. |
PENDING_TOS_ACCEPTANCE |
Entitlement was automatically suspended on creation for pending ToS acceptance on customer. |
OTHER |
Other reasons (internal reasons, abuse, etc.). |
TrialSettings
Settings for trial offers.
JSON representation |
---|
{ "trial": boolean, "endTime": string } |
Fields | |
---|---|
trial |
Determines if the entitlement is in a trial or not:
|
end |
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: |
AssociationInfo
Association links that an entitlement has to other entitlements.
JSON representation |
---|
{ "baseEntitlement": string } |
Fields | |
---|---|
base |
The name of the base entitlement, for which this entitlement is an add-on. |
Parameter
Definition for extended entitlement parameters.
JSON representation |
---|
{
"name": string,
"value": {
object ( |
Fields | |
---|---|
name |
Name of the parameter. |
value |
Value of the parameter. |
editable |
Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. |
Value
Data type and value of a parameter.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field kind . The kind of value. kind can be only one of the following: |
|
int64 |
Represents an int64 value. |
string |
Represents a string value. |
double |
Represents a double value. |
proto |
Represents an 'Any' proto value. An object containing fields of an arbitrary type. An additional field |
bool |
Represents a boolean value. |
Methods |
|
---|---|
|
Activates a previously suspended entitlement. |
|
Cancels a previously fulfilled entitlement. |
|
Updates the Offer for an existing customer entitlement. |
|
Change parameters of the entitlement. |
|
Updates the renewal settings for an existing customer entitlement. |
|
Creates an entitlement for a customer. |
|
Returns the requested Entitlement resource. |
|
Lists Entitlement s belonging to a customer. |
|
List entitlement history. |
|
Returns the requested Offer resource. |
|
Starts paid service for a trial entitlement. |
|
Suspends a previously fulfilled entitlement. |