stripeapi-2.0.1.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.OrderItem

Description

Contains the types generated from the schema OrderItem

Synopsis

Documentation

data OrderItem Source #

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

A representation of the constituent items of any given order. Can be used to represent SKUs, shipping costs, or taxes owed on the order.

Related guide: Orders.

Constructors

OrderItem 

Fields

  • orderItemAmount :: Int

    amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item.

  • orderItemCurrency :: Text

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

  • orderItemDescription :: Text

    description: Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`).

    Constraints:

    • Maximum length of 5000
  • orderItemParent :: Maybe OrderItemParent'Variants

    parent: The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).

  • orderItemQuantity :: Maybe Int

    quantity: A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`.

  • orderItemType :: Text

    type: The type of line item. One of `sku`, `tax`, `shipping`, or `discount`.

    Constraints:

    • Maximum length of 5000

data OrderItemParent'Variants Source #

Defines the oneOf schema located at components.schemas.order_item.properties.parent.anyOf in the specification.

The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).