AccountsCustomersEntitlements
class AccountsCustomersEntitlements extends Resource (View source)
The "entitlements" collection of methods.
Typical usage is:
$cloudchannelService = new Google\Service\Cloudchannel(...);
$entitlements = $cloudchannelService->accounts_customers_entitlements;Methods
Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.activate)
Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend.
Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Offer or Entitlement resource not found. INTERNAL: Any non-user error related to a technical issue in the backend.
Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan.
Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. * INTERNAL: Any non-user error related to a technical issue in the backend.
Creates an entitlement for a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT:
- Required request parameters are missing or invalid. There is already a customer entitlement for a SKU from the same product family. INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already purchased for the customer. The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION:
- The domain required for purchasing a SKU has not been verified. A pre- requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.create)
Returns the requested Entitlement resource. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource. (entitlements.get)
Lists Entitlements belonging to a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements.
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. (entitlements.listEntitlementChanges)
Returns the requested Offer resource. Possible error codes: PERMISSION_DENIED: The entitlement doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource. (entitlements.lookupOffer)
Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_ACTIVE: Entitlement is not active. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long- running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.suspend)
Details
GoogleLongrunningOperation
activate(string $name, GoogleCloudChannelV1ActivateEntitlementRequest $postBody, array $optParams = [])
Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.activate)
GoogleLongrunningOperation
cancel(string $name, GoogleCloudChannelV1CancelEntitlementRequest $postBody, array $optParams = [])
Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend.
Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata. (entitlements.cancel)
GoogleLongrunningOperation
changeOffer(string $name, GoogleCloudChannelV1ChangeOfferRequest $postBody, array $optParams = [])
Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Offer or Entitlement resource not found. INTERNAL: Any non-user error related to a technical issue in the backend.
Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.changeOffer)
GoogleLongrunningOperation
changeParameters(string $name, GoogleCloudChannelV1ChangeParametersRequest $postBody, array $optParams = [])
Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan.
- NOT_FOUND: Entitlement resource not found. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.changeParameters)
GoogleLongrunningOperation
changeRenewalSettings(string $name, GoogleCloudChannelV1ChangeRenewalSettingsRequest $postBody, array $optParams = [])
Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. * INTERNAL: Any non-user error related to a technical issue in the backend.
Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.changeRenewalSettings)
GoogleLongrunningOperation
create(string $parent, GoogleCloudChannelV1CreateEntitlementRequest $postBody, array $optParams = [])
Creates an entitlement for a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT:
- Required request parameters are missing or invalid. There is already a customer entitlement for a SKU from the same product family. INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already purchased for the customer. The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION:
- The domain required for purchasing a SKU has not been verified. A pre- requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.create)
GoogleCloudChannelV1Entitlement
get(string $name, array $optParams = [])
Returns the requested Entitlement resource. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource. (entitlements.get)
GoogleCloudChannelV1ListEntitlementsResponse
listAccountsCustomersEntitlements(string $parent, array $optParams = [])
Lists Entitlements belonging to a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements.
(entitlements.listAccountsCustomersEntitlements)
GoogleCloudChannelV1ListEntitlementChangesResponse
listEntitlementChanges(string $parent, array $optParams = [])
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. (entitlements.listEntitlementChanges)
GoogleCloudChannelV1Offer
lookupOffer(string $entitlement, array $optParams = [])
Returns the requested Offer resource. Possible error codes: PERMISSION_DENIED: The entitlement doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource. (entitlements.lookupOffer)
GoogleLongrunningOperation
startPaidService(string $name, GoogleCloudChannelV1StartPaidServiceRequest $postBody, array $optParams = [])
Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.startPaidService)
GoogleLongrunningOperation
suspend(string $name, GoogleCloudChannelV1SuspendEntitlementRequest $postBody, array $optParams = [])
Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_ACTIVE: Entitlement is not active. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long- running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (entitlements.suspend)