Method: providers.entitlements.rejectPlanChange

Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state.

This method is invoked by the provider to reject the plan change on the entitlement resource.

HTTP request

POST https://cloudcommerceprocurement.googleapis.com/v1/{name=providers/*/entitlements/*}:rejectPlanChange

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the entitlement.

Authorization requires the following IAM permission on the specified resource name:

  • commerceprocurement.providerEntitlements.reject

Request body

The request body contains data with the following structure:

JSON representation
{
  "reason": string,
  "pendingPlanName": string
}
Fields
reason

string

Free form text string explaining the rejection reason.

Max allowed length: 256 bytes. Longer strings will be truncated.

pendingPlanName

string

Required. Name of the pending plan that is being rejected.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.