StripeAPI.Operations.PostCustomersCustomerSubscriptions

Contains the different functions to run the operation postCustomersCustomerSubscriptions

Documentation

postCustomersCustomerSubscriptions

Arguments

:: 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

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

Constructors

PostCustomersCustomerSubscriptionsRequestBody

Fields

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems :: Maybe [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems']

  add_invoice_items: A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items.

• postCustomersCustomerSubscriptionsRequestBodyApplicationFeePercent :: Maybe Double

  application_fee_percent: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.

• postCustomersCustomerSubscriptionsRequestBodyAutomaticTax :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

  automatic_tax: Automatic tax settings for this subscription.

• postCustomersCustomerSubscriptionsRequestBodyBackdateStartDate :: Maybe Int

  backdate_start_date: For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.

• postCustomersCustomerSubscriptionsRequestBodyBillingCycleAnchor :: Maybe Int

  billing_cycle_anchor: A future timestamp to anchor the subscription's billing cycle. This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices.

• postCustomersCustomerSubscriptionsRequestBodyBillingThresholds :: Maybe PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants

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

• postCustomersCustomerSubscriptionsRequestBodyCancelAt :: Maybe Int

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

• postCustomersCustomerSubscriptionsRequestBodyCancelAtPeriodEnd :: Maybe Bool

  cancel_at_period_end: Boolean indicating whether this subscription should cancel at the end of the current period.

• postCustomersCustomerSubscriptionsRequestBodyCollectionMethod :: Maybe PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'

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

• postCustomersCustomerSubscriptionsRequestBodyCoupon :: Maybe Text

  coupon: The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyDaysUntilDue :: Maybe Int

  days_until_due: Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.

• postCustomersCustomerSubscriptionsRequestBodyDefaultPaymentMethod :: Maybe Text

  default_payment_method: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyDefaultSource :: Maybe Text

  default_source: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates :: Maybe PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants

  default_tax_rates: The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.

• postCustomersCustomerSubscriptionsRequestBodyExpand :: Maybe [Text]

  expand: Specifies which fields in the response should be expanded.

• postCustomersCustomerSubscriptionsRequestBodyItems :: Maybe [PostCustomersCustomerSubscriptionsRequestBodyItems']

  items: A list of up to 20 subscription items, each with an attached price.

• postCustomersCustomerSubscriptionsRequestBodyMetadata :: Maybe PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants

  metadata: 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`.

• postCustomersCustomerSubscriptionsRequestBodyOffSession :: Maybe Bool

  off_session: Indicates if a customer is on or off-session while an invoice payment is attempted.

• postCustomersCustomerSubscriptionsRequestBodyPaymentBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'

  payment_behavior: 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.

• postCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval :: Maybe PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants

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

• postCustomersCustomerSubscriptionsRequestBodyPromotionCode :: Maybe Text

  promotion_code: The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyProrationBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'

  proration_behavior: 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`.

• postCustomersCustomerSubscriptionsRequestBodyTransferData :: Maybe PostCustomersCustomerSubscriptionsRequestBodyTransferData'

  transfer_data: 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.

• postCustomersCustomerSubscriptionsRequestBodyTrialEnd :: Maybe PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants

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

• postCustomersCustomerSubscriptionsRequestBodyTrialFromPlan :: Maybe Bool

  trial_from_plan: Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed.

• postCustomersCustomerSubscriptionsRequestBodyTrialPeriodDays :: Maybe Int

  trial_period_days: Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan.

Instances

Eq PostCustomersCustomerSubscriptionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBody -> PostCustomersCustomerSubscriptionsRequestBody -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBody -> PostCustomersCustomerSubscriptionsRequestBody -> Bool

Show PostCustomersCustomerSubscriptionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBody -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBody -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBody] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBody -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBody -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBody] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBody] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBody

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBody]

mkPostCustomersCustomerSubscriptionsRequestBody :: PostCustomersCustomerSubscriptionsRequestBody

Create a new PostCustomersCustomerSubscriptionsRequestBody with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

Fields

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'Price :: Maybe Text

  price

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

  price_data

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'Quantity :: Maybe Int

  quantity

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants

  tax_rates

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems']

mkPostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'

Create a new PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems' with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

Fields

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'Currency :: Text

  currency

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'Product :: Text

  product

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'

  tax_behavior

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'UnitAmount :: Maybe Int

  unit_amount

• postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'UnitAmountDecimal :: Maybe Text

  unit_amount_decimal

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData']

mkPostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

Arguments

:: Text

postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'Currency

-> Text

postCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'Product

-> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'

Create a new PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData' with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'

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.

Constructors

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 "exclusive"

PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior']

data PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'EmptyString

Represents the JSON value ""

PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'ListTText [Text]

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants]

data PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

Fields

• postCustomersCustomerSubscriptionsRequestBodyAutomaticTax'Enabled :: Bool

  enabled

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax']

mkPostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

Arguments

:: Bool

postCustomersCustomerSubscriptionsRequestBodyAutomaticTax'Enabled

-> PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax'

Create a new PostCustomersCustomerSubscriptionsRequestBodyAutomaticTax' with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

Fields

• postCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1AmountGte :: Maybe Int

  amount_gte

• postCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1ResetBillingCycleAnchor :: Maybe Bool

  reset_billing_cycle_anchor

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1]

mkPostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

Create a new PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'EmptyString

Represents the JSON value ""

PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1 PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'OneOf1

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyBillingThresholds'Variants]

data PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'

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`.

Constructors

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 "charge_automatically"

PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'EnumSendInvoice

Represents the JSON value "send_invoice"

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyCollectionMethod']

data PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'EmptyString

Represents the JSON value ""

PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'ListTText [Text]

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyDefaultTaxRates'Variants]

data PostCustomersCustomerSubscriptionsRequestBodyItems'

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyItems'

Fields

• postCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants

  billing_thresholds

• postCustomersCustomerSubscriptionsRequestBodyItems'Metadata :: Maybe Object

  metadata

• postCustomersCustomerSubscriptionsRequestBodyItems'Price :: Maybe Text

  price

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

  price_data

• postCustomersCustomerSubscriptionsRequestBodyItems'Quantity :: Maybe Int

  quantity

• postCustomersCustomerSubscriptionsRequestBodyItems'TaxRates :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants

  tax_rates

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems' -> PostCustomersCustomerSubscriptionsRequestBodyItems' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems' -> PostCustomersCustomerSubscriptionsRequestBodyItems' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems']

mkPostCustomersCustomerSubscriptionsRequestBodyItems' :: PostCustomersCustomerSubscriptionsRequestBodyItems'

Create a new PostCustomersCustomerSubscriptionsRequestBodyItems' with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Fields

• postCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1UsageGte :: Int

  usage_gte

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1]

mkPostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Arguments

:: Int

postCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1UsageGte

-> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Create a new PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'EmptyString

Represents the JSON value ""

PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'OneOf1

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems'BillingThresholds'Variants]

data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

Fields

• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Currency :: Text

  currency

• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Product :: Text

  product

  Constraints:

  • Maximum length of 5000
• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

  recurring

• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior :: Maybe PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'

  tax_behavior

• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'UnitAmount :: Maybe Int

  unit_amount

• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'UnitAmountDecimal :: Maybe Text

  unit_amount_decimal

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData']

mkPostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

Arguments

:: Text

postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Currency

-> Text

postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Product

-> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring

-> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'

Create a new PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData' with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

Fields

• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

  interval

• postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'IntervalCount :: Maybe Int

  interval_count

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring']

mkPostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

Arguments

:: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

postCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval

-> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'

Create a new PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring' with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

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.

Constructors

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 "day"

PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumMonth

Represents the JSON value "month"

PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumWeek

Represents the JSON value "week"

PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumYear

Represents the JSON value "year"

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'Recurring'Interval']

data PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'

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.

Constructors

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 "exclusive"

PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems'PriceData'TaxBehavior']

data PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'EmptyString

Represents the JSON value ""

PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'ListTText [Text]

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyItems'TaxRates'Variants]

data PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants

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`.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostCustomersCustomerSubscriptionsRequestBodyMetadata'Object Object

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyMetadata'Variants]

data PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'

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.

Constructors

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 "allow_incomplete"

PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumDefaultIncomplete

Represents the JSON value "default_incomplete"

PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumErrorIfIncomplete

Represents the JSON value "error_if_incomplete"

PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'EnumPendingIfIncomplete

Represents the JSON value "pending_if_incomplete"

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyPaymentBehavior']

data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Fields

• postCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

  interval

• postCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1IntervalCount :: Maybe Int

  interval_count

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1]

mkPostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Arguments

:: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

postCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval

-> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Create a new PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

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.

Constructors

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 "day"

PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth

Represents the JSON value "month"

PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek

Represents the JSON value "week"

PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear

Represents the JSON value "year"

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval']

data PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'EmptyString

Represents the JSON value ""

PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants]

data PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'

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`.

Constructors

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 "always_invoice"

PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumCreateProrations

Represents the JSON value "create_prorations"

PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'EnumNone

Represents the JSON value "none"

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyProrationBehavior']

data PostCustomersCustomerSubscriptionsRequestBodyTransferData'

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.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyTransferData'

Fields

• postCustomersCustomerSubscriptionsRequestBodyTransferData'AmountPercent :: Maybe Double

  amount_percent

• postCustomersCustomerSubscriptionsRequestBodyTransferData'Destination :: Text

  destination

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyTransferData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyTransferData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyTransferData'] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyTransferData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyTransferData' -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyTransferData'] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyTransferData'] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyTransferData'

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyTransferData'

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyTransferData']

mkPostCustomersCustomerSubscriptionsRequestBodyTransferData'

Arguments

:: Text

postCustomersCustomerSubscriptionsRequestBodyTransferData'Destination

-> PostCustomersCustomerSubscriptionsRequestBodyTransferData'

Create a new PostCustomersCustomerSubscriptionsRequestBodyTransferData' with all required fields.

data PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants

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`.

Constructors

PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Now

Represents the JSON value "now"

PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Int Int

Instances

Eq PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> Bool

(/=) :: PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> Bool

Show PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> ShowS

show :: PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> String

showList :: [PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants] -> ShowS

ToJSON PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

toJSON :: PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> Value

toEncoding :: PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants -> Encoding

toJSONList :: [PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants] -> Value

toEncodingList :: [PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants] -> Encoding

FromJSON PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants

parseJSONList :: Value -> Parser [PostCustomersCustomerSubscriptionsRequestBodyTrialEnd'Variants]

data PostCustomersCustomerSubscriptionsResponse

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.

Constructors

PostCustomersCustomerSubscriptionsResponseError String

Means either no matching case available or a parse error

PostCustomersCustomerSubscriptionsResponse200 Subscription

Successful response.

PostCustomersCustomerSubscriptionsResponseDefault Error

Error response.

Instances

Eq PostCustomersCustomerSubscriptionsResponse

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

(==) :: PostCustomersCustomerSubscriptionsResponse -> PostCustomersCustomerSubscriptionsResponse -> Bool

(/=) :: PostCustomersCustomerSubscriptionsResponse -> PostCustomersCustomerSubscriptionsResponse -> Bool

Show PostCustomersCustomerSubscriptionsResponse

Defined in StripeAPI.Operations.PostCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> PostCustomersCustomerSubscriptionsResponse -> ShowS

show :: PostCustomersCustomerSubscriptionsResponse -> String

showList :: [PostCustomersCustomerSubscriptionsResponse] -> ShowS