Package 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 Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.SubscriptionListParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.SubscriptionListParams.Builder
setCollectionMethod(SubscriptionListParams.CollectionMethod collectionMethod)
The collection method of the subscriptions to retrieve.SubscriptionListParams.Builder
setCreated(SubscriptionListParams.Created created)
SubscriptionListParams.Builder
setCreated(java.lang.Long created)
SubscriptionListParams.Builder
setCurrentPeriodEnd(SubscriptionListParams.CurrentPeriodEnd currentPeriodEnd)
SubscriptionListParams.Builder
setCurrentPeriodEnd(java.lang.Long currentPeriodEnd)
SubscriptionListParams.Builder
setCurrentPeriodStart(SubscriptionListParams.CurrentPeriodStart currentPeriodStart)
SubscriptionListParams.Builder
setCurrentPeriodStart(java.lang.Long 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
setPrice(java.lang.String price)
Filter for subscriptions that contain this recurring price ID.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.
-
-
-
Method Detail
-
build
public SubscriptionListParams build()
Finalize and obtain parameter instance from this builder.
-
setCollectionMethod
public SubscriptionListParams.Builder setCollectionMethod(SubscriptionListParams.CollectionMethod collectionMethod)
The collection method of the subscriptions to retrieve. Eithercharge_automatically
orsend_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 withobj_bar
, your subsequent call can includeending_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. SeeSubscriptionListParams.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. SeeSubscriptionListParams.expand
for the field documentation.
-
putExtraParam
public SubscriptionListParams.Builder putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSubscriptionListParams.extraParams
for the field documentation.
-
putAllExtraParam
public SubscriptionListParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSubscriptionListParams.extraParams
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.
-
setPrice
public SubscriptionListParams.Builder setPrice(java.lang.String price)
Filter for subscriptions that contain this recurring price ID.
-
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 withobj_foo
, your subsequent call can includestarting_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. Passing in a value ofcanceled
will return all canceled subscriptions, including those belonging to deleted customers. Passended
to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value ofall
will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
-
-