Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.DeleteSubscriptionItemsItem

Description

Contains the different functions to run the operation deleteSubscriptionItemsItem

Synopsis

deleteSubscriptionItemsItem :: forall m. MonadHTTP m => Text -> Maybe DeleteSubscriptionItemsItemRequestBody -> StripeT m (Response DeleteSubscriptionItemsItemResponse)
data DeleteSubscriptionItemsItemRequestBody = DeleteSubscriptionItemsItemRequestBody {
}
mkDeleteSubscriptionItemsItemRequestBody :: DeleteSubscriptionItemsItemRequestBody
data DeleteSubscriptionItemsItemRequestBodyProrationBehavior'
data DeleteSubscriptionItemsItemResponse

Documentation

deleteSubscriptionItemsItem Source #

Arguments

:: forall m. MonadHTTP m
=> Text	item \| Constraints: Maximum length of 5000
-> Maybe DeleteSubscriptionItemsItemRequestBody	The request body to send
-> StripeT m (Response DeleteSubscriptionItemsItemResponse)	Monadic computation which returns 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 object schema located at paths./v1/subscription_items/{item}.DELETE.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

DeleteSubscriptionItemsItemRequestBody

Fields

deleteSubscriptionItemsItemRequestBodyClearUsage :: Maybe Bool
clear_usage: Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.
deleteSubscriptionItemsItemRequestBodyProrationBehavior :: Maybe DeleteSubscriptionItemsItemRequestBodyProrationBehavior'
proration_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`.
deleteSubscriptionItemsItemRequestBodyProrationDate :: Maybe Int
proration_date: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.

Instances

Instances details

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

mkDeleteSubscriptionItemsItemRequestBody :: DeleteSubscriptionItemsItemRequestBody Source #

Create a new DeleteSubscriptionItemsItemRequestBody with all required fields.

data DeleteSubscriptionItemsItemRequestBodyProrationBehavior' Source #

Defines the enum schema located at paths./v1/subscription_items/{item}.DELETE.requestBody.content.application/x-www-form-urlencoded.schema.properties.proration_behavior in the specification.

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

Constructors

DeleteSubscriptionItemsItemRequestBodyProrationBehavior'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
DeleteSubscriptionItemsItemRequestBodyProrationBehavior'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
DeleteSubscriptionItemsItemRequestBodyProrationBehavior'EnumAlwaysInvoice	Represents the JSON value `"always_invoice"`
DeleteSubscriptionItemsItemRequestBodyProrationBehavior'EnumCreateProrations	Represents the JSON value `"create_prorations"`
DeleteSubscriptionItemsItemRequestBodyProrationBehavior'EnumNone	Represents the JSON value `"none"`

Instances

Instances details

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

data DeleteSubscriptionItemsItemResponse Source #

Represents a response of the operation deleteSubscriptionItemsItem.

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

Constructors

DeleteSubscriptionItemsItemResponseError String	Means either no matching case available or a parse error
DeleteSubscriptionItemsItemResponse200 DeletedSubscriptionItem	Successful response.
DeleteSubscriptionItemsItemResponseDefault Error	Error response.

Instances

Instances details

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