Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.DeleteSubscriptionsSubscriptionExposedId

Description

Contains the different functions to run the operation deleteSubscriptionsSubscriptionExposedId

Synopsis

deleteSubscriptionsSubscriptionExposedId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response DeleteSubscriptionsSubscriptionExposedIdResponse))
deleteSubscriptionsSubscriptionExposedIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response ByteString))
deleteSubscriptionsSubscriptionExposedIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteSubscriptionsSubscriptionExposedIdResponse))
deleteSubscriptionsSubscriptionExposedIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data DeleteSubscriptionsSubscriptionExposedIdRequestBody = DeleteSubscriptionsSubscriptionExposedIdRequestBody {
}
data DeleteSubscriptionsSubscriptionExposedIdResponse

Documentation

deleteSubscriptionsSubscriptionExposedId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	subscription_exposed_id \| Constraints: Maximum length of 5000
-> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody	The request body to send
-> m (Either HttpException (Response DeleteSubscriptionsSubscriptionExposedIdResponse))	Monad containing the result of the operation

DELETE /v1/subscriptions/{subscription_exposed_id}

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually <a href="#delete_invoiceitem">deleted</a>. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

deleteSubscriptionsSubscriptionExposedIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

DELETE /v1/subscriptions/{subscription_exposed_id}

The same as deleteSubscriptionsSubscriptionExposedId but returns the raw ByteString

deleteSubscriptionsSubscriptionExposedIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteSubscriptionsSubscriptionExposedIdResponse)) Source #

DELETE /v1/subscriptions/{subscription_exposed_id}

Monadic version of deleteSubscriptionsSubscriptionExposedId (use with runWithConfiguration)

deleteSubscriptionsSubscriptionExposedIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

DELETE /v1/subscriptions/{subscription_exposed_id}

Monadic version of deleteSubscriptionsSubscriptionExposedIdRaw (use with runWithConfiguration)

data DeleteSubscriptionsSubscriptionExposedIdRequestBody Source #

Defines the data type for the schema deleteSubscriptionsSubscriptionExposedIdRequestBody

Constructors

DeleteSubscriptionsSubscriptionExposedIdRequestBody

Fields

deleteSubscriptionsSubscriptionExposedIdRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
deleteSubscriptionsSubscriptionExposedIdRequestBodyInvoiceNow :: Maybe Bool
invoice_now: Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.
deleteSubscriptionsSubscriptionExposedIdRequestBodyProrate :: Maybe Bool
prorate: Will generate a proration invoice item that credits remaining unused time until the subscription period end.

Instances

Eq DeleteSubscriptionsSubscriptionExposedIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeleteSubscriptionsSubscriptionExposedId Methods (==) :: DeleteSubscriptionsSubscriptionExposedIdRequestBody -> DeleteSubscriptionsSubscriptionExposedIdRequestBody -> Bool # (/=) :: DeleteSubscriptionsSubscriptionExposedIdRequestBody -> DeleteSubscriptionsSubscriptionExposedIdRequestBody -> Bool #
Show DeleteSubscriptionsSubscriptionExposedIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeleteSubscriptionsSubscriptionExposedId Methods showsPrec :: Int -> DeleteSubscriptionsSubscriptionExposedIdRequestBody -> ShowS # show :: DeleteSubscriptionsSubscriptionExposedIdRequestBody -> String # showList :: [DeleteSubscriptionsSubscriptionExposedIdRequestBody] -> ShowS #
ToJSON DeleteSubscriptionsSubscriptionExposedIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeleteSubscriptionsSubscriptionExposedId Methods toJSON :: DeleteSubscriptionsSubscriptionExposedIdRequestBody -> Value # toEncoding :: DeleteSubscriptionsSubscriptionExposedIdRequestBody -> Encoding # toJSONList :: [DeleteSubscriptionsSubscriptionExposedIdRequestBody] -> Value # toEncodingList :: [DeleteSubscriptionsSubscriptionExposedIdRequestBody] -> Encoding #
FromJSON DeleteSubscriptionsSubscriptionExposedIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.DeleteSubscriptionsSubscriptionExposedId Methods parseJSON :: Value -> Parser DeleteSubscriptionsSubscriptionExposedIdRequestBody # parseJSONList :: Value -> Parser [DeleteSubscriptionsSubscriptionExposedIdRequestBody] #

data DeleteSubscriptionsSubscriptionExposedIdResponse Source #

Represents a response of the operation deleteSubscriptionsSubscriptionExposedId.

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

Constructors

DeleteSubscriptionsSubscriptionExposedIdResponseError String	Means either no matching case available or a parse error
DeleteSubscriptionsSubscriptionExposedIdResponse200 Subscription	Successful response.
DeleteSubscriptionsSubscriptionExposedIdResponseDefault Error	Error response.

Eq DeleteSubscriptionsSubscriptionExposedIdResponse Source #
Instance details Defined in StripeAPI.Operations.DeleteSubscriptionsSubscriptionExposedId Methods (==) :: DeleteSubscriptionsSubscriptionExposedIdResponse -> DeleteSubscriptionsSubscriptionExposedIdResponse -> Bool # (/=) :: DeleteSubscriptionsSubscriptionExposedIdResponse -> DeleteSubscriptionsSubscriptionExposedIdResponse -> Bool #
Show DeleteSubscriptionsSubscriptionExposedIdResponse Source #
Instance details Defined in StripeAPI.Operations.DeleteSubscriptionsSubscriptionExposedId Methods showsPrec :: Int -> DeleteSubscriptionsSubscriptionExposedIdResponse -> ShowS # show :: DeleteSubscriptionsSubscriptionExposedIdResponse -> String # showList :: [DeleteSubscriptionsSubscriptionExposedIdResponse] -> ShowS #