StripeAPI.Types.Order

Contains the types generated from the schema Order

Documentation

data Order

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.

Constructors

Order

Fields

• orderAmount :: 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 order.

• orderAmountReturned :: Maybe Int

  amount_returned: The total amount that was returned to the customer.

• orderApplication :: Maybe Text

  application: ID of the Connect Application that created the order.

  Constraints:

  • Maximum length of 5000
• orderApplicationFee :: Maybe Int

  application_fee: A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

• orderCharge :: Maybe OrderCharge'Variants

  charge: The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`.

• orderCreated :: Int

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

• orderCurrency :: Text

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

• orderCustomer :: Maybe OrderCustomer'Variants

  customer: The customer used for the order.

• orderEmail :: Maybe Text

  email: The email address of the customer placing the order.

  Constraints:

  • Maximum length of 5000
• orderExternalCouponCode :: Maybe Text

  external_coupon_code: External coupon code to load for this order.

  Constraints:

  • Maximum length of 5000
• orderId :: Text

  id: Unique identifier for the object.

  Constraints:

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

  items: List of items constituting the order. An order can have up to 25 items.

• orderLivemode :: Bool

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

• orderMetadata :: Maybe 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.

• orderReturns :: Maybe OrderReturns'

  returns: A list of returns that have taken place for this order.

• orderSelectedShippingMethod :: Maybe Text

  selected_shipping_method: The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method.

  Constraints:

  • Maximum length of 5000
• orderShipping :: Maybe OrderShipping'

  shipping: The shipping address for the order. Present if the order is for goods to be shipped.

• orderShippingMethods :: Maybe [ShippingMethod]

  shipping_methods: A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it.

• orderStatus :: Text

  status: Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the Orders Guide.

  Constraints:

  • Maximum length of 5000
• orderStatusTransitions :: Maybe OrderStatusTransitions'

  status_transitions: The timestamps at which the order status was updated.

• orderUpdated :: Maybe Int

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

• orderUpstreamId :: Maybe Text

  upstream_id: The user's order ID if it is different from the Stripe order ID.

  Constraints:

  • Maximum length of 5000

Instances

Eq Order

Defined in StripeAPI.Types.Order

Methods

(==) :: Order -> Order -> Bool

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

Show Order

Defined in StripeAPI.Types.Order

Methods

showsPrec :: Int -> Order -> ShowS

show :: Order -> String

showList :: [Order] -> ShowS

ToJSON Order

Defined in StripeAPI.Types.Order

Methods

toJSON :: Order -> Value

toEncoding :: Order -> Encoding

toJSONList :: [Order] -> Value

toEncodingList :: [Order] -> Encoding

FromJSON Order

Defined in StripeAPI.Types.Order

Methods

parseJSON :: Value -> Parser Order

parseJSONList :: Value -> Parser [Order]

mkOrder

Arguments

:: Int

orderAmount

-> Int

orderCreated

-> Text

orderCurrency

-> Text

orderId

-> [OrderItem]

orderItems

-> Bool

orderLivemode

-> Text

orderStatus

-> Order

Create a new Order with all required fields.

data OrderCharge'Variants

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

Constructors

OrderCharge'Text Text

OrderCharge'Charge Charge

Instances

Eq OrderCharge'Variants

Defined in StripeAPI.Types.Order

Methods

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

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

Show OrderCharge'Variants

Defined in StripeAPI.Types.Order

Methods

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

show :: OrderCharge'Variants -> String

showList :: [OrderCharge'Variants] -> ShowS

ToJSON OrderCharge'Variants

Defined in StripeAPI.Types.Order

Methods

toJSON :: OrderCharge'Variants -> Value

toEncoding :: OrderCharge'Variants -> Encoding

toJSONList :: [OrderCharge'Variants] -> Value

toEncodingList :: [OrderCharge'Variants] -> Encoding

FromJSON OrderCharge'Variants

Defined in StripeAPI.Types.Order

Methods

parseJSON :: Value -> Parser OrderCharge'Variants

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

data OrderCustomer'Variants

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

The customer used for the order.

Constructors

OrderCustomer'Text Text

OrderCustomer'Customer Customer

OrderCustomer'DeletedCustomer DeletedCustomer

Instances

Eq OrderCustomer'Variants

Defined in StripeAPI.Types.Order

Methods

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

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

Show OrderCustomer'Variants

Defined in StripeAPI.Types.Order

Methods

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

show :: OrderCustomer'Variants -> String

showList :: [OrderCustomer'Variants] -> ShowS

ToJSON OrderCustomer'Variants

Defined in StripeAPI.Types.Order

Methods

toJSON :: OrderCustomer'Variants -> Value

toEncoding :: OrderCustomer'Variants -> Encoding

toJSONList :: [OrderCustomer'Variants] -> Value

toEncodingList :: [OrderCustomer'Variants] -> Encoding

FromJSON OrderCustomer'Variants

Defined in StripeAPI.Types.Order

Methods

parseJSON :: Value -> Parser OrderCustomer'Variants

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

data OrderReturns'

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.

Constructors

OrderReturns'

Fields

• orderReturns'Data :: [OrderReturn]

  data: Details about each object.

• orderReturns'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• orderReturns'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq OrderReturns'

Defined in StripeAPI.Types.Order

Methods

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

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

Show OrderReturns'

Defined in StripeAPI.Types.Order

Methods

showsPrec :: Int -> OrderReturns' -> ShowS

show :: OrderReturns' -> String

showList :: [OrderReturns'] -> ShowS

ToJSON OrderReturns'

Defined in StripeAPI.Types.Order

Methods

toJSON :: OrderReturns' -> Value

toEncoding :: OrderReturns' -> Encoding

toJSONList :: [OrderReturns'] -> Value

toEncodingList :: [OrderReturns'] -> Encoding

FromJSON OrderReturns'

Defined in StripeAPI.Types.Order

Methods

parseJSON :: Value -> Parser OrderReturns'

parseJSONList :: Value -> Parser [OrderReturns']

mkOrderReturns'

Arguments

:: [OrderReturn]

orderReturns'Data

-> Bool

orderReturns'HasMore

-> Text

orderReturns'Url

-> OrderReturns'

Create a new OrderReturns' with all required fields.

data OrderShipping'

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.

Constructors

OrderShipping'

Fields

• orderShipping'Address :: Maybe Address

  address:

• orderShipping'Carrier :: Maybe Text

  carrier: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

  Constraints:

  • Maximum length of 5000
• orderShipping'Name :: Maybe Text

  name: Recipient name.

  Constraints:

  • Maximum length of 5000
• orderShipping'Phone :: Maybe Text

  phone: Recipient phone (including extension).

  Constraints:

  • Maximum length of 5000
• orderShipping'TrackingNumber :: Maybe Text

  tracking_number: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

  Constraints:

  • Maximum length of 5000

Instances

Eq OrderShipping'

Defined in StripeAPI.Types.Order

Methods

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

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

Show OrderShipping'

Defined in StripeAPI.Types.Order

Methods

showsPrec :: Int -> OrderShipping' -> ShowS

show :: OrderShipping' -> String

showList :: [OrderShipping'] -> ShowS

ToJSON OrderShipping'

Defined in StripeAPI.Types.Order

Methods

toJSON :: OrderShipping' -> Value

toEncoding :: OrderShipping' -> Encoding

toJSONList :: [OrderShipping'] -> Value

toEncodingList :: [OrderShipping'] -> Encoding

FromJSON OrderShipping'

Defined in StripeAPI.Types.Order

Methods

parseJSON :: Value -> Parser OrderShipping'

parseJSONList :: Value -> Parser [OrderShipping']

mkOrderShipping' :: OrderShipping'

Create a new OrderShipping' with all required fields.

data OrderStatusTransitions'

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.

Constructors

OrderStatusTransitions'

Fields

• orderStatusTransitions'Canceled :: Maybe Int

  canceled: The time that the order was canceled.

• orderStatusTransitions'Fulfiled :: Maybe Int

  fulfiled: The time that the order was fulfilled.

• orderStatusTransitions'Paid :: Maybe Int

  paid: The time that the order was paid.

• orderStatusTransitions'Returned :: Maybe Int

  returned: The time that the order was returned.

Instances

Eq OrderStatusTransitions'

Defined in StripeAPI.Types.Order

Methods

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

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

Show OrderStatusTransitions'

Defined in StripeAPI.Types.Order

Methods

showsPrec :: Int -> OrderStatusTransitions' -> ShowS

show :: OrderStatusTransitions' -> String

showList :: [OrderStatusTransitions'] -> ShowS

ToJSON OrderStatusTransitions'

Defined in StripeAPI.Types.Order

Methods

toJSON :: OrderStatusTransitions' -> Value

toEncoding :: OrderStatusTransitions' -> Encoding

toJSONList :: [OrderStatusTransitions'] -> Value

toEncodingList :: [OrderStatusTransitions'] -> Encoding

FromJSON OrderStatusTransitions'

Defined in StripeAPI.Types.Order

Methods

parseJSON :: Value -> Parser OrderStatusTransitions'

parseJSONList :: Value -> Parser [OrderStatusTransitions']

mkOrderStatusTransitions' :: OrderStatusTransitions'

Create a new OrderStatusTransitions' with all required fields.