| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostSubscriptionItemsItem
Description
Contains the different functions to run the operation postSubscriptionItemsItem
Synopsis
- postSubscriptionItemsItem :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSubscriptionItemsItemRequestBody -> m (Either HttpException (Response PostSubscriptionItemsItemResponse))
- postSubscriptionItemsItemRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSubscriptionItemsItemRequestBody -> m (Either HttpException (Response ByteString))
- postSubscriptionItemsItemM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionItemsItemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionItemsItemResponse))
- postSubscriptionItemsItemRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionItemsItemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostSubscriptionItemsItemRequestBody = PostSubscriptionItemsItemRequestBody {
- postSubscriptionItemsItemRequestBodyBillingThresholds :: Maybe PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants
- postSubscriptionItemsItemRequestBodyExpand :: Maybe ([] String)
- postSubscriptionItemsItemRequestBodyMetadata :: Maybe PostSubscriptionItemsItemRequestBodyMetadata'
- postSubscriptionItemsItemRequestBodyOffSession :: Maybe Bool
- postSubscriptionItemsItemRequestBodyPaymentBehavior :: Maybe PostSubscriptionItemsItemRequestBodyPaymentBehavior'
- postSubscriptionItemsItemRequestBodyPlan :: Maybe String
- postSubscriptionItemsItemRequestBodyProrate :: Maybe Bool
- postSubscriptionItemsItemRequestBodyProrationBehavior :: Maybe PostSubscriptionItemsItemRequestBodyProrationBehavior'
- postSubscriptionItemsItemRequestBodyProrationDate :: Maybe Integer
- postSubscriptionItemsItemRequestBodyQuantity :: Maybe Integer
- postSubscriptionItemsItemRequestBodyTaxRates :: Maybe PostSubscriptionItemsItemRequestBodyTaxRates'Variants
- data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
- data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 = PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 {}
- data PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants
- = PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
- | PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2
- data PostSubscriptionItemsItemRequestBodyMetadata' = PostSubscriptionItemsItemRequestBodyMetadata' {
- data PostSubscriptionItemsItemRequestBodyPaymentBehavior'
- = PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumOther Value
- | PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumTyped String
- | PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumStringAllowIncomplete
- | PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumStringErrorIfIncomplete
- | PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumStringPendingIfIncomplete
- data PostSubscriptionItemsItemRequestBodyProrationBehavior'
- = PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumOther Value
- | PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumTyped String
- | PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumStringAlwaysInvoice
- | PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumStringCreateProrations
- | PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumStringNone
- data PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1
- data PostSubscriptionItemsItemRequestBodyTaxRates'Variants
- data PostSubscriptionItemsItemResponse
Documentation
postSubscriptionItemsItem Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | item | Constraints: Maximum length of 5000 |
| -> PostSubscriptionItemsItemRequestBody | The request body to send |
| -> m (Either HttpException (Response PostSubscriptionItemsItemResponse)) | Monad containing the result of the operation |
POST /v1/subscription_items/{item}<p>Updates the plan or quantity of an item on a current subscription.</p>
postSubscriptionItemsItemRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSubscriptionItemsItemRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_items/{item}The same as postSubscriptionItemsItem but returns the raw ByteString
postSubscriptionItemsItemM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionItemsItemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionItemsItemResponse)) Source #
POST /v1/subscription_items/{item}Monadic version of postSubscriptionItemsItem (use with runWithConfiguration)
postSubscriptionItemsItemRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionItemsItemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_items/{item}Monadic version of postSubscriptionItemsItemRaw (use with runWithConfiguration)
data PostSubscriptionItemsItemRequestBody Source #
Defines the data type for the schema postSubscriptionItemsItemRequestBody
Constructors
| PostSubscriptionItemsItemRequestBody | |
Fields
| |
Instances
data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionItemsItemRequestBodyBilling_thresholds'OneOf1
Constructors
Instances
data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionItemsItemRequestBodyBilling_thresholds'OneOf2
Constructors
| PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 | |
Fields | |
Instances
data PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #
Define the one-of schema postSubscriptionItemsItemRequestBodyBilling_thresholds'
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
Constructors
Instances
data PostSubscriptionItemsItemRequestBodyMetadata' Source #
Defines the data type for the schema postSubscriptionItemsItemRequestBodyMetadata'
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
Constructors
| PostSubscriptionItemsItemRequestBodyMetadata' | |
data PostSubscriptionItemsItemRequestBodyPaymentBehavior' Source #
Defines the enum schema postSubscriptionItemsItemRequestBodyPayment_behavior'
Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.
Use `pending_if_incomplete` to update the subscription using pending updates. When you use `pending_if_incomplete` you can only pass the parameters supported by pending updates.
Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.
Constructors
Instances
data PostSubscriptionItemsItemRequestBodyProrationBehavior' Source #
Defines the enum schema postSubscriptionItemsItemRequestBodyProration_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`.
Constructors
Instances
data PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1 Source #
Defines the enum schema postSubscriptionItemsItemRequestBodyTax_rates'OneOf1
Constructors
| PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1EnumOther Value | |
| PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1EnumTyped String | |
| PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1EnumString_ |
Instances
data PostSubscriptionItemsItemRequestBodyTaxRates'Variants Source #
Define the one-of schema postSubscriptionItemsItemRequestBodyTax_rates'
A list of Tax Rate ids. These Tax Rates will override the `default_tax_rates` on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
Constructors
Instances
data PostSubscriptionItemsItemResponse Source #
Represents a response of the operation postSubscriptionItemsItem.
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), PostSubscriptionItemsItemResponseError is used.
Constructors
| PostSubscriptionItemsItemResponseError String | Means either no matching case available or a parse error |
| PostSubscriptionItemsItemResponse200 SubscriptionItem | Successful response. |
| PostSubscriptionItemsItemResponseDefault Error | Error response. |