StripeAPI.Types.Item

Contains the types generated from the schema Item

Documentation

data Item

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

A line item.

Constructors

Item

Fields

• itemAmountSubtotal :: Int

  amount_subtotal: Total before any discounts or taxes are applied.

• itemAmountTotal :: Int

  amount_total: Total after discounts and taxes.

• itemCurrency :: Text

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

• itemDescription :: Text

  description: An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.

  Constraints:

  • Maximum length of 5000
• itemDiscounts :: Maybe [LineItemsDiscountAmount]

  discounts: The discounts applied to the line item.

• itemId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• itemPrice :: Maybe ItemPrice'

  price: The price used to generate the line item.

• itemQuantity :: Maybe Int

  quantity: The quantity of products being purchased.

• itemTaxes :: Maybe [LineItemsTaxAmount]

  taxes: The taxes applied to the line item.

Instances

Eq Item

Defined in StripeAPI.Types.Item

Methods

(==) :: Item -> Item -> Bool

(/=) :: Item -> Item -> Bool

Show Item

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

ToJSON Item

Defined in StripeAPI.Types.Item

Methods

toJSON :: Item -> Value

toEncoding :: Item -> Encoding

toJSONList :: [Item] -> Value

toEncodingList :: [Item] -> Encoding

FromJSON Item

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser Item

parseJSONList :: Value -> Parser [Item]

mkItem

Arguments

:: Int

itemAmountSubtotal

-> Int

itemAmountTotal

-> Text

itemCurrency

-> Text

itemDescription

-> Text

itemId

-> Item

Create a new Item with all required fields.

data ItemPrice'

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

The price used to generate the line item.

Constructors

ItemPrice'

Fields

• itemPrice'Active :: Maybe Bool

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

• itemPrice'BillingScheme :: Maybe ItemPrice'BillingScheme'

  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.

• itemPrice'Created :: Maybe Int

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

• itemPrice'Currency :: Maybe Text

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

• itemPrice'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• itemPrice'Livemode :: Maybe Bool

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

• itemPrice'LookupKey :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• itemPrice'Metadata :: Maybe 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.

• itemPrice'Nickname :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• itemPrice'Object :: Maybe ItemPrice'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• itemPrice'Product :: Maybe ItemPrice'Product'Variants

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

• itemPrice'Recurring :: Maybe ItemPrice'Recurring'

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

• itemPrice'TaxBehavior :: Maybe ItemPrice'TaxBehavior'

  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.

• itemPrice'Tiers :: 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`.

• itemPrice'TiersMode :: Maybe ItemPrice'TiersMode'

  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.

• itemPrice'TransformQuantity :: Maybe ItemPrice'TransformQuantity'

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

• itemPrice'Type :: Maybe ItemPrice'Type'

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

• itemPrice'UnitAmount :: 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`.

• itemPrice'UnitAmountDecimal :: 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

Eq ItemPrice'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice' -> ItemPrice' -> Bool

(/=) :: ItemPrice' -> ItemPrice' -> Bool

Show ItemPrice'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice' -> ShowS

show :: ItemPrice' -> String

showList :: [ItemPrice'] -> ShowS

ToJSON ItemPrice'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice' -> Value

toEncoding :: ItemPrice' -> Encoding

toJSONList :: [ItemPrice'] -> Value

toEncodingList :: [ItemPrice'] -> Encoding

FromJSON ItemPrice'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'

parseJSONList :: Value -> Parser [ItemPrice']

mkItemPrice' :: ItemPrice'

Create a new ItemPrice' with all required fields.

data ItemPrice'BillingScheme'

Defines the enum schema located at components.schemas.item.properties.price.anyOf.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

ItemPrice'BillingScheme'Other Value

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

ItemPrice'BillingScheme'Typed Text

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

ItemPrice'BillingScheme'EnumPerUnit

Represents the JSON value "per_unit"

ItemPrice'BillingScheme'EnumTiered

Represents the JSON value "tiered"

Instances

Eq ItemPrice'BillingScheme'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'BillingScheme' -> ItemPrice'BillingScheme' -> Bool

(/=) :: ItemPrice'BillingScheme' -> ItemPrice'BillingScheme' -> Bool

Show ItemPrice'BillingScheme'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'BillingScheme' -> ShowS

show :: ItemPrice'BillingScheme' -> String

showList :: [ItemPrice'BillingScheme'] -> ShowS

ToJSON ItemPrice'BillingScheme'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'BillingScheme' -> Value

toEncoding :: ItemPrice'BillingScheme' -> Encoding

toJSONList :: [ItemPrice'BillingScheme'] -> Value

toEncodingList :: [ItemPrice'BillingScheme'] -> Encoding

FromJSON ItemPrice'BillingScheme'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'BillingScheme'

parseJSONList :: Value -> Parser [ItemPrice'BillingScheme']

data ItemPrice'Object'

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

String representing the object's type. Objects of the same type share the same value.

Constructors

ItemPrice'Object'Other Value

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

ItemPrice'Object'Typed Text

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

ItemPrice'Object'EnumPrice

Represents the JSON value "price"

Instances

Eq ItemPrice'Object'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'Object' -> ItemPrice'Object' -> Bool

(/=) :: ItemPrice'Object' -> ItemPrice'Object' -> Bool

Show ItemPrice'Object'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'Object' -> ShowS

show :: ItemPrice'Object' -> String

showList :: [ItemPrice'Object'] -> ShowS

ToJSON ItemPrice'Object'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'Object' -> Value

toEncoding :: ItemPrice'Object' -> Encoding

toJSONList :: [ItemPrice'Object'] -> Value

toEncodingList :: [ItemPrice'Object'] -> Encoding

FromJSON ItemPrice'Object'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'Object'

parseJSONList :: Value -> Parser [ItemPrice'Object']

data ItemPrice'Product'Variants

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

The ID of the product this price is associated with.

Constructors

ItemPrice'Product'Text Text

ItemPrice'Product'Product Product

ItemPrice'Product'DeletedProduct DeletedProduct

Instances

Eq ItemPrice'Product'Variants

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'Product'Variants -> ItemPrice'Product'Variants -> Bool

(/=) :: ItemPrice'Product'Variants -> ItemPrice'Product'Variants -> Bool

Show ItemPrice'Product'Variants

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'Product'Variants -> ShowS

show :: ItemPrice'Product'Variants -> String

showList :: [ItemPrice'Product'Variants] -> ShowS

ToJSON ItemPrice'Product'Variants

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'Product'Variants -> Value

toEncoding :: ItemPrice'Product'Variants -> Encoding

toJSONList :: [ItemPrice'Product'Variants] -> Value

toEncodingList :: [ItemPrice'Product'Variants] -> Encoding

FromJSON ItemPrice'Product'Variants

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'Product'Variants

parseJSONList :: Value -> Parser [ItemPrice'Product'Variants]

data ItemPrice'Recurring'

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

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

Constructors

ItemPrice'Recurring'

Fields

• itemPrice'Recurring'AggregateUsage :: Maybe ItemPrice'Recurring'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`.

• itemPrice'Recurring'Interval :: Maybe ItemPrice'Recurring'Interval'

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

• itemPrice'Recurring'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.

• itemPrice'Recurring'UsageType :: Maybe ItemPrice'Recurring'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`.

Instances

Eq ItemPrice'Recurring'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'Recurring' -> ItemPrice'Recurring' -> Bool

(/=) :: ItemPrice'Recurring' -> ItemPrice'Recurring' -> Bool

Show ItemPrice'Recurring'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'Recurring' -> ShowS

show :: ItemPrice'Recurring' -> String

showList :: [ItemPrice'Recurring'] -> ShowS

ToJSON ItemPrice'Recurring'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'Recurring' -> Value

toEncoding :: ItemPrice'Recurring' -> Encoding

toJSONList :: [ItemPrice'Recurring'] -> Value

toEncodingList :: [ItemPrice'Recurring'] -> Encoding

FromJSON ItemPrice'Recurring'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'Recurring'

parseJSONList :: Value -> Parser [ItemPrice'Recurring']

mkItemPrice'Recurring' :: ItemPrice'Recurring'

Create a new ItemPrice'Recurring' with all required fields.

data ItemPrice'Recurring'AggregateUsage'

Defines the enum schema located at components.schemas.item.properties.price.anyOf.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

ItemPrice'Recurring'AggregateUsage'Other Value

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

ItemPrice'Recurring'AggregateUsage'Typed Text

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

ItemPrice'Recurring'AggregateUsage'EnumLastDuringPeriod

Represents the JSON value "last_during_period"

ItemPrice'Recurring'AggregateUsage'EnumLastEver

Represents the JSON value "last_ever"

ItemPrice'Recurring'AggregateUsage'EnumMax

Represents the JSON value "max"

ItemPrice'Recurring'AggregateUsage'EnumSum

Represents the JSON value "sum"

Instances

Eq ItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'Recurring'AggregateUsage' -> ItemPrice'Recurring'AggregateUsage' -> Bool

(/=) :: ItemPrice'Recurring'AggregateUsage' -> ItemPrice'Recurring'AggregateUsage' -> Bool

Show ItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'Recurring'AggregateUsage' -> ShowS

show :: ItemPrice'Recurring'AggregateUsage' -> String

showList :: [ItemPrice'Recurring'AggregateUsage'] -> ShowS

ToJSON ItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'Recurring'AggregateUsage' -> Value

toEncoding :: ItemPrice'Recurring'AggregateUsage' -> Encoding

toJSONList :: [ItemPrice'Recurring'AggregateUsage'] -> Value

toEncodingList :: [ItemPrice'Recurring'AggregateUsage'] -> Encoding

FromJSON ItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'Recurring'AggregateUsage'

parseJSONList :: Value -> Parser [ItemPrice'Recurring'AggregateUsage']

data ItemPrice'Recurring'Interval'

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

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

Constructors

ItemPrice'Recurring'Interval'Other Value

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

ItemPrice'Recurring'Interval'Typed Text

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

ItemPrice'Recurring'Interval'EnumDay

Represents the JSON value "day"

ItemPrice'Recurring'Interval'EnumMonth

Represents the JSON value "month"

ItemPrice'Recurring'Interval'EnumWeek

Represents the JSON value "week"

ItemPrice'Recurring'Interval'EnumYear

Represents the JSON value "year"

Instances

Eq ItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'Recurring'Interval' -> ItemPrice'Recurring'Interval' -> Bool

(/=) :: ItemPrice'Recurring'Interval' -> ItemPrice'Recurring'Interval' -> Bool

Show ItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'Recurring'Interval' -> ShowS

show :: ItemPrice'Recurring'Interval' -> String

showList :: [ItemPrice'Recurring'Interval'] -> ShowS

ToJSON ItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'Recurring'Interval' -> Value

toEncoding :: ItemPrice'Recurring'Interval' -> Encoding

toJSONList :: [ItemPrice'Recurring'Interval'] -> Value

toEncodingList :: [ItemPrice'Recurring'Interval'] -> Encoding

FromJSON ItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'Recurring'Interval'

parseJSONList :: Value -> Parser [ItemPrice'Recurring'Interval']

data ItemPrice'Recurring'UsageType'

Defines the enum schema located at components.schemas.item.properties.price.anyOf.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

ItemPrice'Recurring'UsageType'Other Value

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

ItemPrice'Recurring'UsageType'Typed Text

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

ItemPrice'Recurring'UsageType'EnumLicensed

Represents the JSON value "licensed"

ItemPrice'Recurring'UsageType'EnumMetered

Represents the JSON value "metered"

Instances

Eq ItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'Recurring'UsageType' -> ItemPrice'Recurring'UsageType' -> Bool

(/=) :: ItemPrice'Recurring'UsageType' -> ItemPrice'Recurring'UsageType' -> Bool

Show ItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'Recurring'UsageType' -> ShowS

show :: ItemPrice'Recurring'UsageType' -> String

showList :: [ItemPrice'Recurring'UsageType'] -> ShowS

ToJSON ItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'Recurring'UsageType' -> Value

toEncoding :: ItemPrice'Recurring'UsageType' -> Encoding

toJSONList :: [ItemPrice'Recurring'UsageType'] -> Value

toEncodingList :: [ItemPrice'Recurring'UsageType'] -> Encoding

FromJSON ItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'Recurring'UsageType'

parseJSONList :: Value -> Parser [ItemPrice'Recurring'UsageType']

data ItemPrice'TaxBehavior'

Defines the enum schema located at components.schemas.item.properties.price.anyOf.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

ItemPrice'TaxBehavior'Other Value

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

ItemPrice'TaxBehavior'Typed Text

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

ItemPrice'TaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

ItemPrice'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

ItemPrice'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Eq ItemPrice'TaxBehavior'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'TaxBehavior' -> ItemPrice'TaxBehavior' -> Bool

(/=) :: ItemPrice'TaxBehavior' -> ItemPrice'TaxBehavior' -> Bool

Show ItemPrice'TaxBehavior'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'TaxBehavior' -> ShowS

show :: ItemPrice'TaxBehavior' -> String

showList :: [ItemPrice'TaxBehavior'] -> ShowS

ToJSON ItemPrice'TaxBehavior'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'TaxBehavior' -> Value

toEncoding :: ItemPrice'TaxBehavior' -> Encoding

toJSONList :: [ItemPrice'TaxBehavior'] -> Value

toEncodingList :: [ItemPrice'TaxBehavior'] -> Encoding

FromJSON ItemPrice'TaxBehavior'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'TaxBehavior'

parseJSONList :: Value -> Parser [ItemPrice'TaxBehavior']

data ItemPrice'TiersMode'

Defines the enum schema located at components.schemas.item.properties.price.anyOf.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

ItemPrice'TiersMode'Other Value

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

ItemPrice'TiersMode'Typed Text

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

ItemPrice'TiersMode'EnumGraduated

Represents the JSON value "graduated"

ItemPrice'TiersMode'EnumVolume

Represents the JSON value "volume"

Instances

Eq ItemPrice'TiersMode'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'TiersMode' -> ItemPrice'TiersMode' -> Bool

(/=) :: ItemPrice'TiersMode' -> ItemPrice'TiersMode' -> Bool

Show ItemPrice'TiersMode'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'TiersMode' -> ShowS

show :: ItemPrice'TiersMode' -> String

showList :: [ItemPrice'TiersMode'] -> ShowS

ToJSON ItemPrice'TiersMode'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'TiersMode' -> Value

toEncoding :: ItemPrice'TiersMode' -> Encoding

toJSONList :: [ItemPrice'TiersMode'] -> Value

toEncodingList :: [ItemPrice'TiersMode'] -> Encoding

FromJSON ItemPrice'TiersMode'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'TiersMode'

parseJSONList :: Value -> Parser [ItemPrice'TiersMode']

data ItemPrice'TransformQuantity'

Defines the object schema located at components.schemas.item.properties.price.anyOf.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

ItemPrice'TransformQuantity'

Fields

• itemPrice'TransformQuantity'DivideBy :: Maybe Int

  divide_by: Divide usage by this number.

• itemPrice'TransformQuantity'Round :: Maybe ItemPrice'TransformQuantity'Round'

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

Instances

Eq ItemPrice'TransformQuantity'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'TransformQuantity' -> ItemPrice'TransformQuantity' -> Bool

(/=) :: ItemPrice'TransformQuantity' -> ItemPrice'TransformQuantity' -> Bool

Show ItemPrice'TransformQuantity'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'TransformQuantity' -> ShowS

show :: ItemPrice'TransformQuantity' -> String

showList :: [ItemPrice'TransformQuantity'] -> ShowS

ToJSON ItemPrice'TransformQuantity'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'TransformQuantity' -> Value

toEncoding :: ItemPrice'TransformQuantity' -> Encoding

toJSONList :: [ItemPrice'TransformQuantity'] -> Value

toEncodingList :: [ItemPrice'TransformQuantity'] -> Encoding

FromJSON ItemPrice'TransformQuantity'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'TransformQuantity'

parseJSONList :: Value -> Parser [ItemPrice'TransformQuantity']

mkItemPrice'TransformQuantity' :: ItemPrice'TransformQuantity'

Create a new ItemPrice'TransformQuantity' with all required fields.

data ItemPrice'TransformQuantity'Round'

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

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

Constructors

ItemPrice'TransformQuantity'Round'Other Value

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

ItemPrice'TransformQuantity'Round'Typed Text

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

ItemPrice'TransformQuantity'Round'EnumDown

Represents the JSON value "down"

ItemPrice'TransformQuantity'Round'EnumUp

Represents the JSON value "up"

Instances

Eq ItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'TransformQuantity'Round' -> ItemPrice'TransformQuantity'Round' -> Bool

(/=) :: ItemPrice'TransformQuantity'Round' -> ItemPrice'TransformQuantity'Round' -> Bool

Show ItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'TransformQuantity'Round' -> ShowS

show :: ItemPrice'TransformQuantity'Round' -> String

showList :: [ItemPrice'TransformQuantity'Round'] -> ShowS

ToJSON ItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'TransformQuantity'Round' -> Value

toEncoding :: ItemPrice'TransformQuantity'Round' -> Encoding

toJSONList :: [ItemPrice'TransformQuantity'Round'] -> Value

toEncodingList :: [ItemPrice'TransformQuantity'Round'] -> Encoding

FromJSON ItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'TransformQuantity'Round'

parseJSONList :: Value -> Parser [ItemPrice'TransformQuantity'Round']

data ItemPrice'Type'

Defines the enum schema located at components.schemas.item.properties.price.anyOf.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

ItemPrice'Type'Other Value

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

ItemPrice'Type'Typed Text

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

ItemPrice'Type'EnumOneTime

Represents the JSON value "one_time"

ItemPrice'Type'EnumRecurring

Represents the JSON value "recurring"

Instances

Eq ItemPrice'Type'

Defined in StripeAPI.Types.Item

Methods

(==) :: ItemPrice'Type' -> ItemPrice'Type' -> Bool

(/=) :: ItemPrice'Type' -> ItemPrice'Type' -> Bool

Show ItemPrice'Type'

Defined in StripeAPI.Types.Item

Methods

showsPrec :: Int -> ItemPrice'Type' -> ShowS

show :: ItemPrice'Type' -> String

showList :: [ItemPrice'Type'] -> ShowS

ToJSON ItemPrice'Type'

Defined in StripeAPI.Types.Item

Methods

toJSON :: ItemPrice'Type' -> Value

toEncoding :: ItemPrice'Type' -> Encoding

toJSONList :: [ItemPrice'Type'] -> Value

toEncodingList :: [ItemPrice'Type'] -> Encoding

FromJSON ItemPrice'Type'

Defined in StripeAPI.Types.Item

Methods

parseJSON :: Value -> Parser ItemPrice'Type'

parseJSONList :: Value -> Parser [ItemPrice'Type']