Package com.stripe.param

Class InvoiceItemUpdateParams

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

  • Method Details

    • builder

      public static InvoiceItemUpdateParams.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 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 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 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.

    • getPeriod

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

    • getPriceData

      public InvoiceItemUpdateParams.PriceData getPriceData()
      Data used to generate a new Price object inline.

    • getQuantity

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

    • getTaxBehavior

      public InvoiceItemUpdateParams.TaxBehavior getTaxBehavior()
      Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

    • getTaxCode

      public Object getTaxCode()
      A tax code ID.

    • getTaxRates

      public Object 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. Pass an empty string to remove previously-defined tax rates.

    • getUnitAmount

      public Long getUnitAmount()
      The integer unit amount in cents (or local equivalent) 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 Object getUnitAmountDecimal()
      Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.