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 -> Text -> Maybe PostSubscriptionItemsItemRequestBody -> m (Either HttpException (Response PostSubscriptionItemsItemResponse))
postSubscriptionItemsItemRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionItemsItemRequestBody -> m (Either HttpException (Response ByteString))
postSubscriptionItemsItemM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionItemsItemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionItemsItemResponse))
postSubscriptionItemsItemRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionItemsItemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostSubscriptionItemsItemRequestBody = PostSubscriptionItemsItemRequestBody {
}
data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 = PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 {
- postSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2UsageGte :: Integer
}
data PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants
- = PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
- | PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2
data PostSubscriptionItemsItemRequestBodyMetadata' = PostSubscriptionItemsItemRequestBodyMetadata' {
}
data PostSubscriptionItemsItemRequestBodyPaymentBehavior'
data PostSubscriptionItemsItemRequestBodyProrationBehavior'
data PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1
data PostSubscriptionItemsItemRequestBodyTaxRates'Variants
- = PostSubscriptionItemsItemRequestBodyTaxRates'PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1 PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1
- | PostSubscriptionItemsItemRequestBodyTaxRates'ListText ([] Text)
data PostSubscriptionItemsItemResponse

Documentation

postSubscriptionItemsItem Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	item \| Constraints: Maximum length of 5000
-> Maybe 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 -> Text -> Maybe 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) => Text -> Maybe 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) => Text -> Maybe 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

postSubscriptionItemsItemRequestBodyBillingThresholds :: Maybe PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants
billing_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.
postSubscriptionItemsItemRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postSubscriptionItemsItemRequestBodyMetadata :: Maybe PostSubscriptionItemsItemRequestBodyMetadata'
metadata: 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`.
postSubscriptionItemsItemRequestBodyOffSession :: Maybe Bool
off_session: Indicates if a customer is on or off-session while an invoice payment is attempted.
postSubscriptionItemsItemRequestBodyPaymentBehavior :: Maybe PostSubscriptionItemsItemRequestBodyPaymentBehavior'
payment_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.
postSubscriptionItemsItemRequestBodyPlan :: Maybe Text
plan: The identifier of the new plan for this subscription item.
Constraints:
- Maximum length of 5000
postSubscriptionItemsItemRequestBodyProrate :: Maybe Bool
prorate: This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`.
postSubscriptionItemsItemRequestBodyProrationBehavior :: Maybe PostSubscriptionItemsItemRequestBodyProrationBehavior'
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`.
postSubscriptionItemsItemRequestBodyProrationDate :: Maybe Integer
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.
postSubscriptionItemsItemRequestBodyQuantity :: Maybe Integer
quantity: The quantity you'd like to apply to the subscription item you're creating.
postSubscriptionItemsItemRequestBodyTaxRates :: Maybe PostSubscriptionItemsItemRequestBodyTaxRates'Variants
tax_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.

Instances

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

data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 Source #

Defines the enum schema postSubscriptionItemsItemRequestBodyBilling_thresholds'OneOf1

Constructors

PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1EnumOther Value
PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1EnumTyped Text
PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1EnumString_

Instances

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

data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 Source #

Defines the data type for the schema postSubscriptionItemsItemRequestBodyBilling_thresholds'OneOf2

Constructors

PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2
Fields postSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2UsageGte :: Integer usage_gte

Instances

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

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

PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2

Instances

Eq PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods (==) :: PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> Bool # (/=) :: PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> Bool #
Show PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods showsPrec :: Int -> PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> ShowS # show :: PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> String # showList :: [PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants] -> ShowS #
Generic PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Associated Types type Rep PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants :: Type -> Type # Methods from :: PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> Rep PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants x # to :: Rep PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants x -> PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants #
ToJSON PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods toJSON :: PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> Value # toEncoding :: PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants -> Encoding # toJSONList :: [PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants] -> Value # toEncodingList :: [PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants] -> Encoding #
FromJSON PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods parseJSON :: Value -> Parser PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants # parseJSONList :: Value -> Parser [PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants] #
type Rep PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem type Rep PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants = D1 (MetaData "PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants" "StripeAPI.Operations.PostSubscriptionItemsItem" "stripeapi-0.1.0.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1)) :+: C1 (MetaCons "PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf2)))

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'

Instances

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

PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumOther Value
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumTyped Text
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumStringAllowIncomplete
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumStringErrorIfIncomplete
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumStringPendingIfIncomplete

Instances

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

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

PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumOther Value
PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumTyped Text
PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumStringAlwaysInvoice
PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumStringCreateProrations
PostSubscriptionItemsItemRequestBodyProrationBehavior'EnumStringNone

Instances

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

data PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1 Source #

Defines the enum schema postSubscriptionItemsItemRequestBodyTax_rates'OneOf1

Constructors

PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1EnumOther Value
PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1EnumTyped Text
PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1EnumString_

Instances

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

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

PostSubscriptionItemsItemRequestBodyTaxRates'PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1 PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1
PostSubscriptionItemsItemRequestBodyTaxRates'ListText ([] Text)

Instances

Eq PostSubscriptionItemsItemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods (==) :: PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> Bool # (/=) :: PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> Bool #
Show PostSubscriptionItemsItemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods showsPrec :: Int -> PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> ShowS # show :: PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> String # showList :: [PostSubscriptionItemsItemRequestBodyTaxRates'Variants] -> ShowS #
Generic PostSubscriptionItemsItemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Associated Types type Rep PostSubscriptionItemsItemRequestBodyTaxRates'Variants :: Type -> Type # Methods from :: PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> Rep PostSubscriptionItemsItemRequestBodyTaxRates'Variants x # to :: Rep PostSubscriptionItemsItemRequestBodyTaxRates'Variants x -> PostSubscriptionItemsItemRequestBodyTaxRates'Variants #
ToJSON PostSubscriptionItemsItemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods toJSON :: PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> Value # toEncoding :: PostSubscriptionItemsItemRequestBodyTaxRates'Variants -> Encoding # toJSONList :: [PostSubscriptionItemsItemRequestBodyTaxRates'Variants] -> Value # toEncodingList :: [PostSubscriptionItemsItemRequestBodyTaxRates'Variants] -> Encoding #
FromJSON PostSubscriptionItemsItemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem Methods parseJSON :: Value -> Parser PostSubscriptionItemsItemRequestBodyTaxRates'Variants # parseJSONList :: Value -> Parser [PostSubscriptionItemsItemRequestBodyTaxRates'Variants] #
type Rep PostSubscriptionItemsItemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsItem type Rep PostSubscriptionItemsItemRequestBodyTaxRates'Variants = D1 (MetaData "PostSubscriptionItemsItemRequestBodyTaxRates'Variants" "StripeAPI.Operations.PostSubscriptionItemsItem" "stripeapi-0.1.0.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostSubscriptionItemsItemRequestBodyTaxRates'PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostSubscriptionItemsItemRequestBodyTaxRates'OneOf1)) :+: C1 (MetaCons "PostSubscriptionItemsItemRequestBodyTaxRates'ListText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

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.

Instances

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