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

Contains the types generated from the schema Price

  • 13 types
  • 4 values
datadata Price
#

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

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

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

Related guides: Set up a subscription, create an invoice, and more about products and prices.

Constructors

  • Price
    • priceActive :: Bool

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

    • priceBillingScheme :: PriceBillingScheme'

      billing_scheme: Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices 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.

    • priceCreated :: Int

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

    • priceCurrency :: Text

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

    • priceCustomUnitAmount :: Maybe (Nullable PriceCustomUnitAmount'NonNullable)

      custom_unit_amount: When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

    • priceId :: Text

      id: Unique identifier for the object.

      Constraints:

      • Maximum length of 5000

    • priceLivemode :: Bool

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

    • priceLookupKey :: Maybe (Nullable Text)

      lookup_key: A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

      Constraints:

      • Maximum length of 5000

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

    • priceNickname :: Maybe (Nullable Text)

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

      Constraints:

      • Maximum length of 5000

    • priceProduct :: PriceProduct'Variants

      product: The ID of the product this price is associated with.

    • priceRecurring :: Maybe (Nullable PriceRecurring'NonNullable)

      recurring: The recurring components of a price such as `interval` and `usage_type`.

    • priceTaxBehavior :: Maybe (Nullable PriceTaxBehavior'NonNullable)

      tax_behavior: Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.

    • priceTiers :: Maybe [PriceTier]

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

    • priceTiersMode :: Maybe (Nullable PriceTiersMode'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.

    • priceTransformQuantity :: Maybe (Nullable PriceTransformQuantity'NonNullable)

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

    • priceType :: PriceType'

      type: One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

    • priceUnitAmount :: Maybe (Nullable Int)

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

    • priceUnitAmountDecimal :: Maybe (Nullable Text)

      unit_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`.

Instances4Eq, Show, FromJSON, ToJSON
  • Eq PriceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Price
  • Show PriceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Price
  • FromJSON PriceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Price
  • ToJSON PriceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Price
datadata PriceBillingScheme'
#

Defines the enum schema located at components.schemas.price.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 `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices 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 PriceCustomUnitAmount'NonNullable
#

Defines the object schema located at components.schemas.price.properties.custom_unit_amount.anyOf in the specification.

When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PriceProduct'Variants
#

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

The ID of the product this price is associated with.

Constructors

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

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

The recurring components of a price such as \`interval\` and \`usage_type\`.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PriceRecurring'NonNullableAggregateUsage'NonNullable
#

Defines the enum schema located at components.schemas.price.properties.recurring.anyOf.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 PriceRecurring'NonNullableInterval'
#

Defines the enum schema located at components.schemas.price.properties.recurring.anyOf.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 PriceRecurring'NonNullableUsageType'
#

Defines the enum schema located at components.schemas.price.properties.recurring.anyOf.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
datadata PriceTaxBehavior'NonNullable
#

Defines the enum schema located at components.schemas.price.properties.tax_behavior in the specification.

Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.

Constructors

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

Defines the enum schema located at components.schemas.price.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 PriceTransformQuantity'NonNullable
#

Defines the object schema located at components.schemas.price.properties.transform_quantity.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 PriceTransformQuantity'NonNullableRound'
#

Defines the enum schema located at components.schemas.price.properties.transform_quantity.anyOf.properties.round in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PriceType'
#

Defines the enum schema located at components.schemas.price.properties.type in the specification.

One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

Constructors

Instances4Eq, Show, FromJSON, ToJSON