com.stripe.param

Class SubscriptionListParams.Builder

java.lang.Object

com.stripe.param.SubscriptionListParams.Builder

Enclosing class:

SubscriptionListParams

public static class SubscriptionListParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscriptionListParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
SubscriptionListParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
SubscriptionListParams	build() Finalize and obtain parameter instance from this builder.
SubscriptionListParams.Builder	setBilling(SubscriptionListParams.Billing billing) The billing mode of the subscriptions to retrieve.
SubscriptionListParams.Builder	setCreated(java.lang.Long created)
SubscriptionListParams.Builder	setCreated(SubscriptionListParams.Created created)
SubscriptionListParams.Builder	setCurrentPeriodEnd(java.lang.Long currentPeriodEnd)
SubscriptionListParams.Builder	setCurrentPeriodEnd(SubscriptionListParams.CurrentPeriodEnd currentPeriodEnd)
SubscriptionListParams.Builder	setCurrentPeriodStart(java.lang.Long currentPeriodStart)
SubscriptionListParams.Builder	setCurrentPeriodStart(SubscriptionListParams.CurrentPeriodStart currentPeriodStart)
SubscriptionListParams.Builder	setCustomer(java.lang.String customer) The ID of the customer whose subscriptions will be retrieved.
SubscriptionListParams.Builder	setEndingBefore(java.lang.String endingBefore) A cursor for use in pagination.
SubscriptionListParams.Builder	setLimit(java.lang.Long limit) A limit on the number of objects to be returned.
SubscriptionListParams.Builder	setPlan(java.lang.String plan) The ID of the plan whose subscriptions will be retrieved.
SubscriptionListParams.Builder	setStartingAfter(java.lang.String startingAfter) A cursor for use in pagination.
SubscriptionListParams.Builder	setStatus(SubscriptionListParams.Status status) The status of the subscriptions to retrieve.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public SubscriptionListParams build()

Finalize and obtain parameter instance from this builder.

setBilling

public SubscriptionListParams.Builder setBilling(SubscriptionListParams.Billing billing)

The billing mode of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.

setCreated

public SubscriptionListParams.Builder setCreated(SubscriptionListParams.Created created)

setCreated

public SubscriptionListParams.Builder setCreated(java.lang.Long created)

setCurrentPeriodEnd

public SubscriptionListParams.Builder setCurrentPeriodEnd(SubscriptionListParams.CurrentPeriodEnd currentPeriodEnd)

setCurrentPeriodEnd

public SubscriptionListParams.Builder setCurrentPeriodEnd(java.lang.Long currentPeriodEnd)

setCurrentPeriodStart

public SubscriptionListParams.Builder setCurrentPeriodStart(SubscriptionListParams.CurrentPeriodStart currentPeriodStart)

setCurrentPeriodStart

public SubscriptionListParams.Builder setCurrentPeriodStart(java.lang.Long currentPeriodStart)

setCustomer

public SubscriptionListParams.Builder setCustomer(java.lang.String customer)

The ID of the customer whose subscriptions will be retrieved.

setEndingBefore

public SubscriptionListParams.Builder setEndingBefore(java.lang.String endingBefore)

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.

addExpand

public SubscriptionListParams.Builder addExpand(java.lang.String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionListParams.expand for the field documentation.

addAllExpand

public SubscriptionListParams.Builder addAllExpand(java.util.List<java.lang.String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionListParams.expand for the field documentation.

setLimit

public SubscriptionListParams.Builder setLimit(java.lang.Long limit)

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

setPlan

public SubscriptionListParams.Builder setPlan(java.lang.String plan)

The ID of the plan whose subscriptions will be retrieved.

setStartingAfter

public SubscriptionListParams.Builder setStartingAfter(java.lang.String startingAfter)

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.

setStatus

public SubscriptionListParams.Builder setStatus(SubscriptionListParams.Status status)

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.