Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetPlansPlan

Description

Contains the different functions to run the operation getPlansPlan

Synopsis

getPlansPlan :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetPlansPlanRequestBody -> m (Either HttpException (Response GetPlansPlanResponse))
getPlansPlanRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetPlansPlanRequestBody -> m (Either HttpException (Response ByteString))
getPlansPlanM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetPlansPlanResponse))
getPlansPlanRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetPlansPlanRequestBody = GetPlansPlanRequestBody {
}
data GetPlansPlanResponse

Documentation

getPlansPlan Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Maybe String	expand: Specifies which fields in the response should be expanded.
-> String	plan \| Constraints: Maximum length of 5000
-> GetPlansPlanRequestBody	The request body to send
-> m (Either HttpException (Response GetPlansPlanResponse))	Monad containing the result of the operation

GET /v1/plans/{plan}

<p>Retrieves the plan with the given ID.</p>

getPlansPlanRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetPlansPlanRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/plans/{plan}

The same as getPlansPlan but returns the raw ByteString

getPlansPlanM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetPlansPlanResponse)) Source #

GET /v1/plans/{plan}

Monadic version of getPlansPlan (use with runWithConfiguration)

getPlansPlanRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/plans/{plan}

Monadic version of getPlansPlanRaw (use with runWithConfiguration)

data GetPlansPlanRequestBody Source #

Defines the data type for the schema getPlansPlanRequestBody

Constructors

GetPlansPlanRequestBody

Instances

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

data GetPlansPlanResponse Source #

Represents a response of the operation getPlansPlan.

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

Constructors

GetPlansPlanResponseError String	Means either no matching case available or a parse error
GetPlansPlanResponse200 Plan	Successful response.
GetPlansPlanResponseDefault Error	Error response.

Instances

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