com.stripe.param

Class OrderListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.OrderListParams

public class OrderListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderListParams.Builder
static class	OrderListParams.Created
static class	OrderListParams.StatusTransitions Maximum value to filter by (inclusive).

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static OrderListParams.Builder	builder()
java.lang.Object	getCreated() Date this order was created.
java.lang.String	getCustomer() Only return orders for the given customer.
java.lang.String	getEndingBefore() A cursor for use in pagination.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.util.List<java.lang.String>	getIds() Only return orders with the given IDs.
java.lang.Long	getLimit() A limit on the number of objects to be returned.
java.lang.String	getStartingAfter() A cursor for use in pagination.
java.lang.String	getStatus() Only return orders that have the given status.
OrderListParams.StatusTransitions	getStatusTransitions() Filter orders based on when they were paid, fulfilled, canceled, or returned.
java.util.List<java.lang.String>	getUpstreamIds() Only return orders with the given upstream order IDs.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static OrderListParams.Builder builder()

getCreated

public java.lang.Object getCreated()

Date this order was created.

getCustomer

public java.lang.String getCustomer()

Only return orders for the given customer.

getEndingBefore

public java.lang.String getEndingBefore()

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.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getIds

public java.util.List<java.lang.String> getIds()

Only return orders with the given IDs.

getLimit

public java.lang.Long getLimit()

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

getStartingAfter

public java.lang.String getStartingAfter()

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.

getStatus

public java.lang.String getStatus()

Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`.

getStatusTransitions

public OrderListParams.StatusTransitions getStatusTransitions()

Filter orders based on when they were paid, fulfilled, canceled, or returned.

getUpstreamIds

public java.util.List<java.lang.String> getUpstreamIds()

Only return orders with the given upstream order IDs.