Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Get_preview_renewal

Description

Contains the different functions to run the operation get_preview_renewal

Synopsis

get_preview_renewal :: forall m. MonadHTTP m => Text -> ClientT m (Response Get_preview_renewalResponse)
data Get_preview_renewalResponse
get_preview_renewalWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Get_preview_renewalResponse)
get_preview_renewalRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
get_preview_renewalWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)

Documentation

get_preview_renewal Source #

Arguments

:: forall m. MonadHTTP m
=> Text	subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> ClientT m (Response Get_preview_renewalResponse)	Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/preview_renewal

The subscriptions's renewal invoice(s) will be returned if they exist; if they don't (for example, if the subscription is not set to renew), it will return an result with no invoices.

data Get_preview_renewalResponse Source #

Represents a response of the operation get_preview_renewal.

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), Get_preview_renewalResponseError is used.

Constructors

Get_preview_renewalResponseError String	Means either no matching case available or a parse error
Get_preview_renewalResponse200 InvoiceCollection	A preview of the subscription's renewal invoice(s).
Get_preview_renewalResponse400 Error	Invalid or unpermitted parameter.
Get_preview_renewalResponse404 Error	Incorrect site ID or subscription ID.
Get_preview_renewalResponseDefault Error	Unexpected error.

Instances

Instances details

Show Get_preview_renewalResponse Source #
Instance details Defined in RecurlyClient.Operations.Get_preview_renewal Methods showsPrec :: Int -> Get_preview_renewalResponse -> ShowS # show :: Get_preview_renewalResponse -> String # showList :: [Get_preview_renewalResponse] -> ShowS #
Eq Get_preview_renewalResponse Source #
Instance details Defined in RecurlyClient.Operations.Get_preview_renewal Methods (==) :: Get_preview_renewalResponse -> Get_preview_renewalResponse -> Bool # (/=) :: Get_preview_renewalResponse -> Get_preview_renewalResponse -> Bool #

get_preview_renewalWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> m (Response Get_preview_renewalResponse)	Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/preview_renewal

The same as get_preview_renewal but accepts an explicit configuration.

get_preview_renewalRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Text	subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/preview_renewal

The same as get_preview_renewal but returns the raw ByteString.

get_preview_renewalWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	subscription_id: Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> m (Response ByteString)	Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/preview_renewal

The same as get_preview_renewal but accepts an explicit configuration and returns the raw ByteString.