Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the types generated from the schema Order
Synopsis
- data Order = Order {
- orderAmount :: Int
- orderAmountReturned :: Maybe Int
- orderApplication :: Maybe Text
- orderApplicationFee :: Maybe Int
- orderCharge :: Maybe OrderCharge'Variants
- orderCreated :: Int
- orderCurrency :: Text
- orderCustomer :: Maybe OrderCustomer'Variants
- orderEmail :: Maybe Text
- orderExternalCouponCode :: Maybe Text
- orderId :: Text
- orderItems :: [OrderItem]
- orderLivemode :: Bool
- orderMetadata :: Maybe Object
- orderReturns :: Maybe OrderReturns'
- orderSelectedShippingMethod :: Maybe Text
- orderShipping :: Maybe OrderShipping'
- orderShippingMethods :: Maybe [ShippingMethod]
- orderStatus :: Text
- orderStatusTransitions :: Maybe OrderStatusTransitions'
- orderUpdated :: Maybe Int
- orderUpstreamId :: Maybe Text
- mkOrder :: Int -> Int -> Text -> Text -> [OrderItem] -> Bool -> Text -> Order
- data OrderCharge'Variants
- data OrderCustomer'Variants
- data OrderReturns' = OrderReturns' {}
- mkOrderReturns' :: [OrderReturn] -> Bool -> Text -> OrderReturns'
- data OrderShipping' = OrderShipping' {}
- mkOrderShipping' :: OrderShipping'
- data OrderStatusTransitions' = OrderStatusTransitions' {}
- mkOrderStatusTransitions' :: OrderStatusTransitions'
Documentation
Defines the object schema located at components.schemas.order
in the specification.
Order objects are created to handle end customers' purchases of previously defined products. You can create, retrieve, and pay individual orders, as well as list all orders. Orders are identified by a unique, random ID.
Related guide: Tax, Shipping, and Inventory.
Order | |
|
Create a new Order
with all required fields.
data OrderCharge'Variants Source #
Defines the oneOf schema located at components.schemas.order.properties.charge.anyOf
in the specification.
The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`.
Instances
Eq OrderCharge'Variants Source # | |
Defined in StripeAPI.Types.Order (==) :: OrderCharge'Variants -> OrderCharge'Variants -> Bool # (/=) :: OrderCharge'Variants -> OrderCharge'Variants -> Bool # | |
Show OrderCharge'Variants Source # | |
Defined in StripeAPI.Types.Order showsPrec :: Int -> OrderCharge'Variants -> ShowS # show :: OrderCharge'Variants -> String # showList :: [OrderCharge'Variants] -> ShowS # | |
ToJSON OrderCharge'Variants Source # | |
Defined in StripeAPI.Types.Order toJSON :: OrderCharge'Variants -> Value # toEncoding :: OrderCharge'Variants -> Encoding # toJSONList :: [OrderCharge'Variants] -> Value # toEncodingList :: [OrderCharge'Variants] -> Encoding # | |
FromJSON OrderCharge'Variants Source # | |
Defined in StripeAPI.Types.Order parseJSON :: Value -> Parser OrderCharge'Variants # parseJSONList :: Value -> Parser [OrderCharge'Variants] # |
data OrderCustomer'Variants Source #
Defines the oneOf schema located at components.schemas.order.properties.customer.anyOf
in the specification.
The customer used for the order.
OrderCustomer'Text Text | |
OrderCustomer'Customer Customer | |
OrderCustomer'DeletedCustomer DeletedCustomer |
Instances
Eq OrderCustomer'Variants Source # | |
Defined in StripeAPI.Types.Order | |
Show OrderCustomer'Variants Source # | |
Defined in StripeAPI.Types.Order showsPrec :: Int -> OrderCustomer'Variants -> ShowS # show :: OrderCustomer'Variants -> String # showList :: [OrderCustomer'Variants] -> ShowS # | |
ToJSON OrderCustomer'Variants Source # | |
Defined in StripeAPI.Types.Order toJSON :: OrderCustomer'Variants -> Value # toEncoding :: OrderCustomer'Variants -> Encoding # toJSONList :: [OrderCustomer'Variants] -> Value # | |
FromJSON OrderCustomer'Variants Source # | |
Defined in StripeAPI.Types.Order |
data OrderReturns' Source #
Defines the object schema located at components.schemas.order.properties.returns
in the specification.
A list of returns that have taken place for this order.
OrderReturns' | |
|
Instances
Eq OrderReturns' Source # | |
Defined in StripeAPI.Types.Order (==) :: OrderReturns' -> OrderReturns' -> Bool # (/=) :: OrderReturns' -> OrderReturns' -> Bool # | |
Show OrderReturns' Source # | |
Defined in StripeAPI.Types.Order showsPrec :: Int -> OrderReturns' -> ShowS # show :: OrderReturns' -> String # showList :: [OrderReturns'] -> ShowS # | |
ToJSON OrderReturns' Source # | |
Defined in StripeAPI.Types.Order toJSON :: OrderReturns' -> Value # toEncoding :: OrderReturns' -> Encoding # toJSONList :: [OrderReturns'] -> Value # toEncodingList :: [OrderReturns'] -> Encoding # | |
FromJSON OrderReturns' Source # | |
Defined in StripeAPI.Types.Order parseJSON :: Value -> Parser OrderReturns' # parseJSONList :: Value -> Parser [OrderReturns'] # |
Create a new OrderReturns'
with all required fields.
data OrderShipping' Source #
Defines the object schema located at components.schemas.order.properties.shipping.anyOf
in the specification.
The shipping address for the order. Present if the order is for goods to be shipped.
OrderShipping' | |
|
Instances
Eq OrderShipping' Source # | |
Defined in StripeAPI.Types.Order (==) :: OrderShipping' -> OrderShipping' -> Bool # (/=) :: OrderShipping' -> OrderShipping' -> Bool # | |
Show OrderShipping' Source # | |
Defined in StripeAPI.Types.Order showsPrec :: Int -> OrderShipping' -> ShowS # show :: OrderShipping' -> String # showList :: [OrderShipping'] -> ShowS # | |
ToJSON OrderShipping' Source # | |
Defined in StripeAPI.Types.Order toJSON :: OrderShipping' -> Value # toEncoding :: OrderShipping' -> Encoding # toJSONList :: [OrderShipping'] -> Value # toEncodingList :: [OrderShipping'] -> Encoding # | |
FromJSON OrderShipping' Source # | |
Defined in StripeAPI.Types.Order parseJSON :: Value -> Parser OrderShipping' # parseJSONList :: Value -> Parser [OrderShipping'] # |
mkOrderShipping' :: OrderShipping' Source #
Create a new OrderShipping'
with all required fields.
data OrderStatusTransitions' Source #
Defines the object schema located at components.schemas.order.properties.status_transitions.anyOf
in the specification.
The timestamps at which the order status was updated.
OrderStatusTransitions' | |
|
Instances
Eq OrderStatusTransitions' Source # | |
Defined in StripeAPI.Types.Order | |
Show OrderStatusTransitions' Source # | |
Defined in StripeAPI.Types.Order showsPrec :: Int -> OrderStatusTransitions' -> ShowS # show :: OrderStatusTransitions' -> String # showList :: [OrderStatusTransitions'] -> ShowS # | |
ToJSON OrderStatusTransitions' Source # | |
Defined in StripeAPI.Types.Order | |
FromJSON OrderStatusTransitions' Source # | |
Defined in StripeAPI.Types.Order |
mkOrderStatusTransitions' :: OrderStatusTransitions' Source #
Create a new OrderStatusTransitions'
with all required fields.