StripeAPI.Types.Product

Contains the types generated from the schema Product

Documentation

data Product

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

Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Checkout and Subscriptions.

Related guides: Set up a subscription or accept one-time payments with Checkout and more about Products and Prices

Constructors

Product

Fields

• productActive :: Bool

  active: Whether the product is currently available for purchase.

• productCreated :: Int

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

• productDescription :: Maybe Text

  description: The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

  Constraints:

  • Maximum length of 5000
• productId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• productImages :: [Text]

  images: A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

• productLivemode :: Bool

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

• productMetadata :: 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.

• productName :: Text

  name: The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.

  Constraints:

  • Maximum length of 5000
• productPackageDimensions :: Maybe ProductPackageDimensions'

  package_dimensions: The dimensions of this product for shipping purposes.

• productShippable :: Maybe Bool

  shippable: Whether this product is shipped (i.e., physical goods).

• productStatementDescriptor :: Maybe Text

  statement_descriptor: Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.

  Constraints:

  • Maximum length of 5000
• productTaxCode :: Maybe ProductTaxCode'Variants

  tax_code: A tax code ID.

• productUnitLabel :: Maybe Text

  unit_label: A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.

  Constraints:

  • Maximum length of 5000
• productUpdated :: Int

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

• productUrl :: Maybe Text

  url: A URL of a publicly-accessible webpage for this product.

  Constraints:

  • Maximum length of 2048

Instances

Eq Product

Defined in StripeAPI.Types.Product

Methods

(==) :: Product -> Product -> Bool

(/=) :: Product -> Product -> Bool

Show Product

Defined in StripeAPI.Types.Product

Methods

showsPrec :: Int -> Product -> ShowS

show :: Product -> String

showList :: [Product] -> ShowS

ToJSON Product

Defined in StripeAPI.Types.Product

Methods

toJSON :: Product -> Value

toEncoding :: Product -> Encoding

toJSONList :: [Product] -> Value

toEncodingList :: [Product] -> Encoding

FromJSON Product

Defined in StripeAPI.Types.Product

Methods

parseJSON :: Value -> Parser Product

parseJSONList :: Value -> Parser [Product]

mkProduct

Arguments

:: Bool

productActive

-> Int

productCreated

-> Text

productId

-> [Text]

productImages

-> Bool

productLivemode

-> Object

productMetadata

-> Text

productName

-> Int

productUpdated

-> Product

Create a new Product with all required fields.

data ProductPackageDimensions'

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

The dimensions of this product for shipping purposes.

Constructors

ProductPackageDimensions'

Fields

• productPackageDimensions'Height :: Maybe Double

  height: Height, in inches.

• productPackageDimensions'Length :: Maybe Double

  length: Length, in inches.

• productPackageDimensions'Weight :: Maybe Double

  weight: Weight, in ounces.

• productPackageDimensions'Width :: Maybe Double

  width: Width, in inches.

Instances

Eq ProductPackageDimensions'

Defined in StripeAPI.Types.Product

Methods

(==) :: ProductPackageDimensions' -> ProductPackageDimensions' -> Bool

(/=) :: ProductPackageDimensions' -> ProductPackageDimensions' -> Bool

Show ProductPackageDimensions'

Defined in StripeAPI.Types.Product

Methods

showsPrec :: Int -> ProductPackageDimensions' -> ShowS

show :: ProductPackageDimensions' -> String

showList :: [ProductPackageDimensions'] -> ShowS

ToJSON ProductPackageDimensions'

Defined in StripeAPI.Types.Product

Methods

toJSON :: ProductPackageDimensions' -> Value

toEncoding :: ProductPackageDimensions' -> Encoding

toJSONList :: [ProductPackageDimensions'] -> Value

toEncodingList :: [ProductPackageDimensions'] -> Encoding

FromJSON ProductPackageDimensions'

Defined in StripeAPI.Types.Product

Methods

parseJSON :: Value -> Parser ProductPackageDimensions'

parseJSONList :: Value -> Parser [ProductPackageDimensions']

mkProductPackageDimensions' :: ProductPackageDimensions'

Create a new ProductPackageDimensions' with all required fields.

data ProductTaxCode'Variants

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

A tax code ID.

Constructors

ProductTaxCode'Text Text

ProductTaxCode'TaxCode TaxCode

Instances

Eq ProductTaxCode'Variants

Defined in StripeAPI.Types.Product

Methods

(==) :: ProductTaxCode'Variants -> ProductTaxCode'Variants -> Bool

(/=) :: ProductTaxCode'Variants -> ProductTaxCode'Variants -> Bool

Show ProductTaxCode'Variants

Defined in StripeAPI.Types.Product

Methods

showsPrec :: Int -> ProductTaxCode'Variants -> ShowS

show :: ProductTaxCode'Variants -> String

showList :: [ProductTaxCode'Variants] -> ShowS

ToJSON ProductTaxCode'Variants

Defined in StripeAPI.Types.Product

Methods

toJSON :: ProductTaxCode'Variants -> Value

toEncoding :: ProductTaxCode'Variants -> Encoding

toJSONList :: [ProductTaxCode'Variants] -> Value

toEncodingList :: [ProductTaxCode'Variants] -> Encoding

FromJSON ProductTaxCode'Variants

Defined in StripeAPI.Types.Product

Methods

parseJSON :: Value -> Parser ProductTaxCode'Variants

parseJSONList :: Value -> Parser [ProductTaxCode'Variants]