Package com.stripe.param
Class OrderListParams.Builder
java.lang.Object
com.stripe.param.OrderListParams.Builder
- Enclosing class:
OrderListParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllExpand
(List<String> elements) Add all elements to `expand` list.Add all elements to `ids` list.addAllUpstreamId
(List<String> elements) Add all elements to `upstreamIds` list.Add an element to `expand` list.Add an element to `ids` list.addUpstreamId
(String element) Add an element to `upstreamIds` 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.setCreated
(OrderListParams.Created created) Date this order was created.setCreated
(Long created) Date this order was created.setCustomer
(String customer) Only return orders for the given customer.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.Only return orders that have the given status.setStatusTransitions
(OrderListParams.StatusTransitions statusTransitions) Filter orders based on when they were paid, fulfilled, canceled, or returned.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setCreated
Date this order was created. -
setCreated
Date this order was created. -
setCustomer
Only return orders for the given customer. -
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. SeeOrderListParams.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. SeeOrderListParams.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. SeeOrderListParams.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. SeeOrderListParams.extraParams
for the field documentation. -
addId
Add an element to `ids` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeOrderListParams.ids
for the field documentation. -
addAllId
Add all elements to `ids` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeOrderListParams.ids
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
Only return orders that have the given status. One ofcreated
,paid
,fulfilled
, orrefunded
. -
setStatusTransitions
public OrderListParams.Builder setStatusTransitions(OrderListParams.StatusTransitions statusTransitions) Filter orders based on when they were paid, fulfilled, canceled, or returned. -
addUpstreamId
Add an element to `upstreamIds` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeOrderListParams.upstreamIds
for the field documentation. -
addAllUpstreamId
Add all elements to `upstreamIds` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeOrderListParams.upstreamIds
for the field documentation.
-