Package com.stripe.param

Class CreditNoteCreateParams.Line

java.lang.Object
com.stripe.param.CreditNoteCreateParams.Line
Enclosing class:
CreditNoteCreateParams
public static class CreditNoteCreateParams.Line
extends java.lang.Object

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  CreditNoteCreateParams.Line.Builder  
    static class  CreditNoteCreateParams.Line.Type  

  • Method Summary

    Modifier and Type Method Description
    static CreditNoteCreateParams.Line.Builder builder()  
    java.lang.Long getAmount()
    The line item amount to credit.
    java.lang.String getDescription()
    The description of the credit note line item.
    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 getInvoiceLineItem()
    The invoice line item to credit.
    java.lang.Long getQuantity()
    The line item quantity to credit.
    java.lang.Object getTaxRates()
    The tax rates which apply to the credit note line item.
    CreditNoteCreateParams.Line.Type getType()
    Type of the credit note line item, one of `custom_line_item` or `invoice_line_item`.
    java.lang.Long getUnitAmount()
    The integer unit amount in **%s** of the credit note line item.
    java.math.BigDecimal getUnitAmountDecimal()
    Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • builder

      public static CreditNoteCreateParams.Line.Builder builder()

    • getAmount

      public java.lang.Long getAmount()
      The line item amount to credit. Only valid when `type` is `invoice_line_item` and the referenced invoice line item does not have a quantity, only an amount.

    • getDescription

      public java.lang.String getDescription()
      The description of the credit note line item. Only valid when the `type` is `custom_line_item`.

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

    • getInvoiceLineItem

      public java.lang.String getInvoiceLineItem()
      The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.

    • getQuantity

      public java.lang.Long getQuantity()
      The line item quantity to credit.

    • getTaxRates

      public java.lang.Object getTaxRates()
      The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item`.

    • getType

      public CreditNoteCreateParams.Line.Type getType()
      Type of the credit note line item, one of `custom_line_item` or `invoice_line_item`.

    • getUnitAmount

      public java.lang.Long getUnitAmount()
      The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.

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