Package com.stripe.param
Class InvoiceItemUpdateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.InvoiceItemUpdateParams
-
public class InvoiceItemUpdateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InvoiceItemUpdateParams.Builder
static class
InvoiceItemUpdateParams.Discount
static class
InvoiceItemUpdateParams.Period
Add all map key/value pairs to `extraParams` map.static class
InvoiceItemUpdateParams.PriceData
The start of the period.-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InvoiceItemUpdateParams.Builder
builder()
java.lang.Long
getAmount()
The integer amount in %s of the charge to be applied to the upcoming invoice.java.lang.Object
getDescription()
An arbitrary string which you can attach to the invoice item.java.lang.Boolean
getDiscountable()
Controls whether discounts apply to this invoice item.java.lang.Object
getDiscounts()
The coupons & existing discounts which apply to the invoice item or invoice line item.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.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.Object
getMetadata()
Set of key-value pairs that you can attach to an object.InvoiceItemUpdateParams.Period
getPeriod()
The period associated with this invoice item.java.lang.Object
getPrice()
The ID of the price object.InvoiceItemUpdateParams.PriceData
getPriceData()
Data used to generate a new Price object inline.java.lang.Long
getQuantity()
Non-negative integer.java.lang.Object
getTaxRates()
The tax rates which apply to the invoice item.java.lang.Long
getUnitAmount()
The integer unit amount in %s of the charge to be applied to the upcoming invoice.java.lang.Object
getUnitAmountDecimal()
Same asunit_amount
, but accepts a decimal value in %s with at most 12 decimal places.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static InvoiceItemUpdateParams.Builder builder()
-
getAmount
public java.lang.Long getAmount()
The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
-
getDescription
public java.lang.Object 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()
Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.
-
getDiscounts
public java.lang.Object getDiscounts()
The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
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.
-
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 InvoiceItemUpdateParams.Period getPeriod()
The period associated with this invoice item.
-
getPrice
public java.lang.Object getPrice()
The ID of the price object.
-
getPriceData
public InvoiceItemUpdateParams.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()
The tax rates which apply to the invoice item. When set, thedefault_tax_rates
on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
-
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.lang.Object getUnitAmountDecimal()
Same asunit_amount
, but accepts a decimal value in %s with at most 12 decimal places. Only one ofunit_amount
andunit_amount_decimal
can be set.
-
-