Package com.stripe.param
Class InvoiceListParams.Builder
java.lang.Object
com.stripe.param.InvoiceListParams.Builder
- Enclosing class:
- InvoiceListParams
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAllExpand
(List<String> elements) Add all elements to `expand` list.Add an element to `expand` list.build()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.setCollectionMethod
(InvoiceListParams.CollectionMethod collectionMethod) The collection method of the invoice to retrieve.setCreated
(InvoiceListParams.Created created) Only return invoices that were created during the given date interval.setCreated
(Long created) Only return invoices that were created during the given date interval.setCustomer
(String customer) Only return invoices for the customer specified by this customer ID.setDueDate
(InvoiceListParams.DueDate dueDate) setDueDate
(Long dueDate) setEndingBefore
(String endingBefore) A cursor for use in pagination.A limit on the number of objects to be returned.setStartingAfter
(String startingAfter) A cursor for use in pagination.setStatus
(InvoiceListParams.Status status) The status of the invoice, one ofdraft
,open
,paid
,uncollectible
, orvoid
.setSubscription
(String subscription) Only return invoices for the subscription specified by this subscription ID.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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. Eithercharge_automatically
orsend_invoice
. -
setCreated
Only return invoices that were created during the given date interval. -
setCreated
Only return invoices that were created during the given date interval. -
setCustomer
Only return invoices for the customer specified by this customer ID. -
setDueDate
-
setDueDate
-
setEndingBefore
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 withobj_bar
, your subsequent call can includeending_before=obj_bar
in order to fetch the previous page of the list. -
addExpand
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. SeeInvoiceListParams.expand
for the field documentation. -
addAllExpand
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. SeeInvoiceListParams.expand
for the field documentation. -
putExtraParam
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. SeeInvoiceListParams.extraParams
for the field documentation. -
putAllExtraParam
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. SeeInvoiceListParams.extraParams
for the field documentation. -
setLimit
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. -
setStartingAfter
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 withobj_foo
, your subsequent call can includestarting_after=obj_foo
in order to fetch the next page of the list. -
setStatus
-
setSubscription
Only return invoices for the subscription specified by this subscription ID.
-