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 and Description
static class	InvoiceItemCreateParams.Builder
static class	InvoiceItemCreateParams.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

Modifier and Type	Method and 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](https://www.iso.org/iso-4217-currency-codes.html), 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.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.util.Map<java.lang.String,java.lang.String>	getMetadata() A set of key-value pairs that you can attach to an invoice item object.
InvoiceItemCreateParams.Period	getPeriod() The period associated with this invoice item.
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 as `unit_amount`, but accepts a decimal value with at most 12 decimal places.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 negative `amount` will reduce the `amount_due` on the invoice.

getCurrency

public java.lang.String getCurrency()

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

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.

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.

getMetadata

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

A set of key-value pairs that you can attach to an invoice item object. It can be useful for storing additional information about the invoice item in a structured format.

getPeriod

public InvoiceItemCreateParams.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.

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, the `default_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. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.

getUnitAmountDecimal

public java.math.BigDecimal getUnitAmountDecimal()

Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.