orb-billing 1.14.0 → 1.15.0

data/lib/orb/models/price_interval.rb

@@ -72,7 +72,7 @@ module Orb
       #   For more on the types of prices, see
       #   [the core concepts documentation](/core-concepts#plan-and-price)
       #
-      #   @return [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::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::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
+      #   @return [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]
       required :price, union: -> { Orb::Price }
 
       # @!attribute start_date
@@ -122,7 +122,7 @@ module Orb
       #
       #   @param fixed_fee_quantity_transitions [Array<Orb::Models::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
       #
-      #   @param price [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::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::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
+      #   @param price [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] The Price resource represents a price that can be billed on a subscription, resu
       #
       #   @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
       #

data/lib/orb/models/subscription.rb

@@ -31,6 +31,15 @@ module Orb
       #   @return [Boolean, nil]
       required :auto_collection, Orb::Internal::Type::Boolean, nil?: true
 
+      # @!attribute auto_issuance
+      #   Determines whether invoices for this subscription will be automatically issued.
+      #   This resolves the effective setting for the subscription: a subscription-level
+      #   override if set, otherwise the customer-level setting, otherwise the
+      #   account-level default.
+      #
+      #   @return [Boolean, nil]
+      required :auto_issuance, Orb::Internal::Type::Boolean, nil?: true
+
       # @!attribute billing_cycle_anchor_configuration
       #
       #   @return [Orb::Models::BillingCycleAnchorConfiguration]
@@ -102,7 +111,7 @@ module Orb
       #   The discount intervals for this subscription sorted by the start_date. This
       #   field is deprecated in favor of `adjustment_intervals`.
       #
-      #   @return [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>]
+      #   @return [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval, Orb::Models::Subscription::DiscountInterval::TieredPercentage>]
       required :discount_intervals,
                -> { Orb::Internal::Type::ArrayOf[union: Orb::Subscription::DiscountInterval] }
 
@@ -207,7 +216,7 @@ module Orb
       #   @return [Orb::Models::SubscriptionTrialInfo]
       required :trial_info, -> { Orb::SubscriptionTrialInfo }
 
-      # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, name:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
+      # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, auto_issuance:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, name:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::Subscription} for more details.
       #
@@ -239,6 +248,8 @@ module Orb
       #
       #   @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
       #
+      #   @param auto_issuance [Boolean, nil] Determines whether invoices for this subscription will be automatically issued.
+      #
       #   @param billing_cycle_anchor_configuration [Orb::Models::BillingCycleAnchorConfiguration]
       #
       #   @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
@@ -253,7 +264,7 @@ module Orb
       #
       #   @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
       #
-      #   @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date. This fiel
+      #   @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval, Orb::Models::Subscription::DiscountInterval::TieredPercentage>] The discount intervals for this subscription sorted by the start_date. This fiel
       #
       #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
       #
@@ -296,8 +307,161 @@ module Orb
 
         variant :usage, -> { Orb::UsageDiscountInterval }
 
+        variant :tiered_percentage, -> { Orb::Subscription::DiscountInterval::TieredPercentage }
+
+        class TieredPercentage < Orb::Internal::Type::BaseModel
+          # @!attribute applies_to_price_interval_ids
+          #   The price interval ids that this discount interval applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
+
+          # @!attribute discount_type
+          #
+          #   @return [Symbol, :tiered_percentage]
+          required :discount_type, const: :tiered_percentage
+
+          # @!attribute end_date
+          #   The end date of the discount interval.
+          #
+          #   @return [Time, nil]
+          required :end_date, Time, nil?: true
+
+          # @!attribute filters
+          #   The filters that determine which prices this discount interval applies to.
+          #
+          #   @return [Array<Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter>]
+          required :filters,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::DiscountInterval::TieredPercentage::Filter] }
+
+          # @!attribute start_date
+          #   The start date of the discount interval.
+          #
+          #   @return [Time]
+          required :start_date, Time
+
+          # @!attribute tiers
+          #   Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+          #   bands of cumulative eligible spend, each discounted at its own percentage.
+          #
+          #   @return [Array<Orb::Models::Subscription::DiscountInterval::TieredPercentage::Tier>]
+          required :tiers,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::DiscountInterval::TieredPercentage::Tier] }
+
+          # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, start_date:, tiers:, discount_type: :tiered_percentage)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Subscription::DiscountInterval::TieredPercentage} for more
+          #   details.
+          #
+          #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
+          #
+          #   @param end_date [Time, nil] The end date of the discount interval.
+          #
+          #   @param filters [Array<Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter>] The filters that determine which prices this discount interval applies to.
+          #
+          #   @param start_date [Time] The start date of the discount interval.
+          #
+          #   @param tiers [Array<Orb::Models::Subscription::DiscountInterval::TieredPercentage::Tier>] Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+          #
+          #   @param discount_type [Symbol, :tiered_percentage]
+
+          class Filter < Orb::Internal::Type::BaseModel
+            # @!attribute field
+            #   The property of the price to filter on.
+            #
+            #   @return [Symbol, Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter::Field]
+            required :field, enum: -> { Orb::Subscription::DiscountInterval::TieredPercentage::Filter::Field }
+
+            # @!attribute operator
+            #   Should prices that match the filter be included or excluded.
+            #
+            #   @return [Symbol, Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter::Operator]
+            required :operator, enum: -> { Orb::Subscription::DiscountInterval::TieredPercentage::Filter::Operator }
+
+            # @!attribute values
+            #   The IDs or values that match this filter.
+            #
+            #   @return [Array<String>]
+            required :values, Orb::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(field:, operator:, values:)
+            #   @param field [Symbol, Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter::Field] The property of the price to filter on.
+            #
+            #   @param operator [Symbol, Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter::Operator] Should prices that match the filter be included or excluded.
+            #
+            #   @param values [Array<String>] The IDs or values that match this filter.
+
+            # The property of the price to filter on.
+            #
+            # @see Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter#field
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              PRICE_ID = :price_id
+              ITEM_ID = :item_id
+              PRICE_TYPE = :price_type
+              CURRENCY = :currency
+              PRICING_UNIT_ID = :pricing_unit_id
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Should prices that match the filter be included or excluded.
+            #
+            # @see Orb::Models::Subscription::DiscountInterval::TieredPercentage::Filter#operator
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES = :includes
+              EXCLUDES = :excludes
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Tier < Orb::Internal::Type::BaseModel
+            # @!attribute lower_bound
+            #   Exclusive lower bound of cumulative spend for this tier.
+            #
+            #   @return [Float]
+            required :lower_bound, Float
+
+            # @!attribute percentage
+            #   The percentage (between 0 and 1) discounted from spend that falls within this
+            #   tier.
+            #
+            #   @return [Float]
+            required :percentage, Float
+
+            # @!attribute upper_bound
+            #   Inclusive upper bound of cumulative spend for this tier; null for the final
+            #   open-ended tier.
+            #
+            #   @return [Float, nil]
+            optional :upper_bound, Float, nil?: true
+
+            # @!method initialize(lower_bound:, percentage:, upper_bound: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Subscription::DiscountInterval::TieredPercentage::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.
+            #
+            #   @param lower_bound [Float] Exclusive lower bound of cumulative spend for this tier.
+            #
+            #   @param percentage [Float] The percentage (between 0 and 1) discounted from spend that falls within this ti
+            #
+            #   @param upper_bound [Float, nil] Inclusive upper bound of cumulative spend for this tier; null for the final open
+          end
+        end
+
         # @!method self.variants
-        #   @return [Array(Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval)]
+        #   @return [Array(Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval, Orb::Models::Subscription::DiscountInterval::TieredPercentage)]
       end
 
       # @see Orb::Models::Subscription#status