Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation deleteSubscriptionsSubscriptionExposedId
Synopsis
- deleteSubscriptionsSubscriptionExposedId :: forall m. MonadHTTP m => Text -> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody -> StripeT m (Response DeleteSubscriptionsSubscriptionExposedIdResponse)
- data DeleteSubscriptionsSubscriptionExposedIdRequestBody = DeleteSubscriptionsSubscriptionExposedIdRequestBody {}
- mkDeleteSubscriptionsSubscriptionExposedIdRequestBody :: DeleteSubscriptionsSubscriptionExposedIdRequestBody
- data DeleteSubscriptionsSubscriptionExposedIdResponse
Documentation
deleteSubscriptionsSubscriptionExposedId Source #
:: forall m. MonadHTTP m | |
=> Text | subscription_exposed_id | Constraints: Maximum length of 5000 |
-> Maybe DeleteSubscriptionsSubscriptionExposedIdRequestBody | The request body to send |
-> StripeT m (Response DeleteSubscriptionsSubscriptionExposedIdResponse) | Monadic computation which returns the result of the operation |
DELETE /v1/subscriptions/{subscription_exposed_id}
<p>Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.</p>
<p>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.</p>
<p>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.</p>
data DeleteSubscriptionsSubscriptionExposedIdRequestBody Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.DELETE.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
DeleteSubscriptionsSubscriptionExposedIdRequestBody | |
|
Instances
mkDeleteSubscriptionsSubscriptionExposedIdRequestBody :: DeleteSubscriptionsSubscriptionExposedIdRequestBody Source #
Create a new DeleteSubscriptionsSubscriptionExposedIdRequestBody
with all required fields.
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.
DeleteSubscriptionsSubscriptionExposedIdResponseError String | Means either no matching case available or a parse error |
DeleteSubscriptionsSubscriptionExposedIdResponse200 Subscription | Successful response. |
DeleteSubscriptionsSubscriptionExposedIdResponseDefault Error | Error response. |