com.stripe.param

Class SkuCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SkuCreateParams

public class SkuCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SkuCreateParams.Builder
static class	SkuCreateParams.Inventory
static class	SkuCreateParams.PackageDimensions

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 SkuCreateParams.Builder	builder()
java.lang.Boolean	getActive() Whether the SKU is available for purchase.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() A dictionary of attributes and values for the attributes defined by the product.
java.lang.String	getCurrency() Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
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.String	getId() The identifier for the SKU.
java.lang.String	getImage() The URL of an image for this SKU, meant to be displayable to the customer.
SkuCreateParams.Inventory	getInventory() Description of the SKU's inventory.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() A set of key-value pairs that you can attach to a SKU object.
SkuCreateParams.PackageDimensions	getPackageDimensions() The dimensions of this SKU for shipping purposes.
java.lang.Long	getPrice() The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
java.lang.String	getProduct() The ID of the product this SKU is associated with.

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 SkuCreateParams.Builder builder()

getActive

public java.lang.Boolean getActive()

Whether the SKU is available for purchase. Default to `true`.

getAttributes

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

A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`.

getCurrency

public java.lang.String getCurrency()

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

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.

getId

public java.lang.String getId()

The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.

getImage

public java.lang.String getImage()

The URL of an image for this SKU, meant to be displayable to the customer.

getInventory

public SkuCreateParams.Inventory getInventory()

Description of the SKU's inventory.

getMetadata

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

A set of key-value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.

getPackageDimensions

public SkuCreateParams.PackageDimensions getPackageDimensions()

The dimensions of this SKU for shipping purposes.

getPrice

public java.lang.Long getPrice()

The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).

getProduct

public java.lang.String getProduct()

The ID of the product this SKU is associated with. Must be a product with type `good`.