StripeAPI.Types.LineItem

Contains the types generated from the schema LineItem

Documentation

data LineItem

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

Constructors

LineItem

Fields

• lineItemAmount :: Int

  amount: The amount, in %s.

• lineItemCurrency :: Text

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

• lineItemDescription :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• lineItemDiscountAmounts :: Maybe [DiscountsResourceDiscountAmount]

  discount_amounts: The amount of discount calculated per discount for this line item.

• lineItemDiscountable :: Bool

  discountable: If true, discounts will apply to this line item. Always false for prorations.

• lineItemDiscounts :: Maybe [LineItemDiscounts'Variants]

  discounts: The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.

• lineItemId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• lineItemInvoiceItem :: Maybe Text

  invoice_item: The ID of the invoice item associated with this line item if any.

  Constraints:

  • Maximum length of 5000
• lineItemLivemode :: Bool

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

• lineItemMetadata :: 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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.

• lineItemPeriod :: InvoiceLineItemPeriod

  period:

• lineItemPrice :: Maybe LineItemPrice'

  price: The price of the line item.

• lineItemProration :: Bool

  proration: Whether this is a proration.

• lineItemQuantity :: Maybe Int

  quantity: The quantity of the subscription, if the line item is a subscription or a proration.

• lineItemSubscription :: Maybe Text

  subscription: The subscription that the invoice item pertains to, if any.

  Constraints:

  • Maximum length of 5000
• lineItemSubscriptionItem :: Maybe Text

  subscription_item: The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.

  Constraints:

  • Maximum length of 5000
• lineItemTaxAmounts :: Maybe [InvoiceTaxAmount]

  tax_amounts: The amount of tax calculated per tax rate for this line item

• lineItemTaxRates :: Maybe [TaxRate]

  tax_rates: The tax rates which apply to the line item.

• lineItemType :: LineItemType'

  type: A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.

Instances

Eq LineItem

Defined in StripeAPI.Types.LineItem

Methods

(==) :: LineItem -> LineItem -> Bool

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

Show LineItem

Defined in StripeAPI.Types.LineItem

Methods

showsPrec :: Int -> LineItem -> ShowS

show :: LineItem -> String

showList :: [LineItem] -> ShowS

ToJSON LineItem

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItem -> Value

toEncoding :: LineItem -> Encoding

toJSONList :: [LineItem] -> Value

toEncodingList :: [LineItem] -> Encoding

FromJSON LineItem

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItem

parseJSONList :: Value -> Parser [LineItem]

mkLineItem

Arguments

:: Int

lineItemAmount

-> Text

lineItemCurrency

-> Bool

lineItemDiscountable

-> Text

lineItemId

-> Bool

lineItemLivemode

-> Object

lineItemMetadata

-> InvoiceLineItemPeriod

lineItemPeriod

-> Bool

lineItemProration

-> LineItemType'

lineItemType

-> LineItem

Create a new LineItem with all required fields.

data LineItemDiscounts'Variants

Defines the oneOf schema located at components.schemas.line_item.properties.discounts.items.anyOf in the specification.

Constructors

LineItemDiscounts'Text Text

LineItemDiscounts'Discount Discount

Instances

Eq LineItemDiscounts'Variants

Defined in StripeAPI.Types.LineItem

Methods

(==) :: LineItemDiscounts'Variants -> LineItemDiscounts'Variants -> Bool

(/=) :: LineItemDiscounts'Variants -> LineItemDiscounts'Variants -> Bool

Show LineItemDiscounts'Variants

Defined in StripeAPI.Types.LineItem

Methods

showsPrec :: Int -> LineItemDiscounts'Variants -> ShowS

show :: LineItemDiscounts'Variants -> String

showList :: [LineItemDiscounts'Variants] -> ShowS

ToJSON LineItemDiscounts'Variants

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemDiscounts'Variants -> Value

toEncoding :: LineItemDiscounts'Variants -> Encoding

toJSONList :: [LineItemDiscounts'Variants] -> Value

toEncodingList :: [LineItemDiscounts'Variants] -> Encoding

FromJSON LineItemDiscounts'Variants

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemDiscounts'Variants

parseJSONList :: Value -> Parser [LineItemDiscounts'Variants]

data LineItemPrice'

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

The price of the line item.

Constructors

LineItemPrice'

Fields

• lineItemPrice'Active :: Maybe Bool

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

• lineItemPrice'BillingScheme :: Maybe LineItemPrice'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.

• lineItemPrice'Created :: Maybe Int

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

• lineItemPrice'Currency :: Maybe Text

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

• lineItemPrice'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• lineItemPrice'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.

• lineItemPrice'LookupKey :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• lineItemPrice'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.

• lineItemPrice'Nickname :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• lineItemPrice'Object :: Maybe LineItemPrice'Object'

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

• lineItemPrice'Product :: Maybe LineItemPrice'Product'Variants

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

• lineItemPrice'Recurring :: Maybe LineItemPrice'Recurring'

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

• lineItemPrice'TaxBehavior :: Maybe LineItemPrice'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.

• lineItemPrice'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`.

• lineItemPrice'TiersMode :: Maybe LineItemPrice'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.

• lineItemPrice'TransformQuantity :: Maybe LineItemPrice'TransformQuantity'

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

• lineItemPrice'Type :: Maybe LineItemPrice'Type'

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

• lineItemPrice'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`.

• lineItemPrice'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 LineItemPrice'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'

Defined in StripeAPI.Types.LineItem

Methods

showsPrec :: Int -> LineItemPrice' -> ShowS

show :: LineItemPrice' -> String

showList :: [LineItemPrice'] -> ShowS

ToJSON LineItemPrice'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice' -> Value

toEncoding :: LineItemPrice' -> Encoding

toJSONList :: [LineItemPrice'] -> Value

toEncodingList :: [LineItemPrice'] -> Encoding

FromJSON LineItemPrice'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'

parseJSONList :: Value -> Parser [LineItemPrice']

mkLineItemPrice' :: LineItemPrice'

Create a new LineItemPrice' with all required fields.

data LineItemPrice'BillingScheme'

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

LineItemPrice'BillingScheme'Other Value

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

LineItemPrice'BillingScheme'Typed Text

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

LineItemPrice'BillingScheme'EnumPerUnit

Represents the JSON value "per_unit"

LineItemPrice'BillingScheme'EnumTiered

Represents the JSON value "tiered"

Instances

Eq LineItemPrice'BillingScheme'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'BillingScheme'

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'BillingScheme' -> String

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

ToJSON LineItemPrice'BillingScheme'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'BillingScheme' -> Value

toEncoding :: LineItemPrice'BillingScheme' -> Encoding

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

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

FromJSON LineItemPrice'BillingScheme'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'BillingScheme'

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

data LineItemPrice'Object'

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

LineItemPrice'Object'Other Value

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

LineItemPrice'Object'Typed Text

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

LineItemPrice'Object'EnumPrice

Represents the JSON value "price"

Instances

Eq LineItemPrice'Object'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'Object'

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'Object' -> String

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

ToJSON LineItemPrice'Object'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'Object' -> Value

toEncoding :: LineItemPrice'Object' -> Encoding

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

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

FromJSON LineItemPrice'Object'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'Object'

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

data LineItemPrice'Product'Variants

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

The ID of the product this price is associated with.

Constructors

LineItemPrice'Product'Text Text

LineItemPrice'Product'Product Product

LineItemPrice'Product'DeletedProduct DeletedProduct

Instances

Eq LineItemPrice'Product'Variants

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'Product'Variants

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'Product'Variants -> String

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

ToJSON LineItemPrice'Product'Variants

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'Product'Variants -> Value

toEncoding :: LineItemPrice'Product'Variants -> Encoding

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

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

FromJSON LineItemPrice'Product'Variants

Defined in StripeAPI.Types.LineItem

Methods

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

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

data LineItemPrice'Recurring'

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

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

Constructors

LineItemPrice'Recurring'

Fields

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

• lineItemPrice'Recurring'Interval :: Maybe LineItemPrice'Recurring'Interval'

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

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

• lineItemPrice'Recurring'UsageType :: Maybe LineItemPrice'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 LineItemPrice'Recurring'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'Recurring'

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'Recurring' -> String

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

ToJSON LineItemPrice'Recurring'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'Recurring' -> Value

toEncoding :: LineItemPrice'Recurring' -> Encoding

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

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

FromJSON LineItemPrice'Recurring'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'Recurring'

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

mkLineItemPrice'Recurring' :: LineItemPrice'Recurring'

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

data LineItemPrice'Recurring'AggregateUsage'

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

LineItemPrice'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.

LineItemPrice'Recurring'AggregateUsage'Typed Text

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

LineItemPrice'Recurring'AggregateUsage'EnumLastDuringPeriod

Represents the JSON value "last_during_period"

LineItemPrice'Recurring'AggregateUsage'EnumLastEver

Represents the JSON value "last_ever"

LineItemPrice'Recurring'AggregateUsage'EnumMax

Represents the JSON value "max"

LineItemPrice'Recurring'AggregateUsage'EnumSum

Represents the JSON value "sum"

Instances

Eq LineItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

ToJSON LineItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

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

FromJSON LineItemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.LineItem

Methods

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

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

data LineItemPrice'Recurring'Interval'

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

LineItemPrice'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.

LineItemPrice'Recurring'Interval'Typed Text

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

LineItemPrice'Recurring'Interval'EnumDay

Represents the JSON value "day"

LineItemPrice'Recurring'Interval'EnumMonth

Represents the JSON value "month"

LineItemPrice'Recurring'Interval'EnumWeek

Represents the JSON value "week"

LineItemPrice'Recurring'Interval'EnumYear

Represents the JSON value "year"

Instances

Eq LineItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

ToJSON LineItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

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

FromJSON LineItemPrice'Recurring'Interval'

Defined in StripeAPI.Types.LineItem

Methods

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

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

data LineItemPrice'Recurring'UsageType'

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

LineItemPrice'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.

LineItemPrice'Recurring'UsageType'Typed Text

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

LineItemPrice'Recurring'UsageType'EnumLicensed

Represents the JSON value "licensed"

LineItemPrice'Recurring'UsageType'EnumMetered

Represents the JSON value "metered"

Instances

Eq LineItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

ToJSON LineItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

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

FromJSON LineItemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.LineItem

Methods

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

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

data LineItemPrice'TaxBehavior'

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

LineItemPrice'TaxBehavior'Other Value

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

LineItemPrice'TaxBehavior'Typed Text

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

LineItemPrice'TaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

LineItemPrice'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

LineItemPrice'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Eq LineItemPrice'TaxBehavior'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'TaxBehavior'

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'TaxBehavior' -> String

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

ToJSON LineItemPrice'TaxBehavior'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'TaxBehavior' -> Value

toEncoding :: LineItemPrice'TaxBehavior' -> Encoding

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

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

FromJSON LineItemPrice'TaxBehavior'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'TaxBehavior'

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

data LineItemPrice'TiersMode'

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

LineItemPrice'TiersMode'Other Value

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

LineItemPrice'TiersMode'Typed Text

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

LineItemPrice'TiersMode'EnumGraduated

Represents the JSON value "graduated"

LineItemPrice'TiersMode'EnumVolume

Represents the JSON value "volume"

Instances

Eq LineItemPrice'TiersMode'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'TiersMode'

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'TiersMode' -> String

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

ToJSON LineItemPrice'TiersMode'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'TiersMode' -> Value

toEncoding :: LineItemPrice'TiersMode' -> Encoding

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

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

FromJSON LineItemPrice'TiersMode'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'TiersMode'

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

data LineItemPrice'TransformQuantity'

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

LineItemPrice'TransformQuantity'

Fields

• lineItemPrice'TransformQuantity'DivideBy :: Maybe Int

  divide_by: Divide usage by this number.

• lineItemPrice'TransformQuantity'Round :: Maybe LineItemPrice'TransformQuantity'Round'

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

Instances

Eq LineItemPrice'TransformQuantity'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'TransformQuantity'

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'TransformQuantity' -> String

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

ToJSON LineItemPrice'TransformQuantity'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'TransformQuantity' -> Value

toEncoding :: LineItemPrice'TransformQuantity' -> Encoding

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

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

FromJSON LineItemPrice'TransformQuantity'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'TransformQuantity'

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

mkLineItemPrice'TransformQuantity' :: LineItemPrice'TransformQuantity'

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

data LineItemPrice'TransformQuantity'Round'

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

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

Constructors

LineItemPrice'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.

LineItemPrice'TransformQuantity'Round'Typed Text

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

LineItemPrice'TransformQuantity'Round'EnumDown

Represents the JSON value "down"

LineItemPrice'TransformQuantity'Round'EnumUp

Represents the JSON value "up"

Instances

Eq LineItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

ToJSON LineItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.LineItem

Methods

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

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

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

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

FromJSON LineItemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.LineItem

Methods

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

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

data LineItemPrice'Type'

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

LineItemPrice'Type'Other Value

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

LineItemPrice'Type'Typed Text

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

LineItemPrice'Type'EnumOneTime

Represents the JSON value "one_time"

LineItemPrice'Type'EnumRecurring

Represents the JSON value "recurring"

Instances

Eq LineItemPrice'Type'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemPrice'Type'

Defined in StripeAPI.Types.LineItem

Methods

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

show :: LineItemPrice'Type' -> String

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

ToJSON LineItemPrice'Type'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemPrice'Type' -> Value

toEncoding :: LineItemPrice'Type' -> Encoding

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

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

FromJSON LineItemPrice'Type'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemPrice'Type'

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

data LineItemType'

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

A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.

Constructors

LineItemType'Other Value

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

LineItemType'Typed Text

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

LineItemType'EnumInvoiceitem

Represents the JSON value "invoiceitem"

LineItemType'EnumSubscription

Represents the JSON value "subscription"

Instances

Eq LineItemType'

Defined in StripeAPI.Types.LineItem

Methods

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

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

Show LineItemType'

Defined in StripeAPI.Types.LineItem

Methods

showsPrec :: Int -> LineItemType' -> ShowS

show :: LineItemType' -> String

showList :: [LineItemType'] -> ShowS

ToJSON LineItemType'

Defined in StripeAPI.Types.LineItem

Methods

toJSON :: LineItemType' -> Value

toEncoding :: LineItemType' -> Encoding

toJSONList :: [LineItemType'] -> Value

toEncodingList :: [LineItemType'] -> Encoding

FromJSON LineItemType'

Defined in StripeAPI.Types.LineItem

Methods

parseJSON :: Value -> Parser LineItemType'

parseJSONList :: Value -> Parser [LineItemType']