| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Create_authorize_purchase
Description
Contains the different functions to run the operation create_authorize_purchase
Synopsis
- create_authorize_purchase :: forall m. MonadHTTP m => PurchaseCreate -> ClientT m (Response Create_authorize_purchaseResponse)
- data Create_authorize_purchaseResponse
- create_authorize_purchaseWithConfiguration :: forall m. MonadHTTP m => Configuration -> PurchaseCreate -> m (Response Create_authorize_purchaseResponse)
- create_authorize_purchaseRaw :: forall m. MonadHTTP m => PurchaseCreate -> ClientT m (Response ByteString)
- create_authorize_purchaseWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> PurchaseCreate -> m (Response ByteString)
Documentation
create_authorize_purchase Source #
Arguments
| :: forall m. MonadHTTP m | |
| => PurchaseCreate | The request body to send |
| -> ClientT m (Response Create_authorize_purchaseResponse) | Monadic computation which returns the result of the operation |
POST /purchases/authorize
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.
The authorize endpoint will create a pending purchase that can be activated at a later time once payment has been completed on an external source.
For additional information regarding shipping fees, please see https://docs.recurly.com/docs/shipping
data Create_authorize_purchaseResponse Source #
Represents a response of the operation create_authorize_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), Create_authorize_purchaseResponseError is used.
Constructors
| Create_authorize_purchaseResponseError String | Means either no matching case available or a parse error |
| Create_authorize_purchaseResponse200 InvoiceCollection | Returns the authorize invoice |
| Create_authorize_purchaseResponse400 Error | Bad request; perhaps missing or invalid parameters. |
| Create_authorize_purchaseResponse422 Error | authorize purchase cannot be completed for the specified reason. |
| Create_authorize_purchaseResponseDefault Error | Unexpected error. |
Instances
create_authorize_purchaseWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> PurchaseCreate | The request body to send |
| -> m (Response Create_authorize_purchaseResponse) | Monadic computation which returns the result of the operation |
POST /purchases/authorize
The same as create_authorize_purchase but accepts an explicit configuration.
create_authorize_purchaseRaw Source #
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/authorize
The same as create_authorize_purchase but returns the raw ByteString.
create_authorize_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/authorize
The same as create_authorize_purchase but accepts an explicit configuration and returns the raw ByteString.