Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

Contains the different functions to run the operation postSubscriptionSchedulesScheduleCancel

2 types
2 values

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostSubscriptionSchedulesScheduleCancel.hs

valuepostSubscriptionSchedulesScheduleCancel

:: MonadHTTP m
=> Text
schedule | Constraints: Maximum length of 5000
-> Maybe PostSubscriptionSchedulesScheduleCancelRequestBody
The request body to send
-> ClientT 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>

datadata PostSubscriptionSchedulesScheduleCancelRequestBody

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostSubscriptionSchedulesScheduleCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel
Show PostSubscriptionSchedulesScheduleCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel
FromJSON PostSubscriptionSchedulesScheduleCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel
ToJSON PostSubscriptionSchedulesScheduleCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel

valuemkPostSubscriptionSchedulesScheduleCancelRequestBody :: PostSubscriptionSchedulesScheduleCancelRequestBody

Create a new PostSubscriptionSchedulesScheduleCancelRequestBody with all required fields.

datadata PostSubscriptionSchedulesScheduleCancelResponse

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.

Instances2Eq, Show

Eq PostSubscriptionSchedulesScheduleCancelResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel
Show PostSubscriptionSchedulesScheduleCancelResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSubscriptionSchedulesScheduleCancel