HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Recurring

Contains the types generated from the schema Recurring

  • 4 types
  • 1 value
datadata Recurring
#

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

Constructors

  • Recurring
    • recurringAggregateUsage :: Maybe (Nullable RecurringAggregateUsage'NonNullable)

      aggregate_usage: Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.

    • recurringInterval :: RecurringInterval'

      interval: The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.

    • recurringIntervalCount :: Int

      interval_count: The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.

    • recurringUsageType :: RecurringUsageType'

      usage_type: Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.

Instances4Eq, Show, FromJSON, ToJSON
  • Eq RecurringDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recurring
  • Show RecurringDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recurring
  • FromJSON RecurringDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recurring
  • ToJSON RecurringDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recurring
datadata RecurringAggregateUsage'NonNullable
#

Defines the enum schema located at components.schemas.recurring.properties.aggregate_usage in the specification.

Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata RecurringInterval'
#

Defines the enum schema located at components.schemas.recurring.properties.interval in the specification.

The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata RecurringUsageType'
#

Defines the enum schema located at components.schemas.recurring.properties.usage_type in the specification.

Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.

Constructors

Instances4Eq, Show, FromJSON, ToJSON