Package com.stripe.param

Class SubscriptionSearchParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionSearchParams

public class SubscriptionSearchParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionSearchParams.Builder

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 SubscriptionSearchParams.Builder	builder()
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Long	getLimit()	A limit on the number of objects to be returned.
String	getPage()	A cursor for pagination across multiple pages of results.
String	getQuery()	Required. The search query string.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SubscriptionSearchParams.Builder builder()

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,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.

getLimit

public Long getLimit()

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

getPage

public String getPage()

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

getQuery

public String getQuery()

Required. The search query string. See search query language and the list of supported query fields for subscriptions.