StripeAPI.Types.Invoiceitem

Contains the types generated from the schema Invoiceitem

Documentation

data Invoiceitem

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

Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.

Related guide: Subscription Invoices.

Constructors

Invoiceitem

Fields

• invoiceitemAmount :: Int

  amount: Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.

• invoiceitemCurrency :: Text

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

• invoiceitemCustomer :: InvoiceitemCustomer'Variants

  customer: The ID of the customer who will be billed when this invoice item is billed.

• invoiceitemDate :: Int

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

• invoiceitemDescription :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• invoiceitemDiscountable :: Bool

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

• invoiceitemDiscounts :: Maybe [InvoiceitemDiscounts'Variants]

  discounts: The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.

• invoiceitemId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• invoiceitemInvoice :: Maybe InvoiceitemInvoice'Variants

  invoice: The ID of the invoice this invoice item belongs to.

• invoiceitemLivemode :: Bool

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

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

• invoiceitemPeriod :: InvoiceLineItemPeriod

  period:

• invoiceitemPrice :: Maybe InvoiceitemPrice'

  price: The price of the invoice item.

• invoiceitemProration :: Bool

  proration: Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.

• invoiceitemQuantity :: Int

  quantity: Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.

• invoiceitemSubscription :: Maybe InvoiceitemSubscription'Variants

  subscription: The subscription that this invoice item has been created for, if any.

• invoiceitemSubscriptionItem :: Maybe Text

  subscription_item: The subscription item that this invoice item has been created for, if any.

  Constraints:

  • Maximum length of 5000
• invoiceitemTaxRates :: Maybe [TaxRate]

  tax_rates: The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.

• invoiceitemUnitAmount :: Maybe Int

  unit_amount: Unit amount (in the `currency` specified) of the invoice item.

• invoiceitemUnitAmountDecimal :: Maybe Text

  unit_amount_decimal: Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.

Instances

Eq Invoiceitem

Defined in StripeAPI.Types.Invoiceitem

Methods

(==) :: Invoiceitem -> Invoiceitem -> Bool

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

Show Invoiceitem

Defined in StripeAPI.Types.Invoiceitem

Methods

showsPrec :: Int -> Invoiceitem -> ShowS

show :: Invoiceitem -> String

showList :: [Invoiceitem] -> ShowS

ToJSON Invoiceitem

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: Invoiceitem -> Value

toEncoding :: Invoiceitem -> Encoding

toJSONList :: [Invoiceitem] -> Value

toEncodingList :: [Invoiceitem] -> Encoding

FromJSON Invoiceitem

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser Invoiceitem

parseJSONList :: Value -> Parser [Invoiceitem]

mkInvoiceitem

Arguments

:: Int

invoiceitemAmount

-> Text

invoiceitemCurrency

-> InvoiceitemCustomer'Variants

invoiceitemCustomer

-> Int

invoiceitemDate

-> Bool

invoiceitemDiscountable

-> Text

invoiceitemId

-> Bool

invoiceitemLivemode

-> InvoiceLineItemPeriod

invoiceitemPeriod

-> Bool

invoiceitemProration

-> Int

invoiceitemQuantity

-> Invoiceitem

Create a new Invoiceitem with all required fields.

data InvoiceitemCustomer'Variants

Defines the oneOf schema located at components.schemas.invoiceitem.properties.customer.anyOf in the specification.

The ID of the customer who will be billed when this invoice item is billed.

Constructors

InvoiceitemCustomer'Text Text

InvoiceitemCustomer'Customer Customer

InvoiceitemCustomer'DeletedCustomer DeletedCustomer

Instances

Eq InvoiceitemCustomer'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemCustomer'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemCustomer'Variants -> String

showList :: [InvoiceitemCustomer'Variants] -> ShowS

ToJSON InvoiceitemCustomer'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemCustomer'Variants -> Value

toEncoding :: InvoiceitemCustomer'Variants -> Encoding

toJSONList :: [InvoiceitemCustomer'Variants] -> Value

toEncodingList :: [InvoiceitemCustomer'Variants] -> Encoding

FromJSON InvoiceitemCustomer'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemCustomer'Variants

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

data InvoiceitemDiscounts'Variants

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

Constructors

InvoiceitemDiscounts'Text Text

InvoiceitemDiscounts'Discount Discount

Instances

Eq InvoiceitemDiscounts'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemDiscounts'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemDiscounts'Variants -> String

showList :: [InvoiceitemDiscounts'Variants] -> ShowS

ToJSON InvoiceitemDiscounts'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemDiscounts'Variants -> Value

toEncoding :: InvoiceitemDiscounts'Variants -> Encoding

toJSONList :: [InvoiceitemDiscounts'Variants] -> Value

toEncodingList :: [InvoiceitemDiscounts'Variants] -> Encoding

FromJSON InvoiceitemDiscounts'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemDiscounts'Variants

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

data InvoiceitemInvoice'Variants

Defines the oneOf schema located at components.schemas.invoiceitem.properties.invoice.anyOf in the specification.

The ID of the invoice this invoice item belongs to.

Constructors

InvoiceitemInvoice'Text Text

InvoiceitemInvoice'Invoice Invoice

Instances

Eq InvoiceitemInvoice'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemInvoice'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemInvoice'Variants -> String

showList :: [InvoiceitemInvoice'Variants] -> ShowS

ToJSON InvoiceitemInvoice'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemInvoice'Variants -> Value

toEncoding :: InvoiceitemInvoice'Variants -> Encoding

toJSONList :: [InvoiceitemInvoice'Variants] -> Value

toEncodingList :: [InvoiceitemInvoice'Variants] -> Encoding

FromJSON InvoiceitemInvoice'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemInvoice'Variants

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

data InvoiceitemPrice'

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

The price of the invoice item.

Constructors

InvoiceitemPrice'

Fields

• invoiceitemPrice'Active :: Maybe Bool

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

• invoiceitemPrice'BillingScheme :: Maybe InvoiceitemPrice'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.

• invoiceitemPrice'Created :: Maybe Int

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

• invoiceitemPrice'Currency :: Maybe Text

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

• invoiceitemPrice'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

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

• invoiceitemPrice'LookupKey :: Maybe Text

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

  Constraints:

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

• invoiceitemPrice'Nickname :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• invoiceitemPrice'Object :: Maybe InvoiceitemPrice'Object'

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

• invoiceitemPrice'Product :: Maybe InvoiceitemPrice'Product'Variants

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

• invoiceitemPrice'Recurring :: Maybe InvoiceitemPrice'Recurring'

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

• invoiceitemPrice'TaxBehavior :: Maybe InvoiceitemPrice'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.

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

• invoiceitemPrice'TiersMode :: Maybe InvoiceitemPrice'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.

• invoiceitemPrice'TransformQuantity :: Maybe InvoiceitemPrice'TransformQuantity'

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

• invoiceitemPrice'Type :: Maybe InvoiceitemPrice'Type'

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

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

• invoiceitemPrice'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 InvoiceitemPrice'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'

Defined in StripeAPI.Types.Invoiceitem

Methods

showsPrec :: Int -> InvoiceitemPrice' -> ShowS

show :: InvoiceitemPrice' -> String

showList :: [InvoiceitemPrice'] -> ShowS

ToJSON InvoiceitemPrice'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice' -> Value

toEncoding :: InvoiceitemPrice' -> Encoding

toJSONList :: [InvoiceitemPrice'] -> Value

toEncodingList :: [InvoiceitemPrice'] -> Encoding

FromJSON InvoiceitemPrice'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'

parseJSONList :: Value -> Parser [InvoiceitemPrice']

mkInvoiceitemPrice' :: InvoiceitemPrice'

Create a new InvoiceitemPrice' with all required fields.

data InvoiceitemPrice'BillingScheme'

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

InvoiceitemPrice'BillingScheme'Other Value

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

InvoiceitemPrice'BillingScheme'Typed Text

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

InvoiceitemPrice'BillingScheme'EnumPerUnit

Represents the JSON value "per_unit"

InvoiceitemPrice'BillingScheme'EnumTiered

Represents the JSON value "tiered"

Instances

Eq InvoiceitemPrice'BillingScheme'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'BillingScheme'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'BillingScheme' -> String

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

ToJSON InvoiceitemPrice'BillingScheme'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'BillingScheme' -> Value

toEncoding :: InvoiceitemPrice'BillingScheme' -> Encoding

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

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

FromJSON InvoiceitemPrice'BillingScheme'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'BillingScheme'

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

data InvoiceitemPrice'Object'

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

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

Constructors

InvoiceitemPrice'Object'Other Value

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

InvoiceitemPrice'Object'Typed Text

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

InvoiceitemPrice'Object'EnumPrice

Represents the JSON value "price"

Instances

Eq InvoiceitemPrice'Object'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'Object'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'Object' -> String

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

ToJSON InvoiceitemPrice'Object'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'Object' -> Value

toEncoding :: InvoiceitemPrice'Object' -> Encoding

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

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

FromJSON InvoiceitemPrice'Object'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'Object'

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

data InvoiceitemPrice'Product'Variants

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

The ID of the product this price is associated with.

Constructors

InvoiceitemPrice'Product'Text Text

InvoiceitemPrice'Product'Product Product

InvoiceitemPrice'Product'DeletedProduct DeletedProduct

Instances

Eq InvoiceitemPrice'Product'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'Product'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'Product'Variants -> String

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

ToJSON InvoiceitemPrice'Product'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'Product'Variants -> Value

toEncoding :: InvoiceitemPrice'Product'Variants -> Encoding

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

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

FromJSON InvoiceitemPrice'Product'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

data InvoiceitemPrice'Recurring'

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

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

Constructors

InvoiceitemPrice'Recurring'

Fields

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

• invoiceitemPrice'Recurring'Interval :: Maybe InvoiceitemPrice'Recurring'Interval'

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

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

• invoiceitemPrice'Recurring'UsageType :: Maybe InvoiceitemPrice'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 InvoiceitemPrice'Recurring'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'Recurring'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'Recurring' -> String

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

ToJSON InvoiceitemPrice'Recurring'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'Recurring' -> Value

toEncoding :: InvoiceitemPrice'Recurring' -> Encoding

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

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

FromJSON InvoiceitemPrice'Recurring'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'Recurring'

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

mkInvoiceitemPrice'Recurring' :: InvoiceitemPrice'Recurring'

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

data InvoiceitemPrice'Recurring'AggregateUsage'

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

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

InvoiceitemPrice'Recurring'AggregateUsage'Typed Text

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

InvoiceitemPrice'Recurring'AggregateUsage'EnumLastDuringPeriod

Represents the JSON value "last_during_period"

InvoiceitemPrice'Recurring'AggregateUsage'EnumLastEver

Represents the JSON value "last_ever"

InvoiceitemPrice'Recurring'AggregateUsage'EnumMax

Represents the JSON value "max"

InvoiceitemPrice'Recurring'AggregateUsage'EnumSum

Represents the JSON value "sum"

Instances

Eq InvoiceitemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

ToJSON InvoiceitemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

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

FromJSON InvoiceitemPrice'Recurring'AggregateUsage'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

data InvoiceitemPrice'Recurring'Interval'

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

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

InvoiceitemPrice'Recurring'Interval'Typed Text

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

InvoiceitemPrice'Recurring'Interval'EnumDay

Represents the JSON value "day"

InvoiceitemPrice'Recurring'Interval'EnumMonth

Represents the JSON value "month"

InvoiceitemPrice'Recurring'Interval'EnumWeek

Represents the JSON value "week"

InvoiceitemPrice'Recurring'Interval'EnumYear

Represents the JSON value "year"

Instances

Eq InvoiceitemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

ToJSON InvoiceitemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

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

FromJSON InvoiceitemPrice'Recurring'Interval'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

data InvoiceitemPrice'Recurring'UsageType'

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

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

InvoiceitemPrice'Recurring'UsageType'Typed Text

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

InvoiceitemPrice'Recurring'UsageType'EnumLicensed

Represents the JSON value "licensed"

InvoiceitemPrice'Recurring'UsageType'EnumMetered

Represents the JSON value "metered"

Instances

Eq InvoiceitemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

ToJSON InvoiceitemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

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

FromJSON InvoiceitemPrice'Recurring'UsageType'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

data InvoiceitemPrice'TaxBehavior'

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

InvoiceitemPrice'TaxBehavior'Other Value

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

InvoiceitemPrice'TaxBehavior'Typed Text

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

InvoiceitemPrice'TaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

InvoiceitemPrice'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

InvoiceitemPrice'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Eq InvoiceitemPrice'TaxBehavior'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'TaxBehavior'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'TaxBehavior' -> String

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

ToJSON InvoiceitemPrice'TaxBehavior'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'TaxBehavior' -> Value

toEncoding :: InvoiceitemPrice'TaxBehavior' -> Encoding

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

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

FromJSON InvoiceitemPrice'TaxBehavior'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'TaxBehavior'

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

data InvoiceitemPrice'TiersMode'

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

InvoiceitemPrice'TiersMode'Other Value

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

InvoiceitemPrice'TiersMode'Typed Text

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

InvoiceitemPrice'TiersMode'EnumGraduated

Represents the JSON value "graduated"

InvoiceitemPrice'TiersMode'EnumVolume

Represents the JSON value "volume"

Instances

Eq InvoiceitemPrice'TiersMode'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'TiersMode'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'TiersMode' -> String

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

ToJSON InvoiceitemPrice'TiersMode'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'TiersMode' -> Value

toEncoding :: InvoiceitemPrice'TiersMode' -> Encoding

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

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

FromJSON InvoiceitemPrice'TiersMode'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'TiersMode'

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

data InvoiceitemPrice'TransformQuantity'

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

InvoiceitemPrice'TransformQuantity'

Fields

• invoiceitemPrice'TransformQuantity'DivideBy :: Maybe Int

  divide_by: Divide usage by this number.

• invoiceitemPrice'TransformQuantity'Round :: Maybe InvoiceitemPrice'TransformQuantity'Round'

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

Instances

Eq InvoiceitemPrice'TransformQuantity'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'TransformQuantity'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'TransformQuantity' -> String

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

ToJSON InvoiceitemPrice'TransformQuantity'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'TransformQuantity' -> Value

toEncoding :: InvoiceitemPrice'TransformQuantity' -> Encoding

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

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

FromJSON InvoiceitemPrice'TransformQuantity'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'TransformQuantity'

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

mkInvoiceitemPrice'TransformQuantity' :: InvoiceitemPrice'TransformQuantity'

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

data InvoiceitemPrice'TransformQuantity'Round'

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

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

Constructors

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

InvoiceitemPrice'TransformQuantity'Round'Typed Text

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

InvoiceitemPrice'TransformQuantity'Round'EnumDown

Represents the JSON value "down"

InvoiceitemPrice'TransformQuantity'Round'EnumUp

Represents the JSON value "up"

Instances

Eq InvoiceitemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

ToJSON InvoiceitemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

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

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

FromJSON InvoiceitemPrice'TransformQuantity'Round'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

data InvoiceitemPrice'Type'

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

InvoiceitemPrice'Type'Other Value

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

InvoiceitemPrice'Type'Typed Text

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

InvoiceitemPrice'Type'EnumOneTime

Represents the JSON value "one_time"

InvoiceitemPrice'Type'EnumRecurring

Represents the JSON value "recurring"

Instances

Eq InvoiceitemPrice'Type'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemPrice'Type'

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemPrice'Type' -> String

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

ToJSON InvoiceitemPrice'Type'

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemPrice'Type' -> Value

toEncoding :: InvoiceitemPrice'Type' -> Encoding

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

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

FromJSON InvoiceitemPrice'Type'

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemPrice'Type'

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

data InvoiceitemSubscription'Variants

Defines the oneOf schema located at components.schemas.invoiceitem.properties.subscription.anyOf in the specification.

The subscription that this invoice item has been created for, if any.

Constructors

InvoiceitemSubscription'Text Text

InvoiceitemSubscription'Subscription Subscription

Instances

Eq InvoiceitemSubscription'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

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

Show InvoiceitemSubscription'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

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

show :: InvoiceitemSubscription'Variants -> String

showList :: [InvoiceitemSubscription'Variants] -> ShowS

ToJSON InvoiceitemSubscription'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

toJSON :: InvoiceitemSubscription'Variants -> Value

toEncoding :: InvoiceitemSubscription'Variants -> Encoding

toJSONList :: [InvoiceitemSubscription'Variants] -> Value

toEncodingList :: [InvoiceitemSubscription'Variants] -> Encoding

FromJSON InvoiceitemSubscription'Variants

Defined in StripeAPI.Types.Invoiceitem

Methods

parseJSON :: Value -> Parser InvoiceitemSubscription'Variants

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