Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.DeletePlansPlan

Description

Contains the different functions to run the operation deletePlansPlan

Synopsis

deletePlansPlan :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeletePlansPlanRequestBody -> m (Either HttpException (Response DeletePlansPlanResponse))
deletePlansPlanRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeletePlansPlanRequestBody -> m (Either HttpException (Response ByteString))
deletePlansPlanM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeletePlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeletePlansPlanResponse))
deletePlansPlanRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeletePlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data DeletePlansPlanRequestBody = DeletePlansPlanRequestBody {
}
data DeletePlansPlanResponse

Documentation

deletePlansPlan Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	plan \| Constraints: Maximum length of 5000
-> Maybe DeletePlansPlanRequestBody	The request body to send
-> m (Either HttpException (Response DeletePlansPlanResponse))	Monad containing the result of the operation

DELETE /v1/plans/{plan}

<p>Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.</p>

deletePlansPlanRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeletePlansPlanRequestBody -> m (Either HttpException (Response ByteString)) Source #

DELETE /v1/plans/{plan}

The same as deletePlansPlan but returns the raw ByteString

deletePlansPlanM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeletePlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeletePlansPlanResponse)) Source #

DELETE /v1/plans/{plan}

Monadic version of deletePlansPlan (use with runWithConfiguration)

deletePlansPlanRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeletePlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

DELETE /v1/plans/{plan}

Monadic version of deletePlansPlanRaw (use with runWithConfiguration)

data DeletePlansPlanRequestBody Source #

Defines the data type for the schema deletePlansPlanRequestBody

Constructors

DeletePlansPlanRequestBody

Instances

Eq DeletePlansPlanRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeletePlansPlan Methods (==) :: DeletePlansPlanRequestBody -> DeletePlansPlanRequestBody -> Bool # (/=) :: DeletePlansPlanRequestBody -> DeletePlansPlanRequestBody -> Bool #
Show DeletePlansPlanRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeletePlansPlan Methods showsPrec :: Int -> DeletePlansPlanRequestBody -> ShowS # show :: DeletePlansPlanRequestBody -> String # showList :: [DeletePlansPlanRequestBody] -> ShowS #
ToJSON DeletePlansPlanRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeletePlansPlan Methods toJSON :: DeletePlansPlanRequestBody -> Value # toEncoding :: DeletePlansPlanRequestBody -> Encoding # toJSONList :: [DeletePlansPlanRequestBody] -> Value # toEncodingList :: [DeletePlansPlanRequestBody] -> Encoding #
FromJSON DeletePlansPlanRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeletePlansPlan Methods parseJSON :: Value -> Parser DeletePlansPlanRequestBody # parseJSONList :: Value -> Parser [DeletePlansPlanRequestBody] #

data DeletePlansPlanResponse Source #

Represents a response of the operation deletePlansPlan.

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

Constructors

DeletePlansPlanResponseError String	Means either no matching case available or a parse error
DeletePlansPlanResponse200 DeletedPlan	Successful response.
DeletePlansPlanResponseDefault Error	Error response.

Instances

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