| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostSubscriptions
Description
Contains the different functions to run the operation postSubscriptions
Synopsis
- postSubscriptions :: forall m. MonadHTTP m => PostSubscriptionsRequestBody -> ClientT m (Response PostSubscriptionsResponse)
- data PostSubscriptionsRequestBody = PostSubscriptionsRequestBody {
- postSubscriptionsRequestBodyAddInvoiceItems :: Maybe [PostSubscriptionsRequestBodyAddInvoiceItems']
- postSubscriptionsRequestBodyApplicationFeePercent :: Maybe Double
- postSubscriptionsRequestBodyAutomaticTax :: Maybe PostSubscriptionsRequestBodyAutomaticTax'
- postSubscriptionsRequestBodyBackdateStartDate :: Maybe Int
- postSubscriptionsRequestBodyBillingCycleAnchor :: Maybe Int
- postSubscriptionsRequestBodyBillingThresholds :: Maybe PostSubscriptionsRequestBodyBillingThresholds'Variants
- postSubscriptionsRequestBodyCancelAt :: Maybe Int
- postSubscriptionsRequestBodyCancelAtPeriodEnd :: Maybe Bool
- postSubscriptionsRequestBodyCollectionMethod :: Maybe PostSubscriptionsRequestBodyCollectionMethod'
- postSubscriptionsRequestBodyCoupon :: Maybe Text
- postSubscriptionsRequestBodyCustomer :: Text
- postSubscriptionsRequestBodyDaysUntilDue :: Maybe Int
- postSubscriptionsRequestBodyDefaultPaymentMethod :: Maybe Text
- postSubscriptionsRequestBodyDefaultSource :: Maybe Text
- postSubscriptionsRequestBodyDefaultTaxRates :: Maybe PostSubscriptionsRequestBodyDefaultTaxRates'Variants
- postSubscriptionsRequestBodyExpand :: Maybe [Text]
- postSubscriptionsRequestBodyItems :: Maybe [PostSubscriptionsRequestBodyItems']
- postSubscriptionsRequestBodyMetadata :: Maybe PostSubscriptionsRequestBodyMetadata'Variants
- postSubscriptionsRequestBodyOffSession :: Maybe Bool
- postSubscriptionsRequestBodyPaymentBehavior :: Maybe PostSubscriptionsRequestBodyPaymentBehavior'
- postSubscriptionsRequestBodyPendingInvoiceItemInterval :: Maybe PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants
- postSubscriptionsRequestBodyPromotionCode :: Maybe Text
- postSubscriptionsRequestBodyProrationBehavior :: Maybe PostSubscriptionsRequestBodyProrationBehavior'
- postSubscriptionsRequestBodyTransferData :: Maybe PostSubscriptionsRequestBodyTransferData'
- postSubscriptionsRequestBodyTrialEnd :: Maybe PostSubscriptionsRequestBodyTrialEnd'Variants
- postSubscriptionsRequestBodyTrialFromPlan :: Maybe Bool
- postSubscriptionsRequestBodyTrialPeriodDays :: Maybe Int
- mkPostSubscriptionsRequestBody :: Text -> PostSubscriptionsRequestBody
- data PostSubscriptionsRequestBodyAddInvoiceItems' = PostSubscriptionsRequestBodyAddInvoiceItems' {
- postSubscriptionsRequestBodyAddInvoiceItems'Price :: Maybe Text
- postSubscriptionsRequestBodyAddInvoiceItems'PriceData :: Maybe PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'
- postSubscriptionsRequestBodyAddInvoiceItems'Quantity :: Maybe Int
- postSubscriptionsRequestBodyAddInvoiceItems'TaxRates :: Maybe PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants
- mkPostSubscriptionsRequestBodyAddInvoiceItems' :: PostSubscriptionsRequestBodyAddInvoiceItems'
- data PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' = PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' {
- postSubscriptionsRequestBodyAddInvoiceItems'PriceData'Currency :: Text
- postSubscriptionsRequestBodyAddInvoiceItems'PriceData'Product :: Text
- postSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior :: Maybe PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- postSubscriptionsRequestBodyAddInvoiceItems'PriceData'UnitAmount :: Maybe Int
- postSubscriptionsRequestBodyAddInvoiceItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostSubscriptionsRequestBodyAddInvoiceItems'PriceData' :: Text -> Text -> PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'
- data PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- = PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Other Value
- | PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text
- | PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive
- | PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive
- | PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified
- data PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants
- data PostSubscriptionsRequestBodyAutomaticTax' = PostSubscriptionsRequestBodyAutomaticTax' {}
- mkPostSubscriptionsRequestBodyAutomaticTax' :: Bool -> PostSubscriptionsRequestBodyAutomaticTax'
- data PostSubscriptionsRequestBodyBillingThresholds'OneOf1 = PostSubscriptionsRequestBodyBillingThresholds'OneOf1 {}
- mkPostSubscriptionsRequestBodyBillingThresholds'OneOf1 :: PostSubscriptionsRequestBodyBillingThresholds'OneOf1
- data PostSubscriptionsRequestBodyBillingThresholds'Variants
- data PostSubscriptionsRequestBodyCollectionMethod'
- data PostSubscriptionsRequestBodyDefaultTaxRates'Variants
- data PostSubscriptionsRequestBodyItems' = PostSubscriptionsRequestBodyItems' {
- postSubscriptionsRequestBodyItems'BillingThresholds :: Maybe PostSubscriptionsRequestBodyItems'BillingThresholds'Variants
- postSubscriptionsRequestBodyItems'Metadata :: Maybe Object
- postSubscriptionsRequestBodyItems'Price :: Maybe Text
- postSubscriptionsRequestBodyItems'PriceData :: Maybe PostSubscriptionsRequestBodyItems'PriceData'
- postSubscriptionsRequestBodyItems'Quantity :: Maybe Int
- postSubscriptionsRequestBodyItems'TaxRates :: Maybe PostSubscriptionsRequestBodyItems'TaxRates'Variants
- mkPostSubscriptionsRequestBodyItems' :: PostSubscriptionsRequestBodyItems'
- data PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 = PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 {}
- mkPostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 :: Int -> PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1
- data PostSubscriptionsRequestBodyItems'BillingThresholds'Variants
- data PostSubscriptionsRequestBodyItems'PriceData' = PostSubscriptionsRequestBodyItems'PriceData' {
- postSubscriptionsRequestBodyItems'PriceData'Currency :: Text
- postSubscriptionsRequestBodyItems'PriceData'Product :: Text
- postSubscriptionsRequestBodyItems'PriceData'Recurring :: PostSubscriptionsRequestBodyItems'PriceData'Recurring'
- postSubscriptionsRequestBodyItems'PriceData'TaxBehavior :: Maybe PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'
- postSubscriptionsRequestBodyItems'PriceData'UnitAmount :: Maybe Int
- postSubscriptionsRequestBodyItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostSubscriptionsRequestBodyItems'PriceData' :: Text -> Text -> PostSubscriptionsRequestBodyItems'PriceData'Recurring' -> PostSubscriptionsRequestBodyItems'PriceData'
- data PostSubscriptionsRequestBodyItems'PriceData'Recurring' = PostSubscriptionsRequestBodyItems'PriceData'Recurring' {}
- mkPostSubscriptionsRequestBodyItems'PriceData'Recurring' :: PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> PostSubscriptionsRequestBodyItems'PriceData'Recurring'
- data PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'
- = PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Other Value
- | PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Typed Text
- | PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumDay
- | PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumMonth
- | PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumWeek
- | PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumYear
- data PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'
- = PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'Other Value
- | PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'Typed Text
- | PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumExclusive
- | PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumInclusive
- | PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified
- data PostSubscriptionsRequestBodyItems'TaxRates'Variants
- data PostSubscriptionsRequestBodyMetadata'Variants
- data PostSubscriptionsRequestBodyPaymentBehavior'
- = PostSubscriptionsRequestBodyPaymentBehavior'Other Value
- | PostSubscriptionsRequestBodyPaymentBehavior'Typed Text
- | PostSubscriptionsRequestBodyPaymentBehavior'EnumAllowIncomplete
- | PostSubscriptionsRequestBodyPaymentBehavior'EnumDefaultIncomplete
- | PostSubscriptionsRequestBodyPaymentBehavior'EnumErrorIfIncomplete
- | PostSubscriptionsRequestBodyPaymentBehavior'EnumPendingIfIncomplete
- data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 = PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 {}
- mkPostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 :: PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'
- = PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value
- | PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text
- | PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay
- | PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth
- | PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek
- | PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear
- data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants
- data PostSubscriptionsRequestBodyProrationBehavior'
- = PostSubscriptionsRequestBodyProrationBehavior'Other Value
- | PostSubscriptionsRequestBodyProrationBehavior'Typed Text
- | PostSubscriptionsRequestBodyProrationBehavior'EnumAlwaysInvoice
- | PostSubscriptionsRequestBodyProrationBehavior'EnumCreateProrations
- | PostSubscriptionsRequestBodyProrationBehavior'EnumNone
- data PostSubscriptionsRequestBodyTransferData' = PostSubscriptionsRequestBodyTransferData' {}
- mkPostSubscriptionsRequestBodyTransferData' :: Text -> PostSubscriptionsRequestBodyTransferData'
- data PostSubscriptionsRequestBodyTrialEnd'Variants
- data PostSubscriptionsResponse
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => PostSubscriptionsRequestBody | The request body to send |
| -> ClientT m (Response PostSubscriptionsResponse) | Monadic computation which returns the result of the operation |
POST /v1/subscriptions
<p>Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.</p>
data PostSubscriptionsRequestBody Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostSubscriptionsRequestBody | |
Fields
| |
Instances
mkPostSubscriptionsRequestBody Source #
Create a new PostSubscriptionsRequestBody with all required fields.
data PostSubscriptionsRequestBodyAddInvoiceItems' Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items in the specification.
Constructors
mkPostSubscriptionsRequestBodyAddInvoiceItems' :: PostSubscriptionsRequestBodyAddInvoiceItems' Source #
Create a new PostSubscriptionsRequestBodyAddInvoiceItems' with all required fields.
data PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data in the specification.
Constructors
| PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' | |
Fields
| |
Instances
mkPostSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source #
Arguments
| :: Text |
|
| -> Text |
|
| -> PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' |
Create a new PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' with all required fields.
data PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior in the specification.
Constructors
| PostSubscriptionsRequestBodyAddInvoiceItems'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. |
| PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
| PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
| PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.tax_rates.anyOf in the specification.
Constructors
| PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'EmptyString | Represents the JSON value |
| PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'ListTText [Text] |
Instances
data PostSubscriptionsRequestBodyAutomaticTax' Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax in the specification.
Automatic tax settings for this subscription.
Constructors
| PostSubscriptionsRequestBodyAutomaticTax' | |
Fields | |
Instances
mkPostSubscriptionsRequestBodyAutomaticTax' Source #
Arguments
| :: Bool | |
| -> PostSubscriptionsRequestBodyAutomaticTax' |
Create a new PostSubscriptionsRequestBodyAutomaticTax' with all required fields.
data PostSubscriptionsRequestBodyBillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.
Constructors
| PostSubscriptionsRequestBodyBillingThresholds'OneOf1 | |
Fields
| |
Instances
mkPostSubscriptionsRequestBodyBillingThresholds'OneOf1 :: PostSubscriptionsRequestBodyBillingThresholds'OneOf1 Source #
Create a new PostSubscriptionsRequestBodyBillingThresholds'OneOf1 with all required fields.
data PostSubscriptionsRequestBodyBillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
Constructors
Instances
data PostSubscriptionsRequestBodyCollectionMethod' Source #
Defines the enum schema located at paths./v1/subscriptions.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
| PostSubscriptionsRequestBodyCollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSubscriptionsRequestBodyCollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSubscriptionsRequestBodyCollectionMethod'EnumChargeAutomatically | Represents the JSON value |
| PostSubscriptionsRequestBodyCollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data PostSubscriptionsRequestBodyDefaultTaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.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.
Constructors
| PostSubscriptionsRequestBodyDefaultTaxRates'EmptyString | Represents the JSON value |
| PostSubscriptionsRequestBodyDefaultTaxRates'ListTText [Text] |
Instances
data PostSubscriptionsRequestBodyItems' Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items in the specification.
Constructors
| PostSubscriptionsRequestBodyItems' | |
Fields
| |
Instances
mkPostSubscriptionsRequestBodyItems' :: PostSubscriptionsRequestBodyItems' Source #
Create a new PostSubscriptionsRequestBodyItems' with all required fields.
data PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.
Constructors
| PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 | |
Fields | |
Instances
mkPostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source #
Arguments
| :: Int |
|
| -> PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 |
Create a new PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 with all required fields.
data PostSubscriptionsRequestBodyItems'BillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.
Constructors
Instances
data PostSubscriptionsRequestBodyItems'PriceData' Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data in the specification.
Constructors
| PostSubscriptionsRequestBodyItems'PriceData' | |
Fields
| |
mkPostSubscriptionsRequestBodyItems'PriceData' Source #
Arguments
| :: Text | |
| -> Text | |
| -> PostSubscriptionsRequestBodyItems'PriceData'Recurring' | |
| -> PostSubscriptionsRequestBodyItems'PriceData' |
Create a new PostSubscriptionsRequestBodyItems'PriceData' with all required fields.
data PostSubscriptionsRequestBodyItems'PriceData'Recurring' Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring in the specification.
Instances
mkPostSubscriptionsRequestBodyItems'PriceData'Recurring' Source #
Arguments
| :: PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' |
|
| -> PostSubscriptionsRequestBodyItems'PriceData'Recurring' |
Create a new PostSubscriptionsRequestBodyItems'PriceData'Recurring' with all required fields.
data PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' Source #
Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring.properties.interval in the specification.
Constructors
| PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumDay | Represents the JSON value |
| PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumMonth | Represents the JSON value |
| PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumWeek | Represents the JSON value |
| PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumYear | Represents the JSON value |
Instances
data PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.tax_behavior in the specification.
Constructors
| PostSubscriptionsRequestBodyItems'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. |
| PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
| PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
| PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostSubscriptionsRequestBodyItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.tax_rates.anyOf in the specification.
Constructors
| PostSubscriptionsRequestBodyItems'TaxRates'EmptyString | Represents the JSON value |
| PostSubscriptionsRequestBodyItems'TaxRates'ListTText [Text] |
Instances
data PostSubscriptionsRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
Constructors
| PostSubscriptionsRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostSubscriptionsRequestBodyMetadata'Object Object |
Instances
data PostSubscriptionsRequestBodyPaymentBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_behavior in the specification.
Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status 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 create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. 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. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=expired_incomplete`, which is a terminal state.
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.
`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.
Constructors
| PostSubscriptionsRequestBodyPaymentBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSubscriptionsRequestBodyPaymentBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSubscriptionsRequestBodyPaymentBehavior'EnumAllowIncomplete | Represents the JSON value |
| PostSubscriptionsRequestBodyPaymentBehavior'EnumDefaultIncomplete | Represents the JSON value |
| PostSubscriptionsRequestBodyPaymentBehavior'EnumErrorIfIncomplete | Represents the JSON value |
| PostSubscriptionsRequestBodyPaymentBehavior'EnumPendingIfIncomplete | Represents the JSON value |
data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.
Instances
mkPostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Arguments
Create a new PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 with all required fields.
data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source #
Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf.properties.interval in the specification.
Constructors
| PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay | Represents the JSON value |
| PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth | Represents the JSON value |
| PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek | Represents the JSON value |
| PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear | Represents the JSON value |
Instances
data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.
Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
Constructors
Instances
data PostSubscriptionsRequestBodyProrationBehavior' Source #
Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.proration_behavior in the specification.
Determines how to handle prorations resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`.
Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`.
Constructors
| PostSubscriptionsRequestBodyProrationBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSubscriptionsRequestBodyProrationBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSubscriptionsRequestBodyProrationBehavior'EnumAlwaysInvoice | Represents the JSON value |
| PostSubscriptionsRequestBodyProrationBehavior'EnumCreateProrations | Represents the JSON value |
| PostSubscriptionsRequestBodyProrationBehavior'EnumNone | Represents the JSON value |
Instances
data PostSubscriptionsRequestBodyTransferData' Source #
Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data 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.
Constructors
| PostSubscriptionsRequestBodyTransferData' | |
Fields
| |
Instances
mkPostSubscriptionsRequestBodyTransferData' Source #
Arguments
| :: Text | |
| -> PostSubscriptionsRequestBodyTransferData' |
Create a new PostSubscriptionsRequestBodyTransferData' with all required fields.
data PostSubscriptionsRequestBodyTrialEnd'Variants Source #
Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.trial_end.anyOf in the specification.
Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
Constructors
| PostSubscriptionsRequestBodyTrialEnd'Now | Represents the JSON value |
| PostSubscriptionsRequestBodyTrialEnd'Int Int |
Instances
data PostSubscriptionsResponse Source #
Represents a response of the operation postSubscriptions.
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), PostSubscriptionsResponseError is used.
Constructors
| PostSubscriptionsResponseError String | Means either no matching case available or a parse error |
| PostSubscriptionsResponse200 Subscription | Successful response. |
| PostSubscriptionsResponseDefault Error | Error response. |
Instances
| Eq PostSubscriptionsResponse Source # | |
Defined in StripeAPI.Operations.PostSubscriptions Methods (==) :: PostSubscriptionsResponse -> PostSubscriptionsResponse -> Bool # (/=) :: PostSubscriptionsResponse -> PostSubscriptionsResponse -> Bool # | |
| Show PostSubscriptionsResponse Source # | |
Defined in StripeAPI.Operations.PostSubscriptions Methods showsPrec :: Int -> PostSubscriptionsResponse -> ShowS # show :: PostSubscriptionsResponse -> String # showList :: [PostSubscriptionsResponse] -> ShowS # | |