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
SubscriptionSchedulePhaseConfigurationsubscriptionSchedulePhaseConfigurationAddInvoiceItems :: [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 (Nullable 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 SchedulesPhaseAutomaticTaxautomatic_tax:
subscriptionSchedulePhaseConfigurationBillingCycleAnchor :: Maybe (Nullable SubscriptionSchedulePhaseConfigurationBillingCycleAnchor'NonNullable)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 (Nullable SubscriptionSchedulePhaseConfigurationBillingThresholds'NonNullable)billing_thresholds: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
subscriptionSchedulePhaseConfigurationCollectionMethod :: Maybe (Nullable SubscriptionSchedulePhaseConfigurationCollectionMethod'NonNullable)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 (Nullable SubscriptionSchedulePhaseConfigurationCoupon'NonNullableVariants)coupon: ID of the coupon to use during this phase of the subscription schedule.
subscriptionSchedulePhaseConfigurationDefaultPaymentMethod :: Maybe (Nullable SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod'NonNullableVariants)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 (Nullable [TaxRate])default_tax_rates: The default tax rates to apply to the subscription during this phase of the subscription schedule.
subscriptionSchedulePhaseConfigurationEndDate :: Intend_date: The end of this phase of the subscription schedule.
subscriptionSchedulePhaseConfigurationInvoiceSettings :: Maybe (Nullable SubscriptionSchedulePhaseConfigurationInvoiceSettings'NonNullable)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.
subscriptionSchedulePhaseConfigurationMetadata :: Maybe (Nullable Object)metadata: Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
subscriptionSchedulePhaseConfigurationProrationBehavior :: SubscriptionSchedulePhaseConfigurationProrationBehavior'proration_behavior: If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.
subscriptionSchedulePhaseConfigurationStartDate :: Intstart_date: The start of this phase of the subscription schedule.
subscriptionSchedulePhaseConfigurationTransferData :: Maybe (Nullable SubscriptionSchedulePhaseConfigurationTransferData'NonNullable)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 (Nullable Int)trial_end: When the trial ends within the phase.
Instances4Eq, Show, FromJSON, ToJSON
Eq SubscriptionSchedulePhaseConfigurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulePhaseConfigurationShow SubscriptionSchedulePhaseConfigurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulePhaseConfigurationFromJSON SubscriptionSchedulePhaseConfigurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulePhaseConfigurationToJSON SubscriptionSchedulePhaseConfigurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulePhaseConfiguration