Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetSubscriptionSchedulesSchedule

Description

Contains the different functions to run the operation getSubscriptionSchedulesSchedule

Synopsis

getSubscriptionSchedulesSchedule :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Text -> Maybe GetSubscriptionSchedulesScheduleRequestBody -> m (Either HttpException (Response GetSubscriptionSchedulesScheduleResponse))
getSubscriptionSchedulesScheduleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Text -> Maybe GetSubscriptionSchedulesScheduleRequestBody -> m (Either HttpException (Response ByteString))
getSubscriptionSchedulesScheduleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Text -> Maybe GetSubscriptionSchedulesScheduleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionSchedulesScheduleResponse))
getSubscriptionSchedulesScheduleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Text -> Maybe GetSubscriptionSchedulesScheduleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetSubscriptionSchedulesScheduleRequestBody = GetSubscriptionSchedulesScheduleRequestBody {
}
data GetSubscriptionSchedulesScheduleResponse

Documentation

getSubscriptionSchedulesSchedule Source #

Arguments

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

GET /v1/subscription_schedules/{schedule}

<p>Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.</p>

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

GET /v1/subscription_schedules/{schedule}

The same as getSubscriptionSchedulesSchedule but returns the raw ByteString

getSubscriptionSchedulesScheduleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Text -> Maybe GetSubscriptionSchedulesScheduleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionSchedulesScheduleResponse)) Source #

GET /v1/subscription_schedules/{schedule}

Monadic version of getSubscriptionSchedulesSchedule (use with runWithConfiguration)

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

GET /v1/subscription_schedules/{schedule}

Monadic version of getSubscriptionSchedulesScheduleRaw (use with runWithConfiguration)

data GetSubscriptionSchedulesScheduleRequestBody Source #

Defines the data type for the schema getSubscriptionSchedulesScheduleRequestBody

Constructors

GetSubscriptionSchedulesScheduleRequestBody

Instances

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

data GetSubscriptionSchedulesScheduleResponse Source #

Represents a response of the operation getSubscriptionSchedulesSchedule.

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

Constructors

GetSubscriptionSchedulesScheduleResponseError String	Means either no matching case available or a parse error
GetSubscriptionSchedulesScheduleResponse200 SubscriptionSchedule	Successful response.
GetSubscriptionSchedulesScheduleResponseDefault Error	Error response.

Instances

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