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

Contains the types generated from the schema Plan

  • 9 types
  • 2 values
datadata Plan
#

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

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.

Related guides: Set up a subscription and more about products and prices.

Constructors

  • Plan
    • planActive :: Bool

      active: Whether the plan can be used for new purchases.

    • planAggregateUsage :: Maybe (Nullable PlanAggregateUsage'NonNullable)

      aggregate_usage: Specifies a usage aggregation strategy for plans 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`.

    • planAmount :: Maybe (Nullable Int)

      amount: The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.

    • planAmountDecimal :: Maybe (Nullable Text)

      amount_decimal: The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.

    • planBillingScheme :: PlanBillingScheme'

      billing_scheme: Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.

    • planCreated :: Int

      created: Time at which the object was created. Measured in seconds since the Unix epoch.

    • planCurrency :: Text

      currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • planId :: Text

      id: Unique identifier for the object.

      Constraints:

      • Maximum length of 5000

    • planInterval :: PlanInterval'

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

    • planIntervalCount :: 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.

    • planLivemode :: Bool

      livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

    • planMetadata :: Maybe (Nullable Object)

      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.

    • planNickname :: Maybe (Nullable Text)

      nickname: A brief description of the plan, hidden from customers.

      Constraints:

      • Maximum length of 5000

    • planProduct :: Maybe (Nullable PlanProduct'NonNullableVariants)

      product: The product whose pricing this plan determines.

    • planTiers :: Maybe [PlanTier]

      tiers: Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.

    • planTiersMode :: Maybe (Nullable PlanTiersMode'NonNullable)

      tiers_mode: Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.

    • planTransformUsage :: Maybe (Nullable PlanTransformUsage'NonNullable)

      transform_usage: Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.

    • planTrialPeriodDays :: Maybe (Nullable Int)

      trial_period_days: Default number of trial days when subscribing a customer to this plan using `trial_from_plan=true`.

    • planUsageType :: PlanUsageType'

      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 PlanDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Plan
  • Show PlanDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Plan
  • FromJSON PlanDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Plan
  • ToJSON PlanDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Plan
datadata PlanAggregateUsage'NonNullable
#

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

Specifies a usage aggregation strategy for plans 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 PlanBillingScheme'
#

Defines the enum schema located at components.schemas.plan.properties.billing_scheme in the specification.

Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PlanInterval'
#

Defines the enum schema located at components.schemas.plan.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 PlanProduct'NonNullableVariants
#

Defines the oneOf schema located at components.schemas.plan.properties.product.anyOf in the specification.

The product whose pricing this plan determines.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PlanTiersMode'NonNullable
#

Defines the enum schema located at components.schemas.plan.properties.tiers_mode in the specification.

Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PlanTransformUsage'NonNullable
#

Defines the object schema located at components.schemas.plan.properties.transform_usage.anyOf in the specification.

Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with \`tiers\`.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PlanTransformUsage'NonNullableRound'
#

Defines the enum schema located at components.schemas.plan.properties.transform_usage.anyOf.properties.round in the specification.

After division, either round the result `up` or `down`.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PlanUsageType'
#

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