Method: billingAccounts.orders.cancel

Cancels an existing Order. Every product procured in the Order will be cancelled.

HTTP request

POST https://cloudcommerceconsumerprocurement.googleapis.com/v1/{name=billingAccounts/*/orders/*}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the order.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "etag": string,
  "cancellationPolicy": enum (CancellationPolicy)
}
Fields
etag

string

Optional. The weak etag, which can be optionally populated, of the order that this cancel request is based on. Validation checking will only happen if the invoker supplies this field.
cancellationPolicy

enum (CancellationPolicy)

Optional. Cancellation policy of this request.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • consumerprocurement.orders.cancel

For more information, see the IAM documentation.

CancellationPolicy

Indicates the cancellation policy the customer uses to cancel the order.

Enums
CANCELLATION_POLICY_UNSPECIFIED If unspecified, cancellation will try to cancel the order, if order cannot be immediately cancelled, auto renewal will be turned off. However, caller should avoid using the value as it will yield a non-deterministic result. This is still supported mainly to maintain existing integrated usages and ensure backwards compatibility.
CANCELLATION_POLICY_CANCEL_IMMEDIATELY Request will cancel the whole order immediately, if order cannot be immediately cancelled, the request will fail.
CANCELLATION_POLICY_CANCEL_AT_TERM_END Request will cancel the auto renewal, if order is not subscription based, the request will fail.