Package com.stripe.param

Class CreditNotePreviewLinesListParams.Line.Builder

java.lang.Object

com.stripe.param.CreditNotePreviewLinesListParams.Line.Builder

Enclosing class:

CreditNotePreviewLinesListParams.Line

public static class CreditNotePreviewLinesListParams.Line.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreditNotePreviewLinesListParams.Line.Builder	addAllTaxAmount(List<CreditNotePreviewLinesListParams.Line.TaxAmount> elements)	Add all elements to `taxAmounts` list.
CreditNotePreviewLinesListParams.Line.Builder	addAllTaxRate(List<String> elements)	Add all elements to `taxRates` list.
CreditNotePreviewLinesListParams.Line.Builder	addTaxAmount(CreditNotePreviewLinesListParams.Line.TaxAmount element)	Add an element to `taxAmounts` list.
CreditNotePreviewLinesListParams.Line.Builder	addTaxRate(String element)	Add an element to `taxRates` list.
CreditNotePreviewLinesListParams.Line	build()	Finalize and obtain parameter instance from this builder.
CreditNotePreviewLinesListParams.Line.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
CreditNotePreviewLinesListParams.Line.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
CreditNotePreviewLinesListParams.Line.Builder	setAmount(Long amount)	The line item amount to credit.
CreditNotePreviewLinesListParams.Line.Builder	setDescription(String description)	The description of the credit note line item.
CreditNotePreviewLinesListParams.Line.Builder	setInvoiceLineItem(String invoiceLineItem)	The invoice line item to credit.
CreditNotePreviewLinesListParams.Line.Builder	setQuantity(Long quantity)	The line item quantity to credit.
CreditNotePreviewLinesListParams.Line.Builder	setTaxAmounts(EmptyParam taxAmounts)	A list of up to 10 tax amounts for the credit note line item.
CreditNotePreviewLinesListParams.Line.Builder	setTaxAmounts(List<CreditNotePreviewLinesListParams.Line.TaxAmount> taxAmounts)	A list of up to 10 tax amounts for the credit note line item.
CreditNotePreviewLinesListParams.Line.Builder	setTaxRates(EmptyParam taxRates)	The tax rates which apply to the credit note line item.
CreditNotePreviewLinesListParams.Line.Builder	setTaxRates(List<String> taxRates)	The tax rates which apply to the credit note line item.
CreditNotePreviewLinesListParams.Line.Builder	setType(CreditNotePreviewLinesListParams.Line.Type type)	Required. Type of the credit note line item, one of invoice_line_item or custom_line_item
CreditNotePreviewLinesListParams.Line.Builder	setUnitAmount(Long unitAmount)	The integer unit amount in cents (or local equivalent) of the credit note line item.
CreditNotePreviewLinesListParams.Line.Builder	setUnitAmountDecimal(BigDecimal unitAmountDecimal)	Same as unit_amount, but accepts a decimal value in cents (or local equivalent) 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 Details

Builder

public Builder()

Method Details

build

public CreditNotePreviewLinesListParams.Line build()

Finalize and obtain parameter instance from this builder.

setAmount

public CreditNotePreviewLinesListParams.Line.Builder setAmount(Long amount)

The line item amount to credit. Only valid when type is invoice_line_item.

setDescription

public CreditNotePreviewLinesListParams.Line.Builder setDescription(String description)

The description of the credit note line item. Only valid when the type is custom_line_item.

putExtraParam

public CreditNotePreviewLinesListParams.Line.Builder putExtraParam(String key,
 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 CreditNotePreviewLinesListParams.Line.extraParams for the field documentation.

putAllExtraParam

public CreditNotePreviewLinesListParams.Line.Builder putAllExtraParam(Map<String,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 CreditNotePreviewLinesListParams.Line.extraParams for the field documentation.

setInvoiceLineItem

public CreditNotePreviewLinesListParams.Line.Builder setInvoiceLineItem(String invoiceLineItem)

The invoice line item to credit. Only valid when the type is invoice_line_item.

setQuantity

public CreditNotePreviewLinesListParams.Line.Builder setQuantity(Long quantity)

The line item quantity to credit.

addTaxAmount

public CreditNotePreviewLinesListParams.Line.Builder addTaxAmount(CreditNotePreviewLinesListParams.Line.TaxAmount element)

Add an element to `taxAmounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CreditNotePreviewLinesListParams.Line.taxAmounts for the field documentation.

addAllTaxAmount

public CreditNotePreviewLinesListParams.Line.Builder addAllTaxAmount(List<CreditNotePreviewLinesListParams.Line.TaxAmount> elements)

Add all elements to `taxAmounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CreditNotePreviewLinesListParams.Line.taxAmounts for the field documentation.

setTaxAmounts

public CreditNotePreviewLinesListParams.Line.Builder setTaxAmounts(EmptyParam taxAmounts)

A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with tax_rates.

setTaxAmounts

public CreditNotePreviewLinesListParams.Line.Builder setTaxAmounts(List<CreditNotePreviewLinesListParams.Line.TaxAmount> taxAmounts)

A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with tax_rates.

addTaxRate

public CreditNotePreviewLinesListParams.Line.Builder addTaxRate(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 CreditNotePreviewLinesListParams.Line.taxRates for the field documentation.

addAllTaxRate

public CreditNotePreviewLinesListParams.Line.Builder addAllTaxRate(List<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 CreditNotePreviewLinesListParams.Line.taxRates for the field documentation.

setTaxRates

public CreditNotePreviewLinesListParams.Line.Builder setTaxRates(EmptyParam taxRates)

The tax rates which apply to the credit note line item. Only valid when the type is custom_line_item and cannot be mixed with tax_amounts.

setTaxRates

public CreditNotePreviewLinesListParams.Line.Builder setTaxRates(List<String> taxRates)

The tax rates which apply to the credit note line item. Only valid when the type is custom_line_item and cannot be mixed with tax_amounts.

setType

public CreditNotePreviewLinesListParams.Line.Builder setType(CreditNotePreviewLinesListParams.Line.Type type)

Required. Type of the credit note line item, one of invoice_line_item or custom_line_item

setUnitAmount

public CreditNotePreviewLinesListParams.Line.Builder setUnitAmount(Long unitAmount)

The integer unit amount in cents (or local equivalent) of the credit note line item. This unit_amount will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when type is custom_line_item.

setUnitAmountDecimal

public CreditNotePreviewLinesListParams.Line.Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal)

Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.