InvoiceItem (stripe-java 10.11.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.InvoiceItem

All Implemented Interfaces:: HasId, MetadataStore<InvoiceItem>

public class InvoiceItem
extends ApiResource
implements HasId, MetadataStore<InvoiceItem>

Nested Class Summary
- Nested classes/interfaces inherited from class com.stripe.net.ApiResource
  ApiResource.RequestMethod, ApiResource.RequestType

Field Summary
- Fields inherited from class com.stripe.net.ApiResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

InvoiceItem()

Constructors
Constructor and Description
`InvoiceItem()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`static InvoiceItem`	`create(InvoiceItemCreateParams params)` Creates an item to be added to a draft invoice.
`static InvoiceItem`	`create(InvoiceItemCreateParams params, RequestOptions options)` Creates an item to be added to a draft invoice.
`static InvoiceItem`	`create(java.util.Map<java.lang.String,java.lang.Object> params)` Creates an item to be added to a draft invoice.
`static InvoiceItem`	`create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Creates an item to be added to a draft invoice.
`InvoiceItem`	`delete()` Deletes an invoice item, removing it from an invoice.
`InvoiceItem`	`delete(java.util.Map<java.lang.String,java.lang.Object> params)` Deletes an invoice item, removing it from an invoice.
`InvoiceItem`	`delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deletes an invoice item, removing it from an invoice.
`InvoiceItem`	`delete(RequestOptions options)` Deletes an invoice item, removing it from an invoice.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Long`	`getAmount()` Amount (in the `currency` specified) of the invoice item.
`java.lang.String`	`getCurrency()` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
`java.lang.String`	`getCustomer()` Get id of expandable `customer` object.
`Customer`	`getCustomerObject()` Get expanded `customer`.
`java.lang.Long`	`getDate()`
`java.lang.Boolean`	`getDeleted()` Always true for a deleted object.
`java.lang.String`	`getDescription()` An arbitrary string attached to the object.
`java.lang.Boolean`	`getDiscountable()` If true, discounts will apply to this invoice item.
`java.lang.String`	`getId()` Unique identifier for the object.
`java.lang.String`	`getInvoice()` Get id of expandable `invoice` object.
`Invoice`	`getInvoiceObject()` Get expanded `invoice`.
`java.lang.Boolean`	`getLivemode()` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Set of key-value pairs that you can attach to an object.
`java.lang.String`	`getObject()` String representing the object's type.
`InvoiceLineItemPeriod`	`getPeriod()`
`Plan`	`getPlan()` If the invoice item is a proration, the plan of the subscription that the proration was computed for.
`java.lang.Boolean`	`getProration()` Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
`java.lang.Long`	`getQuantity()` Quantity of units for the invoice item.
`java.lang.String`	`getSubscription()` Get id of expandable `subscription` object.
`java.lang.String`	`getSubscriptionItem()`
`Subscription`	`getSubscriptionObject()` Get expanded `subscription`.
`java.util.List<TaxRate>`	`getTaxRates()` The tax rates which apply to the invoice item.
`java.lang.Boolean`	`getUnifiedProration()` For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.
`java.lang.Long`	`getUnitAmount()` Unit Amount (in the `currency` specified) of the invoice item.
`int`	`hashCode()`
`static InvoiceItemCollection`	`list(InvoiceItemListParams params)` Returns a list of your invoice items.
`static InvoiceItemCollection`	`list(InvoiceItemListParams params, RequestOptions options)` Returns a list of your invoice items.
`static InvoiceItemCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of your invoice items.
`static InvoiceItemCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of your invoice items.
`static InvoiceItem`	`retrieve(java.lang.String invoiceitem)` Retrieves the invoice item with the given ID.
`static InvoiceItem`	`retrieve(java.lang.String invoiceitem, InvoiceItemRetrieveParams params, RequestOptions options)` Retrieves the invoice item with the given ID.
`static InvoiceItem`	`retrieve(java.lang.String invoiceitem, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves the invoice item with the given ID.
`static InvoiceItem`	`retrieve(java.lang.String invoiceitem, RequestOptions options)` Retrieves the invoice item with the given ID.
`void`	`setAmount(java.lang.Long amount)` Amount (in the `currency` specified) of the invoice item.
`void`	`setCurrency(java.lang.String currency)` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
`void`	`setCustomer(java.lang.String id)`
`void`	`setCustomerObject(Customer expandableObject)`
`void`	`setDate(java.lang.Long date)`
`void`	`setDeleted(java.lang.Boolean deleted)` Always true for a deleted object.
`void`	`setDescription(java.lang.String description)` An arbitrary string attached to the object.
`void`	`setDiscountable(java.lang.Boolean discountable)` If true, discounts will apply to this invoice item.
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setInvoice(java.lang.String id)`
`void`	`setInvoiceObject(Invoice expandableObject)`
`void`	`setLivemode(java.lang.Boolean livemode)` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Set of key-value pairs that you can attach to an object.
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setPeriod(InvoiceLineItemPeriod period)`
`void`	`setPlan(Plan plan)` If the invoice item is a proration, the plan of the subscription that the proration was computed for.
`void`	`setProration(java.lang.Boolean proration)` Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
`void`	`setQuantity(java.lang.Long quantity)` Quantity of units for the invoice item.
`void`	`setSubscription(java.lang.String id)`
`void`	`setSubscriptionItem(java.lang.String subscriptionItem)`
`void`	`setSubscriptionObject(Subscription expandableObject)`
`void`	`setTaxRates(java.util.List<TaxRate> taxRates)` The tax rates which apply to the invoice item.
`void`	`setUnifiedProration(java.lang.Boolean unifiedProration)` For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.
`void`	`setUnitAmount(java.lang.Long unitAmount)` Unit Amount (in the `currency` specified) of the invoice item.
`InvoiceItem`	`update(InvoiceItemUpdateParams params)` Updates the amount or description of an invoice item on an upcoming invoice.
`InvoiceItem`	`update(InvoiceItemUpdateParams params, RequestOptions options)` Updates the amount or description of an invoice item on an upcoming invoice.
`InvoiceItem`	`update(java.util.Map<java.lang.String,java.lang.Object> params)` Updates the amount or description of an invoice item on an upcoming invoice.
`InvoiceItem`	`update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Updates the amount or description of an invoice item on an upcoming invoice.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, multipartRequest, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InvoiceItem
```
public InvoiceItem()
```
- Method Detail
  - getCustomer
```
public java.lang.String getCustomer()
```
    Get id of expandable `customer` object.
  - setCustomer
```
public void setCustomer(java.lang.String id)
```
  - getCustomerObject
```
public Customer getCustomerObject()
```
    Get expanded `customer`.
  - setCustomerObject
```
public void setCustomerObject(Customer expandableObject)
```
  - getInvoice
```
public java.lang.String getInvoice()
```
    Get id of expandable `invoice` object.
  - setInvoice
```
public void setInvoice(java.lang.String id)
```
  - getInvoiceObject
```
public Invoice getInvoiceObject()
```
    Get expanded `invoice`.
  - setInvoiceObject
```
public void setInvoiceObject(Invoice expandableObject)
```
  - getSubscription
```
public java.lang.String getSubscription()
```
    Get id of expandable `subscription` object.
  - setSubscription
```
public void setSubscription(java.lang.String id)
```
  - getSubscriptionObject
```
public Subscription getSubscriptionObject()
```
    Get expanded `subscription`.
  - setSubscriptionObject
```
public void setSubscriptionObject(Subscription expandableObject)
```
  - list
```
public static InvoiceItemCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                  throws StripeException
```
    Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static InvoiceItemCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                         RequestOptions options)
                                  throws StripeException
```
    Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static InvoiceItemCollection list(InvoiceItemListParams params)
                                  throws StripeException
```
    Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static InvoiceItemCollection list(InvoiceItemListParams params,
                                         RequestOptions options)
                                  throws StripeException
```
    Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
    
    Throws:
    
    StripeException
  - create
```
public static InvoiceItem create(java.util.Map<java.lang.String,java.lang.Object> params)
                          throws StripeException
```
    Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.
    
    Throws:
    
    StripeException
  - create
```
public static InvoiceItem create(java.util.Map<java.lang.String,java.lang.Object> params,
                                 RequestOptions options)
                          throws StripeException
```
    Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.
    
    Throws:
    
    StripeException
  - create
```
public static InvoiceItem create(InvoiceItemCreateParams params)
                          throws StripeException
```
    Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.
    
    Throws:
    
    StripeException
  - create
```
public static InvoiceItem create(InvoiceItemCreateParams params,
                                 RequestOptions options)
                          throws StripeException
```
    Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.
    
    Throws:
    
    StripeException
  - retrieve
```
public static InvoiceItem retrieve(java.lang.String invoiceitem)
                            throws StripeException
```
    Retrieves the invoice item with the given ID.
    
    Throws:
    
    StripeException
  - retrieve
```
public static InvoiceItem retrieve(java.lang.String invoiceitem,
                                   RequestOptions options)
                            throws StripeException
```
    Retrieves the invoice item with the given ID.
    
    Throws:
    
    StripeException
  - retrieve
```
public static InvoiceItem retrieve(java.lang.String invoiceitem,
                                   java.util.Map<java.lang.String,java.lang.Object> params,
                                   RequestOptions options)
                            throws StripeException
```
    Retrieves the invoice item with the given ID.
    
    Throws:
    
    StripeException
  - retrieve
```
public static InvoiceItem retrieve(java.lang.String invoiceitem,
                                   InvoiceItemRetrieveParams params,
                                   RequestOptions options)
                            throws StripeException
```
    Retrieves the invoice item with the given ID.
    
    Throws:
    
    StripeException
  - update
```
public InvoiceItem update(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws StripeException
```
    Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.
    
    Specified by:
    
    update in interface MetadataStore<InvoiceItem>
    
    Throws:
    
    StripeException
  - update
```
public InvoiceItem update(java.util.Map<java.lang.String,java.lang.Object> params,
                          RequestOptions options)
                   throws StripeException
```
    Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.
    
    Specified by:
    
    update in interface MetadataStore<InvoiceItem>
    
    Throws:
    
    StripeException
  - update
```
public InvoiceItem update(InvoiceItemUpdateParams params)
                   throws StripeException
```
    Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.
    
    Throws:
    
    StripeException
  - update
```
public InvoiceItem update(InvoiceItemUpdateParams params,
                          RequestOptions options)
                   throws StripeException
```
    Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.
    
    Throws:
    
    StripeException
  - delete
```
public InvoiceItem delete()
                   throws StripeException
```
    Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.
    
    Throws:
    
    StripeException
  - delete
```
public InvoiceItem delete(RequestOptions options)
                   throws StripeException
```
    Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.
    
    Throws:
    
    StripeException
  - delete
```
public InvoiceItem delete(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws StripeException
```
    Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.
    
    Throws:
    
    StripeException
  - delete
```
public InvoiceItem delete(java.util.Map<java.lang.String,java.lang.Object> params,
                          RequestOptions options)
                   throws StripeException
```
    Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.
    
    Throws:
    
    StripeException
  - getAmount
```
public java.lang.Long getAmount()
```
    Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
  - 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).
  - getDate
```
public java.lang.Long getDate()
```
  - getDeleted
```
public java.lang.Boolean getDeleted()
```
    Always true for a deleted object.
  - getDescription
```
public java.lang.String getDescription()
```
    An arbitrary string attached to the object. Often useful for displaying to users.
  - getDiscountable
```
public java.lang.Boolean getDiscountable()
```
    If true, discounts will apply to this invoice item. Always false for prorations.
  - getLivemode
```
public java.lang.Boolean getLivemode()
```
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
  - getObject
```
public java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
  - getPeriod
```
public InvoiceLineItemPeriod getPeriod()
```
  - getPlan
```
public Plan getPlan()
```
    If the invoice item is a proration, the plan of the subscription that the proration was computed for.
  - getProration
```
public java.lang.Boolean getProration()
```
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
  - getQuantity
```
public java.lang.Long getQuantity()
```
    Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
  - getSubscriptionItem
```
public java.lang.String getSubscriptionItem()
```
  - getTaxRates
```
public java.util.List<TaxRate> 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.
  - getUnifiedProration
```
public java.lang.Boolean getUnifiedProration()
```
    For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.
  - getUnitAmount
```
public java.lang.Long getUnitAmount()
```
    Unit Amount (in the `currency` specified) of the invoice item.
  - setAmount
```
public void setAmount(java.lang.Long amount)
```
    Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    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).
  - setDate
```
public void setDate(java.lang.Long date)
```
  - setDeleted
```
public void setDeleted(java.lang.Boolean deleted)
```
    Always true for a deleted object.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    An arbitrary string attached to the object. Often useful for displaying to users.
  - setDiscountable
```
public void setDiscountable(java.lang.Boolean discountable)
```
    If true, discounts will apply to this invoice item. Always false for prorations.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object.
  - setLivemode
```
public void setLivemode(java.lang.Boolean livemode)
```
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
  - setMetadata
```
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
```
    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.
  - setObject
```
public void setObject(java.lang.String object)
```
    String representing the object's type. Objects of the same type share the same value.
  - setPeriod
```
public void setPeriod(InvoiceLineItemPeriod period)
```
  - setPlan
```
public void setPlan(Plan plan)
```
    If the invoice item is a proration, the plan of the subscription that the proration was computed for.
  - setProration
```
public void setProration(java.lang.Boolean proration)
```
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
  - setQuantity
```
public void setQuantity(java.lang.Long quantity)
```
    Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
  - setSubscriptionItem
```
public void setSubscriptionItem(java.lang.String subscriptionItem)
```
  - setTaxRates
```
public void setTaxRates(java.util.List<TaxRate> taxRates)
```
    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.
  - setUnifiedProration
```
public void setUnifiedProration(java.lang.Boolean unifiedProration)
```
    For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.
  - setUnitAmount
```
public void setUnitAmount(java.lang.Long unitAmount)
```
    Unit Amount (in the `currency` specified) of the invoice item.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId
  - 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.
    
    Specified by:
    
    getMetadata in interface MetadataStore<InvoiceItem>

Class InvoiceItem

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

InvoiceItem

Method Detail

getCustomer

setCustomer

getCustomerObject

setCustomerObject

getInvoice

setInvoice

getInvoiceObject

setInvoiceObject

getSubscription

setSubscription

getSubscriptionObject

setSubscriptionObject

list

list

list

list

create

create

create

create

retrieve

retrieve

retrieve

retrieve

update

update

update

update

delete

delete

delete

delete

getAmount

getCurrency

getDate

getDeleted

getDescription

getDiscountable

getLivemode

getObject

getPeriod

getPlan

getProration

getQuantity

getSubscriptionItem

getTaxRates

getUnifiedProration

getUnitAmount

setAmount

setCurrency

setDate

setDeleted

setDescription

setDiscountable

setId

setLivemode

setMetadata

setObject

setPeriod

setPlan

setProration

setQuantity

setSubscriptionItem

setTaxRates

setUnifiedProration

setUnitAmount