Package com.stripe.param.tax

Class CalculationCreateParams.LineItem

java.lang.Object

com.stripe.param.tax.CalculationCreateParams.LineItem

Enclosing class:

CalculationCreateParams

public static class CalculationCreateParams.LineItem
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CalculationCreateParams.LineItem.Builder
static enum	CalculationCreateParams.LineItem.TaxBehavior

Method Summary

Modifier and Type	Method	Description
static CalculationCreateParams.LineItem.Builder	builder()
Long	getAmount()	Required. A positive integer in the smallest currency unit representing the line item's total price.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
String	getProduct()	If provided, the product's tax_code will be used as the line item's tax_code.
Long	getQuantity()	The number of units of the item being purchased.
String	getReference()	A custom identifier for this line item, which must be unique across the line items in the calculation.
CalculationCreateParams.LineItem.TaxBehavior	getTaxBehavior()	Specifies whether the amount includes taxes.
String	getTaxCode()	A tax code ID to use for this line item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static CalculationCreateParams.LineItem.Builder builder()

getAmount

public Long getAmount()

Required. A positive integer in the smallest currency unit representing the line item's total price. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.

getExtraParams

public Map<String,Object> 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.

getProduct

public String getProduct()

If provided, the product's tax_code will be used as the line item's tax_code.

getQuantity

public Long getQuantity()

The number of units of the item being purchased. Used to calculate the per-unit price from the total amount for the line. For example, if amount=100 and quantity=4, the calculated unit price is 25.

getReference

public String getReference()

A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported tax reports.

getTaxBehavior

public CalculationCreateParams.LineItem.TaxBehavior getTaxBehavior()

Specifies whether the amount includes taxes. Defaults to exclusive.

getTaxCode

public String getTaxCode()

A tax code ID to use for this line item. If not provided, we will use the tax code from the provided product param. If neither tax_code nor product is provided, we will use the default tax code from your Tax Settings.