StripeAPI.Types.OrderReturn

Contains the types generated from the schema OrderReturn

Documentation

data OrderReturn

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

A return represents the full or partial return of a number of order items. Returns always belong to an order, and may optionally contain a refund.

Related guide: Handling Returns.

Constructors

OrderReturn

Fields

• orderReturnAmount :: 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 returned line item.

• orderReturnCreated :: Int

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

• orderReturnCurrency :: Text

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

• orderReturnId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• orderReturnItems :: [OrderItem]

  items: The items included in this order return.

• orderReturnLivemode :: Bool

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

• orderReturnOrder :: Maybe OrderReturnOrder'Variants

  order: The order that this return includes items from.

• orderReturnRefund :: Maybe OrderReturnRefund'Variants

  refund: The ID of the refund issued for this return.

Instances

Eq OrderReturn

Defined in StripeAPI.Types.OrderReturn

Methods

(==) :: OrderReturn -> OrderReturn -> Bool

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

Show OrderReturn

Defined in StripeAPI.Types.OrderReturn

Methods

showsPrec :: Int -> OrderReturn -> ShowS

show :: OrderReturn -> String

showList :: [OrderReturn] -> ShowS

ToJSON OrderReturn

Defined in StripeAPI.Types.OrderReturn

Methods

toJSON :: OrderReturn -> Value

toEncoding :: OrderReturn -> Encoding

toJSONList :: [OrderReturn] -> Value

toEncodingList :: [OrderReturn] -> Encoding

FromJSON OrderReturn

Defined in StripeAPI.Types.OrderReturn

Methods

parseJSON :: Value -> Parser OrderReturn

parseJSONList :: Value -> Parser [OrderReturn]

mkOrderReturn

Arguments

:: Int

orderReturnAmount

-> Int

orderReturnCreated

-> Text

orderReturnCurrency

-> Text

orderReturnId

-> [OrderItem]

orderReturnItems

-> Bool

orderReturnLivemode

-> OrderReturn

Create a new OrderReturn with all required fields.

data OrderReturnOrder'Variants

Defines the oneOf schema located at components.schemas.order_return.properties.order.anyOf in the specification.

The order that this return includes items from.

Constructors

OrderReturnOrder'Text Text

OrderReturnOrder'Order Order

Instances

Eq OrderReturnOrder'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

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

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

Show OrderReturnOrder'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

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

show :: OrderReturnOrder'Variants -> String

showList :: [OrderReturnOrder'Variants] -> ShowS

ToJSON OrderReturnOrder'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

toJSON :: OrderReturnOrder'Variants -> Value

toEncoding :: OrderReturnOrder'Variants -> Encoding

toJSONList :: [OrderReturnOrder'Variants] -> Value

toEncodingList :: [OrderReturnOrder'Variants] -> Encoding

FromJSON OrderReturnOrder'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

parseJSON :: Value -> Parser OrderReturnOrder'Variants

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

data OrderReturnRefund'Variants

Defines the oneOf schema located at components.schemas.order_return.properties.refund.anyOf in the specification.

The ID of the refund issued for this return.

Constructors

OrderReturnRefund'Text Text

OrderReturnRefund'Refund Refund

Instances

Eq OrderReturnRefund'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

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

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

Show OrderReturnRefund'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

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

show :: OrderReturnRefund'Variants -> String

showList :: [OrderReturnRefund'Variants] -> ShowS

ToJSON OrderReturnRefund'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

toJSON :: OrderReturnRefund'Variants -> Value

toEncoding :: OrderReturnRefund'Variants -> Encoding

toJSONList :: [OrderReturnRefund'Variants] -> Value

toEncodingList :: [OrderReturnRefund'Variants] -> Encoding

FromJSON OrderReturnRefund'Variants

Defined in StripeAPI.Types.OrderReturn

Methods

parseJSON :: Value -> Parser OrderReturnRefund'Variants

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