StripeAPI.Operations.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Contains the different functions to run the operation deleteCustomersCustomerSubscriptionsSubscriptionExposedId

Documentation

deleteCustomersCustomerSubscriptionsSubscriptionExposedId

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> String

customer | Constraints: Maximum length of 5000

-> String

subscription_exposed_id | Constraints: Maximum length of 5000

-> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

The request body to send

-> m (Either HttpException (Response DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse))

Monad containing the result of the operation

DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}

<p>Cancels a customer’s subscription. If you set the <code>at_period_end</code> parameter to <code>true</code>, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default <code>false</code> value, the subscription is terminated immediately. In either case, 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>

deleteCustomersCustomerSubscriptionsSubscriptionExposedIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> String -> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response ByteString))

DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}

The same as deleteCustomersCustomerSubscriptionsSubscriptionExposedId but returns the raw ByteString

deleteCustomersCustomerSubscriptionsSubscriptionExposedIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> String -> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse))

DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}

Monadic version of deleteCustomersCustomerSubscriptionsSubscriptionExposedId (use with runWithConfiguration)

deleteCustomersCustomerSubscriptionsSubscriptionExposedIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> String -> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}

Monadic version of deleteCustomersCustomerSubscriptionsSubscriptionExposedIdRaw (use with runWithConfiguration)

data DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

Defines the data type for the schema deleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

Constructors

DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

Fields

• deleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyExpand :: Maybe ([] String)

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

• deleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyInvoiceNow :: Maybe Bool

  invoice_now: Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.

• deleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrate :: Maybe Bool

  prorate: Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end.

Instances

Eq DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

Defined in StripeAPI.Operations.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Methods

(==) :: DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> Bool

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

Show DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

Defined in StripeAPI.Operations.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Methods

showsPrec :: Int -> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ShowS

show :: DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> String

showList :: [DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody] -> ShowS

ToJSON DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

Defined in StripeAPI.Operations.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Methods

toJSON :: DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> Value

toEncoding :: DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> Encoding

toJSONList :: [DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody] -> Value

toEncodingList :: [DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody] -> Encoding

FromJSON DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

Defined in StripeAPI.Operations.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Methods

parseJSON :: Value -> Parser DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody

parseJSONList :: Value -> Parser [DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody]

data DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse

Represents a response of the operation deleteCustomersCustomerSubscriptionsSubscriptionExposedId.

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

Constructors

DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponseError String

Means either no matching case available or a parse error

DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse200 Subscription

Successful response.

DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponseDefault Error

Error response.

Instances

Eq DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse

Defined in StripeAPI.Operations.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Methods

(==) :: DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse -> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse -> Bool

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

Show DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse

Defined in StripeAPI.Operations.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Methods

showsPrec :: Int -> DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse -> ShowS

show :: DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse -> String

showList :: [DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdResponse] -> ShowS