Package com.stripe.param
Class InvoiceItemCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.InvoiceItemCreateParams
-
public class InvoiceItemCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InvoiceItemCreateParams.Builder
static class
InvoiceItemCreateParams.Discount
static class
InvoiceItemCreateParams.Period
Add all map key/value pairs to `extraParams` map.static class
InvoiceItemCreateParams.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 InvoiceItemCreateParams.Builder
builder()
java.lang.Long
getAmount()
The integer amount in %s of the charge to be applied to the upcoming invoice.java.lang.String
getCurrency()
Three-letter ISO currency code, in lowercase.java.lang.String
getCustomer()
The ID of the customer who will be billed when this invoice item is billed.java.lang.String
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 to redeem into discounts for 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.String
getInvoice()
The ID of an existing invoice to add this invoice item to.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.InvoiceItemCreateParams.Period
getPeriod()
The period associated with this invoice item.java.lang.String
getPrice()
The ID of the price object.InvoiceItemCreateParams.PriceData
getPriceData()
Data used to generate a new Price object inline.java.lang.Long
getQuantity()
Non-negative integer.java.lang.String
getSubscription()
The ID of a subscription to add this invoice item to.java.util.List<java.lang.String>
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.math.BigDecimal
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 InvoiceItemCreateParams.Builder builder()
-
getAmount
public java.lang.Long getAmount()
The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negativeamount
will reduce theamount_due
on the invoice.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getCustomer
public java.lang.String getCustomer()
The ID of the customer who will be billed when this invoice item is billed.
-
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()
Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
-
getDiscounts
public java.lang.Object getDiscounts()
The coupons to redeem into discounts for the invoice item or invoice line item.
-
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.
-
getInvoice
public java.lang.String getInvoice()
The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per 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 InvoiceItemCreateParams.Period getPeriod()
The period associated with this invoice item.
-
getPrice
public java.lang.String getPrice()
The ID of the price object.
-
getPriceData
public InvoiceItemCreateParams.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.
-
getSubscription
public java.lang.String getSubscription()
The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
-
getTaxRates
public java.util.List<java.lang.String> 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.
-
getUnitAmount
public java.lang.Long getUnitAmount()
The integer unit amount in %s of the charge to be applied to the upcoming invoice. Thisunit_amount
will be multiplied by the quantity to get the full amount. Passing in a negativeunit_amount
will reduce theamount_due
on the invoice.
-
getUnitAmountDecimal
public java.math.BigDecimal 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.
-
-