Package com.stripe.param
Class PlanListParams.Builder
- java.lang.Object
-
- com.stripe.param.PlanListParams.Builder
-
- Enclosing class:
- PlanListParams
public static class PlanListParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PlanListParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.PlanListParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.PlanListParams
build()
Finalize and obtain parameter instance from this builder.PlanListParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.PlanListParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.PlanListParams.Builder
setActive(java.lang.Boolean active)
Only return plans that are active or inactive (e.g., passfalse
to list all inactive plans).PlanListParams.Builder
setCreated(PlanListParams.Created created)
A filter on the list, based on the objectcreated
field.PlanListParams.Builder
setCreated(java.lang.Long created)
A filter on the list, based on the objectcreated
field.PlanListParams.Builder
setEndingBefore(java.lang.String endingBefore)
A cursor for use in pagination.PlanListParams.Builder
setLimit(java.lang.Long limit)
A limit on the number of objects to be returned.PlanListParams.Builder
setProduct(java.lang.String product)
Only return plans for the given product.PlanListParams.Builder
setStartingAfter(java.lang.String startingAfter)
A cursor for use in pagination.
-
-
-
Method Detail
-
build
public PlanListParams build()
Finalize and obtain parameter instance from this builder.
-
setActive
public PlanListParams.Builder setActive(java.lang.Boolean active)
Only return plans that are active or inactive (e.g., passfalse
to list all inactive plans).
-
setCreated
public PlanListParams.Builder setCreated(PlanListParams.Created created)
A filter on the list, based on the objectcreated
field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
-
setCreated
public PlanListParams.Builder setCreated(java.lang.Long created)
A filter on the list, based on the objectcreated
field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
-
setEndingBefore
public PlanListParams.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 PlanListParams.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. SeePlanListParams.expand
for the field documentation.
-
addAllExpand
public PlanListParams.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. SeePlanListParams.expand
for the field documentation.
-
putExtraParam
public PlanListParams.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. SeePlanListParams.extraParams
for the field documentation.
-
putAllExtraParam
public PlanListParams.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. SeePlanListParams.extraParams
for the field documentation.
-
setLimit
public PlanListParams.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.
-
setProduct
public PlanListParams.Builder setProduct(java.lang.String product)
Only return plans for the given product.
-
setStartingAfter
public PlanListParams.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.
-
-