Package com.stripe.param
Class CreditNotePreviewParams.Builder
- java.lang.Object
-
- com.stripe.param.CreditNotePreviewParams.Builder
-
- Enclosing class:
- CreditNotePreviewParams
public static class CreditNotePreviewParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreditNotePreviewParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.CreditNotePreviewParams.Builder
addAllLine(java.util.List<CreditNotePreviewParams.Line> elements)
Add all elements to `lines` list.CreditNotePreviewParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.CreditNotePreviewParams.Builder
addLine(CreditNotePreviewParams.Line element)
Add an element to `lines` list.CreditNotePreviewParams
build()
Finalize and obtain parameter instance from this builder.CreditNotePreviewParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.CreditNotePreviewParams.Builder
putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map.CreditNotePreviewParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.CreditNotePreviewParams.Builder
putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map.CreditNotePreviewParams.Builder
setAmount(java.lang.Long amount)
The integer amount in %s representing the total amount of the credit note.CreditNotePreviewParams.Builder
setCreditAmount(java.lang.Long creditAmount)
The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.CreditNotePreviewParams.Builder
setInvoice(java.lang.String invoice)
ID of the invoice.CreditNotePreviewParams.Builder
setMemo(java.lang.String memo)
The credit note's memo appears on the credit note PDF.CreditNotePreviewParams.Builder
setOutOfBandAmount(java.lang.Long outOfBandAmount)
The integer amount in %s representing the amount that is credited outside of Stripe.CreditNotePreviewParams.Builder
setReason(CreditNotePreviewParams.Reason reason)
Reason for issuing this credit note, one ofduplicate
,fraudulent
,order_change
, orproduct_unsatisfactory
.CreditNotePreviewParams.Builder
setRefund(java.lang.String refund)
ID of an existing refund to link this credit note to.CreditNotePreviewParams.Builder
setRefundAmount(java.lang.Long refundAmount)
The integer amount in %s representing the amount to refund.
-
-
-
Method Detail
-
build
public CreditNotePreviewParams build()
Finalize and obtain parameter instance from this builder.
-
setAmount
public CreditNotePreviewParams.Builder setAmount(java.lang.Long amount)
The integer amount in %s representing the total amount of the credit note.
-
setCreditAmount
public CreditNotePreviewParams.Builder setCreditAmount(java.lang.Long creditAmount)
The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
-
addExpand
public CreditNotePreviewParams.Builder addExpand(java.lang.String element)
Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeCreditNotePreviewParams.expand
for the field documentation.
-
addAllExpand
public CreditNotePreviewParams.Builder addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeCreditNotePreviewParams.expand
for the field documentation.
-
putExtraParam
public CreditNotePreviewParams.Builder putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeCreditNotePreviewParams.extraParams
for the field documentation.
-
putAllExtraParam
public CreditNotePreviewParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeCreditNotePreviewParams.extraParams
for the field documentation.
-
setInvoice
public CreditNotePreviewParams.Builder setInvoice(java.lang.String invoice)
ID of the invoice.
-
addLine
public CreditNotePreviewParams.Builder addLine(CreditNotePreviewParams.Line element)
Add an element to `lines` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeCreditNotePreviewParams.lines
for the field documentation.
-
addAllLine
public CreditNotePreviewParams.Builder addAllLine(java.util.List<CreditNotePreviewParams.Line> elements)
Add all elements to `lines` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeCreditNotePreviewParams.lines
for the field documentation.
-
setMemo
public CreditNotePreviewParams.Builder setMemo(java.lang.String memo)
The credit note's memo appears on the credit note PDF.
-
putMetadata
public CreditNotePreviewParams.Builder putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeCreditNotePreviewParams.metadata
for the field documentation.
-
putAllMetadata
public CreditNotePreviewParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeCreditNotePreviewParams.metadata
for the field documentation.
-
setOutOfBandAmount
public CreditNotePreviewParams.Builder setOutOfBandAmount(java.lang.Long outOfBandAmount)
The integer amount in %s representing the amount that is credited outside of Stripe.
-
setReason
public CreditNotePreviewParams.Builder setReason(CreditNotePreviewParams.Reason reason)
Reason for issuing this credit note, one ofduplicate
,fraudulent
,order_change
, orproduct_unsatisfactory
.
-
setRefund
public CreditNotePreviewParams.Builder setRefund(java.lang.String refund)
ID of an existing refund to link this credit note to.
-
setRefundAmount
public CreditNotePreviewParams.Builder setRefundAmount(java.lang.Long refundAmount)
The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
-
-