Package com.stripe.param

Class CreditNotePreviewParams.Line

java.lang.Object

com.stripe.param.CreditNotePreviewParams.Line

Enclosing class:

CreditNotePreviewParams

public static class CreditNotePreviewParams.Line
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreditNotePreviewParams.Line.Builder
static class	CreditNotePreviewParams.Line.TaxAmount
static enum	CreditNotePreviewParams.Line.Type	Required. The amount on which tax is calculated, in cents (or local equivalent).

Method Summary

Modifier and Type	Method	Description
static CreditNotePreviewParams.Line.Builder	builder()
Long	getAmount()	The line item amount to credit.
String	getDescription()	The description of the credit note line item.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
String	getInvoiceLineItem()	The invoice line item to credit.
Long	getQuantity()	The line item quantity to credit.
Object	getTaxAmounts()	A list of up to 10 tax amounts for the credit note line item.
Object	getTaxRates()	The tax rates which apply to the credit note line item.
CreditNotePreviewParams.Line.Type	getType()	Required. Type of the credit note line item, one of invoice_line_item or custom_line_item
Long	getUnitAmount()	The integer unit amount in cents (or local equivalent) of the credit note line item.
BigDecimal	getUnitAmountDecimal()	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

Method Details

builder

public static CreditNotePreviewParams.Line.Builder builder()

getAmount

public Long getAmount()

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

getDescription

public String getDescription()

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

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.

getInvoiceLineItem

public String getInvoiceLineItem()

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

getQuantity

public Long getQuantity()

The line item quantity to credit.

getTaxAmounts

public Object getTaxAmounts()

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

getTaxRates

public Object getTaxRates()

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.

getType

public CreditNotePreviewParams.Line.Type getType()

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

getUnitAmount

public Long getUnitAmount()

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.

getUnitAmountDecimal

public BigDecimal getUnitAmountDecimal()

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.