Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostOrders

Description

Contains the different functions to run the operation postOrders

Synopsis

postOrders :: forall m. MonadHTTP m => PostOrdersRequestBody -> ClientT m (Response PostOrdersResponse)
data PostOrdersRequestBody = PostOrdersRequestBody {
}
mkPostOrdersRequestBody :: Text -> PostOrdersRequestBody
data PostOrdersRequestBodyItems' = PostOrdersRequestBodyItems' {
}
mkPostOrdersRequestBodyItems' :: PostOrdersRequestBodyItems'
data PostOrdersRequestBodyItems'Type'
data PostOrdersRequestBodyShipping' = PostOrdersRequestBodyShipping' {
}
mkPostOrdersRequestBodyShipping' :: PostOrdersRequestBodyShipping'Address' -> Text -> PostOrdersRequestBodyShipping'
data PostOrdersRequestBodyShipping'Address' = PostOrdersRequestBodyShipping'Address' {
}
mkPostOrdersRequestBodyShipping'Address' :: Text -> PostOrdersRequestBodyShipping'Address'
data PostOrdersResponse

Documentation

postOrders Source #

Arguments

:: forall m. MonadHTTP m
=> PostOrdersRequestBody	The request body to send
-> ClientT m (Response PostOrdersResponse)	Monadic computation which returns the result of the operation

POST /v1/orders

<p>Creates a new order object.</p>

data PostOrdersRequestBody Source #

Defines the object schema located at paths./v1/orders.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostOrdersRequestBody

Fields

postOrdersRequestBodyCoupon :: Maybe Text
coupon: A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons.
Constraints:
- Maximum length of 5000
postOrdersRequestBodyCurrency :: Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
postOrdersRequestBodyCustomer :: Maybe Text
customer: The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object.
Constraints:
- Maximum length of 5000
postOrdersRequestBodyEmail :: Maybe Text
email: The email address of the customer placing the order.
Constraints:
- Maximum length of 5000
postOrdersRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postOrdersRequestBodyItems :: Maybe [PostOrdersRequestBodyItems']
items: List of items constituting the order. An order can have up to 25 items.
postOrdersRequestBodyMetadata :: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
postOrdersRequestBodyShipping :: Maybe PostOrdersRequestBodyShipping'
shipping: Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.

Instances

Instances details

Eq PostOrdersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods (==) :: PostOrdersRequestBody -> PostOrdersRequestBody -> Bool # (/=) :: PostOrdersRequestBody -> PostOrdersRequestBody -> Bool #
Show PostOrdersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods showsPrec :: Int -> PostOrdersRequestBody -> ShowS # show :: PostOrdersRequestBody -> String # showList :: [PostOrdersRequestBody] -> ShowS #
ToJSON PostOrdersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods toJSON :: PostOrdersRequestBody -> Value # toEncoding :: PostOrdersRequestBody -> Encoding # toJSONList :: [PostOrdersRequestBody] -> Value # toEncodingList :: [PostOrdersRequestBody] -> Encoding #
FromJSON PostOrdersRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods parseJSON :: Value -> Parser PostOrdersRequestBody # parseJSONList :: Value -> Parser [PostOrdersRequestBody] #

mkPostOrdersRequestBody Source #

Arguments

:: Text	`postOrdersRequestBodyCurrency`
-> PostOrdersRequestBody

Create a new PostOrdersRequestBody with all required fields.

data PostOrdersRequestBodyItems' Source #

Defines the object schema located at paths./v1/orders.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items in the specification.

Constructors

PostOrdersRequestBodyItems'

Fields

postOrdersRequestBodyItems'Amount :: Maybe Int
amount
postOrdersRequestBodyItems'Currency :: Maybe Text
currency
postOrdersRequestBodyItems'Description :: Maybe Text
description
Constraints:
- Maximum length of 1000
postOrdersRequestBodyItems'Parent :: Maybe Text
parent
Constraints:
- Maximum length of 5000
postOrdersRequestBodyItems'Quantity :: Maybe Int
quantity
postOrdersRequestBodyItems'Type :: Maybe PostOrdersRequestBodyItems'Type'
type
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq PostOrdersRequestBodyItems' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods (==) :: PostOrdersRequestBodyItems' -> PostOrdersRequestBodyItems' -> Bool # (/=) :: PostOrdersRequestBodyItems' -> PostOrdersRequestBodyItems' -> Bool #
Show PostOrdersRequestBodyItems' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods showsPrec :: Int -> PostOrdersRequestBodyItems' -> ShowS # show :: PostOrdersRequestBodyItems' -> String # showList :: [PostOrdersRequestBodyItems'] -> ShowS #
ToJSON PostOrdersRequestBodyItems' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods toJSON :: PostOrdersRequestBodyItems' -> Value # toEncoding :: PostOrdersRequestBodyItems' -> Encoding # toJSONList :: [PostOrdersRequestBodyItems'] -> Value # toEncodingList :: [PostOrdersRequestBodyItems'] -> Encoding #
FromJSON PostOrdersRequestBodyItems' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods parseJSON :: Value -> Parser PostOrdersRequestBodyItems' # parseJSONList :: Value -> Parser [PostOrdersRequestBodyItems'] #

mkPostOrdersRequestBodyItems' :: PostOrdersRequestBodyItems' Source #

Create a new PostOrdersRequestBodyItems' with all required fields.

data PostOrdersRequestBodyItems'Type' Source #

Defines the enum schema located at paths./v1/orders.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.type in the specification.

Constructors

PostOrdersRequestBodyItems'Type'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostOrdersRequestBodyItems'Type'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostOrdersRequestBodyItems'Type'EnumDiscount	Represents the JSON value `"discount"`
PostOrdersRequestBodyItems'Type'EnumShipping	Represents the JSON value `"shipping"`
PostOrdersRequestBodyItems'Type'EnumSku	Represents the JSON value `"sku"`
PostOrdersRequestBodyItems'Type'EnumTax	Represents the JSON value `"tax"`

Instances

Instances details

Eq PostOrdersRequestBodyItems'Type' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods (==) :: PostOrdersRequestBodyItems'Type' -> PostOrdersRequestBodyItems'Type' -> Bool # (/=) :: PostOrdersRequestBodyItems'Type' -> PostOrdersRequestBodyItems'Type' -> Bool #
Show PostOrdersRequestBodyItems'Type' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods showsPrec :: Int -> PostOrdersRequestBodyItems'Type' -> ShowS # show :: PostOrdersRequestBodyItems'Type' -> String # showList :: [PostOrdersRequestBodyItems'Type'] -> ShowS #
ToJSON PostOrdersRequestBodyItems'Type' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods toJSON :: PostOrdersRequestBodyItems'Type' -> Value # toEncoding :: PostOrdersRequestBodyItems'Type' -> Encoding # toJSONList :: [PostOrdersRequestBodyItems'Type'] -> Value # toEncodingList :: [PostOrdersRequestBodyItems'Type'] -> Encoding #
FromJSON PostOrdersRequestBodyItems'Type' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods parseJSON :: Value -> Parser PostOrdersRequestBodyItems'Type' # parseJSONList :: Value -> Parser [PostOrdersRequestBodyItems'Type'] #

data PostOrdersRequestBodyShipping' Source #

Defines the object schema located at paths./v1/orders.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping in the specification.

Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.

Constructors

PostOrdersRequestBodyShipping'
Fields postOrdersRequestBodyShipping'Address :: PostOrdersRequestBodyShipping'Address' address postOrdersRequestBodyShipping'Name :: Text name Constraints: Maximum length of 5000 postOrdersRequestBodyShipping'Phone :: Maybe Text phone Constraints: Maximum length of 5000

Instances

Instances details

Eq PostOrdersRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods (==) :: PostOrdersRequestBodyShipping' -> PostOrdersRequestBodyShipping' -> Bool # (/=) :: PostOrdersRequestBodyShipping' -> PostOrdersRequestBodyShipping' -> Bool #
Show PostOrdersRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods showsPrec :: Int -> PostOrdersRequestBodyShipping' -> ShowS # show :: PostOrdersRequestBodyShipping' -> String # showList :: [PostOrdersRequestBodyShipping'] -> ShowS #
ToJSON PostOrdersRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods toJSON :: PostOrdersRequestBodyShipping' -> Value # toEncoding :: PostOrdersRequestBodyShipping' -> Encoding # toJSONList :: [PostOrdersRequestBodyShipping'] -> Value # toEncodingList :: [PostOrdersRequestBodyShipping'] -> Encoding #
FromJSON PostOrdersRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods parseJSON :: Value -> Parser PostOrdersRequestBodyShipping' # parseJSONList :: Value -> Parser [PostOrdersRequestBodyShipping'] #

mkPostOrdersRequestBodyShipping' Source #

Arguments

:: PostOrdersRequestBodyShipping'Address'	`postOrdersRequestBodyShipping'Address`
-> Text	`postOrdersRequestBodyShipping'Name`
-> PostOrdersRequestBodyShipping'

Create a new PostOrdersRequestBodyShipping' with all required fields.

data PostOrdersRequestBodyShipping'Address' Source #

Defines the object schema located at paths./v1/orders.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping.properties.address in the specification.

Constructors

PostOrdersRequestBodyShipping'Address'

Fields

postOrdersRequestBodyShipping'Address'City :: Maybe Text
city
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'Country :: Maybe Text
country
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'Line1 :: Text
line1
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'Line2 :: Maybe Text
line2
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'PostalCode :: Maybe Text
postal_code
Constraints:
- Maximum length of 5000
postOrdersRequestBodyShipping'Address'State :: Maybe Text
state
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq PostOrdersRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods (==) :: PostOrdersRequestBodyShipping'Address' -> PostOrdersRequestBodyShipping'Address' -> Bool # (/=) :: PostOrdersRequestBodyShipping'Address' -> PostOrdersRequestBodyShipping'Address' -> Bool #
Show PostOrdersRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods showsPrec :: Int -> PostOrdersRequestBodyShipping'Address' -> ShowS # show :: PostOrdersRequestBodyShipping'Address' -> String # showList :: [PostOrdersRequestBodyShipping'Address'] -> ShowS #
ToJSON PostOrdersRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods toJSON :: PostOrdersRequestBodyShipping'Address' -> Value # toEncoding :: PostOrdersRequestBodyShipping'Address' -> Encoding # toJSONList :: [PostOrdersRequestBodyShipping'Address'] -> Value # toEncodingList :: [PostOrdersRequestBodyShipping'Address'] -> Encoding #
FromJSON PostOrdersRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods parseJSON :: Value -> Parser PostOrdersRequestBodyShipping'Address' # parseJSONList :: Value -> Parser [PostOrdersRequestBodyShipping'Address'] #

mkPostOrdersRequestBodyShipping'Address' Source #

Arguments

:: Text	`postOrdersRequestBodyShipping'Address'Line1`
-> PostOrdersRequestBodyShipping'Address'

Create a new PostOrdersRequestBodyShipping'Address' with all required fields.

data PostOrdersResponse Source #

Represents a response of the operation postOrders.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostOrdersResponseError is used.

Constructors

PostOrdersResponseError String	Means either no matching case available or a parse error
PostOrdersResponse200 Order	Successful response.
PostOrdersResponseDefault Error	Error response.

Instances

Instances details

Eq PostOrdersResponse Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods (==) :: PostOrdersResponse -> PostOrdersResponse -> Bool # (/=) :: PostOrdersResponse -> PostOrdersResponse -> Bool #
Show PostOrdersResponse Source #
Instance details Defined in StripeAPI.Operations.PostOrders Methods showsPrec :: Int -> PostOrdersResponse -> ShowS # show :: PostOrdersResponse -> String # showList :: [PostOrdersResponse] -> ShowS #