PriceAttribute

  • Price attributes provide order and line item pricing details, including type, name, ID, state, tax inclusion, and monetary amount or percentage.

  • The PriceAttribute object uses a spec field to represent monetary amount through the amount object or a milli percentage with amountMillipercentage.

  • Money objects detail an amount with its currency, using currencyCode and amountInMicros for representation.

  • The amountMillipercentage field within PriceAttribute is deprecated and should be avoided if possible.

Price attribute of an order or a line item.

JSON representation 
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
Fields
type

enum (Type)

Required: type of money attribute.
name

string

Required: User displayed string of the price attribute. This is sent and localized by merchant.
id

string

Optional: Id of the lineitem to which this price corresponds.
state

enum (State)

Required: state of the price: Estimate vs Actual.
taxIncluded

boolean

Whether the price is tax included.
Union field spec. Represents either monetary amount or milli percentage. spec can be only one of the following:
amount

object (Money)

Monetary amount.
amountMillipercentage
(deprecated)

integer

The percentage spec, to 1/1000th of a percent. Eg: 8.750% is represented as 8750, negative percentages represent percentage discounts. Deprecating this field. Can consider adding back when a solid usecase is required.

Money

Represents an amount of money with its currency type.

JSON representation 
{
  "currencyCode": string,
  "amountInMicros": string
}
Fields
currencyCode

string

The 3-letter currency code defined in ISO 4217.
amountInMicros

string (int64 format)

Amount in micros. For example, this field should be set as 1990000 for $1.99.