Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Order

Contains the types generated from the schema Order

12 types
7 values

Packagestripeapi-3.0.0.0
Exports19
LanguageHaskell2010
LicenceMIT
SourceOrder.hs

datadata Order

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

An Order describes a purchase being made by a customer, including the products & quantities being purchased, the order status, the payment information, and the billing/shipping details.

Related guide: Orders overview

Constructors

Order
- orderAmountSubtotal :: Int
  amount_subtotal: Order cost before any discounts or taxes are applied. A positive integer representing the subtotal of the order in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).
- orderAmountTotal :: Int
  amount_total: Total order cost after discounts and taxes are applied. A positive integer representing the cost of the order in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or equivalent in charge currency.
- orderApplication :: Maybe (Nullable OrderApplication'NonNullableVariants)
  application: ID of the Connect application that created the Order, if any.
- orderAutomaticTax :: Maybe OrdersV2ResourceAutomaticTax
  automatic_tax:
- orderBillingDetails :: Maybe (Nullable OrderBillingDetails'NonNullable)
  billing_details: Customer billing details associated with the order.
- orderClientSecret :: Maybe (Nullable Text)
  client_secret: The client secret of this Order. Used for client-side retrieval using a publishable key.
  The client secret can be used to complete a payment for an Order from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
  Refer to our docs for creating and processing an order to learn about how client_secret should be handled.
  Constraints:
  - Maximum length of 5000
- 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 (Nullable OrderCustomer'NonNullableVariants)
  customer: The customer which this orders belongs to.
- orderDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- orderDiscounts :: Maybe (Nullable [OrderDiscounts'NonNullableVariants])
  discounts: The discounts applied to the order. Use `expand[]=discounts` to expand each discount.
- orderId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- orderIpAddress :: Maybe (Nullable Text)
  ip_address: A recent IP address of the purchaser used for tax reporting and tax location inference.
  Constraints:
  - Maximum length of 5000
- orderLineItems :: Maybe OrderLineItems'
  line_items: A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. There is a maximum of 100 line 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 (Nullable 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.
- orderPayment :: OrdersV2ResourcePayment
  payment:
- orderShippingCost :: Maybe (Nullable OrderShippingCost'NonNullable)
  shipping_cost: The details of the customer cost of shipping, including the customer chosen ShippingRate.
- orderShippingDetails :: Maybe (Nullable OrderShippingDetails'NonNullable)
  shipping_details: Customer shipping information associated with the order.
- orderStatus :: OrderStatus'
  status: The overall status of the order.
- orderTaxDetails :: Maybe OrdersV2ResourceTaxDetails
  tax_details:
- orderTotalDetails :: OrdersV2ResourceTotalDetails
  total_details:

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

valuemkOrder

:: Int
orderAmountSubtotal
-> Int
orderAmountTotal
-> Int
orderCreated
-> Text
orderCurrency
-> Text
orderId
-> Bool
orderLivemode
-> OrdersV2ResourcePayment
orderPayment
-> OrderStatus'
orderStatus
-> OrdersV2ResourceTotalDetails
orderTotalDetails
-> Order

Create a new Order with all required fields.

datadata OrderApplication'NonNullableVariants

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

ID of the Connect application that created the Order, if any.

Constructors

OrderApplication'NonNullableText Text
OrderApplication'NonNullableApplication Application

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

datadata OrderBillingDetails'NonNullable

Defines the object schema located at components.schemas.order.properties.billing_details.anyOf in the specification.

Customer billing details associated with the order.

Constructors

OrderBillingDetails'NonNullable
- orderBillingDetails'NonNullableAddress :: Maybe (Nullable OrderBillingDetails'NonNullableAddress'NonNullable)
  address: Billing address for the order.
- orderBillingDetails'NonNullableEmail :: Maybe (Nullable Text)
  email: Email address for the order.
  Constraints:
  - Maximum length of 5000
- orderBillingDetails'NonNullableName :: Maybe (Nullable Text)
  name: Full name for the order.
  Constraints:
  - Maximum length of 5000
- orderBillingDetails'NonNullablePhone :: Maybe (Nullable Text)
  phone: Billing phone number for the order (including extension).
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderBillingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderBillingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderBillingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderBillingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

valuemkOrderBillingDetails'NonNullable :: OrderBillingDetails'NonNullable

Create a new OrderBillingDetails'NonNullable with all required fields.

datadata OrderBillingDetails'NonNullableAddress'NonNullable

Defines the object schema located at components.schemas.order.properties.billing_details.anyOf.properties.address.anyOf in the specification.

Billing address for the order.

Constructors

OrderBillingDetails'NonNullableAddress'NonNullable
- orderBillingDetails'NonNullableAddress'NonNullableCity :: Maybe (Nullable Text)
  city: City, district, suburb, town, or village.
  Constraints:
  - Maximum length of 5000
- orderBillingDetails'NonNullableAddress'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter country code (ISO 3166-1 alpha-2).
  Constraints:
  - Maximum length of 5000
- orderBillingDetails'NonNullableAddress'NonNullableLine1 :: Maybe (Nullable Text)
  line1: Address line 1 (e.g., street, PO Box, or company name).
  Constraints:
  - Maximum length of 5000
- orderBillingDetails'NonNullableAddress'NonNullableLine2 :: Maybe (Nullable Text)
  line2: Address line 2 (e.g., apartment, suite, unit, or building).
  Constraints:
  - Maximum length of 5000
- orderBillingDetails'NonNullableAddress'NonNullablePostalCode :: Maybe (Nullable Text)
  postal_code: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- orderBillingDetails'NonNullableAddress'NonNullableState :: Maybe (Nullable Text)
  state: State, county, province, or region.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderBillingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderBillingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderBillingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderBillingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

valuemkOrderBillingDetails'NonNullableAddress'NonNullable :: OrderBillingDetails'NonNullableAddress'NonNullable

Create a new OrderBillingDetails'NonNullableAddress'NonNullable with all required fields.

datadata OrderCustomer'NonNullableVariants

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

The customer which this orders belongs to.

Constructors

OrderCustomer'NonNullableText Text
OrderCustomer'NonNullableCustomer Customer
OrderCustomer'NonNullableDeletedCustomer DeletedCustomer

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

datadata OrderDiscounts'NonNullableVariants

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

Constructors

OrderDiscounts'NonNullableText Text
OrderDiscounts'NonNullableDiscount Discount

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderDiscounts'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderDiscounts'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderDiscounts'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderDiscounts'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

datadata OrderLineItems'

Defines the object schema located at components.schemas.order.properties.line_items in the specification.

A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. There is a maximum of 100 line items.

Constructors

OrderLineItems'
- orderLineItems'Data :: [Item]
  data: Details about each object.
- orderLineItems'HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- orderLineItems'Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderLineItems'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderLineItems'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderLineItems'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderLineItems'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

valuemkOrderLineItems'

:: [Item]
orderLineItems'Data
-> Bool
orderLineItems'HasMore
-> Text
orderLineItems'Url
-> OrderLineItems'

Create a new OrderLineItems' with all required fields.

datadata OrderShippingCost'NonNullable

Defines the object schema located at components.schemas.order.properties.shipping_cost.anyOf in the specification.

The details of the customer cost of shipping, including the customer chosen ShippingRate.

Constructors

OrderShippingCost'NonNullable
- orderShippingCost'NonNullableAmountSubtotal :: Maybe Int
  amount_subtotal: Total shipping cost before any discounts or taxes are applied.
- orderShippingCost'NonNullableAmountTax :: Maybe Int
  amount_tax: Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
- orderShippingCost'NonNullableAmountTotal :: Maybe Int
  amount_total: Total shipping cost after discounts and taxes are applied.
- orderShippingCost'NonNullableShippingRate :: Maybe (Nullable OrderShippingCost'NonNullableShippingRate'NonNullableVariants)
  shipping_rate: The ID of the ShippingRate for this order.
- orderShippingCost'NonNullableTaxes :: Maybe [LineItemsTaxAmount]
  taxes: The taxes applied to the shipping rate.

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderShippingCost'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderShippingCost'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderShippingCost'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderShippingCost'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

valuemkOrderShippingCost'NonNullable :: OrderShippingCost'NonNullable

Create a new OrderShippingCost'NonNullable with all required fields.

datadata OrderShippingCost'NonNullableShippingRate'NonNullableVariants

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

The ID of the ShippingRate for this order.

Constructors

OrderShippingCost'NonNullableShippingRate'NonNullableText Text
OrderShippingCost'NonNullableShippingRate'NonNullableShippingRate ShippingRate

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderShippingCost'NonNullableShippingRate'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderShippingCost'NonNullableShippingRate'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderShippingCost'NonNullableShippingRate'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderShippingCost'NonNullableShippingRate'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

datadata OrderShippingDetails'NonNullable

Defines the object schema located at components.schemas.order.properties.shipping_details.anyOf in the specification.

Customer shipping information associated with the order.

Constructors

OrderShippingDetails'NonNullable
- orderShippingDetails'NonNullableAddress :: Maybe (Nullable OrderShippingDetails'NonNullableAddress'NonNullable)
  address: Recipient shipping address. Required if the order includes products that are shippable.
- orderShippingDetails'NonNullableName :: Maybe (Nullable Text)
  name: Recipient name.
  Constraints:
  - Maximum length of 5000
- orderShippingDetails'NonNullablePhone :: Maybe (Nullable Text)
  phone: Recipient phone (including extension).
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderShippingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderShippingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderShippingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderShippingDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

valuemkOrderShippingDetails'NonNullable :: OrderShippingDetails'NonNullable

Create a new OrderShippingDetails'NonNullable with all required fields.

datadata OrderShippingDetails'NonNullableAddress'NonNullable

Defines the object schema located at components.schemas.order.properties.shipping_details.anyOf.properties.address.anyOf in the specification.

Recipient shipping address. Required if the order includes products that are shippable.

Constructors

OrderShippingDetails'NonNullableAddress'NonNullable
- orderShippingDetails'NonNullableAddress'NonNullableCity :: Maybe (Nullable Text)
  city: City, district, suburb, town, or village.
  Constraints:
  - Maximum length of 5000
- orderShippingDetails'NonNullableAddress'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter country code (ISO 3166-1 alpha-2).
  Constraints:
  - Maximum length of 5000
- orderShippingDetails'NonNullableAddress'NonNullableLine1 :: Maybe (Nullable Text)
  line1: Address line 1 (e.g., street, PO Box, or company name).
  Constraints:
  - Maximum length of 5000
- orderShippingDetails'NonNullableAddress'NonNullableLine2 :: Maybe (Nullable Text)
  line2: Address line 2 (e.g., apartment, suite, unit, or building).
  Constraints:
  - Maximum length of 5000
- orderShippingDetails'NonNullableAddress'NonNullablePostalCode :: Maybe (Nullable Text)
  postal_code: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- orderShippingDetails'NonNullableAddress'NonNullableState :: Maybe (Nullable Text)
  state: State, county, province, or region.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderShippingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderShippingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderShippingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderShippingDetails'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Order

valuemkOrderShippingDetails'NonNullableAddress'NonNullable :: OrderShippingDetails'NonNullableAddress'NonNullable

Create a new OrderShippingDetails'NonNullableAddress'NonNullable with all required fields.

datadata OrderStatus'

Defines the enum schema located at components.schemas.order.properties.status in the specification.

The overall status of the order.

Constructors

OrderStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
OrderStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
OrderStatus'EnumCanceled
Represents the JSON value "canceled"
OrderStatus'EnumComplete
Represents the JSON value "complete"
OrderStatus'EnumOpen
Represents the JSON value "open"
OrderStatus'EnumProcessing
Represents the JSON value "processing"
OrderStatus'EnumSubmitted
Represents the JSON value "submitted"

Instances4Eq, Show, FromJSON, ToJSON

Eq OrderStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
Show OrderStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
FromJSON OrderStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order
ToJSON OrderStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Order