Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Pause_subscription

Description

Contains the different functions to run the operation pause_subscription

Synopsis

pause_subscription :: forall m. MonadHTTP m => Text -> SubscriptionPause -> ClientT m (Response Pause_subscriptionResponse)
data Pause_subscriptionResponse
pause_subscriptionWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> SubscriptionPause -> m (Response Pause_subscriptionResponse)
pause_subscriptionRaw :: forall m. MonadHTTP m => Text -> SubscriptionPause -> ClientT m (Response ByteString)
pause_subscriptionWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> SubscriptionPause -> m (Response ByteString)

Documentation

pause_subscription 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`.
-> SubscriptionPause	The request body to send
-> ClientT m (Response Pause_subscriptionResponse)	Monadic computation which returns the result of the operation

PUT /subscriptions/{subscription_id}/pause

This will put a subscription into the pause state at the next renewal. The body of the request must contain the `remaining_pause_cycles` parameter. If the subscription is currently paused and `remaining_pause_cycles` is 0, the subscription will be resumed.

Expired, cancelled, or failed subscriptions cannot be paused.

data Pause_subscriptionResponse Source #

Represents a response of the operation pause_subscription.

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

Constructors

Pause_subscriptionResponseError String	Means either no matching case available or a parse error
Pause_subscriptionResponse200 Subscription	A subscription.
Pause_subscriptionResponse404 Error	Incorrect site or subscription ID.
Pause_subscriptionResponse422 Error	A validation error such as "remaining_pause_cycles is required".
Pause_subscriptionResponseDefault Error	Unexpected error.

Instances

Instances details

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

pause_subscriptionWithConfiguration 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`.
-> SubscriptionPause	The request body to send
-> m (Response Pause_subscriptionResponse)	Monadic computation which returns the result of the operation

PUT /subscriptions/{subscription_id}/pause

The same as pause_subscription but accepts an explicit configuration.

pause_subscriptionRaw 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`.
-> SubscriptionPause	The request body to send
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /subscriptions/{subscription_id}/pause

The same as pause_subscription but returns the raw ByteString.

pause_subscriptionWithConfigurationRaw 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`.
-> SubscriptionPause	The request body to send
-> m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /subscriptions/{subscription_id}/pause

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