Package com.stripe.param

Class SubscriptionListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionListParams

public class SubscriptionListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionListParams.AutomaticTax
static class	SubscriptionListParams.Builder
static enum	SubscriptionListParams.CollectionMethod	Maximum value to filter by (inclusive).
static class	SubscriptionListParams.Created	Add all map key/value pairs to `extraParams` map.
static class	SubscriptionListParams.CurrentPeriodEnd	Maximum value to filter by (inclusive).
static class	SubscriptionListParams.CurrentPeriodStart	Maximum value to filter by (inclusive).
static enum	SubscriptionListParams.Status

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 SubscriptionListParams.Builder	builder()
SubscriptionListParams.AutomaticTax	getAutomaticTax()	Filter subscriptions by their automatic tax settings.
SubscriptionListParams.CollectionMethod	getCollectionMethod()	The collection method of the subscriptions to retrieve.
Object	getCreated()	Only return subscriptions that were created during the given date interval.
Object	getCurrentPeriodEnd()
Object	getCurrentPeriodStart()
String	getCustomer()	The ID of the customer whose subscriptions will be retrieved.
String	getEndingBefore()	A cursor for use in pagination.
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	getPlan()	The ID of the plan whose subscriptions will be retrieved.
String	getPrice()	Filter for subscriptions that contain this recurring price ID.
String	getStartingAfter()	A cursor for use in pagination.
SubscriptionListParams.Status	getStatus()	The status of the subscriptions to retrieve.
String	getTestClock()	Filter for subscriptions that are associated with the specified test clock.

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

getAutomaticTax

public SubscriptionListParams.AutomaticTax getAutomaticTax()

Filter subscriptions by their automatic tax settings.

getCollectionMethod

public SubscriptionListParams.CollectionMethod getCollectionMethod()

The collection method of the subscriptions to retrieve. Either charge_automatically or send_invoice.

getCreated

public Object getCreated()

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

getCurrentPeriodEnd

public Object getCurrentPeriodEnd()

getCurrentPeriodStart

public Object getCurrentPeriodStart()

getCustomer

public String getCustomer()

The ID of the customer whose subscriptions will be retrieved.

getEndingBefore

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

getPlan

public String getPlan()

The ID of the plan whose subscriptions will be retrieved.

getPrice

public String getPrice()

Filter for subscriptions that contain this recurring price ID.

getStartingAfter

public 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 SubscriptionListParams.Status getStatus()

The status of the subscriptions to retrieve. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Pass ended to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of all will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.

getTestClock

public String getTestClock()

Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.