Class EntitlementChange (1.13.0)

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

Change event entry for Entitlement order history

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`suspension_reason`	`google.cloud.channel_v1.types.Entitlement.SuspensionReason` Suspension reason for the Entitlement. This field is a member of `oneof`_ `change_reason`.
`cancellation_reason`	`google.cloud.channel_v1.types.EntitlementChange.CancellationReason` Cancellation reason for the Entitlement. This field is a member of `oneof`_ `change_reason`.
`activation_reason`	`google.cloud.channel_v1.types.EntitlementChange.ActivationReason` The Entitlement's activation reason This field is a member of `oneof`_ `change_reason`.
`other_change_reason`	`str` e.g. purchase_number change reason, entered by CRS. This field is a member of `oneof`_ `change_reason`.
`entitlement`	`str` Required. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`offer`	`str` Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.
`provisioned_service`	`google.cloud.channel_v1.types.ProvisionedService` Service provisioned for an Entitlement.
`change_type`	`google.cloud.channel_v1.types.EntitlementChange.ChangeType` The change action type.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` The submitted time of the change.
`operator_type`	`google.cloud.channel_v1.types.EntitlementChange.OperatorType` Operator type responsible for the change.
`parameters`	`MutableSequence[google.cloud.channel_v1.types.Parameter]` Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.
`operator`	`str` Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty.

Classes

ActivationReason

ActivationReason(value)

The Entitlement's activation reason

Values: ACTIVATION_REASON_UNSPECIFIED (0): Not used. RESELLER_REVOKED_SUSPENSION (1): Reseller reactivated a suspended Entitlement. CUSTOMER_ACCEPTED_PENDING_TOS (2): Customer accepted pending terms of service. RENEWAL_SETTINGS_CHANGED (3): Reseller updated the renewal settings on an entitlement that was suspended due to cancellation, and this update reactivated the entitlement. OTHER_ACTIVATION_REASON (100): Other reasons (Activated temporarily for cancellation, added a payment plan to a trial entitlement, etc.)

CancellationReason

CancellationReason(value)

Cancellation reason for the entitlement

Values: CANCELLATION_REASON_UNSPECIFIED (0): Not used. SERVICE_TERMINATED (1): Reseller triggered a cancellation of the service. RELATIONSHIP_ENDED (2): Relationship between the reseller and customer has ended due to a transfer. PARTIAL_TRANSFER (3): Entitlement transferred away from reseller while still keeping other entitlement(s) with the reseller.

ChangeType

ChangeType(value)

Specifies the type of change action

Values: CHANGE_TYPE_UNSPECIFIED (0): Not used. CREATED (1): New Entitlement was created. PRICE_PLAN_SWITCHED (3): Price plan associated with an Entitlement was changed. COMMITMENT_CHANGED (4): Number of seats committed for a commitment Entitlement was changed. RENEWED (5): An annual Entitlement was renewed. SUSPENDED (6): Entitlement was suspended. ACTIVATED (7): Entitlement was activated. CANCELLED (8): Entitlement was cancelled. SKU_CHANGED (9): Entitlement was upgraded or downgraded for ex. from Google Workspace Business Standard to Google Workspace Business Plus. RENEWAL_SETTING_CHANGED (10): The settings for renewal of an Entitlement have changed. PAID_SUBSCRIPTION_STARTED (11): Use for Google Workspace subscription. Either a trial was converted to a paid subscription or a new subscription with no trial is created. LICENSE_CAP_CHANGED (12): License cap was changed for the entitlement. SUSPENSION_DETAILS_CHANGED (13): The suspension details have changed (but it is still suspended). TRIAL_END_DATE_EXTENDED (14): The trial end date was extended. TRIAL_STARTED (15): Entitlement started trial.

OperatorType

OperatorType(value)

Specifies the type of operator responsible for the change

Values: OPERATOR_TYPE_UNSPECIFIED (0): Not used. CUSTOMER_SERVICE_REPRESENTATIVE (1): Customer service representative. SYSTEM (2): System auto job. CUSTOMER (3): Customer user. RESELLER (4): Reseller user.