| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCustomersCustomerSubscriptionsSubscriptionExposedId
Description
Contains the different functions to run the operation postCustomersCustomerSubscriptionsSubscriptionExposedId
Synopsis
- postCustomersCustomerSubscriptionsSubscriptionExposedId :: forall m. MonadHTTP m => PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ClientT m (Response PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse)
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters = PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters {}
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters :: Text -> Text -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems :: Maybe [PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems']
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyApplicationFeePercent :: Maybe Double
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAtPeriodEnd :: Maybe Bool
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCoupon :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDaysUntilDue :: Maybe Int
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultPaymentMethod :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultSource :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyExpand :: Maybe [Text]
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems :: Maybe [PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems']
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyOffSession :: Maybe Bool
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPromotionCode :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationDate :: Maybe Int
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialFromPlan :: Maybe Bool
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'Price :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'Quantity :: Maybe Int
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'Currency :: Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'Product :: Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'UnitAmount :: Maybe Int
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' :: Text -> Text -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' {}
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' :: Bool -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax'
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumNow
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumUnchanged
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 {}
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'EmptyString
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumChargeAutomatically
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumSendInvoice
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems' {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'ClearUsage :: Maybe Bool
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Deleted :: Maybe Bool
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Id :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Price :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Quantity :: Maybe Int
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems' :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 {}
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 :: Int -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'EmptyString
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Currency :: Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Product :: Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'UnitAmount :: Maybe Int
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' :: Text -> Text -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'IntervalCount :: Maybe Int
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumDay
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumMonth
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumWeek
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval'EnumYear
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumExclusive
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumInclusive
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1ResumesAt :: Maybe Int
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumKeepAsDraft
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumMarkUncollectible
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumVoid
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'EmptyString
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumAllowIncomplete
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumDefaultIncomplete
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumErrorIfIncomplete
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumPendingIfIncomplete
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1IntervalCount :: Maybe Int
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'EmptyString
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Other Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumAlwaysInvoice
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumCreateProrations
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumNone
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 {}
- mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 :: Text -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'EmptyString
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse
Documentation
postCustomersCustomerSubscriptionsSubscriptionExposedId Source #
Arguments
| :: forall m. MonadHTTP m | |
| => PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters | Contains all available parameters of this operation (query and path parameters) |
| -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody | The request body to send |
| -> ClientT m (Response PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse) | Monadic computation which returns the result of the operation |
POST /v1/customers/{customer}/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 PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.parameters in the specification.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters | |
Fields
| |
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters Source #
Arguments
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdParameters with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody | |
Fields
| |
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody Source #
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items in the specification.
Constructors
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source #
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data in the specification.
Constructors
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source #
Arguments
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'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. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source #
Defines the object schema located at paths./v1/customers/{customer}/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
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source #
Arguments
| :: Bool |
|
| -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' |
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumNow | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumUnchanged | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 | |
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source #
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'EmptyString | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Int Int |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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`.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumChargeAutomatically | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items in the specification.
Constructors
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems' :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems' Source #
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems' with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 | |
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source #
Arguments
| :: Int | |
| -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 |
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.metadata.anyOf in the specification.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data in the specification.
Constructors
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source #
Arguments
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring in the specification.
Constructors
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source #
Arguments
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'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. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.tax_rates.anyOf in the specification.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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`.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf in the specification.
Constructors
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source #
Arguments
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf.properties.behavior in the specification.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumKeepAsDraft | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumMarkUncollectible | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumVoid | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.
Constructors
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Arguments
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source #
Defines the enum schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf.properties.interval in the specification.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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`.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumAlwaysInvoice | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumCreateProrations | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumNone | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data.anyOf in the specification.
Instances
mkPostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source #
Arguments
| :: Text |
|
| -> PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 |
Create a new PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 with all required fields.
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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`.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Now | Represents the JSON value |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Int Int |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse Source #
Represents a response of the operation postCustomersCustomerSubscriptionsSubscriptionExposedId.
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), PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponseError is used.
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponseError String | Means either no matching case available or a parse error |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse200 Subscription | Successful response. |
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponseDefault Error | Error response. |