Class Entitlement (1.7.1)

Entitlement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An entitlement is a representation of a customer's ability to use a service.


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 for a commitment-based Offer. Required for commitment based offers.
Output only. Current provisioning state of the entitlement.
Output only. Service provisioning details for the entitlement.
suspension_reasons Sequence[]
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.
Output only. Settings for trial offers.
Association information to other entitlements.
parameters Sequence[]
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.




Indicates the current provisioning state of the entitlement.



Suspension reason for an entitlement if provisioning_state = SUSPENDED.