Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSubscriptionItems

Description

Contains the different functions to run the operation postSubscriptionItems

Synopsis

postSubscriptionItems :: forall m. MonadHTTP m => PostSubscriptionItemsRequestBody -> StripeT m (Response PostSubscriptionItemsResponse)
data PostSubscriptionItemsRequestBody = PostSubscriptionItemsRequestBody {
}
mkPostSubscriptionItemsRequestBody :: Text -> PostSubscriptionItemsRequestBody
data PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 = PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 {
- postSubscriptionItemsRequestBodyBillingThresholds'OneOf1UsageGte :: Int
}
mkPostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 :: Int -> PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1
data PostSubscriptionItemsRequestBodyBillingThresholds'Variants
- = PostSubscriptionItemsRequestBodyBillingThresholds'EmptyString
- | PostSubscriptionItemsRequestBodyBillingThresholds'PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1
data PostSubscriptionItemsRequestBodyPaymentBehavior'
data PostSubscriptionItemsRequestBodyPriceData' = PostSubscriptionItemsRequestBodyPriceData' {
}
mkPostSubscriptionItemsRequestBodyPriceData' :: Text -> Text -> PostSubscriptionItemsRequestBodyPriceData'Recurring' -> PostSubscriptionItemsRequestBodyPriceData'
data PostSubscriptionItemsRequestBodyPriceData'Recurring' = PostSubscriptionItemsRequestBodyPriceData'Recurring' {
- postSubscriptionItemsRequestBodyPriceData'Recurring'Interval :: PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'
- postSubscriptionItemsRequestBodyPriceData'Recurring'IntervalCount :: Maybe Int
}
mkPostSubscriptionItemsRequestBodyPriceData'Recurring' :: PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval' -> PostSubscriptionItemsRequestBodyPriceData'Recurring'
data PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'
data PostSubscriptionItemsRequestBodyPriceData'TaxBehavior'
data PostSubscriptionItemsRequestBodyProrationBehavior'
data PostSubscriptionItemsRequestBodyTaxRates'Variants
- = PostSubscriptionItemsRequestBodyTaxRates'EmptyString
- | PostSubscriptionItemsRequestBodyTaxRates'ListTText [Text]
data PostSubscriptionItemsResponse

Documentation

postSubscriptionItems Source #

Arguments

:: forall m. MonadHTTP m
=> PostSubscriptionItemsRequestBody	The request body to send
-> StripeT m (Response PostSubscriptionItemsResponse)	Monadic computation which returns the result of the operation

POST /v1/subscription_items

<p>Adds a new item to an existing subscription. No existing items will be changed or replaced.</p>

data PostSubscriptionItemsRequestBody Source #

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

Constructors

PostSubscriptionItemsRequestBody

Fields

postSubscriptionItemsRequestBodyBillingThresholds :: Maybe PostSubscriptionItemsRequestBodyBillingThresholds'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.
postSubscriptionItemsRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postSubscriptionItemsRequestBodyMetadata :: Maybe Object
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`.
postSubscriptionItemsRequestBodyPaymentBehavior :: Maybe PostSubscriptionItemsRequestBodyPaymentBehavior'
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.
postSubscriptionItemsRequestBodyPrice :: Maybe Text
price: The ID of the price object.
Constraints:
- Maximum length of 5000
postSubscriptionItemsRequestBodyPriceData :: Maybe PostSubscriptionItemsRequestBodyPriceData'
price_data: Data used to generate a new Price object inline.
postSubscriptionItemsRequestBodyProrationBehavior :: Maybe PostSubscriptionItemsRequestBodyProrationBehavior'
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`.
postSubscriptionItemsRequestBodyProrationDate :: 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.
postSubscriptionItemsRequestBodyQuantity :: Maybe Int
quantity: The quantity you'd like to apply to the subscription item you're creating.
postSubscriptionItemsRequestBodySubscription :: Text
subscription: The identifier of the subscription to modify.
Constraints:
- Maximum length of 5000
postSubscriptionItemsRequestBodyTaxRates :: Maybe PostSubscriptionItemsRequestBodyTaxRates'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 PostSubscriptionItemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItems Methods (==) :: PostSubscriptionItemsRequestBody -> PostSubscriptionItemsRequestBody -> Bool # (/=) :: PostSubscriptionItemsRequestBody -> PostSubscriptionItemsRequestBody -> Bool #
Show PostSubscriptionItemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItems Methods showsPrec :: Int -> PostSubscriptionItemsRequestBody -> ShowS # show :: PostSubscriptionItemsRequestBody -> String # showList :: [PostSubscriptionItemsRequestBody] -> ShowS #
ToJSON PostSubscriptionItemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItems Methods toJSON :: PostSubscriptionItemsRequestBody -> Value # toEncoding :: PostSubscriptionItemsRequestBody -> Encoding # toJSONList :: [PostSubscriptionItemsRequestBody] -> Value # toEncodingList :: [PostSubscriptionItemsRequestBody] -> Encoding #
FromJSON PostSubscriptionItemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItems Methods parseJSON :: Value -> Parser PostSubscriptionItemsRequestBody # parseJSONList :: Value -> Parser [PostSubscriptionItemsRequestBody] #

mkPostSubscriptionItemsRequestBody Source #

Arguments

:: Text	`postSubscriptionItemsRequestBodySubscription`
-> PostSubscriptionItemsRequestBody

Create a new PostSubscriptionItemsRequestBody with all required fields.

data PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 Source #

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

Constructors

PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1
Fields postSubscriptionItemsRequestBodyBillingThresholds'OneOf1UsageGte :: Int usage_gte

Instances

Instances details

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

mkPostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 Source #

Arguments

:: Int	`postSubscriptionItemsRequestBodyBillingThresholds'OneOf1UsageGte`
-> PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1

Create a new PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 with all required fields.

data PostSubscriptionItemsRequestBodyBillingThresholds'Variants Source #

Defines the oneOf schema located at paths./v1/subscription_items.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

PostSubscriptionItemsRequestBodyBillingThresholds'EmptyString	Represents the JSON value `""`
PostSubscriptionItemsRequestBodyBillingThresholds'PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1 PostSubscriptionItemsRequestBodyBillingThresholds'OneOf1

Instances

Instances details

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

data PostSubscriptionItemsRequestBodyPaymentBehavior' Source #

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

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

Instances

Instances details

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

data PostSubscriptionItemsRequestBodyPriceData' Source #

Defines the object schema located at paths./v1/subscription_items.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

PostSubscriptionItemsRequestBodyPriceData'

Fields

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

Instances

Instances details

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

mkPostSubscriptionItemsRequestBodyPriceData' Source #

Arguments

:: Text	`postSubscriptionItemsRequestBodyPriceData'Currency`
-> Text	`postSubscriptionItemsRequestBodyPriceData'Product`
-> PostSubscriptionItemsRequestBodyPriceData'Recurring'	`postSubscriptionItemsRequestBodyPriceData'Recurring`
-> PostSubscriptionItemsRequestBodyPriceData'

Create a new PostSubscriptionItemsRequestBodyPriceData' with all required fields.

data PostSubscriptionItemsRequestBodyPriceData'Recurring' Source #

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

Constructors

PostSubscriptionItemsRequestBodyPriceData'Recurring'
Fields postSubscriptionItemsRequestBodyPriceData'Recurring'Interval :: PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval' interval postSubscriptionItemsRequestBodyPriceData'Recurring'IntervalCount :: Maybe Int interval_count

Instances

Instances details

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

mkPostSubscriptionItemsRequestBodyPriceData'Recurring' Source #

Arguments

:: PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'	`postSubscriptionItemsRequestBodyPriceData'Recurring'Interval`
-> PostSubscriptionItemsRequestBodyPriceData'Recurring'

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

data PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval' Source #

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

Constructors

PostSubscriptionItemsRequestBodyPriceData'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.
PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'EnumDay	Represents the JSON value `"day"`
PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'EnumMonth	Represents the JSON value `"month"`
PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'EnumWeek	Represents the JSON value `"week"`
PostSubscriptionItemsRequestBodyPriceData'Recurring'Interval'EnumYear	Represents the JSON value `"year"`

Instances

Instances details

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

data PostSubscriptionItemsRequestBodyPriceData'TaxBehavior' Source #

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

Constructors

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

Instances

Instances details

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

data PostSubscriptionItemsRequestBodyProrationBehavior' Source #

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

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

Instances

Instances details

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

data PostSubscriptionItemsRequestBodyTaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/subscription_items.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

PostSubscriptionItemsRequestBodyTaxRates'EmptyString	Represents the JSON value `""`
PostSubscriptionItemsRequestBodyTaxRates'ListTText [Text]

Instances

Instances details

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

data PostSubscriptionItemsResponse Source #

Represents a response of the operation postSubscriptionItems.

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

Constructors

PostSubscriptionItemsResponseError String	Means either no matching case available or a parse error
PostSubscriptionItemsResponse200 SubscriptionItem	Successful response.
PostSubscriptionItemsResponseDefault Error	Error response.

Instances

Instances details

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