Package com.stripe.param

Class CreditNotePreviewLinesListParams.Builder

java.lang.Object

com.stripe.param.CreditNotePreviewLinesListParams.Builder

Enclosing class:

CreditNotePreviewLinesListParams

public static class CreditNotePreviewLinesListParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreditNotePreviewLinesListParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
CreditNotePreviewLinesListParams.Builder	addAllLine(List<CreditNotePreviewLinesListParams.Line> elements)	Add all elements to `lines` list.
CreditNotePreviewLinesListParams.Builder	addExpand(String element)	Add an element to `expand` list.
CreditNotePreviewLinesListParams.Builder	addLine(CreditNotePreviewLinesListParams.Line element)	Add an element to `lines` list.
CreditNotePreviewLinesListParams	build()	Finalize and obtain parameter instance from this builder.
CreditNotePreviewLinesListParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
CreditNotePreviewLinesListParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
CreditNotePreviewLinesListParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
CreditNotePreviewLinesListParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
CreditNotePreviewLinesListParams.Builder	setAmount(Long amount)	The integer amount in cents (or local equivalent) representing the total amount of the credit note.
CreditNotePreviewLinesListParams.Builder	setCreditAmount(Long creditAmount)	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.
CreditNotePreviewLinesListParams.Builder	setEffectiveAt(Long effectiveAt)	The date when this credit note is in effect.
CreditNotePreviewLinesListParams.Builder	setEmailType(CreditNotePreviewLinesListParams.EmailType emailType)	Type of email to send to the customer, one of credit_note or none and the default is credit_note.
CreditNotePreviewLinesListParams.Builder	setEndingBefore(String endingBefore)	A cursor for use in pagination.
CreditNotePreviewLinesListParams.Builder	setInvoice(String invoice)	Required. ID of the invoice.
CreditNotePreviewLinesListParams.Builder	setLimit(Long limit)	A limit on the number of objects to be returned.
CreditNotePreviewLinesListParams.Builder	setMemo(String memo)	The credit note's memo appears on the credit note PDF.
CreditNotePreviewLinesListParams.Builder	setOutOfBandAmount(Long outOfBandAmount)	The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
CreditNotePreviewLinesListParams.Builder	setReason(CreditNotePreviewLinesListParams.Reason reason)	Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.
CreditNotePreviewLinesListParams.Builder	setRefund(String refund)	ID of an existing refund to link this credit note to.
CreditNotePreviewLinesListParams.Builder	setRefundAmount(Long refundAmount)	The integer amount in cents (or local equivalent) representing the amount to refund.
CreditNotePreviewLinesListParams.Builder	setShippingCost(CreditNotePreviewLinesListParams.ShippingCost shippingCost)	When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
CreditNotePreviewLinesListParams.Builder	setStartingAfter(String startingAfter)	A cursor for use in pagination.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public CreditNotePreviewLinesListParams build()

Finalize and obtain parameter instance from this builder.

setAmount

public CreditNotePreviewLinesListParams.Builder setAmount(Long amount)

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

setCreditAmount

public CreditNotePreviewLinesListParams.Builder setCreditAmount(Long creditAmount)

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.

setEffectiveAt

public CreditNotePreviewLinesListParams.Builder setEffectiveAt(Long effectiveAt)

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.

setEmailType

public CreditNotePreviewLinesListParams.Builder setEmailType(CreditNotePreviewLinesListParams.EmailType emailType)

Type of email to send to the customer, one of credit_note or none and the default is credit_note.

setEndingBefore

public CreditNotePreviewLinesListParams.Builder setEndingBefore(String endingBefore)

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

addExpand

public CreditNotePreviewLinesListParams.Builder addExpand(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 CreditNotePreviewLinesListParams.expand for the field documentation.

addAllExpand

public CreditNotePreviewLinesListParams.Builder addAllExpand(List<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 CreditNotePreviewLinesListParams.expand for the field documentation.

putExtraParam

public CreditNotePreviewLinesListParams.Builder putExtraParam(String key,
 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 CreditNotePreviewLinesListParams.extraParams for the field documentation.

putAllExtraParam

public CreditNotePreviewLinesListParams.Builder putAllExtraParam(Map<String,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 CreditNotePreviewLinesListParams.extraParams for the field documentation.

setInvoice

public CreditNotePreviewLinesListParams.Builder setInvoice(String invoice)

Required. ID of the invoice.

setLimit

public CreditNotePreviewLinesListParams.Builder setLimit(Long limit)

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

addLine

public CreditNotePreviewLinesListParams.Builder addLine(CreditNotePreviewLinesListParams.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. See CreditNotePreviewLinesListParams.lines for the field documentation.

addAllLine

public CreditNotePreviewLinesListParams.Builder addAllLine(List<CreditNotePreviewLinesListParams.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. See CreditNotePreviewLinesListParams.lines for the field documentation.

setMemo

public CreditNotePreviewLinesListParams.Builder setMemo(String memo)

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

putMetadata

public CreditNotePreviewLinesListParams.Builder putMetadata(String key,
 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 CreditNotePreviewLinesListParams.metadata for the field documentation.

putAllMetadata

public CreditNotePreviewLinesListParams.Builder putAllMetadata(Map<String,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 CreditNotePreviewLinesListParams.metadata for the field documentation.

setOutOfBandAmount

public CreditNotePreviewLinesListParams.Builder setOutOfBandAmount(Long outOfBandAmount)

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

setReason

public CreditNotePreviewLinesListParams.Builder setReason(CreditNotePreviewLinesListParams.Reason reason)

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

setRefund

public CreditNotePreviewLinesListParams.Builder setRefund(String refund)

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

setRefundAmount

public CreditNotePreviewLinesListParams.Builder setRefundAmount(Long refundAmount)

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.

setShippingCost

public CreditNotePreviewLinesListParams.Builder setShippingCost(CreditNotePreviewLinesListParams.ShippingCost shippingCost)

When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.

setStartingAfter

public CreditNotePreviewLinesListParams.Builder setStartingAfter(String startingAfter)

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.