StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease

Contains the different functions to run the operation postSubscriptionSchedulesScheduleRelease

Documentation

postSubscriptionSchedulesScheduleRelease

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Text

schedule | Constraints: Maximum length of 5000

-> Maybe PostSubscriptionSchedulesScheduleReleaseRequestBody

The request body to send

-> m (Either HttpException (Response PostSubscriptionSchedulesScheduleReleaseResponse))

Monad containing the result of the operation

POST /v1/subscription_schedules/{schedule}/release

<p>Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.</p>

postSubscriptionSchedulesScheduleReleaseRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionSchedulesScheduleReleaseRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/subscription_schedules/{schedule}/release

The same as postSubscriptionSchedulesScheduleRelease but returns the raw ByteString

postSubscriptionSchedulesScheduleReleaseM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleReleaseRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesScheduleReleaseResponse))

POST /v1/subscription_schedules/{schedule}/release

Monadic version of postSubscriptionSchedulesScheduleRelease (use with runWithConfiguration)

postSubscriptionSchedulesScheduleReleaseRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleReleaseRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

POST /v1/subscription_schedules/{schedule}/release

Monadic version of postSubscriptionSchedulesScheduleReleaseRaw (use with runWithConfiguration)

data PostSubscriptionSchedulesScheduleReleaseRequestBody

Defines the data type for the schema postSubscriptionSchedulesScheduleReleaseRequestBody

Constructors

PostSubscriptionSchedulesScheduleReleaseRequestBody

Fields

• postSubscriptionSchedulesScheduleReleaseRequestBodyExpand :: Maybe ([] Text)

  expand: Specifies which fields in the response should be expanded.

• postSubscriptionSchedulesScheduleReleaseRequestBodyPreserveCancelDate :: Maybe Bool

  preserve_cancel_date: Keep any cancellation on the subscription that the schedule has set

Instances

Eq PostSubscriptionSchedulesScheduleReleaseRequestBody

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease

Methods

(==) :: PostSubscriptionSchedulesScheduleReleaseRequestBody -> PostSubscriptionSchedulesScheduleReleaseRequestBody -> Bool

(/=) :: PostSubscriptionSchedulesScheduleReleaseRequestBody -> PostSubscriptionSchedulesScheduleReleaseRequestBody -> Bool

Show PostSubscriptionSchedulesScheduleReleaseRequestBody

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease

Methods

showsPrec :: Int -> PostSubscriptionSchedulesScheduleReleaseRequestBody -> ShowS

show :: PostSubscriptionSchedulesScheduleReleaseRequestBody -> String

showList :: [PostSubscriptionSchedulesScheduleReleaseRequestBody] -> ShowS

ToJSON PostSubscriptionSchedulesScheduleReleaseRequestBody

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease

Methods

toJSON :: PostSubscriptionSchedulesScheduleReleaseRequestBody -> Value

toEncoding :: PostSubscriptionSchedulesScheduleReleaseRequestBody -> Encoding

toJSONList :: [PostSubscriptionSchedulesScheduleReleaseRequestBody] -> Value

toEncodingList :: [PostSubscriptionSchedulesScheduleReleaseRequestBody] -> Encoding

FromJSON PostSubscriptionSchedulesScheduleReleaseRequestBody

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease

Methods

parseJSON :: Value -> Parser PostSubscriptionSchedulesScheduleReleaseRequestBody

parseJSONList :: Value -> Parser [PostSubscriptionSchedulesScheduleReleaseRequestBody]

data PostSubscriptionSchedulesScheduleReleaseResponse

Represents a response of the operation postSubscriptionSchedulesScheduleRelease.

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

Constructors

PostSubscriptionSchedulesScheduleReleaseResponseError String

Means either no matching case available or a parse error

PostSubscriptionSchedulesScheduleReleaseResponse200 SubscriptionSchedule

Successful response.

PostSubscriptionSchedulesScheduleReleaseResponseDefault Error

Error response.

Instances

Eq PostSubscriptionSchedulesScheduleReleaseResponse

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease

Methods

(==) :: PostSubscriptionSchedulesScheduleReleaseResponse -> PostSubscriptionSchedulesScheduleReleaseResponse -> Bool

(/=) :: PostSubscriptionSchedulesScheduleReleaseResponse -> PostSubscriptionSchedulesScheduleReleaseResponse -> Bool

Show PostSubscriptionSchedulesScheduleReleaseResponse

Defined in StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease

Methods

showsPrec :: Int -> PostSubscriptionSchedulesScheduleReleaseResponse -> ShowS

show :: PostSubscriptionSchedulesScheduleReleaseResponse -> String

showList :: [PostSubscriptionSchedulesScheduleReleaseResponse] -> ShowS