Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

Description

Contains the different functions to run the operation postSubscriptionSchedulesScheduleCancel

Synopsis

postSubscriptionSchedulesScheduleCancel :: forall m. MonadHTTP m => Text -> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody -> StripeT m (Response PostSubscriptionSchedulesScheduleCancelResponse)
data PostSubscriptionSchedulesScheduleCancelRequestBody = PostSubscriptionSchedulesScheduleCancelRequestBody {
}
mkPostSubscriptionSchedulesScheduleCancelRequestBody :: PostSubscriptionSchedulesScheduleCancelRequestBody
data PostSubscriptionSchedulesScheduleCancelResponse

Documentation

postSubscriptionSchedulesScheduleCancel Source #

Arguments

:: forall m. MonadHTTP m
=> Text	schedule \| Constraints: Maximum length of 5000
-> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody	The request body to send
-> StripeT m (Response PostSubscriptionSchedulesScheduleCancelResponse)	Monadic computation which returns 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>

data PostSubscriptionSchedulesScheduleCancelRequestBody Source #

Defines the object schema located at paths./v1/subscription_schedules/{schedule}/cancel.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

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 if a final invoice will be generated 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

Instances details

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] #

mkPostSubscriptionSchedulesScheduleCancelRequestBody :: PostSubscriptionSchedulesScheduleCancelRequestBody Source #

Create a new PostSubscriptionSchedulesScheduleCancelRequestBody with all required fields.

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

Instances details

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 #