com.stripe.param

Class InvoiceUpcomingParams.InvoiceItem

java.lang.Object

com.stripe.param.InvoiceUpcomingParams.InvoiceItem

Enclosing class:

InvoiceUpcomingParams

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvoiceUpcomingParams.InvoiceItem.Builder
static class	InvoiceUpcomingParams.InvoiceItem.Period

Method Summary

Modifier and Type	Method and Description
static InvoiceUpcomingParams.InvoiceItem.Builder	builder()
java.lang.Long	getAmount() The integer amount in %s of previewed invoice item.
java.lang.String	getCurrency() Three-letter ISO currency code, in lowercase.
java.lang.String	getDescription() An arbitrary string which you can attach to the invoice item.
java.lang.Boolean	getDiscountable() Explicitly controls whether discounts apply to this invoice item.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.String	getInvoiceitem() The ID of the invoice item to update in preview.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
InvoiceUpcomingParams.InvoiceItem.Period	getPeriod() The period associated with this invoice item.
java.lang.Long	getQuantity() Non-negative integer.
java.lang.Object	getTaxRates()
java.lang.Long	getUnitAmount() The integer unit amount in %s of the charge to be applied to the upcoming invoice.
java.math.BigDecimal	getUnitAmountDecimal() 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

Method Detail

builder

public static InvoiceUpcomingParams.InvoiceItem.Builder builder()

getAmount

public java.lang.Long getAmount()

The integer amount in %s of previewed invoice item.

getCurrency

public java.lang.String getCurrency()

Three-letter ISO currency code, in lowercase. Must be a supported currency. Only applicable to new invoice items.

getDescription

public java.lang.String getDescription()

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

getDiscountable

public java.lang.Boolean getDiscountable()

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

getExtraParams

public java.util.Map<java.lang.String,java.lang.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.

getInvoiceitem

public java.lang.String getInvoiceitem()

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.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

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 to metadata.

getPeriod

public InvoiceUpcomingParams.InvoiceItem.Period getPeriod()

The period associated with this invoice item.

getQuantity

public java.lang.Long getQuantity()

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

getTaxRates

public java.lang.Object getTaxRates()

getUnitAmount

public java.lang.Long getUnitAmount()

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.

getUnitAmountDecimal

public java.math.BigDecimal getUnitAmountDecimal()

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.