com.stripe.param

Class CreditNoteCreateParams.Builder

java.lang.Object

com.stripe.param.CreditNoteCreateParams.Builder

Enclosing class:

CreditNoteCreateParams

public static class CreditNoteCreateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreditNoteCreateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
CreditNoteCreateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
CreditNoteCreateParams	build() Finalize and obtain parameter instance from this builder.
CreditNoteCreateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
CreditNoteCreateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
CreditNoteCreateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
CreditNoteCreateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
CreditNoteCreateParams.Builder	setAmount(java.lang.Long amount) The integer amount in **%s** representing the total amount of the credit note.
CreditNoteCreateParams.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.
CreditNoteCreateParams.Builder	setInvoice(java.lang.String invoice) ID of the invoice.
CreditNoteCreateParams.Builder	setMemo(java.lang.String memo) The credit note's memo appears on the credit note PDF.
CreditNoteCreateParams.Builder	setReason(CreditNoteCreateParams.Reason reason) Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`.
CreditNoteCreateParams.Builder	setRefund(java.lang.String refund) ID of an existing refund to link this credit note to.
CreditNoteCreateParams.Builder	setRefundAmount(java.lang.Long refundAmount) The integer amount in **%s** representing the amount to refund.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public CreditNoteCreateParams build()

Finalize and obtain parameter instance from this builder.

setAmount

public CreditNoteCreateParams.Builder setAmount(java.lang.Long amount)

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

setCreditAmount

public CreditNoteCreateParams.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 CreditNoteCreateParams.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. See CreditNoteCreateParams.expand for the field documentation.

addAllExpand

public CreditNoteCreateParams.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. See CreditNoteCreateParams.expand for the field documentation.

putExtraParam

public CreditNoteCreateParams.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. See CreditNoteCreateParams.extraParams for the field documentation.

putAllExtraParam

public CreditNoteCreateParams.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. See CreditNoteCreateParams.extraParams for the field documentation.

setInvoice

public CreditNoteCreateParams.Builder setInvoice(java.lang.String invoice)

ID of the invoice.

setMemo

public CreditNoteCreateParams.Builder setMemo(java.lang.String memo)

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

putMetadata

public CreditNoteCreateParams.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. See CreditNoteCreateParams.metadata for the field documentation.

putAllMetadata

public CreditNoteCreateParams.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. See CreditNoteCreateParams.metadata for the field documentation.

setReason

public CreditNoteCreateParams.Builder setReason(CreditNoteCreateParams.Reason reason)

Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`.

setRefund

public CreditNoteCreateParams.Builder setRefund(java.lang.String refund)

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

setRefundAmount

public CreditNoteCreateParams.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.