Method: accounts.customers.entitlements.listEntitlementChanges

List entitlement history.

Possible error codes:

  • PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
  • INVALID_ARGUMENT: Missing or invalid required fields in the request.
  • NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return value: List of EntitlementChanges.

HTTP request

GET https://cloudchannel.googleapis.com/v1/{parent=accounts/*/customers/*/entitlements/*}:listEntitlementChanges

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the entitlement for which to list entitlement changes. The - wildcard may be used to match entitlements across a customer. Formats:

  • accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • accounts/{account_id}/customers/{customer_id}/entitlements/-

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of entitlement changes to return. The service may return fewer than this value. If unspecified, returns at most 10 entitlement changes. The maximum value is 50; the server will coerce values above 50.
pageToken

string

Optional. A page token, received from a previous CloudChannelService.ListEntitlementChanges call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to CloudChannelService.ListEntitlementChanges must match the call that provided the page token.
filter

string

Optional. Filters applied to the list results.

Request body

The request body must be empty.

Response body

Response message for CloudChannelService.ListEntitlementChanges

If successful, the response body contains data with the following structure:

JSON representation 
{
  "entitlementChanges": [
    {
      object (EntitlementChange)
    }
  ],
  "nextPageToken": string
}
Fields
entitlementChanges[]

object (EntitlementChange)

The list of entitlement changes.
nextPageToken

string

A token to list the next page of results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview.

EntitlementChange

Change event entry for Entitlement order history

JSON representation 
{
  "entitlement": string,
  "offer": string,
  "provisionedService": {
    object (ProvisionedService)
  },
  "changeType": enum (ChangeType),
  "createTime": string,
  "operatorType": enum (OperatorType),
  "parameters": [
    {
      object (Parameter)
    }
  ],
  "operator": string,

  // Union field change_reason can be only one of the following:
  "suspensionReason": enum (SuspensionReason),
  "cancellationReason": enum (CancellationReason),
  "activationReason": enum (ActivationReason),
  "otherChangeReason": string
  // End of list of possible types for union field change_reason.
}
Fields
entitlement

string

Required. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
offer

string

Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.
provisionedService

object (ProvisionedService)

Service provisioned for an Entitlement.
changeType

enum (ChangeType)

The change action type.
createTime

string (Timestamp format)

The submitted time of the change.

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".
operatorType

enum (OperatorType)

Operator type responsible for the change.
parameters[]

object (Parameter)

Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.
operator

string

Human-readable identifier that shows what operator made a change. When the operatorType is RESELLER, this is the user's email address. For all other operator types, this is empty.
Union field change_reason. The reason the change was made change_reason can be only one of the following:
suspensionReason

enum (SuspensionReason)

Suspension reason for the Entitlement.
cancellationReason

enum (CancellationReason)

Cancellation reason for the Entitlement.
activationReason

enum (ActivationReason)

The Entitlement's activation reason
otherChangeReason

string

e.g. purchase_number change reason, entered by CRS.

CancellationReason

Cancellation reason for the entitlement

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

ActivationReason

The Entitlement's activation reason

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

ChangeType

Specifies the type of change action

Enums
CHANGE_TYPE_UNSPECIFIED Not used.
CREATED New Entitlement was created.
PRICE_PLAN_SWITCHED Price plan associated with an Entitlement was changed.
COMMITMENT_CHANGED Number of seats committed for a commitment Entitlement was changed.
RENEWED An annual Entitlement was renewed.
SUSPENDED Entitlement was suspended.
ACTIVATED Entitlement was activated.
CANCELLED Entitlement was cancelled.
SKU_CHANGED Entitlement was upgraded or downgraded for ex. from Google Workspace Business Standard to Google Workspace Business Plus.
RENEWAL_SETTING_CHANGED The settings for renewal of an Entitlement have changed.
PAID_SUBSCRIPTION_STARTED 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 License cap was changed for the entitlement.
SUSPENSION_DETAILS_CHANGED The suspension details have changed (but it is still suspended).
TRIAL_END_DATE_EXTENDED The trial end date was extended.
TRIAL_STARTED Entitlement started trial.

OperatorType

Specifies the type of operator responsible for the change

Enums
OPERATOR_TYPE_UNSPECIFIED Not used.
CUSTOMER_SERVICE_REPRESENTATIVE Customer service representative.
SYSTEM System auto job.
CUSTOMER Customer user.
RESELLER Reseller user.