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 and Description
static class	SubscriptionListParams.Builder
static class	SubscriptionListParams.CollectionMethod Maximum value to filter by (inclusive).
static class	SubscriptionListParams.Created
static class	SubscriptionListParams.CurrentPeriodEnd Maximum value to filter by (inclusive).
static class	SubscriptionListParams.CurrentPeriodStart Maximum value to filter by (inclusive).
static class	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 and Description
static SubscriptionListParams.Builder	builder()
SubscriptionListParams.CollectionMethod	getCollectionMethod() The collection method of the subscriptions to retrieve.
java.lang.Object	getCreated()
java.lang.Object	getCurrentPeriodEnd()
java.lang.Object	getCurrentPeriodStart()
java.lang.String	getCustomer() The ID of the customer whose subscriptions will be retrieved.
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.lang.Long	getLimit() A limit on the number of objects to be returned.
java.lang.String	getPlan() The ID of the plan whose subscriptions will be retrieved.
java.lang.String	getPrice() Filter for subscriptions that contain this recurring price ID.
java.lang.String	getStartingAfter() A cursor for use in pagination.
SubscriptionListParams.Status	getStatus() The status of the subscriptions to retrieve.

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

getCollectionMethod

public SubscriptionListParams.CollectionMethod getCollectionMethod()

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

getCreated

public java.lang.Object getCreated()

getCurrentPeriodEnd

public java.lang.Object getCurrentPeriodEnd()

getCurrentPeriodStart

public java.lang.Object getCurrentPeriodStart()

getCustomer

public java.lang.String getCustomer()

The ID of the customer whose subscriptions will be retrieved.

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.

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.

getPlan

public java.lang.String getPlan()

The ID of the plan whose subscriptions will be retrieved.

getPrice

public java.lang.String getPrice()

Filter for subscriptions that contain this recurring price ID.

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

The status of the subscriptions to retrieve. One of: incomplete, incomplete_expired, trialing, active, past_due, unpaid, canceled, or all. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of all will return subscriptions of all statuses.