Package com.stripe.param

Class InvoiceCreatePreviewParams.InvoiceItem

java.lang.Object
com.stripe.param.InvoiceCreatePreviewParams.InvoiceItem
Enclosing class:
InvoiceCreatePreviewParams
public static class InvoiceCreatePreviewParams.InvoiceItem extends Object
ID of the promotion code to create a new discount for.

  • Method Details

    • builder

      public static InvoiceCreatePreviewParams.InvoiceItem.Builder builder()

    • getAmount

      public Long getAmount()
      The integer amount in cents (or local equivalent) of previewed invoice item.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency. Only applicable to new invoice items.

    • getDescription

      public 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 Boolean getDiscountable()
      Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.

    • getDiscounts

      public Object getDiscounts()
      The coupons to redeem into discounts for the invoice item in the preview.

    • 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.

    • getInvoiceitem

      public String getInvoiceitem()
      The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.

    • 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 InvoiceCreatePreviewParams.InvoiceItem.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 String getPrice()
      The ID of the price object. One of price or price_data is required.

    • getPriceData

      public InvoiceCreatePreviewParams.InvoiceItem.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 invoice item.

    • getTaxBehavior

      public InvoiceCreatePreviewParams.InvoiceItem.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 that apply to the item. When set, any default_tax_rates do not apply to this item.

    • 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 BigDecimal 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.