Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostOrdersIdCancel

Contains the different functions to run the operation postOrdersIdCancel

2 types
2 values

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostOrdersIdCancel.hs

valuepostOrdersIdCancel

:: MonadHTTP m
=> Text
id | Constraints: Maximum length of 5000
-> Maybe PostOrdersIdCancelRequestBody
The request body to send
-> ClientT m (Response PostOrdersIdCancelResponse)
Monadic computation which returns the result of the operation

POST /v1/orders/{id}/cancel

<p>Cancels the order as well as the payment intent if one is attached.</p>

datadata PostOrdersIdCancelRequestBody

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

Constructors

PostOrdersIdCancelRequestBody
- postOrdersIdCancelRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostOrdersIdCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostOrdersIdCancel
Show PostOrdersIdCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostOrdersIdCancel
FromJSON PostOrdersIdCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostOrdersIdCancel
ToJSON PostOrdersIdCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostOrdersIdCancel

valuemkPostOrdersIdCancelRequestBody :: PostOrdersIdCancelRequestBody

Create a new PostOrdersIdCancelRequestBody with all required fields.

datadata PostOrdersIdCancelResponse

Represents a response of the operation postOrdersIdCancel.

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

Constructors

PostOrdersIdCancelResponseError String
Means either no matching case available or a parse error
PostOrdersIdCancelResponse200 Order
Successful response.
PostOrdersIdCancelResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostOrdersIdCancelResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostOrdersIdCancel
Show PostOrdersIdCancelResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostOrdersIdCancel