com.stripe.param

Class SkuListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SkuListParams

public class SkuListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SkuListParams.Builder

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

Modifier and Type	Method and Description
static SkuListParams.Builder	builder()
java.lang.Boolean	getActive() Only return SKUs that are active or inactive (e.g., pass false to list all inactive products).
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Only return SKUs that have the specified key-value pairs in this partially constructed dictionary.
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.util.List<java.lang.String>	getIds() Only return SKUs with the given IDs.
java.lang.Boolean	getInStock() Only return SKUs that are either in stock or out of stock (e.g., pass false to list all SKUs that are out of stock).
java.lang.Long	getLimit() A limit on the number of objects to be returned.
java.lang.String	getProduct() The ID of the product whose SKUs will be retrieved.
java.lang.String	getStartingAfter() A cursor for use in pagination.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SkuListParams.Builder builder()

getActive

public java.lang.Boolean getActive()

Only return SKUs that are active or inactive (e.g., pass false to list all inactive products).

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if product is also supplied. For instance, if the associated product has attributes ["color", "size"], passing in attributes[color]=red returns all the SKUs for this product that have color set to red.

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 with obj_bar, your subsequent call can include ending_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.

getIds

public java.util.List<java.lang.String> getIds()

Only return SKUs with the given IDs.

getInStock

public java.lang.Boolean getInStock()

Only return SKUs that are either in stock or out of stock (e.g., pass false to list all SKUs that are out of stock). If no value is provided, all SKUs are returned.

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.

getProduct

public java.lang.String getProduct()

The ID of the product whose SKUs will be retrieved. Must be a product with type good.

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 with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.