Package com.stripe.param
Class CreditNoteCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.CreditNoteCreateParams
-
public class CreditNoteCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CreditNoteCreateParams.Builder
static class
CreditNoteCreateParams.Line
static class
CreditNoteCreateParams.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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreditNoteCreateParams.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<CreditNoteCreateParams.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.CreditNoteCreateParams.Reason
getReason()
Reason for issuing this credit note, one ofduplicate
,fraudulent
,order_change
, orproduct_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
-
-
-
-
Method Detail
-
builder
public static CreditNoteCreateParams.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<CreditNoteCreateParams.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 tometadata
.
-
getOutOfBandAmount
public java.lang.Long getOutOfBandAmount()
The integer amount in %s representing the amount that is credited outside of Stripe.
-
getReason
public CreditNoteCreateParams.Reason getReason()
Reason for issuing this credit note, one ofduplicate
,fraudulent
,order_change
, orproduct_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.
-
-