stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.Price

Description

Contains the types generated from the schema Price

Synopsis

Documentation

data Price Source #

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 

Fields

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

  • 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 Text

    lookup_key: A lookup key used to retrieve prices dynamically from a static string.

    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 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 PriceRecurring'

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

  • priceTaxBehavior :: Maybe PriceTaxBehavior'

    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 PriceTiersMode'

    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 PriceTransformQuantity'

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

Instances

Instances details
Eq Price Source # 
Instance details

Defined in StripeAPI.Types.Price

Methods

(==) :: Price -> Price -> Bool #

(/=) :: Price -> Price -> Bool #

Show Price Source # 
Instance details

Defined in StripeAPI.Types.Price

Methods

showsPrec :: Int -> Price -> ShowS #

show :: Price -> String #

showList :: [Price] -> ShowS #

ToJSON Price Source # 
Instance details

Defined in StripeAPI.Types.Price

FromJSON Price Source # 
Instance details

Defined in StripeAPI.Types.Price

data PriceBillingScheme' Source #

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

PriceBillingScheme'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceBillingScheme'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceBillingScheme'EnumPerUnit

Represents the JSON value "per_unit"

PriceBillingScheme'EnumTiered

Represents the JSON value "tiered"

data PriceRecurring' Source #

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

PriceRecurring' 

Fields

  • priceRecurring'AggregateUsage :: Maybe PriceRecurring'AggregateUsage'

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

  • priceRecurring'Interval :: Maybe PriceRecurring'Interval'

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

  • priceRecurring'IntervalCount :: Maybe 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.

  • priceRecurring'UsageType :: Maybe PriceRecurring'UsageType'

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

mkPriceRecurring' :: PriceRecurring' Source #

Create a new PriceRecurring' with all required fields.

data PriceRecurring'AggregateUsage' Source #

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

PriceRecurring'AggregateUsage'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceRecurring'AggregateUsage'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceRecurring'AggregateUsage'EnumLastDuringPeriod

Represents the JSON value "last_during_period"

PriceRecurring'AggregateUsage'EnumLastEver

Represents the JSON value "last_ever"

PriceRecurring'AggregateUsage'EnumMax

Represents the JSON value "max"

PriceRecurring'AggregateUsage'EnumSum

Represents the JSON value "sum"

data PriceRecurring'Interval' Source #

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

PriceRecurring'Interval'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceRecurring'Interval'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceRecurring'Interval'EnumDay

Represents the JSON value "day"

PriceRecurring'Interval'EnumMonth

Represents the JSON value "month"

PriceRecurring'Interval'EnumWeek

Represents the JSON value "week"

PriceRecurring'Interval'EnumYear

Represents the JSON value "year"

data PriceRecurring'UsageType' Source #

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

PriceRecurring'UsageType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceRecurring'UsageType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceRecurring'UsageType'EnumLicensed

Represents the JSON value "licensed"

PriceRecurring'UsageType'EnumMetered

Represents the JSON value "metered"

data PriceTaxBehavior' Source #

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

PriceTaxBehavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceTaxBehavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceTaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

PriceTaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

PriceTaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

data PriceTiersMode' Source #

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

PriceTiersMode'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceTiersMode'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceTiersMode'EnumGraduated

Represents the JSON value "graduated"

PriceTiersMode'EnumVolume

Represents the JSON value "volume"

data PriceTransformQuantity' Source #

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

PriceTransformQuantity' 

Fields

data PriceTransformQuantity'Round' Source #

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

PriceTransformQuantity'Round'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceTransformQuantity'Round'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceTransformQuantity'Round'EnumDown

Represents the JSON value "down"

PriceTransformQuantity'Round'EnumUp

Represents the JSON value "up"

data PriceType' Source #

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

PriceType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PriceType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PriceType'EnumOneTime

Represents the JSON value "one_time"

PriceType'EnumRecurring

Represents the JSON value "recurring"