Class: Orb::Models::InvoiceLineItemCreateResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::InvoiceLineItemCreateResponse

Defined in:

lib/orb/models/invoice_line_item_create_response.rb,
sig/orb/models/invoice_line_item_create_response.rbs

Overview

See Also:

• Orb::Resources::InvoiceLineItems#create

Defined Under Namespace

Modules: Adjustment, SubLineItem

Constant Summary

Orb =

Returns:

• (:MonetaryUsageDiscountAdjustment)

Instance Attribute Summary

• #adjusted_subtotal ⇒ String

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

• #adjustments ⇒ Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>

  All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums).

• #amount ⇒ String

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

• #credits_applied ⇒ String

  The number of prepaid credits applied.

• #end_date ⇒ Time

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

• #filter ⇒ String^?

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

• #grouping ⇒ String^?

  [DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value.

• #id ⇒ String

  A unique ID for this line item.

• #name ⇒ String

  The name of the price associated with this line item.

• #partially_invoiced_amount ⇒ String

  Any amount applied from a partial invoice.

• #price ⇒ Orb::Models::Price::Unit, ...

  The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item.

• #quantity ⇒ Float

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

• #start_date ⇒ Time

  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>

  For complex pricing structures, the line item can be broken down further in sub_line_items.

• #subtotal ⇒ String

  The line amount before any adjustments.

• #tax_amounts ⇒ Array<Orb::Models::TaxAmount>

  An array of tax rates and their incurred tax amounts.

• #usage_customer_ids ⇒ Array<String>^?

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

Class Method Summary

• .variants ⇒ Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)

Instance Method Summary

• #initialize(lower_bound:, percentage:, upper_bound: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Adjustment::TieredPercentageDiscount::Tier for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(lower_bound:, percentage:, upper_bound: nil) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier for more details.

One band of a tiered percentage discount. Bounds are denominated in the discount's currency. lower_bound is the exclusive start of the band and upper_bound is the inclusive end; upper_bound is null only for the open-ended final tier.

Parameters:

• lower_bound (Float) —

  Exclusive lower bound of cumulative spend for this tier.

• percentage (Float) —

  The percentage (between 0 and 1) discounted from spend that falls within this ti

• upper_bound (Float, nil) (defaults to: nil) —

  Inclusive upper bound of cumulative spend for this tier; null for the final open

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 347

Instance Attribute Details

#adjusted_subtotal ⇒ String

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

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 18

required :adjusted_subtotal, String

#adjustments ⇒ Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>

All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums).

Parameters:

• value (::Array[Orb::Models::InvoiceLineItemCreateResponse::adjustment])

Returns:

• (Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 26

required :adjustments,
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment] }

#amount ⇒ String

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

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 34

required :amount, String

#credits_applied ⇒ String

The number of prepaid credits applied.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 40

required :credits_applied, String

#end_date ⇒ Time

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

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 46

required :end_date, Time

#filter ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 52

required :filter, String, nil?: true

#grouping ⇒ String^?

[DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value. The amount and subtotal will be the values for this particular grouping.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 60

required :grouping, String, nil?: true

#id ⇒ String

A unique ID for this line item.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 11

required :id, String

#name ⇒ String

The name of the price associated with this line item.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 66

required :name, String

#partially_invoiced_amount ⇒ String

Any amount applied from a partial invoice

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 72

required :partially_invoiced_amount, String

#price ⇒ Orb::Models::Price::Unit, ...

The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.

Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.

For more on the types of prices, see the core concepts documentation

Parameters:

• value (Orb::Models::price)

Returns:

• (Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 87

required :price, union: -> { Orb::Price }

#quantity ⇒ Float

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

Parameters:

• value (Float)

Returns:

• (Float)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 93

required :quantity, Float

#start_date ⇒ Time

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

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 99

required :start_date, Time

#sub_line_items ⇒ Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>

For complex pricing structures, the line item can be broken down further in sub_line_items.

Parameters:

• value (::Array[Orb::Models::InvoiceLineItemCreateResponse::sub_line_item])

Returns:

• (Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 106

required :sub_line_items,
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem] }

#subtotal ⇒ String

The line amount before any adjustments.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 113

required :subtotal, String

#tax_amounts ⇒ Array<Orb::Models::TaxAmount>

An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured.

Parameters:

• value (::Array[Orb::TaxAmount])

Returns:

• (Array<Orb::Models::TaxAmount>)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 120

required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::TaxAmount] }

#usage_customer_ids ⇒ Array<String>^?

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

Parameters:

• value (::Array[String], nil)

Returns:

• (Array<String>, nil)

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 126

required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true

Class Method Details

.variants ⇒ Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)

Returns:

• (Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment))

# File 'lib/orb/models/invoice_line_item_create_response.rb', line 365

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/invoice_line_item_create_response.rbs', line 79

def to_hash: -> {