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( |
Fields | |
---|---|
name |
The resource name of the order. Order names have the form: |
offer |
The resource name of the offer against which this order is being placed. Offer has the form: |
orderState |
Current state of the order. Read only. |
orderStateReason |
An explanation of the order's state. |
orderItems[] |
The items in the current order. |
entitlements[] |
Entitlement resource. Read-only. |
createTime |
Read-only. The time at which the order is created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
updateTime |
The time at which the order is updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
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( |
Fields | |
---|---|
offerItem |
The resource name of a single item referenced in an offer. Offer items are of the form: |
commitmentSettings |
Commitment settings if commitment-based plan. Read Only. |
numUnits |
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 |
Max units allowed to be assigned for this order. |
renewalSettings |
Renewal settings for renewable plans. |
RenewalSettings
Renewal settings for renewable offers.
JSON representation | |
---|---|
{ "enableRenewal": boolean, "resizeUnitCount": boolean, "disableCommitment": boolean } |
Fields | |
---|---|
enableRenewal |
If false, the plan will be completed at the end date. |
resizeUnitCount |
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 |
If true, disables commitment-based plan on renewal and switches to flexible or pay as you go plan. |
Methods |
|
---|---|
(deprecated) |
Activates a previously suspended Order. |
(deprecated) |
Creates Order on behalf of a customer. |
(deprecated) |
Returns a requested Order resource. |
(deprecated) |
List Order s belonging to a customer. |
(deprecated) |
Updates existing customer [Order]. |
(deprecated) |
Suspends a previously fulfilled Order. |