Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSubscriptionItemsItem

Description

Contains the different functions to run the operation postSubscriptionItemsItem

Synopsis

postSubscriptionItemsItem :: forall m. MonadHTTP m => Text -> Maybe PostSubscriptionItemsItemRequestBody -> ClientT m (Response PostSubscriptionItemsItemResponse)
data PostSubscriptionItemsItemRequestBody = PostSubscriptionItemsItemRequestBody {
}
mkPostSubscriptionItemsItemRequestBody :: PostSubscriptionItemsItemRequestBody
data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 = PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 {
- postSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1UsageGte :: Int
}
mkPostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 :: Int -> PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
data PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants
- = PostSubscriptionItemsItemRequestBodyBillingThresholds'EmptyString
- | PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
data PostSubscriptionItemsItemRequestBodyMetadata'Variants
- = PostSubscriptionItemsItemRequestBodyMetadata'EmptyString
- | PostSubscriptionItemsItemRequestBodyMetadata'Object Object
data PostSubscriptionItemsItemRequestBodyPaymentBehavior'
data PostSubscriptionItemsItemRequestBodyPriceData' = PostSubscriptionItemsItemRequestBodyPriceData' {
}
mkPostSubscriptionItemsItemRequestBodyPriceData' :: Text -> Text -> PostSubscriptionItemsItemRequestBodyPriceData'Recurring' -> PostSubscriptionItemsItemRequestBodyPriceData'
data PostSubscriptionItemsItemRequestBodyPriceData'Recurring' = PostSubscriptionItemsItemRequestBodyPriceData'Recurring' {
- postSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval :: PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'
- postSubscriptionItemsItemRequestBodyPriceData'Recurring'IntervalCount :: Maybe Int
}
mkPostSubscriptionItemsItemRequestBodyPriceData'Recurring' :: PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval' -> PostSubscriptionItemsItemRequestBodyPriceData'Recurring'
data PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'
data PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior'
data PostSubscriptionItemsItemRequestBodyProrationBehavior'
data PostSubscriptionItemsItemRequestBodyTaxRates'Variants
- = PostSubscriptionItemsItemRequestBodyTaxRates'EmptyString
- | PostSubscriptionItemsItemRequestBodyTaxRates'ListTText [Text]
data PostSubscriptionItemsItemResponse

Documentation

postSubscriptionItemsItem Source #

Arguments

:: forall m. MonadHTTP m
=> Text	item \| Constraints: Maximum length of 5000
-> Maybe PostSubscriptionItemsItemRequestBody	The request body to send
-> ClientT m (Response PostSubscriptionItemsItemResponse)	Monadic computation which returns the result of the operation

POST /v1/subscription_items/{item}

<p>Updates the plan or quantity of an item on a current subscription.</p>

data PostSubscriptionItemsItemRequestBody Source #

Defines the object schema located at paths./v1/subscription_items/{item}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

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'Variants
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 `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.
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 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 update the 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.
postSubscriptionItemsItemRequestBodyPrice :: Maybe Text
price: The ID of the price object.
Constraints:
- Maximum length of 5000
postSubscriptionItemsItemRequestBodyPriceData :: Maybe PostSubscriptionItemsItemRequestBodyPriceData'
price_data: Data used to generate a new Price object inline.
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 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.
postSubscriptionItemsItemRequestBodyQuantity :: Maybe Int
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

Instances details

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] #

mkPostSubscriptionItemsItemRequestBody :: PostSubscriptionItemsItemRequestBody Source #

Create a new PostSubscriptionItemsItemRequestBody with all required fields.

data PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 Source #

Defines the object schema located at paths./v1/subscription_items/{item}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.

Constructors

PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1
Fields postSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1UsageGte :: Int usage_gte

Instances

Instances details

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] #

mkPostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 Source #

Arguments

:: Int	`postSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1UsageGte`
-> PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1

Create a new PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 with all required fields.

data PostSubscriptionItemsItemRequestBodyBillingThresholds'Variants Source #

Defines the oneOf schema located at paths./v1/subscription_items/{item}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.

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'EmptyString	Represents the JSON value `""`
PostSubscriptionItemsItemRequestBodyBillingThresholds'PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1 PostSubscriptionItemsItemRequestBodyBillingThresholds'OneOf1

Instances

Instances details

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 #
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] #

data PostSubscriptionItemsItemRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/subscription_items/{item}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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'EmptyString	Represents the JSON value `""`
PostSubscriptionItemsItemRequestBodyMetadata'Object Object

Instances

Instances details

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

data PostSubscriptionItemsItemRequestBodyPaymentBehavior' Source #

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

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 `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.

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 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 update the 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'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostSubscriptionItemsItemRequestBodyPaymentBehavior'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumAllowIncomplete	Represents the JSON value `"allow_incomplete"`
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumDefaultIncomplete	Represents the JSON value `"default_incomplete"`
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumErrorIfIncomplete	Represents the JSON value `"error_if_incomplete"`
PostSubscriptionItemsItemRequestBodyPaymentBehavior'EnumPendingIfIncomplete	Represents the JSON value `"pending_if_incomplete"`

Instances

Instances details

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 PostSubscriptionItemsItemRequestBodyPriceData' Source #

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

Data used to generate a new Price object inline.

Constructors

PostSubscriptionItemsItemRequestBodyPriceData'

Fields

postSubscriptionItemsItemRequestBodyPriceData'Currency :: Text
currency
postSubscriptionItemsItemRequestBodyPriceData'Product :: Text
product
Constraints:
- Maximum length of 5000
postSubscriptionItemsItemRequestBodyPriceData'Recurring :: PostSubscriptionItemsItemRequestBodyPriceData'Recurring'
recurring
postSubscriptionItemsItemRequestBodyPriceData'TaxBehavior :: Maybe PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior'
tax_behavior
postSubscriptionItemsItemRequestBodyPriceData'UnitAmount :: Maybe Int
unit_amount
postSubscriptionItemsItemRequestBodyPriceData'UnitAmountDecimal :: Maybe Text
unit_amount_decimal

Instances

Instances details

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

mkPostSubscriptionItemsItemRequestBodyPriceData' Source #

Arguments

:: Text	`postSubscriptionItemsItemRequestBodyPriceData'Currency`
-> Text	`postSubscriptionItemsItemRequestBodyPriceData'Product`
-> PostSubscriptionItemsItemRequestBodyPriceData'Recurring'	`postSubscriptionItemsItemRequestBodyPriceData'Recurring`
-> PostSubscriptionItemsItemRequestBodyPriceData'

Create a new PostSubscriptionItemsItemRequestBodyPriceData' with all required fields.

data PostSubscriptionItemsItemRequestBodyPriceData'Recurring' Source #

Defines the object schema located at paths./v1/subscription_items/{item}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.price_data.properties.recurring in the specification.

Constructors

PostSubscriptionItemsItemRequestBodyPriceData'Recurring'
Fields postSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval :: PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval' interval postSubscriptionItemsItemRequestBodyPriceData'Recurring'IntervalCount :: Maybe Int interval_count

Instances

Instances details

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

mkPostSubscriptionItemsItemRequestBodyPriceData'Recurring' Source #

Arguments

:: PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'	`postSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval`
-> PostSubscriptionItemsItemRequestBodyPriceData'Recurring'

Create a new PostSubscriptionItemsItemRequestBodyPriceData'Recurring' with all required fields.

data PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval' Source #

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

Constructors

PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'EnumDay	Represents the JSON value `"day"`
PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'EnumMonth	Represents the JSON value `"month"`
PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'EnumWeek	Represents the JSON value `"week"`
PostSubscriptionItemsItemRequestBodyPriceData'Recurring'Interval'EnumYear	Represents the JSON value `"year"`

Instances

Instances details

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

data PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior' Source #

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

Constructors

PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior'EnumExclusive	Represents the JSON value `"exclusive"`
PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior'EnumInclusive	Represents the JSON value `"inclusive"`
PostSubscriptionItemsItemRequestBodyPriceData'TaxBehavior'EnumUnspecified	Represents the JSON value `"unspecified"`

Instances

Instances details

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

data PostSubscriptionItemsItemRequestBodyProrationBehavior' Source #

Defines the enum schema located at paths./v1/subscription_items/{item}.POST.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

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

Instances

Instances details

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'Variants Source #

Defines the oneOf schema located at paths./v1/subscription_items/{item}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax_rates.anyOf in the specification.

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'EmptyString	Represents the JSON value `""`
PostSubscriptionItemsItemRequestBodyTaxRates'ListTText [Text]

Instances

Instances details

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 #
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] #

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

Instances details

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 #