Package 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
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. SeeInvoiceUpcomingParams.Discount.extraParams
for the field documentation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InvoiceUpcomingParams.InvoiceItem.Builder
static class
InvoiceUpcomingParams.InvoiceItem.Discount
static class
InvoiceUpcomingParams.InvoiceItem.Period
Add all map key/value pairs to `extraParams` map.static class
InvoiceUpcomingParams.InvoiceItem.PriceData
The start of the period.
-
Method Summary
Modifier and Type Method 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.lang.Object
getDiscounts()
The coupons to redeem into discounts for the invoice item in the preview.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.lang.Object
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.String
getPrice()
The ID of the price object.InvoiceUpcomingParams.InvoiceItem.PriceData
getPriceData()
Data used to generate a new Price object inline.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 asunit_amount
, but accepts a decimal string with at most 12 decimal places.
-
-
-
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.
-
getDiscounts
public java.lang.Object getDiscounts()
The coupons to redeem into discounts for the invoice item in the preview.
-
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.lang.Object 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 tometadata
.
-
getPeriod
public InvoiceUpcomingParams.InvoiceItem.Period getPeriod()
The period associated with this invoice item.
-
getPrice
public java.lang.String getPrice()
The ID of the price object.
-
getPriceData
public InvoiceUpcomingParams.InvoiceItem.PriceData getPriceData()
Data used to generate a new Price object inline.
-
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 asunit_amount
, but accepts a decimal string with at most 12 decimal places. Only one ofunit_amount
andunit_amount_decimal
can be set.
-
-