StripeAPI.Types.OrderItem

Contains the types generated from the schema OrderItem

Documentation

data OrderItem

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

Instances

Eq OrderItem

Defined in StripeAPI.Types.OrderItem

Methods

(==) :: OrderItem -> OrderItem -> Bool

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

Show OrderItem

Defined in StripeAPI.Types.OrderItem

Methods

showsPrec :: Int -> OrderItem -> ShowS

show :: OrderItem -> String

showList :: [OrderItem] -> ShowS

ToJSON OrderItem

Defined in StripeAPI.Types.OrderItem

Methods

toJSON :: OrderItem -> Value

toEncoding :: OrderItem -> Encoding

toJSONList :: [OrderItem] -> Value

toEncodingList :: [OrderItem] -> Encoding

FromJSON OrderItem

Defined in StripeAPI.Types.OrderItem

Methods

parseJSON :: Value -> Parser OrderItem

parseJSONList :: Value -> Parser [OrderItem]

mkOrderItem

Arguments

:: Int

orderItemAmount

-> Text

orderItemCurrency

-> Text

orderItemDescription

-> Text

orderItemType

-> OrderItem

Create a new OrderItem with all required fields.

data OrderItemParent'Variants

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).

Constructors

OrderItemParent'Text Text

OrderItemParent'Sku Sku

Instances

Eq OrderItemParent'Variants

Defined in StripeAPI.Types.OrderItem

Methods

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

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

Show OrderItemParent'Variants

Defined in StripeAPI.Types.OrderItem

Methods

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

show :: OrderItemParent'Variants -> String

showList :: [OrderItemParent'Variants] -> ShowS

ToJSON OrderItemParent'Variants

Defined in StripeAPI.Types.OrderItem

Methods

toJSON :: OrderItemParent'Variants -> Value

toEncoding :: OrderItemParent'Variants -> Encoding

toJSONList :: [OrderItemParent'Variants] -> Value

toEncodingList :: [OrderItemParent'Variants] -> Encoding

FromJSON OrderItemParent'Variants

Defined in StripeAPI.Types.OrderItem

Methods

parseJSON :: Value -> Parser OrderItemParent'Variants

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