stripeapi-2.0.0.1: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Description

Contains the different functions to run the operation postSubscriptionsSubscriptionExposedId

Synopsis

Documentation

postSubscriptionsSubscriptionExposedId Source #

Arguments

:: forall m. MonadHTTP m 
=> Text

subscription_exposed_id | Constraints: Maximum length of 5000

-> Maybe PostSubscriptionsSubscriptionExposedIdRequestBody

The request body to send

-> ClientT m (Response PostSubscriptionsSubscriptionExposedIdResponse)

Monadic computation which returns the result of the operation

POST /v1/subscriptions/{subscription_exposed_id}

<p>Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the <a href="#upcoming_invoice">upcoming invoice</a> endpoint.</p>

data PostSubscriptionsSubscriptionExposedIdRequestBody Source #

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

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBody 

Fields

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBody Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source #

Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior in the specification.

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.tax_rates.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax in the specification.

Automatic tax settings for this subscription.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyAutomaticTax' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source #

Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_cycle_anchor in the specification.

Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle documentation.

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumNow

Represents the JSON value "now"

PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor'EnumUnchanged

Represents the JSON value "unchanged"

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyBillingCycleAnchor' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source #

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

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.cancel_at.anyOf in the specification.

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyCancelAt'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source #

Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.collection_method in the specification.

Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`.

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumChargeAutomatically

Represents the JSON value "charge_automatically"

PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod'EnumSendInvoice

Represents the JSON value "send_invoice"

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyCollectionMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_tax_rates.anyOf in the specification.

The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source #

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

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.metadata.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'Metadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source #

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

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' Source #

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

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior' Source #

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

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.tax_rates.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyMetadata'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' Source #

Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf.properties.behavior in the specification.

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumKeepAsDraft

Represents the JSON value "keep_as_draft"

PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumMarkUncollectible

Represents the JSON value "mark_uncollectible"

PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior'EnumVoid

Represents the JSON value "void"

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'OneOf1Behavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pause_collection.anyOf in the specification.

If specified, payment collection for this subscription will be paused.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPauseCollection'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source #

Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_behavior in the specification.

Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.

Use `pending_if_incomplete` to update the subscription using pending updates. When you use `pending_if_incomplete` you can only pass the parameters supported by pending updates.

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumAllowIncomplete

Represents the JSON value "allow_incomplete"

PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumDefaultIncomplete

Represents the JSON value "default_incomplete"

PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumErrorIfIncomplete

Represents the JSON value "error_if_incomplete"

PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior'EnumPendingIfIncomplete

Represents the JSON value "pending_if_incomplete"

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPaymentBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source #

Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf.properties.interval in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source #

Defines the enum schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.proration_behavior in the specification.

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`.

Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass `always_invoice`.

Prorations can be disabled by passing `none`.

Constructors

PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumAlwaysInvoice

Represents the JSON value "always_invoice"

PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumCreateProrations

Represents the JSON value "create_prorations"

PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior'EnumNone

Represents the JSON value "none"

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source #

Defines the object schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data.anyOf in the specification.

If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyTransferData'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

data PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions/{subscription_exposed_id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.trial_end.anyOf in the specification.

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.

Instances

Instances details
Eq PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

Show PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

ToJSON PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId

FromJSON PostSubscriptionsSubscriptionExposedIdRequestBodyTrialEnd'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptionsSubscriptionExposedId