stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.DeleteSubscriptionItemsItem

Description

Contains the different functions to run the operation deleteSubscriptionItemsItem

Synopsis

Documentation

deleteSubscriptionItemsItem Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

item | Constraints: Maximum length of 5000

-> DeleteSubscriptionItemsItemRequestBody

The request body to send

-> m (Either HttpException (Response DeleteSubscriptionItemsItemResponse))

Monad containing the result of the operation

DELETE /v1/subscription_items/{item}

<p>Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.</p>

data DeleteSubscriptionItemsItemRequestBody Source #

Defines the data type for the schema deleteSubscriptionItemsItemRequestBody

Constructors

DeleteSubscriptionItemsItemRequestBody 

Fields

data DeleteSubscriptionItemsItemRequestBodyProrationBehavior' Source #

Defines the enum schema deleteSubscriptionItemsItemRequestBodyProration_behavior'

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`.

Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass `always_invoice`.

Prorations can be disabled by passing `none`.

Instances
Eq DeleteSubscriptionItemsItemRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.DeleteSubscriptionItemsItem

Show DeleteSubscriptionItemsItemRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.DeleteSubscriptionItemsItem

ToJSON DeleteSubscriptionItemsItemRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.DeleteSubscriptionItemsItem

FromJSON DeleteSubscriptionItemsItemRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.DeleteSubscriptionItemsItem