Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSetupIntentsIntentCancel

Description

Contains the different functions to run the operation postSetupIntentsIntentCancel

Synopsis

postSetupIntentsIntentCancel :: forall m. MonadHTTP m => Text -> Maybe PostSetupIntentsIntentCancelRequestBody -> ClientT m (Response PostSetupIntentsIntentCancelResponse)
data PostSetupIntentsIntentCancelRequestBody = PostSetupIntentsIntentCancelRequestBody {
- postSetupIntentsIntentCancelRequestBodyCancellationReason :: Maybe PostSetupIntentsIntentCancelRequestBodyCancellationReason'
- postSetupIntentsIntentCancelRequestBodyExpand :: Maybe [Text]
}
mkPostSetupIntentsIntentCancelRequestBody :: PostSetupIntentsIntentCancelRequestBody
data PostSetupIntentsIntentCancelRequestBodyCancellationReason'
data PostSetupIntentsIntentCancelResponse

Documentation

postSetupIntentsIntentCancel Source #

Arguments

:: forall m. MonadHTTP m
=> Text	intent \| Constraints: Maximum length of 5000
-> Maybe PostSetupIntentsIntentCancelRequestBody	The request body to send
-> ClientT m (Response PostSetupIntentsIntentCancelResponse)	Monadic computation which returns 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_confirmation</code>, or <code>requires_action</code>. </p>

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

data PostSetupIntentsIntentCancelRequestBody Source #

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

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 [Text]
expand: Specifies which fields in the response should be expanded.

Instances

Instances details

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] #

mkPostSetupIntentsIntentCancelRequestBody :: PostSetupIntentsIntentCancelRequestBody Source #

Create a new PostSetupIntentsIntentCancelRequestBody with all required fields.

data PostSetupIntentsIntentCancelRequestBodyCancellationReason' Source #

Defines the enum schema located at paths./v1/setup_intents/{intent}/cancel.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.cancellation_reason in the specification.

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

Constructors

PostSetupIntentsIntentCancelRequestBodyCancellationReason'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostSetupIntentsIntentCancelRequestBodyCancellationReason'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumAbandoned	Represents the JSON value `"abandoned"`
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumDuplicate	Represents the JSON value `"duplicate"`
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumRequestedByCustomer	Represents the JSON value `"requested_by_customer"`

Instances

Instances details

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

Instances details

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 #