StripeAPI.Operations.GetOrdersId

Contains the different functions to run the operation getOrdersId

Documentation

getOrdersId

Arguments

:: forall m. MonadHTTP m

=> GetOrdersIdParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetOrdersIdResponse)

Monadic computation which returns the result of the operation

GET /v1/orders/{id}

<p>Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.</p>

data GetOrdersIdParameters

Defines the object schema located at paths./v1/orders/{id}.GET.parameters in the specification.

Constructors

GetOrdersIdParameters

Fields

• getOrdersIdParametersPathId :: Text

  pathId: Represents the parameter named 'id'

  Constraints:

  • Maximum length of 5000
• getOrdersIdParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

Instances

Eq GetOrdersIdParameters

Defined in StripeAPI.Operations.GetOrdersId

Methods

(==) :: GetOrdersIdParameters -> GetOrdersIdParameters -> Bool

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

Show GetOrdersIdParameters

Defined in StripeAPI.Operations.GetOrdersId

Methods

showsPrec :: Int -> GetOrdersIdParameters -> ShowS

show :: GetOrdersIdParameters -> String

showList :: [GetOrdersIdParameters] -> ShowS

ToJSON GetOrdersIdParameters

Defined in StripeAPI.Operations.GetOrdersId

Methods

toJSON :: GetOrdersIdParameters -> Value

toEncoding :: GetOrdersIdParameters -> Encoding

toJSONList :: [GetOrdersIdParameters] -> Value

toEncodingList :: [GetOrdersIdParameters] -> Encoding

FromJSON GetOrdersIdParameters

Defined in StripeAPI.Operations.GetOrdersId

Methods

parseJSON :: Value -> Parser GetOrdersIdParameters

parseJSONList :: Value -> Parser [GetOrdersIdParameters]

mkGetOrdersIdParameters

Arguments

:: Text

getOrdersIdParametersPathId

-> GetOrdersIdParameters

Create a new GetOrdersIdParameters with all required fields.

data GetOrdersIdResponse

Represents a response of the operation getOrdersId.

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), GetOrdersIdResponseError is used.

Constructors

GetOrdersIdResponseError String

Means either no matching case available or a parse error

GetOrdersIdResponse200 Order

Successful response.

GetOrdersIdResponseDefault Error

Error response.

Instances

Eq GetOrdersIdResponse

Defined in StripeAPI.Operations.GetOrdersId

Methods

(==) :: GetOrdersIdResponse -> GetOrdersIdResponse -> Bool

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

Show GetOrdersIdResponse

Defined in StripeAPI.Operations.GetOrdersId

Methods

showsPrec :: Int -> GetOrdersIdResponse -> ShowS

show :: GetOrdersIdResponse -> String

showList :: [GetOrdersIdResponse] -> ShowS