| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostSubscriptionSchedulesScheduleRelease
Description
Contains the different functions to run the operation postSubscriptionSchedulesScheduleRelease
Synopsis
- postSubscriptionSchedulesScheduleRelease :: forall m. MonadHTTP m => Text -> Maybe PostSubscriptionSchedulesScheduleReleaseRequestBody -> ClientT m (Response PostSubscriptionSchedulesScheduleReleaseResponse)
- data PostSubscriptionSchedulesScheduleReleaseRequestBody = PostSubscriptionSchedulesScheduleReleaseRequestBody {}
- mkPostSubscriptionSchedulesScheduleReleaseRequestBody :: PostSubscriptionSchedulesScheduleReleaseRequestBody
- data PostSubscriptionSchedulesScheduleReleaseResponse
Documentation
postSubscriptionSchedulesScheduleRelease Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | schedule | Constraints: Maximum length of 5000 |
| -> Maybe PostSubscriptionSchedulesScheduleReleaseRequestBody | The request body to send |
| -> ClientT m (Response PostSubscriptionSchedulesScheduleReleaseResponse) | Monadic computation which returns 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>
data PostSubscriptionSchedulesScheduleReleaseRequestBody Source #
Defines the object schema located at paths./v1/subscription_schedules/{schedule}/release.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostSubscriptionSchedulesScheduleReleaseRequestBody | |
Fields
| |
Instances
mkPostSubscriptionSchedulesScheduleReleaseRequestBody :: PostSubscriptionSchedulesScheduleReleaseRequestBody Source #
Create a new PostSubscriptionSchedulesScheduleReleaseRequestBody with all required fields.
data PostSubscriptionSchedulesScheduleReleaseResponse Source #
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. |