Package com.stripe.param

Class InvoiceLineItemUpdateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.InvoiceLineItemUpdateParams
public class InvoiceLineItemUpdateParams extends ApiRequestParams

  • Method Details

    • builder

      public static InvoiceLineItemUpdateParams.Builder builder()

    • getAmount

      public Long getAmount()
      The integer amount in cents (or local equivalent) 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 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 Boolean getDiscountable()
      Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.

    • getDiscounts

      public Object getDiscounts()
      The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public Map<String,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 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 to metadata. For type=subscription line items, the incoming metadata specified on the request is directly used to set this value, in contrast to type=invoiceitem line items, where any existing metadata on the invoice line is merged with the incoming data.

    • getPeriod

      public InvoiceLineItemUpdateParams.Period getPeriod()
      The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

    • getPrice

      public Object getPrice()
      The ID of the price object. One of price or price_data is required.

    • getPriceData

      public InvoiceLineItemUpdateParams.PriceData getPriceData()
      Data used to generate a new Price object inline. One of price or price_data is required.

    • getQuantity

      public Long getQuantity()
      Non-negative integer. The quantity of units for the line item.

    • getTaxAmounts

      public Object getTaxAmounts()
      A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has tax_rates or if the invoice has default_tax_rates or uses automatic tax. Pass an empty string to remove previously defined tax amounts.

    • getTaxRates

      public Object getTaxRates()
      The tax rates which apply to the line item. When set, the default_tax_rates on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.