StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Contains the types generated from the schema SubscriptionSchedulePhaseConfiguration

Documentation

data SubscriptionSchedulePhaseConfiguration

Defines the object schema located at components.schemas.subscription_schedule_phase_configuration in the specification.

A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.

Constructors

SubscriptionSchedulePhaseConfiguration

Fields

• subscriptionSchedulePhaseConfigurationAddInvoiceItems :: [SubscriptionScheduleAddInvoiceItem]

  add_invoice_items: A list of prices and quantities that will generate invoice items appended to the first invoice for this phase.

• subscriptionSchedulePhaseConfigurationApplicationFeePercent :: 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 during this phase of the schedule.

• subscriptionSchedulePhaseConfigurationAutomaticTax :: Maybe SchedulesPhaseAutomaticTax

  automatic_tax:

• subscriptionSchedulePhaseConfigurationBillingCycleAnchor :: Maybe SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'

  billing_cycle_anchor: Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.

• subscriptionSchedulePhaseConfigurationBillingThresholds :: Maybe SubscriptionSchedulePhaseConfigurationBillingThresholds'

  billing_thresholds: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

• subscriptionSchedulePhaseConfigurationCollectionMethod :: Maybe SubscriptionSchedulePhaseConfigurationCollectionMethod'

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

• subscriptionSchedulePhaseConfigurationCoupon :: Maybe SubscriptionSchedulePhaseConfigurationCoupon'Variants

  coupon: ID of the coupon to use during this phase of the subscription schedule.

• subscriptionSchedulePhaseConfigurationDefaultPaymentMethod :: Maybe SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants

  default_payment_method: ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

• subscriptionSchedulePhaseConfigurationDefaultTaxRates :: Maybe [TaxRate]

  default_tax_rates: The default tax rates to apply to the subscription during this phase of the subscription schedule.

• subscriptionSchedulePhaseConfigurationEndDate :: Int

  end_date: The end of this phase of the subscription schedule.

• subscriptionSchedulePhaseConfigurationInvoiceSettings :: Maybe SubscriptionSchedulePhaseConfigurationInvoiceSettings'

  invoice_settings: The invoice settings applicable during this phase.

• subscriptionSchedulePhaseConfigurationItems :: [SubscriptionScheduleConfigurationItem]

  items: Subscription items to configure the subscription to during this phase of the subscription schedule.

• subscriptionSchedulePhaseConfigurationProrationBehavior :: SubscriptionSchedulePhaseConfigurationProrationBehavior'

  proration_behavior: If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.

• subscriptionSchedulePhaseConfigurationStartDate :: Int

  start_date: The start of this phase of the subscription schedule.

• subscriptionSchedulePhaseConfigurationTransferData :: Maybe SubscriptionSchedulePhaseConfigurationTransferData'

  transfer_data: The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.

• subscriptionSchedulePhaseConfigurationTrialEnd :: Maybe Int

  trial_end: When the trial ends within the phase.

Instances

Eq SubscriptionSchedulePhaseConfiguration

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

(==) :: SubscriptionSchedulePhaseConfiguration -> SubscriptionSchedulePhaseConfiguration -> Bool

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

Show SubscriptionSchedulePhaseConfiguration

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfiguration -> ShowS

show :: SubscriptionSchedulePhaseConfiguration -> String

showList :: [SubscriptionSchedulePhaseConfiguration] -> ShowS

ToJSON SubscriptionSchedulePhaseConfiguration

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfiguration -> Value

toEncoding :: SubscriptionSchedulePhaseConfiguration -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfiguration] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfiguration] -> Encoding

FromJSON SubscriptionSchedulePhaseConfiguration

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfiguration

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfiguration]

mkSubscriptionSchedulePhaseConfiguration

Arguments

:: [SubscriptionScheduleAddInvoiceItem]

subscriptionSchedulePhaseConfigurationAddInvoiceItems

-> Int

subscriptionSchedulePhaseConfigurationEndDate

-> [SubscriptionScheduleConfigurationItem]

subscriptionSchedulePhaseConfigurationItems

-> SubscriptionSchedulePhaseConfigurationProrationBehavior'

subscriptionSchedulePhaseConfigurationProrationBehavior

-> Int

subscriptionSchedulePhaseConfigurationStartDate

-> SubscriptionSchedulePhaseConfiguration

Create a new SubscriptionSchedulePhaseConfiguration with all required fields.

data SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'

Defines the enum schema located at components.schemas.subscription_schedule_phase_configuration.properties.billing_cycle_anchor in the specification.

Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.

Constructors

SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'Other Value

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

SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'Typed Text

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

SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'EnumAutomatic

Represents the JSON value "automatic"

SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'EnumPhaseStart

Represents the JSON value "phase_start"

Instances

Eq SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfigurationBillingCycleAnchor' -> ShowS

show :: SubscriptionSchedulePhaseConfigurationBillingCycleAnchor' -> String

showList :: [SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationBillingCycleAnchor' -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationBillingCycleAnchor' -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfigurationBillingCycleAnchor']

data SubscriptionSchedulePhaseConfigurationBillingThresholds'

Defines the object schema located at components.schemas.subscription_schedule_phase_configuration.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

Constructors

SubscriptionSchedulePhaseConfigurationBillingThresholds'

Fields

• subscriptionSchedulePhaseConfigurationBillingThresholds'AmountGte :: Maybe Int

  amount_gte: Monetary threshold that triggers the subscription to create an invoice

• subscriptionSchedulePhaseConfigurationBillingThresholds'ResetBillingCycleAnchor :: Maybe Bool

  reset_billing_cycle_anchor: Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.

Instances

Eq SubscriptionSchedulePhaseConfigurationBillingThresholds'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationBillingThresholds'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfigurationBillingThresholds' -> ShowS

show :: SubscriptionSchedulePhaseConfigurationBillingThresholds' -> String

showList :: [SubscriptionSchedulePhaseConfigurationBillingThresholds'] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationBillingThresholds'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationBillingThresholds' -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationBillingThresholds' -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationBillingThresholds'] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationBillingThresholds'] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationBillingThresholds'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationBillingThresholds'

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfigurationBillingThresholds']

mkSubscriptionSchedulePhaseConfigurationBillingThresholds' :: SubscriptionSchedulePhaseConfigurationBillingThresholds'

Create a new SubscriptionSchedulePhaseConfigurationBillingThresholds' with all required fields.

data SubscriptionSchedulePhaseConfigurationCollectionMethod'

Defines the enum schema located at components.schemas.subscription_schedule_phase_configuration.properties.collection_method in the specification.

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

Constructors

SubscriptionSchedulePhaseConfigurationCollectionMethod'Other Value

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

SubscriptionSchedulePhaseConfigurationCollectionMethod'Typed Text

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

SubscriptionSchedulePhaseConfigurationCollectionMethod'EnumChargeAutomatically

Represents the JSON value "charge_automatically"

SubscriptionSchedulePhaseConfigurationCollectionMethod'EnumSendInvoice

Represents the JSON value "send_invoice"

Instances

Eq SubscriptionSchedulePhaseConfigurationCollectionMethod'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationCollectionMethod'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfigurationCollectionMethod' -> ShowS

show :: SubscriptionSchedulePhaseConfigurationCollectionMethod' -> String

showList :: [SubscriptionSchedulePhaseConfigurationCollectionMethod'] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationCollectionMethod'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationCollectionMethod' -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationCollectionMethod' -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationCollectionMethod'] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationCollectionMethod'] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationCollectionMethod'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationCollectionMethod'

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfigurationCollectionMethod']

data SubscriptionSchedulePhaseConfigurationCoupon'Variants

Defines the oneOf schema located at components.schemas.subscription_schedule_phase_configuration.properties.coupon.anyOf in the specification.

ID of the coupon to use during this phase of the subscription schedule.

Constructors

SubscriptionSchedulePhaseConfigurationCoupon'Text Text

SubscriptionSchedulePhaseConfigurationCoupon'Coupon Coupon

SubscriptionSchedulePhaseConfigurationCoupon'DeletedCoupon DeletedCoupon

Instances

Eq SubscriptionSchedulePhaseConfigurationCoupon'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationCoupon'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

show :: SubscriptionSchedulePhaseConfigurationCoupon'Variants -> String

showList :: [SubscriptionSchedulePhaseConfigurationCoupon'Variants] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationCoupon'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationCoupon'Variants -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationCoupon'Variants -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationCoupon'Variants] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationCoupon'Variants] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationCoupon'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationCoupon'Variants

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

data SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants

Defines the oneOf schema located at components.schemas.subscription_schedule_phase_configuration.properties.default_payment_method.anyOf in the specification.

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

Constructors

SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Text Text

SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'PaymentMethod PaymentMethod

Instances

Eq SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

show :: SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants -> String

showList :: [SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'Variants

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

data SubscriptionSchedulePhaseConfigurationInvoiceSettings'

Defines the object schema located at components.schemas.subscription_schedule_phase_configuration.properties.invoice_settings.anyOf in the specification.

The invoice settings applicable during this phase.

Constructors

SubscriptionSchedulePhaseConfigurationInvoiceSettings'

Fields

• subscriptionSchedulePhaseConfigurationInvoiceSettings'DaysUntilDue :: Maybe Int

  days_until_due: Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.

Instances

Eq SubscriptionSchedulePhaseConfigurationInvoiceSettings'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationInvoiceSettings'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfigurationInvoiceSettings' -> ShowS

show :: SubscriptionSchedulePhaseConfigurationInvoiceSettings' -> String

showList :: [SubscriptionSchedulePhaseConfigurationInvoiceSettings'] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationInvoiceSettings'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationInvoiceSettings' -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationInvoiceSettings' -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationInvoiceSettings'] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationInvoiceSettings'] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationInvoiceSettings'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationInvoiceSettings'

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfigurationInvoiceSettings']

mkSubscriptionSchedulePhaseConfigurationInvoiceSettings' :: SubscriptionSchedulePhaseConfigurationInvoiceSettings'

Create a new SubscriptionSchedulePhaseConfigurationInvoiceSettings' with all required fields.

data SubscriptionSchedulePhaseConfigurationProrationBehavior'

Defines the enum schema located at components.schemas.subscription_schedule_phase_configuration.properties.proration_behavior in the specification.

If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.

Constructors

SubscriptionSchedulePhaseConfigurationProrationBehavior'Other Value

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

SubscriptionSchedulePhaseConfigurationProrationBehavior'Typed Text

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

SubscriptionSchedulePhaseConfigurationProrationBehavior'EnumAlwaysInvoice

Represents the JSON value "always_invoice"

SubscriptionSchedulePhaseConfigurationProrationBehavior'EnumCreateProrations

Represents the JSON value "create_prorations"

SubscriptionSchedulePhaseConfigurationProrationBehavior'EnumNone

Represents the JSON value "none"

Instances

Eq SubscriptionSchedulePhaseConfigurationProrationBehavior'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationProrationBehavior'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfigurationProrationBehavior' -> ShowS

show :: SubscriptionSchedulePhaseConfigurationProrationBehavior' -> String

showList :: [SubscriptionSchedulePhaseConfigurationProrationBehavior'] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationProrationBehavior'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationProrationBehavior' -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationProrationBehavior' -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationProrationBehavior'] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationProrationBehavior'] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationProrationBehavior'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationProrationBehavior'

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfigurationProrationBehavior']

data SubscriptionSchedulePhaseConfigurationTransferData'

Defines the object schema located at components.schemas.subscription_schedule_phase_configuration.properties.transfer_data.anyOf in the specification.

The account (if any) the associated subscription\'s payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription\'s invoices.

Constructors

SubscriptionSchedulePhaseConfigurationTransferData'

Fields

• subscriptionSchedulePhaseConfigurationTransferData'AmountPercent :: Maybe Double

  amount_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 destination account. By default, the entire amount is transferred to the destination.

• subscriptionSchedulePhaseConfigurationTransferData'Destination :: Maybe SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants

  destination: The account where funds from the payment will be transferred to upon payment success.

Instances

Eq SubscriptionSchedulePhaseConfigurationTransferData'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

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

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

Show SubscriptionSchedulePhaseConfigurationTransferData'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfigurationTransferData' -> ShowS

show :: SubscriptionSchedulePhaseConfigurationTransferData' -> String

showList :: [SubscriptionSchedulePhaseConfigurationTransferData'] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationTransferData'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationTransferData' -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationTransferData' -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationTransferData'] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationTransferData'] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationTransferData'

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationTransferData'

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfigurationTransferData']

mkSubscriptionSchedulePhaseConfigurationTransferData' :: SubscriptionSchedulePhaseConfigurationTransferData'

Create a new SubscriptionSchedulePhaseConfigurationTransferData' with all required fields.

data SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants

Defines the oneOf schema located at components.schemas.subscription_schedule_phase_configuration.properties.transfer_data.anyOf.properties.destination.anyOf in the specification.

The account where funds from the payment will be transferred to upon payment success.

Constructors

SubscriptionSchedulePhaseConfigurationTransferData'Destination'Text Text

SubscriptionSchedulePhaseConfigurationTransferData'Destination'Account Account

Instances

Eq SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

(==) :: SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> Bool

(/=) :: SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> Bool

Show SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

showsPrec :: Int -> SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> ShowS

show :: SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> String

showList :: [SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants] -> ShowS

ToJSON SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

toJSON :: SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> Value

toEncoding :: SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants -> Encoding

toJSONList :: [SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants] -> Value

toEncodingList :: [SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants] -> Encoding

FromJSON SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants

Defined in StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Methods

parseJSON :: Value -> Parser SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants

parseJSONList :: Value -> Parser [SubscriptionSchedulePhaseConfigurationTransferData'Destination'Variants]