| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId
Description
Contains the different functions to run the operation postSubscriptionsSubscriptionExposedId
Synopsis
- postSubscriptionsSubscriptionExposedId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response PostSubscriptionsSubscriptionExposedIdResponse))
- postSubscriptionsSubscriptionExposedIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response ByteString))
- postSubscriptionsSubscriptionExposedIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionsSubscriptionExposedIdResponse))
- postSubscriptionsSubscriptionExposedIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostSubscriptionsSubscriptionExposedIdRequestBody = PostSubscriptionsSubscriptionExposedIdRequestBody {
- postSubscriptionsSubscriptionExposedIdRequestBodyApplicationFeePercent :: Maybe Double
- postSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- postSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyCancelAt :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyCancelAtPeriodEnd :: Maybe Bool
- postSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- postSubscriptionsSubscriptionExposedIdRequestBodyCoupon :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyDaysUntilDue :: Maybe Integer
- postSubscriptionsSubscriptionExposedIdRequestBodyDefaultPaymentMethod :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyDefaultSource :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyExpand :: Maybe ([] Text)
- postSubscriptionsSubscriptionExposedIdRequestBodyItems :: Maybe ([] PostSubscriptionsSubscriptionExposedIdRequestBodyItems')
- postSubscriptionsSubscriptionExposedIdRequestBodyMetadata :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'
- postSubscriptionsSubscriptionExposedIdRequestBodyOffSession :: Maybe Bool
- postSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- postSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyProrate :: Maybe Bool
- postSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- postSubscriptionsSubscriptionExposedIdRequestBodyProrationDate :: Maybe Integer
- postSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- postSubscriptionsSubscriptionExposedIdRequestBodyTrialFromPlan :: Maybe Bool
- data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumOther Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumTyped Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumStringNow
- | PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumStringUnchanged
- data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 = PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 {}
- data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants
- = PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1
- | PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2
- data PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumOther Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumTyped Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumStringChargeAutomatically
- | PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumStringSendInvoice
- data PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1
- 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'
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'Plan :: Maybe Text
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'Quantity :: Maybe Integer
- postSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates :: Maybe PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 {}
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants
- = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1
- | PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata' = PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata' {
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata' = PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata' {
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumOther Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumTyped Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumStringAllowIncomplete
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumStringErrorIfIncomplete
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumStringPendingIfIncomplete
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 = PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 {}
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumOther Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumTyped Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringDay
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringMonth
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringWeek
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval'EnumStringYear
- data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants
- = PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1
- | PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2
- data PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'
- = PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumOther Value
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumTyped Text
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumStringAlwaysInvoice
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumStringCreateProrations
- | PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumStringNone
- data PostSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'Variants
- data PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'OneOf1
- data PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants
- data PostSubscriptionsSubscriptionExposedIdResponse
Documentation
postSubscriptionsSubscriptionExposedId Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | subscription_exposed_id | Constraints: Maximum length of 5000 |
| -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody | The request body to send |
| -> m (Either HttpException (Response PostSubscriptionsSubscriptionExposedIdResponse)) | Monad containing 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>
postSubscriptionsSubscriptionExposedIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/subscriptions/{subscription_exposed_id}The same as postSubscriptionsSubscriptionExposedId but returns the raw ByteString
postSubscriptionsSubscriptionExposedIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionsSubscriptionExposedIdResponse)) Source #
POST /v1/subscriptions/{subscription_exposed_id}Monadic version of postSubscriptionsSubscriptionExposedId (use with runWithConfiguration)
postSubscriptionsSubscriptionExposedIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/subscriptions/{subscription_exposed_id}Monadic version of postSubscriptionsSubscriptionExposedIdRaw (use with runWithConfiguration)
data PostSubscriptionsSubscriptionExposedIdRequestBody Source #
Defines the data type for the schema postSubscriptionsSubscriptionExposedIdRequestBody
Constructors
| PostSubscriptionsSubscriptionExposedIdRequestBody | |
Fields
| |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyBilling_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 PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyBilling_thresholds'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionsSubscriptionExposedIdRequestBodyBilling_thresholds'OneOf2
Constructors
| PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf2 | |
Fields | |
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyBilling_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 PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyCancel_at'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyCancel_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 PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyCollection_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 PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyDefault_tax_rates'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyDefault_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 PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source #
Defines the data type for the schema postSubscriptionsSubscriptionExposedIdRequestBodyItems'
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyItems'Billing_thresholds'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionsSubscriptionExposedIdRequestBodyItems'Billing_thresholds'OneOf2
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyItems'Billing_thresholds'
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata' Source #
Defines the data type for the schema postSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyItems'Tax_rates'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyItems'Tax_rates'
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata' Source #
Defines the data type for the schema postSubscriptionsSubscriptionExposedIdRequestBodyMetadata'
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 PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyPayment_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 PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyPending_invoice_item_interval'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2 Source #
Defines the data type for the schema postSubscriptionsSubscriptionExposedIdRequestBodyPending_invoice_item_interval'OneOf2
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf2Interval' Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyPending_invoice_item_interval'OneOf2Interval'
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyPending_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 PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyProration_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 PostSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyTax_percent'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyTaxPercent'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyTax_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 PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'OneOf1 Source #
Defines the enum schema postSubscriptionsSubscriptionExposedIdRequestBodyTrial_end'OneOf1
Constructors
Instances
data PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source #
Define the one-of schema postSubscriptionsSubscriptionExposedIdRequestBodyTrial_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 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.
Constructors
| PostSubscriptionsSubscriptionExposedIdResponseError String | Means either no matching case available or a parse error |
| PostSubscriptionsSubscriptionExposedIdResponse200 Subscription | Successful response. |
| PostSubscriptionsSubscriptionExposedIdResponseDefault Error | Error response. |