Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postCustomersCustomerSubscriptions
Synopsis
- postCustomersCustomerSubscriptions :: forall m. MonadHTTP m => Text -> Maybe PostCustomersCustomerSubscriptionsRequestBody -> ClientT m (Response PostCustomersCustomerSubscriptionsResponse)
- data PostCustomersCustomerSubscriptionsRequestBody = PostCustomersCustomerSubscriptionsRequestBody {
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems :: Maybe [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems']
- postCustomersCustomerSubscriptionsRequestBodyApplicationFeePercent :: Maybe Double
- postCustomersCustomerSubscriptionsRequestBodyAutomaticTax :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'
- postCustomersCustomerSubscriptionsRequestBodyBackdateStartDate :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyBillingCycleAnchor :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyBillingThresholds :: Maybe PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants
- postCustomersCustomerSubscriptionsRequestBodyCancelAt :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyCancelAtPeriodEnd :: Maybe Bool
- postCustomersCustomerSubscriptionsRequestBodyCollectionMethod :: Maybe PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'
- postCustomersCustomerSubscriptionsRequestBodyCoupon :: Maybe Text
- postCustomersCustomerSubscriptionsRequestBodyDaysUntilDue :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyDefaultPaymentMethod :: Maybe Text
- postCustomersCustomerSubscriptionsRequestBodyDefaultSource :: Maybe Text
- postCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates :: Maybe PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants
- postCustomersCustomerSubscriptionsRequestBodyExpand :: Maybe [Text]
- postCustomersCustomerSubscriptionsRequestBodyItems :: Maybe [PostCustomersCustomerSubscriptionsRequestBodyItems']
- postCustomersCustomerSubscriptionsRequestBodyMetadata :: Maybe PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants
- postCustomersCustomerSubscriptionsRequestBodyOffSession :: Maybe Bool
- postCustomersCustomerSubscriptionsRequestBodyPaymentBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'
- postCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval :: Maybe PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants
- postCustomersCustomerSubscriptionsRequestBodyPromotionCode :: Maybe Text
- postCustomersCustomerSubscriptionsRequestBodyProrationBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'
- postCustomersCustomerSubscriptionsRequestBodyTransferData :: Maybe PostCustomersCustomerSubscriptionsRequestBodyTransferData'
- postCustomersCustomerSubscriptionsRequestBodyTrialEnd :: Maybe PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants
- postCustomersCustomerSubscriptionsRequestBodyTrialFromPlan :: Maybe Bool
- postCustomersCustomerSubscriptionsRequestBodyTrialPeriodDays :: Maybe Int
- mkPostCustomersCustomerSubscriptionsRequestBody :: PostCustomersCustomerSubscriptionsRequestBody
- data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' = PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' {
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'Price :: Maybe Text
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'Quantity :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants
- mkPostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'
- data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' = PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' {
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'Currency :: Text
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'Product :: Text
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'UnitAmount :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' :: Text -> Text -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'
- data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'
- = PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Other Value
- | PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive
- | PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive
- | PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified
- data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants
- data PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' = PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' {}
- mkPostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' :: Bool -> PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'
- data PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 = PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 {}
- mkPostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1
- data PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants
- data PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'
- = PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'Other Value
- | PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'Typed Text
- | PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'EnumChargeAutomatically
- | PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'EnumSendInvoice
- data PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants
- data PostCustomersCustomerSubscriptionsRequestBodyItems' = PostCustomersCustomerSubscriptionsRequestBodyItems' {
- postCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants
- postCustomersCustomerSubscriptionsRequestBodyItems'Metadata :: Maybe Object
- postCustomersCustomerSubscriptionsRequestBodyItems'Price :: Maybe Text
- postCustomersCustomerSubscriptionsRequestBodyItems'PriceData :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'
- postCustomersCustomerSubscriptionsRequestBodyItems'Quantity :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyItems'TaxRates :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants
- mkPostCustomersCustomerSubscriptionsRequestBodyItems' :: PostCustomersCustomerSubscriptionsRequestBodyItems'
- data PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 = PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 {}
- mkPostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1
- data PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants
- = PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'EmptyString
- | PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1
- data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' = PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' {
- postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Currency :: Text
- postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Product :: Text
- postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'
- postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'
- postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'UnitAmount :: Maybe Int
- postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' :: Text -> Text -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'
- data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' = PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' {}
- mkPostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'
- data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'
- = PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Other Value
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Typed Text
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumDay
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumMonth
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumWeek
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumYear
- data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'
- = PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'Other Value
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumExclusive
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumInclusive
- | PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified
- data PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants
- data PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants
- data PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'
- = PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'Other Value
- | PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumAllowIncomplete
- | PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumDefaultIncomplete
- | PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumErrorIfIncomplete
- | PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumPendingIfIncomplete
- data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 = PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 {}
- mkPostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'
- = PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value
- | PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text
- | PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay
- | PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth
- | PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek
- | PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear
- data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants
- = PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'EmptyString
- | PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1
- data PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'
- = PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'Other Value
- | PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'Typed Text
- | PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumAlwaysInvoice
- | PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumCreateProrations
- | PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumNone
- data PostCustomersCustomerSubscriptionsRequestBodyTransferData' = PostCustomersCustomerSubscriptionsRequestBodyTransferData' {}
- mkPostCustomersCustomerSubscriptionsRequestBodyTransferData' :: Text -> PostCustomersCustomerSubscriptionsRequestBodyTransferData'
- data PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants
- data PostCustomersCustomerSubscriptionsResponse
Documentation
postCustomersCustomerSubscriptions Source #
:: forall m. MonadHTTP m | |
=> Text | customer | Constraints: Maximum length of 5000 |
-> Maybe PostCustomersCustomerSubscriptionsRequestBody | The request body to send |
-> ClientT m (Response PostCustomersCustomerSubscriptionsResponse) | Monadic computation which returns the result of the operation |
POST /v1/customers/{customer}/subscriptions
<p>Creates a new subscription on an existing customer.</p>
data PostCustomersCustomerSubscriptionsRequestBody Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostCustomersCustomerSubscriptionsRequestBody | |
|
Instances
mkPostCustomersCustomerSubscriptionsRequestBody :: PostCustomersCustomerSubscriptionsRequestBody Source #
Create a new PostCustomersCustomerSubscriptionsRequestBody
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' Source #
Create a new PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source #
Create a new PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior
in the specification.
PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'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. |
PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.tax_rates.anyOf
in the specification.
PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'EmptyString | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'ListTText [Text] |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax
in the specification.
Automatic tax settings for this subscription.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' Source #
:: Bool |
|
-> PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' |
Create a new PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 Source #
Create a new PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Instances
data PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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`.
PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'EnumChargeAutomatically | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'EmptyString | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'ListTText [Text] |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyItems' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyItems' :: PostCustomersCustomerSubscriptionsRequestBodyItems' Source #
Create a new PostCustomersCustomerSubscriptionsRequestBodyItems'
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source #
:: Int |
|
-> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 |
Create a new PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf
in the specification.
Instances
data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' Source #
Create a new PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' Source #
Create a new PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' Source #
Defines the enum schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring.properties.interval
in the specification.
PostCustomersCustomerSubscriptionsRequestBodyItems'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. |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumDay | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumMonth | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumWeek | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumYear | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.tax_behavior
in the specification.
PostCustomersCustomerSubscriptionsRequestBodyItems'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. |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.tax_rates.anyOf
in the specification.
PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'EmptyString | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'ListTText [Text] |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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`.
PostCustomersCustomerSubscriptionsRequestBodyMetadata'EmptyString | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyMetadata'Object Object |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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.
PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumAllowIncomplete | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumDefaultIncomplete | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumErrorIfIncomplete | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumPendingIfIncomplete | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf
in the specification.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source #
Create a new PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source #
Defines the enum schema located at paths./v1/customers/{customer}/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf.properties.interval
in the specification.
PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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.
Instances
data PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' Source #
Defines the enum schema located at paths./v1/customers/{customer}/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`.
PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumAlwaysInvoice | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumCreateProrations | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumNone | Represents the JSON value |
Instances
data PostCustomersCustomerSubscriptionsRequestBodyTransferData' Source #
Defines the object schema located at paths./v1/customers/{customer}/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.
Instances
mkPostCustomersCustomerSubscriptionsRequestBodyTransferData' Source #
:: Text |
|
-> PostCustomersCustomerSubscriptionsRequestBodyTransferData' |
Create a new PostCustomersCustomerSubscriptionsRequestBodyTransferData'
with all required fields.
data PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/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`.
PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Now | Represents the JSON value |
PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Int Int |
Instances
data PostCustomersCustomerSubscriptionsResponse Source #
Represents a response of the operation postCustomersCustomerSubscriptions
.
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), PostCustomersCustomerSubscriptionsResponseError
is used.
PostCustomersCustomerSubscriptionsResponseError String | Means either no matching case available or a parse error |
PostCustomersCustomerSubscriptionsResponse200 Subscription | Successful response. |
PostCustomersCustomerSubscriptionsResponseDefault Error | Error response. |