Method: billingAccounts.orders.place

Stay organized with collections Save and categorize content based on your preferences.

Creates a new Order.

The returned long-running operation is in-progress until the backend completes the creation of the resource. Once completed, the order is in OrderState.ORDER_STATE_ACTIVE. In case of failure, the order resource will be removed.

HTTP request

POST https://cloudcommerceconsumerprocurement.googleapis.com/v1alpha1/{parent=billingAccounts/*}/orders:place

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent resource. This field has the form billingAccounts/{billing-account-id}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "displayName": string,
  "lineItemInfo": [
    {
      object (LineItemInfo)
    }
  ],
  "requestId": string
}
Fields
displayName

string

Required. The user-specified name of the order being placed. Must be unique within a billing account.

lineItemInfo[]

object (LineItemInfo)

Optional. Places order for offer. Required when an offer-based order is being placed.

requestId

string

Optional. A unique identifier for this request. The server will ignore subsequent requests that provide a duplicate request ID for at least 120 minutes after the first request.

The request ID must be a valid UUID.

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 parent resource:

  • consumerprocurement.orders.place

For more information, see the IAM documentation.