Reference documentation and code samples for the Google Cloud Commerce Consumer Procurement V1 Client class CancellationPolicy.
Indicates the cancellation policy the customer uses to cancel the order.
Protobuf type google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy
Namespace
Google \ Cloud \ Commerce \ Consumer \ Procurement \ V1 \ CancelOrderRequestMethods
static::name
| Parameter | |
|---|---|
| Name | Description |
value |
mixed
|
static::value
| Parameter | |
|---|---|
| Name | Description |
name |
mixed
|
Constants
CANCELLATION_POLICY_UNSPECIFIED
Value: 0If 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.
Generated from protobuf enum CANCELLATION_POLICY_UNSPECIFIED = 0;
CANCELLATION_POLICY_CANCEL_IMMEDIATELY
Value: 1Request will cancel the whole order immediately, if order cannot be immediately cancelled, the request will fail.
Generated from protobuf enum CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1;
CANCELLATION_POLICY_CANCEL_AT_TERM_END
Value: 2Request will cancel the auto renewal, if order is not subscription based, the request will fail.
Generated from protobuf enum CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2;