StripeAPI.Operations.GetPlansPlan

Contains the different functions to run the operation getPlansPlan

Documentation

getPlansPlan

Arguments

:: forall m. MonadHTTP m

=> GetPlansPlanParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetPlansPlanResponse)

Monadic computation which returns the result of the operation

GET /v1/plans/{plan}

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

data GetPlansPlanParameters

Defines the object schema located at paths./v1/plans/{plan}.GET.parameters in the specification.

Constructors

GetPlansPlanParameters

Fields

• getPlansPlanParametersPathPlan :: Text

  pathPlan: Represents the parameter named 'plan'

  Constraints:

  • Maximum length of 5000
• getPlansPlanParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

Instances

Eq GetPlansPlanParameters

Defined in StripeAPI.Operations.GetPlansPlan

Methods

(==) :: GetPlansPlanParameters -> GetPlansPlanParameters -> Bool

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

Show GetPlansPlanParameters

Defined in StripeAPI.Operations.GetPlansPlan

Methods

showsPrec :: Int -> GetPlansPlanParameters -> ShowS

show :: GetPlansPlanParameters -> String

showList :: [GetPlansPlanParameters] -> ShowS

ToJSON GetPlansPlanParameters

Defined in StripeAPI.Operations.GetPlansPlan

Methods

toJSON :: GetPlansPlanParameters -> Value

toEncoding :: GetPlansPlanParameters -> Encoding

toJSONList :: [GetPlansPlanParameters] -> Value

toEncodingList :: [GetPlansPlanParameters] -> Encoding

FromJSON GetPlansPlanParameters

Defined in StripeAPI.Operations.GetPlansPlan

Methods

parseJSON :: Value -> Parser GetPlansPlanParameters

parseJSONList :: Value -> Parser [GetPlansPlanParameters]

mkGetPlansPlanParameters

Arguments

:: Text

getPlansPlanParametersPathPlan

-> GetPlansPlanParameters

Create a new GetPlansPlanParameters with all required fields.

data GetPlansPlanResponse

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

Defined in StripeAPI.Operations.GetPlansPlan

Methods

(==) :: GetPlansPlanResponse -> GetPlansPlanResponse -> Bool

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

Show GetPlansPlanResponse

Defined in StripeAPI.Operations.GetPlansPlan

Methods

showsPrec :: Int -> GetPlansPlanResponse -> ShowS

show :: GetPlansPlanResponse -> String

showList :: [GetPlansPlanResponse] -> ShowS