Method: providers.entitlements.suspend

Requests suspension of an active Entitlement. This is not yet supported.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the entitlement to suspend.

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

  • commerceprocurement.providerEntitlements.suspend

Request body

The request body contains data with the following structure:

JSON representation
{
  "reason": string
}
Fields
reason

string

A free-form reason string, explaining the reason for suspension request.

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.