Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

Description

Contains the different functions to run the operation postSubscriptionSchedulesScheduleCancel

Synopsis

postSubscriptionSchedulesScheduleCancel :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody -> m (Either HttpException (Response PostSubscriptionSchedulesScheduleCancelResponse))
postSubscriptionSchedulesScheduleCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody -> m (Either HttpException (Response ByteString))
postSubscriptionSchedulesScheduleCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesScheduleCancelResponse))
postSubscriptionSchedulesScheduleCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostSubscriptionSchedulesScheduleCancelRequestBody = PostSubscriptionSchedulesScheduleCancelRequestBody {
}
data PostSubscriptionSchedulesScheduleCancelResponse

Documentation

postSubscriptionSchedulesScheduleCancel Source #

Arguments

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

POST /v1/subscription_schedules/{schedule}/cancel

<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>

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

POST /v1/subscription_schedules/{schedule}/cancel

The same as postSubscriptionSchedulesScheduleCancel but returns the raw ByteString

postSubscriptionSchedulesScheduleCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesScheduleCancelResponse)) Source #

POST /v1/subscription_schedules/{schedule}/cancel

Monadic version of postSubscriptionSchedulesScheduleCancel (use with runWithConfiguration)

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

POST /v1/subscription_schedules/{schedule}/cancel

Monadic version of postSubscriptionSchedulesScheduleCancelRaw (use with runWithConfiguration)

data PostSubscriptionSchedulesScheduleCancelRequestBody Source #

Defines the data type for the schema postSubscriptionSchedulesScheduleCancelRequestBody

Constructors

PostSubscriptionSchedulesScheduleCancelRequestBody

Fields

postSubscriptionSchedulesScheduleCancelRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postSubscriptionSchedulesScheduleCancelRequestBodyInvoiceNow :: Maybe Bool
invoice_now: If the subscription schedule is `active`, indicates whether or not to generate a final invoice that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
postSubscriptionSchedulesScheduleCancelRequestBodyProrate :: Maybe Bool
prorate: If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.

Instances

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

data PostSubscriptionSchedulesScheduleCancelResponse Source #

Represents a response of the operation postSubscriptionSchedulesScheduleCancel.

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

Constructors

PostSubscriptionSchedulesScheduleCancelResponseError String	Means either no matching case available or a parse error
PostSubscriptionSchedulesScheduleCancelResponse200 SubscriptionSchedule	Successful response.
PostSubscriptionSchedulesScheduleCancelResponseDefault Error	Error response.

Instances

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