Package com.stripe.param

Class ProductListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.ProductListParams

public class ProductListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProductListParams.Builder
static class	ProductListParams.Created
static class	ProductListParams.Type	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	Description
static ProductListParams.Builder	builder()
java.lang.Boolean	getActive()	Only return products that are active or inactive (e.g., pass false to list all inactive products).
java.lang.Object	getCreated()	Only return products that were created during the given date interval.
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 products with the given IDs.
java.lang.Long	getLimit()	A limit on the number of objects to be returned.
java.lang.Boolean	getShippable()	Only return products that can be shipped (i.e., physical, not digital products).
java.lang.String	getStartingAfter()	A cursor for use in pagination.
ProductListParams.Type	getType()	Only return products of this type.
java.lang.String	getUrl()	Only return products with the given url.

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 ProductListParams.Builder builder()

getActive

public java.lang.Boolean getActive()

Only return products that are active or inactive (e.g., pass false to list all inactive products).

getCreated

public java.lang.Object getCreated()

Only return products that were created during the given date interval.

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 products 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.

getShippable

public java.lang.Boolean getShippable()

Only return products that can be shipped (i.e., physical, not digital products).

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.

getType

public ProductListParams.Type getType()

Only return products of this type.

getUrl

public java.lang.String getUrl()

Only return products with the given url.