| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Preview_purchase
Description
Contains the different functions to run the operation preview_purchase
Synopsis
- preview_purchase :: forall m. MonadHTTP m => PurchaseCreate -> ClientT m (Response Preview_purchaseResponse)
- data Preview_purchaseResponse
- preview_purchaseWithConfiguration :: forall m. MonadHTTP m => Configuration -> PurchaseCreate -> m (Response Preview_purchaseResponse)
- preview_purchaseRaw :: forall m. MonadHTTP m => PurchaseCreate -> ClientT m (Response ByteString)
- preview_purchaseWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> PurchaseCreate -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => PurchaseCreate | The request body to send |
| -> ClientT m (Response Preview_purchaseResponse) | Monadic computation which returns the result of the operation |
POST /purchases/preview
A purchase is a checkout containing at least one or more subscriptions or one-time charges (line items) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction.
data Preview_purchaseResponse Source #
Represents a response of the operation preview_purchase.
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), Preview_purchaseResponseError is used.
Constructors
| Preview_purchaseResponseError String | Means either no matching case available or a parse error |
| Preview_purchaseResponse200 InvoiceCollection | Returns preview of the new invoices |
| Preview_purchaseResponse400 Error | Bad request; perhaps missing or invalid parameters. |
| Preview_purchaseResponse422 Error | Purchase cannot be previewed for the specified reason. |
| Preview_purchaseResponseDefault Error | Unexpected error. |
Instances
| Show Preview_purchaseResponse Source # | |
Defined in RecurlyClient.Operations.Preview_purchase Methods showsPrec :: Int -> Preview_purchaseResponse -> ShowS # show :: Preview_purchaseResponse -> String # showList :: [Preview_purchaseResponse] -> ShowS # | |
| Eq Preview_purchaseResponse Source # | |
Defined in RecurlyClient.Operations.Preview_purchase Methods (==) :: Preview_purchaseResponse -> Preview_purchaseResponse -> Bool # (/=) :: Preview_purchaseResponse -> Preview_purchaseResponse -> Bool # | |
preview_purchaseWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> PurchaseCreate | The request body to send |
| -> m (Response Preview_purchaseResponse) | Monadic computation which returns the result of the operation |
POST /purchases/preview
The same as preview_purchase but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => PurchaseCreate | The request body to send |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /purchases/preview
The same as preview_purchase but returns the raw ByteString.
preview_purchaseWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> PurchaseCreate | The request body to send |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /purchases/preview
The same as preview_purchase but accepts an explicit configuration and returns the raw ByteString.