| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.CancelPurchase
Description
Contains the different functions to run the operation cancelPurchase
Synopsis
- cancelPurchase :: forall m. MonadHTTP m => ClientT m (Response CancelPurchaseResponse)
- data CancelPurchaseResponse
- cancelPurchaseWithConfiguration :: forall m. MonadHTTP m => Configuration -> m (Response CancelPurchaseResponse)
- cancelPurchaseRaw :: forall m. MonadHTTP m => ClientT m (Response ByteString)
- cancelPurchaseWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => ClientT m (Response CancelPurchaseResponse) | Monadic computation which returns the result of the operation |
POST /purchases/{transaction_id}/cancel/A purchase is a hybrid checkout containing at least one or more subscriptions or one-time charges (adjustments) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction. A purchase is only a request data type and is not persistent in Recurly and an invoice collection will be the returned type.
Cancel an open Authorization request
data CancelPurchaseResponse Source #
Represents a response of the operation cancelPurchase.
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), CancelPurchaseResponseError is used.
Constructors
| CancelPurchaseResponseError String | Means either no matching case available or a parse error |
| CancelPurchaseResponse200 InvoiceCollection | Returns the cancelled invoice |
| CancelPurchaseResponse400 Error | Bad request; perhaps missing or invalid parameters. |
| CancelPurchaseResponse422 Error | Cancel purchase cannot be completed for the specified reason. |
| CancelPurchaseResponseDefault Error | Unexpected error. |
Instances
| Show CancelPurchaseResponse Source # | |
Defined in RecurlyClient.Operations.CancelPurchase Methods showsPrec :: Int -> CancelPurchaseResponse -> ShowS # show :: CancelPurchaseResponse -> String # showList :: [CancelPurchaseResponse] -> ShowS # | |
| Eq CancelPurchaseResponse Source # | |
Defined in RecurlyClient.Operations.CancelPurchase Methods (==) :: CancelPurchaseResponse -> CancelPurchaseResponse -> Bool # (/=) :: CancelPurchaseResponse -> CancelPurchaseResponse -> Bool # | |
cancelPurchaseWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> m (Response CancelPurchaseResponse) | Monadic computation which returns the result of the operation |
POST /purchases/{transaction_id}/cancel/The same as cancelPurchase but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /purchases/{transaction_id}/cancel/The same as cancelPurchase but returns the raw ByteString.
cancelPurchaseWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /purchases/{transaction_id}/cancel/The same as cancelPurchase but accepts an explicit configuration and returns the raw ByteString.