Safe Haskell | None |
---|---|
Language | Haskell2010 |
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 #
:: 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.
PostSubscriptionSchedulesScheduleCancelRequestBody | |
|
Instances
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.
PostSubscriptionSchedulesScheduleCancelResponseError String | Means either no matching case available or a parse error |
PostSubscriptionSchedulesScheduleCancelResponse200 SubscriptionSchedule | Successful response. |
PostSubscriptionSchedulesScheduleCancelResponseDefault Error | Error response. |