Package com.stripe.param

Class CreditNotePreviewParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.CreditNotePreviewParams

public class CreditNotePreviewParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreditNotePreviewParams.Builder
static class	CreditNotePreviewParams.Line
static class	CreditNotePreviewParams.Reason

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static CreditNotePreviewParams.Builder	builder()
java.lang.Long	getAmount()	The integer amount in %s representing the total amount of the credit note.
java.lang.Long	getCreditAmount()	The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
java.util.List<java.lang.String>	getExpand()	Specifies which fields in the response should be expanded.
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	getInvoice()	ID of the invoice.
java.util.List<CreditNotePreviewParams.Line>	getLines()	Line items that make up the credit note.
java.lang.String	getMemo()	The credit note's memo appears on the credit note PDF.
java.util.Map<java.lang.String,java.lang.String>	getMetadata()	Set of key-value pairs that you can attach to an object.
java.lang.Long	getOutOfBandAmount()	The integer amount in %s representing the amount that is credited outside of Stripe.
CreditNotePreviewParams.Reason	getReason()	Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.
java.lang.String	getRefund()	ID of an existing refund to link this credit note to.
java.lang.Long	getRefundAmount()	The integer amount in %s representing the amount to refund.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static CreditNotePreviewParams.Builder builder()

getAmount

public java.lang.Long getAmount()

The integer amount in %s representing the total amount of the credit note.

getCreditAmount

public java.lang.Long getCreditAmount()

The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

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.

getInvoice

public java.lang.String getInvoice()

ID of the invoice.

getLines

public java.util.List<CreditNotePreviewParams.Line> getLines()

Line items that make up the credit note.

getMemo

public java.lang.String getMemo()

The credit note's memo appears on the credit note PDF.

getMetadata

public java.util.Map<java.lang.String,java.lang.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 java.lang.Long getOutOfBandAmount()

The integer amount in %s 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 java.lang.String getRefund()

ID of an existing refund to link this credit note to.

getRefundAmount

public java.lang.Long getRefundAmount()

The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.