---
title: "POST /v1/{+name}:changeRenewalSettings"
method: POST
path: "/v1/{+name}:changeRenewalSettings"
tags: ["accounts"]
---

# POST /v1/{+name}:changeRenewalSettings

`POST /v1/{+name}:changeRenewalSettings`

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.

## Path parameters

- `name` string, required

## Request body

- GoogleCloudChannelV1ChangeRenewalSettingsRequest — Request message for CloudChannelService.ChangeRenewalSettings.
  - `requestId` string — Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
  - `renewalSettings` GoogleCloudChannelV1RenewalSettings — Renewal settings for renewable Offers.
    - `enableRenewal` boolean — If false, the plan will be completed at the end date.
    - `paymentPlan` 'PAYMENT_PLAN_UNSPECIFIED' | 'COMMITMENT' | 'FLEXIBLE' | 'FREE' | 'TRIAL' | 'OFFLINE' — Describes how a reseller will be billed.
    - `resizeUnitCount` boolean — If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.
    - `paymentCycle` GoogleCloudChannelV1Period — Represents period in days/months/years.
      - `duration` integer — Total duration of Period Type defined.
      - `periodType` 'PERIOD_TYPE_UNSPECIFIED' | 'DAY' | 'MONTH' | 'YEAR' — Period Type.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/cloudchannel.md) · [All operations](https://skmtc.net/google/apis/cloudchannel/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/cloudchannel/versions/7477d1d5f236/schema)