Package com.stripe.param

Class CreditNotePreviewParams

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

  • Method Details

    • builder

      public static CreditNotePreviewParams.Builder builder()

    • getAmount

      public Long getAmount()
      The integer amount in cents (or local equivalent) representing the total amount of the credit note.

    • getCreditAmount

      public Long getCreditAmount()
      The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.

    • getEffectiveAt

      public Long getEffectiveAt()
      The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.

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

    • getInvoice

      public String getInvoice()
      Required. ID of the invoice.

    • getLines

      public List<CreditNotePreviewParams.Line> getLines()
      Line items that make up the credit note.

    • getMemo

      public String getMemo()
      The credit note's memo appears on the credit note PDF.

    • getMetadata

      public Map<String,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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • getOutOfBandAmount

      public Long getOutOfBandAmount()
      The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.

    • getReason

      public CreditNotePreviewParams.Reason getReason()
      Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.

    • getRefund

      public String getRefund()
      ID of an existing refund to link this credit note to.

    • getRefundAmount

      public Long getRefundAmount()
      The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

    • getShippingCost

      public CreditNotePreviewParams.ShippingCost getShippingCost()
      When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.