com.stripe.param

Class InvoiceUpcomingParams.InvoiceItem.Builder

java.lang.Object

com.stripe.param.InvoiceUpcomingParams.InvoiceItem.Builder

Enclosing class:

InvoiceUpcomingParams.InvoiceItem

public static class InvoiceUpcomingParams.InvoiceItem.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
InvoiceUpcomingParams.InvoiceItem.Builder	addAllTaxRate(java.util.List<java.lang.String> elements) Add all elements to `taxRates` list.
InvoiceUpcomingParams.InvoiceItem.Builder	addTaxRate(java.lang.String element) Add an element to `taxRates` list.
InvoiceUpcomingParams.InvoiceItem	build() Finalize and obtain parameter instance from this builder.
InvoiceUpcomingParams.InvoiceItem.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
InvoiceUpcomingParams.InvoiceItem.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
InvoiceUpcomingParams.InvoiceItem.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
InvoiceUpcomingParams.InvoiceItem.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
InvoiceUpcomingParams.InvoiceItem.Builder	setAmount(java.lang.Long amount) The integer amount in **%s** of previewed invoice item.
InvoiceUpcomingParams.InvoiceItem.Builder	setCurrency(java.lang.String currency) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
InvoiceUpcomingParams.InvoiceItem.Builder	setDescription(java.lang.String description) An arbitrary string which you can attach to the invoice item.
InvoiceUpcomingParams.InvoiceItem.Builder	setDiscountable(java.lang.Boolean discountable) Explicitly controls whether discounts apply to this invoice item.
InvoiceUpcomingParams.InvoiceItem.Builder	setInvoiceitem(java.lang.String invoiceitem) The ID of the invoice item to update in preview.
InvoiceUpcomingParams.InvoiceItem.Builder	setPeriod(InvoiceUpcomingParams.InvoiceItem.Period period) The period associated with this invoice item.
InvoiceUpcomingParams.InvoiceItem.Builder	setQuantity(java.lang.Long quantity) Non-negative integer.
InvoiceUpcomingParams.InvoiceItem.Builder	setTaxRates(EmptyParam taxRates)
InvoiceUpcomingParams.InvoiceItem.Builder	setTaxRates(java.util.List<java.lang.String> taxRates)
InvoiceUpcomingParams.InvoiceItem.Builder	setUnitAmount(java.lang.Long unitAmount) The integer unit amount in **%s** of the charge to be applied to the upcoming invoice.
InvoiceUpcomingParams.InvoiceItem.Builder	setUnitAmountDecimal(java.math.BigDecimal unitAmountDecimal) Same as `unit_amount`, but accepts a decimal string with at most 12 decimal places.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public InvoiceUpcomingParams.InvoiceItem build()

Finalize and obtain parameter instance from this builder.

setAmount

public InvoiceUpcomingParams.InvoiceItem.Builder setAmount(java.lang.Long amount)

The integer amount in **%s** of previewed invoice item.

setCurrency

public InvoiceUpcomingParams.InvoiceItem.Builder setCurrency(java.lang.String currency)

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.

setDescription

public InvoiceUpcomingParams.InvoiceItem.Builder setDescription(java.lang.String description)

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

setDiscountable

public InvoiceUpcomingParams.InvoiceItem.Builder setDiscountable(java.lang.Boolean discountable)

Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.

putExtraParam

public InvoiceUpcomingParams.InvoiceItem.Builder putExtraParam(java.lang.String key,
                                                               java.lang.Object value)

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. See InvoiceUpcomingParams.InvoiceItem.extraParams for the field documentation.

putAllExtraParam

public InvoiceUpcomingParams.InvoiceItem.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)

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. See InvoiceUpcomingParams.InvoiceItem.extraParams for the field documentation.

setInvoiceitem

public InvoiceUpcomingParams.InvoiceItem.Builder setInvoiceitem(java.lang.String invoiceitem)

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

public InvoiceUpcomingParams.InvoiceItem.Builder putMetadata(java.lang.String key,
                                                             java.lang.String value)

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. See InvoiceUpcomingParams.InvoiceItem.metadata for the field documentation.

putAllMetadata

public InvoiceUpcomingParams.InvoiceItem.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)

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. See InvoiceUpcomingParams.InvoiceItem.metadata for the field documentation.

setPeriod

public InvoiceUpcomingParams.InvoiceItem.Builder setPeriod(InvoiceUpcomingParams.InvoiceItem.Period period)

The period associated with this invoice item.

setQuantity

public InvoiceUpcomingParams.InvoiceItem.Builder setQuantity(java.lang.Long quantity)

Non-negative integer. The quantity of units for the invoice item.

addTaxRate

public InvoiceUpcomingParams.InvoiceItem.Builder addTaxRate(java.lang.String element)

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. See InvoiceUpcomingParams.InvoiceItem.taxRates for the field documentation.

addAllTaxRate

public InvoiceUpcomingParams.InvoiceItem.Builder addAllTaxRate(java.util.List<java.lang.String> elements)

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. See InvoiceUpcomingParams.InvoiceItem.taxRates for the field documentation.

setTaxRates

public InvoiceUpcomingParams.InvoiceItem.Builder setTaxRates(EmptyParam taxRates)

setTaxRates

public InvoiceUpcomingParams.InvoiceItem.Builder setTaxRates(java.util.List<java.lang.String> taxRates)

setUnitAmount

public InvoiceUpcomingParams.InvoiceItem.Builder setUnitAmount(java.lang.Long unitAmount)

The integer unit amount in **%s** 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 InvoiceUpcomingParams.InvoiceItem.Builder setUnitAmountDecimal(java.math.BigDecimal unitAmountDecimal)

Same as `unit_amount`, but accepts a decimal string with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.