Package com.stripe.param
Class PriceListParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.PriceListParams
-
public class PriceListParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PriceListParams.Builder
static class
PriceListParams.Created
static class
PriceListParams.Recurring
Maximum value to filter by (inclusive).static class
PriceListParams.Type
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PriceListParams.Builder
builder()
java.lang.Boolean
getActive()
Only return prices that are active or inactive (e.g., passfalse
to list all inactive prices).java.lang.Object
getCreated()
A filter on the list, based on the objectcreated
field.java.lang.String
getCurrency()
Only return prices for the given currency.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.util.List<java.lang.String>
getLookupKeys()
Only return the price with these lookup_keys, if any exist.java.lang.String
getProduct()
Only return prices for the given product.PriceListParams.Recurring
getRecurring()
Only return prices with these recurring fields.java.lang.String
getStartingAfter()
A cursor for use in pagination.PriceListParams.Type
getType()
Only return prices of typerecurring
orone_time
.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static PriceListParams.Builder builder()
-
getActive
public java.lang.Boolean getActive()
Only return prices that are active or inactive (e.g., passfalse
to list all inactive prices).
-
getCreated
public java.lang.Object getCreated()
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.
-
getCurrency
public java.lang.String getCurrency()
Only return prices for the given currency.
-
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 withobj_bar
, your subsequent call can includeending_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.
-
getLookupKeys
public java.util.List<java.lang.String> getLookupKeys()
Only return the price with these lookup_keys, if any exist.
-
getProduct
public java.lang.String getProduct()
Only return prices for the given product.
-
getRecurring
public PriceListParams.Recurring getRecurring()
Only return prices with these recurring fields.
-
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 withobj_foo
, your subsequent call can includestarting_after=obj_foo
in order to fetch the next page of the list.
-
getType
public PriceListParams.Type getType()
Only return prices of typerecurring
orone_time
.
-
-