Safe Haskell | None |
---|---|
Language | Haskell2010 |
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 {}
- mkPostSetupIntentsIntentCancelRequestBody :: PostSetupIntentsIntentCancelRequestBody
- data PostSetupIntentsIntentCancelRequestBodyCancellationReason'
- = PostSetupIntentsIntentCancelRequestBodyCancellationReason'Other Value
- | PostSetupIntentsIntentCancelRequestBodyCancellationReason'Typed Text
- | PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumAbandoned
- | PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumDuplicate
- | PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumRequestedByCustomer
- data PostSetupIntentsIntentCancelResponse
Documentation
postSetupIntentsIntentCancel Source #
:: 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.
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`
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 |
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumDuplicate | Represents the JSON value |
PostSetupIntentsIntentCancelRequestBodyCancellationReason'EnumRequestedByCustomer | Represents the JSON value |
Instances
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.
PostSetupIntentsIntentCancelResponseError String | Means either no matching case available or a parse error |
PostSetupIntentsIntentCancelResponse200 SetupIntent | Successful response. |
PostSetupIntentsIntentCancelResponseDefault Error | Error response. |