HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.SubscriptionSchedulePhaseConfiguration

Contains the types generated from the schema SubscriptionSchedulePhaseConfiguration

  • 10 types
  • 4 values
  • Packagestripeapi-3.0.0.0
  • Exports14
  • LanguageHaskell2010
  • LicenceMIT
  • SourceSubscriptionSchedulePhaseConfiguration.hs

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

Instances4Eq, Show, FromJSON, ToJSON

Create a new SubscriptionSchedulePhaseConfiguration with all required fields.

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

Instances4Eq, Show, FromJSON, ToJSON

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

Instances4Eq, Show, FromJSON, ToJSON

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

Instances4Eq, Show, FromJSON, ToJSON

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.

Instances4Eq, Show, FromJSON, ToJSON

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.

Instances4Eq, Show, FromJSON, ToJSON

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

Instances4Eq, Show, FromJSON, ToJSON

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

Instances4Eq, Show, FromJSON, ToJSON

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

Instances4Eq, Show, FromJSON, ToJSON

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.

Instances4Eq, Show, FromJSON, ToJSON