com.stripe.param

Class InvoiceListParams.Builder

java.lang.Object

com.stripe.param.InvoiceListParams.Builder

Enclosing class:

InvoiceListParams

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
InvoiceListParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
InvoiceListParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
InvoiceListParams	build() Finalize and obtain parameter instance from this builder.
InvoiceListParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
InvoiceListParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
InvoiceListParams.Builder	setCollectionMethod(InvoiceListParams.CollectionMethod collectionMethod) The collection method of the invoice to retrieve.
InvoiceListParams.Builder	setCreated(InvoiceListParams.Created created)
InvoiceListParams.Builder	setCreated(java.lang.Long created)
InvoiceListParams.Builder	setCustomer(java.lang.String customer) Only return invoices for the customer specified by this customer ID.
InvoiceListParams.Builder	setDueDate(InvoiceListParams.DueDate dueDate)
InvoiceListParams.Builder	setDueDate(java.lang.Long dueDate)
InvoiceListParams.Builder	setEndingBefore(java.lang.String endingBefore) A cursor for use in pagination.
InvoiceListParams.Builder	setLimit(java.lang.Long limit) A limit on the number of objects to be returned.
InvoiceListParams.Builder	setStartingAfter(java.lang.String startingAfter) A cursor for use in pagination.
InvoiceListParams.Builder	setStatus(InvoiceListParams.Status status) The status of the invoice, one of draft, open, paid, uncollectible, or void.
InvoiceListParams.Builder	setSubscription(java.lang.String subscription) Only return invoices for the subscription specified by this subscription ID.

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 InvoiceListParams build()

Finalize and obtain parameter instance from this builder.

setCollectionMethod

public InvoiceListParams.Builder setCollectionMethod(InvoiceListParams.CollectionMethod collectionMethod)

The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.

setCreated

public InvoiceListParams.Builder setCreated(InvoiceListParams.Created created)

setCreated

public InvoiceListParams.Builder setCreated(java.lang.Long created)

setCustomer

public InvoiceListParams.Builder setCustomer(java.lang.String customer)

Only return invoices for the customer specified by this customer ID.

setDueDate

public InvoiceListParams.Builder setDueDate(InvoiceListParams.DueDate dueDate)

setDueDate

public InvoiceListParams.Builder setDueDate(java.lang.Long dueDate)

setEndingBefore

public InvoiceListParams.Builder setEndingBefore(java.lang.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 InvoiceListParams.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 InvoiceListParams.expand for the field documentation.

addAllExpand

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

putExtraParam

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

putAllExtraParam

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

setLimit

public InvoiceListParams.Builder setLimit(java.lang.Long limit)

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

setStartingAfter

public InvoiceListParams.Builder setStartingAfter(java.lang.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.

setStatus

public InvoiceListParams.Builder setStatus(InvoiceListParams.Status status)

The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more

setSubscription

public InvoiceListParams.Builder setSubscription(java.lang.String subscription)

Only return invoices for the subscription specified by this subscription ID.