Entitlement(mapping=None, *, ignore_unknown_fields=False, **kwargs)An entitlement is a representation of a customer's ability to use a service.
Attributes | |
|---|---|
| Name | Description |
name |
str
Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the entitlement is created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the entitlement is updated. |
offer |
str
Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. |
commitment_settings |
google.cloud.channel_v1.types.CommitmentSettings
Commitment settings for a commitment-based Offer. Required for commitment based offers. |
provisioning_state |
google.cloud.channel_v1.types.Entitlement.ProvisioningState
Output only. Current provisioning state of the entitlement. |
provisioned_service |
google.cloud.channel_v1.types.ProvisionedService
Output only. Service provisioning details for the entitlement. |
suspension_reasons |
MutableSequence[google.cloud.channel_v1.types.Entitlement.SuspensionReason]
Output only. Enumerable of all current suspension reasons for an entitlement. |
purchase_order_id |
str
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_settings |
google.cloud.channel_v1.types.TrialSettings
Output only. Settings for trial offers. |
association_info |
google.cloud.channel_v1.types.AssociationInfo
Association information to other entitlements. |
parameters |
MutableSequence[google.cloud.channel_v1.types.Parameter]
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. |
Classes
ProvisioningState
ProvisioningState(value)Indicates the current provisioning state of the entitlement.
Values: PROVISIONING_STATE_UNSPECIFIED (0): Not used. ACTIVE (1): The entitlement is currently active. SUSPENDED (5): The entitlement is currently suspended.
SuspensionReason
SuspensionReason(value)Suspension reason for an entitlement if provisioning_state = SUSPENDED.
Values: SUSPENSION_REASON_UNSPECIFIED (0): Not used. RESELLER_INITIATED (1): Entitlement was manually suspended by the Reseller. TRIAL_ENDED (2): Trial ended. RENEWAL_WITH_TYPE_CANCEL (3): Entitlement renewal was canceled. PENDING_TOS_ACCEPTANCE (4): Entitlement was automatically suspended on creation for pending ToS acceptance on customer. OTHER (100): Other reasons (internal reasons, abuse, etc.).