| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCustomersCustomerSubscriptionsSubscriptionExposedId
Description
Contains the different functions to run the operation postCustomersCustomerSubscriptionsSubscriptionExposedId
Synopsis
- postCustomersCustomerSubscriptionsSubscriptionExposedId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse))
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response ByteString))
- postCustomersCustomerSubscriptionsSubscriptionExposedIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse))
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyApplicationFeePercent :: Maybe Double
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAtPeriodEnd :: Maybe Bool
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCoupon :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDaysUntilDue :: Maybe Integer
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultPaymentMethod :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultSource :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyExpand :: Maybe ([] Text)
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems :: Maybe ([] PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems')
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyOffSession :: Maybe Bool
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrate :: Maybe Bool
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationDate :: Maybe Integer
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialFromPlan :: Maybe Bool
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumStringNow
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumStringUnchanged
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1EnumString_
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 {}
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Integer Integer
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumStringChargeAutomatically
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumStringSendInvoice
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1EnumString_
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'ListText ([] Text)
- 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'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Plan :: Maybe Text
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Quantity :: Maybe Integer
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates :: Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1EnumString_
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 {}
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata' {
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1EnumString_
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'ListText ([] Text)
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata' = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata' {
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumStringAllowIncomplete
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumStringErrorIfIncomplete
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumStringPendingIfIncomplete
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1EnumString_
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 {
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval :: PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'
- postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2IntervalCount :: Maybe Integer
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringDay
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringMonth
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringWeek
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringYear
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumOther Value
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumTyped Text
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumStringAlwaysInvoice
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumStringCreateProrations
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumStringNone
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'Double Double
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'OneOf1
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- = PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'OneOf1 PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'OneOf1
- | PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Integer Integer
- data PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse
Documentation
postCustomersCustomerSubscriptionsSubscriptionExposedId Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | customer | Constraints: Maximum length of 5000 |
| -> Text | subscription_exposed_id | Constraints: Maximum length of 5000 |
| -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody | The request body to send |
| -> m (Either HttpException (Response PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse)) | Monad containing 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>
postCustomersCustomerSubscriptionsSubscriptionExposedIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id}The same as postCustomersCustomerSubscriptionsSubscriptionExposedId but returns the raw ByteString
postCustomersCustomerSubscriptionsSubscriptionExposedIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersCustomerSubscriptionsSubscriptionExposedIdResponse)) Source #
POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id}Monadic version of postCustomersCustomerSubscriptionsSubscriptionExposedId (use with runWithConfiguration)
postCustomersCustomerSubscriptionsSubscriptionExposedIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id}Monadic version of postCustomersCustomerSubscriptionsSubscriptionExposedIdRaw (use with runWithConfiguration)
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody Source #
Defines the data type for the schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBody | |
Fields
| |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBilling_cycle_anchor'
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
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBilling_thresholds'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBilling_thresholds'OneOf2
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 | |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyBilling_thresholds'
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'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancel_at'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCancel_at'
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
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyCollection_method'
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
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefault_tax_rates'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyDefault_tax_rates'
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 data type for the schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Billing_thresholds'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Billing_thresholds'OneOf2
Constructors
| PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 | |
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Billing_thresholds'
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata' Source #
Defines the data type for the schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Tax_rates'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyItems'Tax_rates'
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata' Source #
Defines the data type for the schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyMetadata'
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`.
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPayment_behavior'
Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.
Use `pending_if_incomplete` to update the subscription using pending updates. When you use `pending_if_incomplete` you can only pass the parameters supported by pending updates.
Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPending_invoice_item_interval'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPending_invoice_item_interval'OneOf2
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval' Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPending_invoice_item_interval'OneOf2Interval'
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyPending_invoice_item_interval'
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 postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyProration_behavior'
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`.
Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass `always_invoice`.
Prorations can be disabled by passing `none`.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTax_percent'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTax_percent'
A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the migration docs for `tax_rates`.
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'OneOf1 Source #
Defines the enum schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrial_end'OneOf1
Constructors
Instances
data PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source #
Define the one-of schema postCustomersCustomerSubscriptionsSubscriptionExposedIdRequestBodyTrial_end'
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
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. |