RecurlyClient.Operations.Convert_trial

Contains the different functions to run the operation convert_trial

Documentation

convert_trial

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 Convert_trialResponse)

Monadic computation which returns the result of the operation

PUT /subscriptions/{subscription_id}/convert_trial

This will immediately convert a trial subscription to a fully active paid subscription, creating and collecting an invoice for auto-collecting subsriptions. If the invoice cannot be collected, the subscription will remain in trial. The subscription must be in a trial. Active, paused, expired, cancelled, or failed subscriptions cannot be converted.

data Convert_trialResponse

Represents a response of the operation convert_trial.

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

Constructors

Convert_trialResponseError String

Means either no matching case available or a parse error

Convert_trialResponse200 Subscription

A subscription.

Convert_trialResponse404 Error

Incorrect site or subscription ID.

Convert_trialResponse422 ErrorMayHaveTransaction

A validation error such as "Unable to convert active subscription", or a transaction error if the invoice could not be collected.

Convert_trialResponseDefault Error

Unexpected error.

Instances

Show Convert_trialResponse

Defined in RecurlyClient.Operations.Convert_trial

Methods

showsPrec :: Int -> Convert_trialResponse -> ShowS

show :: Convert_trialResponse -> String

showList :: [Convert_trialResponse] -> ShowS

Eq Convert_trialResponse

Defined in RecurlyClient.Operations.Convert_trial

Methods

(==) :: Convert_trialResponse -> Convert_trialResponse -> Bool

(/=) :: Convert_trialResponse -> Convert_trialResponse -> Bool

convert_trialWithConfiguration

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 Convert_trialResponse)

Monadic computation which returns the result of the operation

PUT /subscriptions/{subscription_id}/convert_trial

The same as convert_trial but accepts an explicit configuration.

convert_trialRaw

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

PUT /subscriptions/{subscription_id}/convert_trial

The same as convert_trial but returns the raw ByteString.

convert_trialWithConfigurationRaw

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

PUT /subscriptions/{subscription_id}/convert_trial

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