- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Modification
- AutoRenewalBehavior
- Try it!
Modifies an existing Order
resource.
HTTP request
POST https://cloudcommerceconsumerprocurement.googleapis.com/v1/{name=billingAccounts/*/orders/*}:modify
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. Name of the order to update. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"modifications": [
{
object ( |
Fields | |
---|---|
modifications[] |
Optional. Modifications for an existing Order created by an Offer. Required when Offer based Order is being modified, except for when going from an offer to a public plan. |
displayName |
Optional. Updated display name of the order, leave as empty if you do not want to update current display name. |
etag |
Optional. The weak etag, which can be optionally populated, of the order that this modify request is based on. Validation checking will only happen if the invoker supplies this field. |
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.modify
For more information, see the IAM documentation.
Modification
Modifications to make on the order.
JSON representation |
---|
{ "lineItemId": string, "changeType": enum ( |
Fields | |
---|---|
lineItemId |
Required. ID of the existing line item to make change to. Required when change type is [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL]. |
changeType |
Required. Type of change to make. |
newLineItemInfo |
Optional. The line item to update to. Required when changeType is [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. |
autoRenewalBehavior |
Optional. Auto renewal behavior of the subscription for the update. Applied when changeType is [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default config when this field is not specified. |
AutoRenewalBehavior
Indicates the auto renewal behavior customer specifies on subscription.
Enums | |
---|---|
AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED |
If unspecified, the auto renewal behavior will follow the default config. |
AUTO_RENEWAL_BEHAVIOR_ENABLE |
Auto Renewal will be enabled on subscription. |
AUTO_RENEWAL_BEHAVIOR_DISABLE |
Auto Renewal will be disabled on subscription. |