Package com.stripe.param
Class SkuListParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.SkuListParams
-
Nested Class Summary
Nested ClassesNested 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 TypeMethodDescriptionstatic SkuListParams.Builderbuilder()Only return SKUs that are active or inactive (e.g., passfalseto list all inactive products).Only return SKUs that have the specified key-value pairs in this partially constructed dictionary.A cursor for use in pagination.Specifies which fields in the response should be expanded.Map of extra parameters for custom features not available in this client library.getIds()Only return SKUs with the given IDs.Only return SKUs that are either in stock or out of stock (e.g., passfalseto list all SKUs that are out of stock).getLimit()A limit on the number of objects to be returned.The ID of the product whose SKUs will be retrieved.A cursor for use in pagination.Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
Method Details
-
builder
-
getActive
Only return SKUs that are active or inactive (e.g., passfalseto list all inactive products). -
getAttributes
Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only ifproductis also supplied. For instance, if the associated product has attributes["color", "size"], passing inattributes[color]=redreturns all the SKUs for this product that havecolorset tored. -
getEndingBefore
A cursor for use in pagination.ending_beforeis 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_barin order to fetch the previous page of the list. -
getExpand
Specifies which fields in the response should be expanded. -
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@SerializedNamevalue. 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. -
getIds
Only return SKUs with the given IDs. -
getInStock
Only return SKUs that are either in stock or out of stock (e.g., passfalseto list all SKUs that are out of stock). If no value is provided, all SKUs are returned. -
getLimit
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. -
getProduct
The ID of the product whose SKUs will be retrieved. Must be a product with typegood. -
getStartingAfter
A cursor for use in pagination.starting_afteris 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_fooin order to fetch the next page of the list.
-