Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postSubscriptionsSubscriptionExposedId
Synopsis
- postSubscriptionsSubscriptionExposedId :: forall m. MonadHTTP m => Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> ClientT m (Response PostSubscriptionsSubscriptionExposedIdResponse)
- data PostSubscriptionsSubscriptionExposedIdRequestBody = PostSubscriptionsSubscriptionExposedIdRequestBody {
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems :: Maybe [PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems']
- postSubscriptionsSubscriptionExposedIdRequestBodyApplicationFeePercent :: Maybe Double
- postSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax'
- postSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- postSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyCancelAt :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyCancelAtPeriodEnd :: Maybe Bool
- postSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- postSubscriptionsSubscriptionExposedIdRequestBodyCoupon :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyDaysUntilDue :: Maybe Int
- postSubscriptionsSubscriptionExposedIdRequestBodyDefaultPaymentMethod :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyDefaultSource :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyExpand :: Maybe [Text]
- postSubscriptionsSubscriptionExposedIdRequestBodyItems :: Maybe [PostSubscriptionsSubscriptionExposedIdRequestBodyItems']
- postSubscriptionsSubscriptionExposedIdRequestBodyMetadata :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyOffSession :: Maybe Bool
- postSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- postSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyPromotionCode :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- postSubscriptionsSubscriptionExposedIdRequestBodyProrationDate :: Maybe Int
- postSubscriptionsSubscriptionExposedIdRequestBodyTransferData :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyTrialFromPlan :: Maybe Bool
- mkPostSubscriptionsSubscriptionExposedIdRequestBody :: PostSubscriptionsSubscriptionExposedIdRequestBody
- data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' = PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' {
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'Price :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'Quantity :: Maybe Int
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' :: PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'
- data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' = PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' {
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'Currency :: Text
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'Product :: Text
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'UnitAmount :: Maybe Int
- postSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' :: Text -> Text -> PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'
- data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive
- | PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive
- | PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified
- data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' = PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' {}
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' :: Bool -> PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax'
- data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumNow
- | PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumUnchanged
- data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 = PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 {}
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 :: PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumChargeAutomatically
- | PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumSendInvoice
- data PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems' = PostSubscriptionsSubscriptionExposedIdRequestBodyItems' {
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'ClearUsage :: Maybe Bool
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'Deleted :: Maybe Bool
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'Id :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'Price :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'Quantity :: Maybe Int
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems' :: PostSubscriptionsSubscriptionExposedIdRequestBodyItems'
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 {}
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 :: Int -> PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants
- = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'EmptyString
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' {
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Currency :: Text
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Product :: Text
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring :: PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'UnitAmount :: Maybe Int
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' :: Text -> Text -> PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' -> PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' {}
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' :: PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' -> PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumDay
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumMonth
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumWeek
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumYear
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumExclusive
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumInclusive
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 = PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 {}
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 :: PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' -> PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumKeepAsDraft
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumMarkUncollectible
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumVoid
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumAllowIncomplete
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumDefaultIncomplete
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumErrorIfIncomplete
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumPendingIfIncomplete
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 = PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 {}
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 :: PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- = PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'EmptyString
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Other Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Typed Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumAlwaysInvoice
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumCreateProrations
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumNone
- data PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 = PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 {}
- mkPostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 :: Text -> PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- data PostSubscriptionsSubscriptionExposedIdResponse
Documentation
postSubscriptionsSubscriptionExposedId Source #
:: forall m. MonadHTTP m | |
=> Text | subscription_exposed_id | Constraints: Maximum length of 5000 |
-> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody | The request body to send |
-> ClientT m (Response PostSubscriptionsSubscriptionExposedIdResponse) | Monadic computation which returns the result of the operation |
POST /v1/subscriptions/{subscription_exposed_id}
<p>Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the <a href="#upcoming_invoice">upcoming invoice</a> endpoint.</p>
data PostSubscriptionsSubscriptionExposedIdRequestBody Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBody | |
|
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBody :: PostSubscriptionsSubscriptionExposedIdRequestBody Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBody
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' :: PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.tax_rates.anyOf
in the specification.
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax
in the specification.
Automatic tax settings for this subscription.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source #
:: Bool |
|
-> PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' |
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax'
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_cycle_anchor
in the specification.
Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle documentation.
PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumNow | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumUnchanged | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 :: PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.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. Pass an empty string to remove previously-defined thresholds.
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.cancel_at.anyOf
in the specification.
A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'EmptyString | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Int Int |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.collection_method
in the specification.
Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`.
PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumChargeAutomatically | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_tax_rates.anyOf
in the specification.
The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'EmptyString | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'ListTText [Text] |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems' :: PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyItems'
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source #
:: Int |
|
-> PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 |
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf
in the specification.
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.metadata.anyOf
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'EmptyString | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Object Object |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring.properties.interval
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'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. |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumDay | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumMonth | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumWeek | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumYear | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.tax_behavior
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.tax_rates.anyOf
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'EmptyString | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'ListTText [Text] |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.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`.
PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'EmptyString | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Object Object |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf.properties.behavior
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumKeepAsDraft | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumMarkUncollectible | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumVoid | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf
in the specification.
If specified, payment collection for this subscription will be paused.
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.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.
PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumAllowIncomplete | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumDefaultIncomplete | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumErrorIfIncomplete | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumPendingIfIncomplete | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf.properties.interval
in the specification.
PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf
in the specification.
Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.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`.
PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumAlwaysInvoice | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumCreateProrations | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumNone | Represents the JSON value |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data.anyOf
in the specification.
Instances
mkPostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source #
:: Text |
|
-> PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 |
Create a new PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1
with all required fields.
data PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data.anyOf
in the specification.
If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.trial_end.anyOf
in the specification.
Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Now | Represents the JSON value |
PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Int Int |
Instances
data PostSubscriptionsSubscriptionExposedIdResponse Source #
Represents a response of the operation postSubscriptionsSubscriptionExposedId
.
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), PostSubscriptionsSubscriptionExposedIdResponseError
is used.
PostSubscriptionsSubscriptionExposedIdResponseError String | Means either no matching case available or a parse error |
PostSubscriptionsSubscriptionExposedIdResponse200 Subscription | Successful response. |
PostSubscriptionsSubscriptionExposedIdResponseDefault Error | Error response. |