Module: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment

Extended by:

Internal::Type::Union

Defined in:

lib/orb/models/invoice_fetch_upcoming_response.rb

Instance Method Summary

• #initialize(id: , adjusted_subtotal: , adjustments: , amount: , credits_applied: , discount: , end_date: , filter: , grouping: , maximum: , maximum_amount: , minimum: , minimum_amount: , name: , partially_invoiced_amount: , price: , quantity: , start_date: , sub_line_items: , subtotal: , tax_amounts: , usage_customer_ids: ) ⇒ Object

  Some parameter documentations has been truncated, see Orb::Models::InvoiceFetchUpcomingResponse::LineItem for more details.

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(id: , adjusted_subtotal: , adjustments: , amount: , credits_applied: , discount: , end_date: , filter: , grouping: , maximum: , maximum_amount: , minimum: , minimum_amount: , name: , partially_invoiced_amount: , price: , quantity: , start_date: , sub_line_items: , subtotal: , tax_amounts: , usage_customer_ids: ) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::InvoiceFetchUpcomingResponse::LineItem for more details.

Parameters:

• id (String) (defaults to: ) —

  A unique ID for this line item.

• adjusted_subtotal (String) (defaults to: ) —

  The line amount after any adjustments and before overage conversion, credits and

• adjustments (Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>) (defaults to: ) —

  All adjustments applied to the line item in the order they were applied based on

• amount (String) (defaults to: ) —

  The final amount for a line item after all adjustments and pre paid credits have

• credits_applied (String) (defaults to: ) —

  The number of prepaid credits applied.

• discount (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil) (defaults to: ) —

  This field is deprecated in favor of ‘adjustments`

• end_date (Time) (defaults to: ) —

  The end date of the range of time applied for this line item’s price.

• filter (String, nil) (defaults to: ) —

  An additional filter that was used to calculate the usage for this line item.

• grouping (String, nil) (defaults to: ) —

  DEPRECATED

  For configured prices that are split by a grouping key, this will b

• maximum (Orb::Models::Maximum, nil) (defaults to: ) —

  This field is deprecated in favor of ‘adjustments`.

• maximum_amount (String, nil) (defaults to: ) —

  This field is deprecated in favor of ‘adjustments`.

• minimum (Orb::Models::Minimum, nil) (defaults to: ) —

  This field is deprecated in favor of ‘adjustments`.

• minimum_amount (String, nil) (defaults to: ) —

  This field is deprecated in favor of ‘adjustments`.

• name (String) (defaults to: ) —

  The name of the price associated with this line item.

• partially_invoiced_amount (String) (defaults to: ) —

  Any amount applied from a partial invoice

• price (Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds) (defaults to: ) —

  The Price resource represents a price that can be billed on a subscription, resu

• quantity (Float) (defaults to: ) —

  Either the fixed fee quantity or the usage during the service period.

• start_date (Time) (defaults to: ) —

  The start date of the range of time applied for this line item’s price.

• sub_line_items (Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>) (defaults to: ) —

  For complex pricing structures, the line item can be broken down further in ‘sub

• subtotal (String) (defaults to: ) —

  The line amount before before any adjustments.

• tax_amounts (Array<Orb::Models::TaxAmount>) (defaults to: ) —

  An array of tax rates and their incurred tax amounts. Empty if no tax integratio

• usage_customer_ids (Array<String>, nil) (defaults to: ) —

  A list of customer ids that were used to calculate the usage for this line item.

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 938

module Adjustment
  extend Orb::Internal::Type::Union

  discriminator :adjustment_type

  variant :usage_discount, -> { Orb::MonetaryUsageDiscountAdjustment }

  variant :amount_discount, -> { Orb::MonetaryAmountDiscountAdjustment }

  variant :percentage_discount, -> { Orb::MonetaryPercentageDiscountAdjustment }

  variant :minimum, -> { Orb::MonetaryMinimumAdjustment }

  variant :maximum, -> { Orb::MonetaryMaximumAdjustment }

  # @!method self.variants
  #   @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
end