Package com.stripe.param
Class InvoiceCreatePreviewParams.InvoiceItem.Builder
java.lang.Object
com.stripe.param.InvoiceCreatePreviewParams.InvoiceItem.Builder
- Enclosing class:
- InvoiceCreatePreviewParams.InvoiceItem
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd all elements to `discounts` list.addAllTaxRate(List<String> elements) Add all elements to `taxRates` list.Add an element to `discounts` list.addTaxRate(String element) Add an element to `taxRates` list.build()Finalize and obtain parameter instance from this builder.putAllExtraParam(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putAllMetadata(Map<String, String> map) Add all map key/value pairs to `metadata` map.putExtraParam(String key, Object value) Add a key/value pair to `extraParams` map.putMetadata(String key, String value) Add a key/value pair to `metadata` map.The integer amount in cents (or local equivalent) of previewed invoice item.setCurrency(String currency) Three-letter ISO currency code, in lowercase.setDescription(String description) An arbitrary string which you can attach to the invoice item.setDiscountable(Boolean discountable) Explicitly controls whether discounts apply to this invoice item.setDiscounts(EmptyParam discounts) The coupons to redeem into discounts for the invoice item in the preview.The coupons to redeem into discounts for the invoice item in the preview.setInvoiceitem(String invoiceitem) The ID of the invoice item to update in preview.setMetadata(EmptyParam metadata) Set of key-value pairs that you can attach to an object.setMetadata(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.The period associated with this invoice item.The ID of the price object.Data used to generate a new Price object inline.setQuantity(Long quantity) Non-negative integer.Only required if a default tax behavior was not provided in the Stripe Tax settings.setTaxCode(EmptyParam taxCode) A tax code ID.setTaxCode(String taxCode) A tax code ID.setTaxRates(EmptyParam taxRates) The tax rates that apply to the item.setTaxRates(List<String> taxRates) The tax rates that apply to the item.setUnitAmount(Long unitAmount) The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice.setUnitAmountDecimal(BigDecimal unitAmountDecimal) Same asunit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setAmount
The integer amount in cents (or local equivalent) of previewed invoice item. -
setCurrency
Three-letter ISO currency code, in lowercase. Must be a supported currency. Only applicable to new invoice items. -
setDescription
An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. -
setDiscountable
Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. -
addDiscount
public InvoiceCreatePreviewParams.InvoiceItem.Builder addDiscount(InvoiceCreatePreviewParams.InvoiceItem.Discount element) Add an element to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeInvoiceCreatePreviewParams.InvoiceItem.discountsfor the field documentation. -
addAllDiscount
public InvoiceCreatePreviewParams.InvoiceItem.Builder addAllDiscount(List<InvoiceCreatePreviewParams.InvoiceItem.Discount> elements) Add all elements to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeInvoiceCreatePreviewParams.InvoiceItem.discountsfor the field documentation. -
setDiscounts
The coupons to redeem into discounts for the invoice item in the preview. -
setDiscounts
public InvoiceCreatePreviewParams.InvoiceItem.Builder setDiscounts(List<InvoiceCreatePreviewParams.InvoiceItem.Discount> discounts) The coupons to redeem into discounts for the invoice item in the preview. -
putExtraParam
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeInvoiceCreatePreviewParams.InvoiceItem.extraParamsfor the field documentation. -
putAllExtraParam
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeInvoiceCreatePreviewParams.InvoiceItem.extraParamsfor the field documentation. -
setInvoiceitem
The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. -
putMetadata
Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeInvoiceCreatePreviewParams.InvoiceItem.metadatafor the field documentation. -
putAllMetadata
Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeInvoiceCreatePreviewParams.InvoiceItem.metadatafor the field documentation. -
setMetadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata. -
setMetadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata. -
setPeriod
public InvoiceCreatePreviewParams.InvoiceItem.Builder setPeriod(InvoiceCreatePreviewParams.InvoiceItem.Period period) The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details. -
setPrice
The ID of the price object. -
setPriceData
public InvoiceCreatePreviewParams.InvoiceItem.Builder setPriceData(InvoiceCreatePreviewParams.InvoiceItem.PriceData priceData) Data used to generate a new Price object inline. -
setQuantity
Non-negative integer. The quantity of units for the invoice item. -
setTaxBehavior
public InvoiceCreatePreviewParams.InvoiceItem.Builder setTaxBehavior(InvoiceCreatePreviewParams.InvoiceItem.TaxBehavior taxBehavior) Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One ofinclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. -
setTaxCode
A tax code ID. -
setTaxCode
A tax code ID. -
addTaxRate
Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeInvoiceCreatePreviewParams.InvoiceItem.taxRatesfor the field documentation. -
addAllTaxRate
Add all elements to `taxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeInvoiceCreatePreviewParams.InvoiceItem.taxRatesfor the field documentation. -
setTaxRates
The tax rates that apply to the item. When set, anydefault_tax_ratesdo not apply to this item. -
setTaxRates
The tax rates that apply to the item. When set, anydefault_tax_ratesdo not apply to this item. -
setUnitAmount
The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. -
setUnitAmountDecimal
public InvoiceCreatePreviewParams.InvoiceItem.Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) Same asunit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
-