Price

  • This document describes the Price object, which is part of the deprecated Orders version 2 API.

  • The Price object includes a type and an amount, which is represented by a Money object.

  • The Money object represents a monetary amount with its currency type, including fields for currency code, whole units, and nano units.

Price in order.

JSON representation
{
  "type": enum(PriceType),
  "amount": {
    object(Money)
  }
}
Fields
type

enum(PriceType)

Type of price. Required.

amount

object(Money)

Monetary amount. Required.

Money

Represents an amount of money with its currency type.

JSON representation
{
  "currencyCode": string,
  "units": string,
  "nanos": number
}
Fields
currencyCode

string

The 3-letter currency code defined in ISO 4217.

units

string (int64 format)

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

nanos

number

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.