stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

Description

Contains the different functions to run the operation postSubscriptionSchedulesScheduleCancel

Synopsis

Documentation

postSubscriptionSchedulesScheduleCancel Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

schedule | Constraints: Maximum length of 5000

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

data PostSubscriptionSchedulesScheduleCancelRequestBody Source #

Defines the data type for the schema postSubscriptionSchedulesScheduleCancelRequestBody

Constructors

PostSubscriptionSchedulesScheduleCancelRequestBody 

Fields

Instances
Eq PostSubscriptionSchedulesScheduleCancelRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

Show PostSubscriptionSchedulesScheduleCancelRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

ToJSON PostSubscriptionSchedulesScheduleCancelRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

FromJSON PostSubscriptionSchedulesScheduleCancelRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel