Method: accounts.customers.entitlements.changeRenewalType

Updates the renewal type for an existing customer entitlement.

An entitlement update is a long running operation and results in updates to the entitlement as a result of fulfillment.

HTTP request

POST https://cloudchannel.googleapis.com/v1alpha1/{name=accounts/*/customers/*/entitlements/*}:changeRenewalType

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the entitlement to update. The name takes the format: 'accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}'

Request body

The request body contains data with the following structure:

JSON representation 
{
  "externalCorrelationId": string,
  "renewalSettings": {
    object(RenewalSettings)
  }
}
Fields
externalCorrelationId

string

An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.

renewalSettings

object(RenewalSettings)

New renewal settings.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

Try it!