REST Resource: accounts.customers.orders

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

Resource: Order

Entity representing an order placed by a reseller for a customer. This resource is being deprecated. When available, use the Entitlement resource.

JSON representation
{
  "name": string,
  "offer": string,
  "orderState": enum(OrderState),
  "orderStateReason": string,
  "orderItems": [
    {
      object(OrderItem)
    }
  ],
  "entitlements": [
    {
      object(Entitlement)
    }
  ],
  "createTime": string,
  "updateTime": string
}
Fields
name
(deprecated)

string

The resource name of the order. Order names have the form: accounts/{account_id}/customers/{customer_id}/orders/{orderId} Read only.

offer
(deprecated)

string

The resource name of the offer against which this order is being placed. Offer has the form: accounts/{account_id}/offers/{offer_id}

orderState
(deprecated)

enum(OrderState)

Current state of the order. Read only.

orderStateReason
(deprecated)

string

An explanation of the order's state.

orderItems[]
(deprecated)

object(OrderItem)

The items in the current order.

entitlements[]
(deprecated)

object(Entitlement)

Entitlement resource. Read-only.

createTime
(deprecated)

string (Timestamp format)

Read-only. The time at which the order is created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime
(deprecated)

string (Timestamp format)

The time at which the order is updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

OrderState

OrderState indicates the current status of the order.

Enums
ORDER_STATE_UNSPECIFIED The state is not specified.
PENDING Order fulfillment is pending.
COMPLETED Order has been executed.
ERROR Order is in error state.

OrderItem

Represents a line item in the order.

JSON representation
{
  "offerItem": string,
  "commitmentSettings": {
    object(CommitmentSettings)
  },
  "numUnits": number,
  "maxUnits": number,
  "renewalSettings": {
    object(RenewalSettings)
  }
}
Fields
offerItem
(deprecated)

string

The resource name of a single item referenced in an offer. Offer items are of the form: accounts/{account_id}/offers/{offer_id}/offerItems/{offer_item_id}.

commitmentSettings
(deprecated)

object(CommitmentSettings)

Commitment settings if commitment-based plan. Read Only.

numUnits
(deprecated)

number

Order units if applicable. For example, for seat-based offers, this would be number of seats; for license based offers, this would be number of licenses;

maxUnits
(deprecated)

number

Max units allowed to be assigned for this order.

renewalSettings
(deprecated)

object(RenewalSettings)

Renewal settings for renewable plans.

RenewalSettings

Renewal settings for renewable offers.

JSON representation
{
  "enableRenewal": boolean,
  "resizeUnitCount": boolean,
  "disableCommitment": boolean
}
Fields
enableRenewal
(deprecated)

boolean

If false, the plan will be completed at the end date.

resizeUnitCount
(deprecated)

boolean

If true and enableRenewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.

disableCommitment
(deprecated)

boolean

If true, disables commitment-based plan on renewal and switches to flexible or pay as you go plan.

Methods

activate
(deprecated)

Activates a previously suspended Order.

create
(deprecated)

Creates Order on behalf of a customer.

get
(deprecated)

Returns a requested Order resource.

list
(deprecated)

List Orders belonging to a customer.

patch
(deprecated)

Updates existing customer [Order].

suspend
(deprecated)

Suspends a previously fulfilled Order.