Class OrderUpdateParams.LineItem
- Enclosing class:
- OrderUpdateParams
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static class
Add all map key/value pairs to `extraParams` map.static class
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The description for the line item.The discounts applied to this line item.Map of extra parameters for custom features not available in this client library.getId()
The ID of an existing line item on the order.getPrice()
The ID of a Price to add to the Order.Data used to generate a new Price object inline.The ID of a Product to add to the Order.Defines a Product inline and adds it to the Order.The quantity of the line item.The tax rates applied to this line item.
-
Method Details
-
builder
-
getDescription
The description for the line item. Will default to the name of the associated product. -
getDiscounts
The discounts applied to this line item. -
getExtraParams
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedName
value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance. -
getId
The ID of an existing line item on the order. -
getPrice
The ID of a Price to add to the Order.The
price
parameter is an alternative to using theproduct
parameter. If each of your products are sold at a single price, you can setProduct.default_price
and then pass theproduct
parameter when creating a line item. If your products are sold at several possible prices, use theprice
parameter to explicitly specify which one to use. -
getPriceData
Data used to generate a new Price object inline.The
price_data
parameter is an alternative to using theproduct
orprice
parameters. If you create products upfront and configure aProduct.default_price
, pass theproduct
parameter when creating a line item. If you prefer not to define products upfront, or if you charge variable prices, pass theprice_data
parameter to describe the price for this line item.Each time you pass
price_data
we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused. -
getProduct
The ID of a Product to add to the Order.The product must have a
default_price
specified. Otherwise, specify the price by passing theprice
orprice_data
parameter. -
getProductData
Defines a Product inline and adds it to the Order.product_data
is an alternative to theproduct
parameter. If you created a Product upfront, use theproduct
parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass theproduct_data
parameter to define a Product inline as part of configuring the Order.product_data
automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, thenproduct_data
re-uses it to avoid duplicates. -
getQuantity
The quantity of the line item. -
getTaxRates
The tax rates applied to this line item.
-