Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSetupIntentsIntentCancel

Description

Contains the different functions to run the operation postSetupIntentsIntentCancel

Synopsis

postSetupIntentsIntentCancel :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSetupIntentsIntentCancelRequestBody -> m (Either HttpException (Response PostSetupIntentsIntentCancelResponse))
postSetupIntentsIntentCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSetupIntentsIntentCancelRequestBody -> m (Either HttpException (Response ByteString))
postSetupIntentsIntentCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSetupIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSetupIntentsIntentCancelResponse))
postSetupIntentsIntentCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSetupIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostSetupIntentsIntentCancelRequestBody = PostSetupIntentsIntentCancelRequestBody {
- postSetupIntentsIntentCancelRequestBodyCancellationReason :: Maybe PostSetupIntentsIntentCancelRequestBodyCancellationReason'
- postSetupIntentsIntentCancelRequestBodyExpand :: Maybe ([] String)
}
data PostSetupIntentsIntentCancelRequestBodyCancellationReason'
data PostSetupIntentsIntentCancelResponse

Documentation

postSetupIntentsIntentCancel Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> String	intent \| Constraints: Maximum length of 5000
-> PostSetupIntentsIntentCancelRequestBody	The request body to send
-> m (Either HttpException (Response PostSetupIntentsIntentCancelResponse))	Monad containing the result of the operation

POST /v1/setup_intents/{intent}/cancel

<p>A SetupIntent object can be canceled when it is in one of these statuses: <code>requires_payment_method</code>, <code>requires_capture</code>, <code>requires_confirmation</code>, <code>requires_action</code>. </p>

<p>Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.</p>

postSetupIntentsIntentCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSetupIntentsIntentCancelRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/setup_intents/{intent}/cancel

The same as postSetupIntentsIntentCancel but returns the raw ByteString

postSetupIntentsIntentCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSetupIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSetupIntentsIntentCancelResponse)) Source #

POST /v1/setup_intents/{intent}/cancel

Monadic version of postSetupIntentsIntentCancel (use with runWithConfiguration)

postSetupIntentsIntentCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSetupIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/setup_intents/{intent}/cancel

Monadic version of postSetupIntentsIntentCancelRaw (use with runWithConfiguration)

data PostSetupIntentsIntentCancelRequestBody Source #

Defines the data type for the schema postSetupIntentsIntentCancelRequestBody

Constructors

PostSetupIntentsIntentCancelRequestBody

Fields

postSetupIntentsIntentCancelRequestBodyCancellationReason :: Maybe PostSetupIntentsIntentCancelRequestBodyCancellationReason'
cancellation_reason: Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate`
Constraints:
- Maximum length of 5000
postSetupIntentsIntentCancelRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.

Instances

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

data PostSetupIntentsIntentCancelRequestBodyCancellationReason' Source #

Defines the enum schema postSetupIntentsIntentCancelRequestBodyCancellation_reason'

Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate`

Constructors

PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumOther Value
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumTyped String
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumStringAbandoned
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumStringDuplicate
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumStringRequestedByCustomer

Instances

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

data PostSetupIntentsIntentCancelResponse Source #

Represents a response of the operation postSetupIntentsIntentCancel.

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

Constructors

PostSetupIntentsIntentCancelResponseError String	Means either no matching case available or a parse error
PostSetupIntentsIntentCancelResponse200 SetupIntent	Successful response.
PostSetupIntentsIntentCancelResponseDefault Error	Error response.

Instances

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