stripeapi-2.0.1.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.Sku

Description

Contains the types generated from the schema Sku

Synopsis

Documentation

data Sku Source #

Defines the object schema located at components.schemas.sku in the specification.

Stores representations of stock keeping units. SKUs describe specific product variations, taking into account any combination of: attributes, currency, and cost. For example, a product may be a T-shirt, whereas a specific SKU represents the `size: large`, `color: red` version of that shirt.

Can also be used to manage inventory.

Related guide: Tax, Shipping, and Inventory.

Constructors

Sku 

Fields

  • skuActive :: Bool

    active: Whether the SKU is available for purchase.

  • skuAttributes :: Object

    attributes: 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"}`.

  • skuCreated :: Int

    created: Time at which the object was created. Measured in seconds since the Unix epoch.

  • skuCurrency :: Text

    currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • skuId :: Text

    id: Unique identifier for the object.

    Constraints:

    • Maximum length of 5000
  • skuImage :: Maybe Text

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

    Constraints:

    • Maximum length of 2048
  • skuInventory :: SkuInventory

    inventory:

  • skuLivemode :: Bool

    livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

  • skuMetadata :: Object

    metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • skuPackageDimensions :: Maybe SkuPackageDimensions'

    package_dimensions: The dimensions of this SKU for shipping purposes.

  • skuPrice :: Int

    price: The cost of the item as a positive 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).

  • skuProduct :: SkuProduct'Variants

    product: The ID of the product this SKU is associated with. The product must be currently active.

  • skuUpdated :: Int

    updated: Time at which the object was last updated. Measured in seconds since the Unix epoch.

Instances

Instances details
Eq Sku Source # 
Instance details

Defined in StripeAPI.Types.Sku

Methods

(==) :: Sku -> Sku -> Bool #

(/=) :: Sku -> Sku -> Bool #

Show Sku Source # 
Instance details

Defined in StripeAPI.Types.Sku

Methods

showsPrec :: Int -> Sku -> ShowS #

show :: Sku -> String #

showList :: [Sku] -> ShowS #

ToJSON Sku Source # 
Instance details

Defined in StripeAPI.Types.Sku

FromJSON Sku Source # 
Instance details

Defined in StripeAPI.Types.Sku

data SkuPackageDimensions' Source #

Defines the object schema located at components.schemas.sku.properties.package_dimensions.anyOf in the specification.

The dimensions of this SKU for shipping purposes.

Constructors

SkuPackageDimensions' 

Fields

data SkuProduct'Variants Source #

Defines the oneOf schema located at components.schemas.sku.properties.product.anyOf in the specification.

The ID of the product this SKU is associated with. The product must be currently active.