orb-billing 1.0.1 → 1.1.0

data/lib/orb/models/new_plan_tiered_bps_price.rb

@@ -113,7 +113,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanTieredBPSPrice} for more details.
       #
@@ -150,6 +157,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/new_plan_tiered_package_price.rb

@@ -113,7 +113,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanTieredPackagePrice} for more details.
       #
@@ -150,6 +157,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb

@@ -113,7 +113,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_package_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_package_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanTieredPackageWithMinimumPrice} for more details.
       #
@@ -150,6 +157,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/new_plan_tiered_price.rb

@@ -115,7 +115,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanTieredPrice} for more details.
       #
@@ -152,6 +159,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/new_plan_tiered_with_minimum_price.rb

@@ -113,7 +113,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanTieredWithMinimumPrice} for more details.
       #
@@ -150,6 +157,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/new_plan_unit_price.rb

@@ -111,7 +111,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanUnitPrice} for more details.
       #
@@ -148,6 +155,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/new_plan_unit_with_percent_price.rb

@@ -113,7 +113,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanUnitWithPercentPrice} for more details.
       #
@@ -150,6 +157,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/new_plan_unit_with_proration_price.rb

@@ -113,7 +113,14 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(cadence:, item_id:, model_type:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      # @!attribute reference_id
+      #   A transient ID that can be used to reference this price when adding adjustments
+      #   in the same API call.
+      #
+      #   @return [String, nil]
+      optional :reference_id, String, nil?: true
+
+      # @!method initialize(cadence:, item_id:, model_type:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::NewPlanUnitWithProrationPrice} for more details.
       #
@@ -150,6 +157,8 @@ module Orb
       #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
 
       # The cadence to bill for this price on.
       #

data/lib/orb/models/plan_create_params.rb

@@ -23,8 +23,19 @@ module Orb
       #   Prices for this plan. If the plan has phases, this includes prices across all
       #   phases of the plan.
       #
-      #   @return [Array<Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice>]
-      required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::PlanCreateParams::Price] }
+      #   @return [Array<Orb::Models::PlanCreateParams::Price>]
+      required :prices, -> { Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price] }
+
+      # @!attribute adjustments
+      #   Adjustments for this plan. If the plan has phases, this includes adjustments
+      #   across all phases of the plan.
+      #
+      #   @return [Array<Orb::Models::PlanCreateParams::Adjustment>, nil]
+      optional :adjustments,
+               -> {
+                 Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Adjustment]
+               },
+               nil?: true
 
       # @!attribute default_invoice_memo
       #   Free-form text which is available on the invoice PDF and the Orb invoice portal.
@@ -53,6 +64,13 @@ module Orb
       #   @return [Integer, nil]
       optional :net_terms, Integer, nil?: true
 
+      # @!attribute plan_phases
+      #   Configuration of pre-defined phases, each with their own prices and adjustments.
+      #   Leave unspecified for plans with a single phase.
+      #
+      #   @return [Array<Orb::Models::PlanCreateParams::PlanPhase>, nil]
+      optional :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::PlanPhase] }, nil?: true
+
       # @!attribute status
       #   The status of the plan to create (either active or draft). If not specified,
       #   this defaults to active.
@@ -60,7 +78,7 @@ module Orb
       #   @return [Symbol, Orb::Models::PlanCreateParams::Status, nil]
       optional :status, enum: -> { Orb::PlanCreateParams::Status }
 
-      # @!method initialize(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
+      # @!method initialize(currency:, name:, prices:, adjustments: nil, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, plan_phases: nil, status: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanCreateParams} for more details.
       #
@@ -68,7 +86,9 @@ module Orb
       #
       #   @param name [String]
       #
-      #   @param prices [Array<Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      #   @param prices [Array<Orb::Models::PlanCreateParams::Price>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      #
+      #   @param adjustments [Array<Orb::Models::PlanCreateParams::Adjustment>, nil] Adjustments for this plan. If the plan has phases, this includes adjustments acr
       #
       #   @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
       #
@@ -78,73 +98,201 @@ module Orb
       #
       #   @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
       #
+      #   @param plan_phases [Array<Orb::Models::PlanCreateParams::PlanPhase>, nil] Configuration of pre-defined phases, each with their own prices and adjustments.
+      #
       #   @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
-      module Price
-        extend Orb::Internal::Type::Union
+      class Price < Orb::Internal::Type::BaseModel
+        # @!attribute allocation_price
+        #   The allocation price to add to the plan.
+        #
+        #   @return [Orb::Models::NewAllocationPrice, nil]
+        optional :allocation_price, -> { Orb::NewAllocationPrice }, nil?: true
+
+        # @!attribute plan_phase_order
+        #   The phase to add this price to.
+        #
+        #   @return [Integer, nil]
+        optional :plan_phase_order, Integer, nil?: true
+
+        # @!attribute price
+        #   The price to add to the plan
+        #
+        #   @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice, nil]
+        optional :price, union: -> { Orb::PlanCreateParams::Price::Price }, nil?: true
+
+        # @!method initialize(allocation_price: nil, plan_phase_order: nil, price: nil)
+        #   @param allocation_price [Orb::Models::NewAllocationPrice, nil] The allocation price to add to the plan.
+        #
+        #   @param plan_phase_order [Integer, nil] The phase to add this price to.
+        #
+        #   @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice, nil] The price to add to the plan
+
+        # The price to add to the plan
+        #
+        # @see Orb::Models::PlanCreateParams::Price#price
+        module Price
+          extend Orb::Internal::Type::Union
+
+          discriminator :model_type
+
+          variant :unit, -> { Orb::NewPlanUnitPrice }
 
-        discriminator :model_type
+          variant :package, -> { Orb::NewPlanPackagePrice }
 
-        variant :unit, -> { Orb::NewPlanUnitPrice }
+          variant :matrix, -> { Orb::NewPlanMatrixPrice }
 
-        variant :package, -> { Orb::NewPlanPackagePrice }
+          variant :tiered, -> { Orb::NewPlanTieredPrice }
 
-        variant :matrix, -> { Orb::NewPlanMatrixPrice }
+          variant :tiered_bps, -> { Orb::NewPlanTieredBPSPrice }
 
-        variant :tiered, -> { Orb::NewPlanTieredPrice }
+          variant :bps, -> { Orb::NewPlanBPSPrice }
 
-        variant :tiered_bps, -> { Orb::NewPlanTieredBPSPrice }
+          variant :bulk_bps, -> { Orb::NewPlanBulkBPSPrice }
 
-        variant :bps, -> { Orb::NewPlanBPSPrice }
+          variant :bulk, -> { Orb::NewPlanBulkPrice }
 
-        variant :bulk_bps, -> { Orb::NewPlanBulkBPSPrice }
+          variant :threshold_total_amount, -> { Orb::NewPlanThresholdTotalAmountPrice }
 
-        variant :bulk, -> { Orb::NewPlanBulkPrice }
+          variant :tiered_package, -> { Orb::NewPlanTieredPackagePrice }
 
-        variant :threshold_total_amount, -> { Orb::NewPlanThresholdTotalAmountPrice }
+          variant :tiered_with_minimum, -> { Orb::NewPlanTieredWithMinimumPrice }
 
-        variant :tiered_package, -> { Orb::NewPlanTieredPackagePrice }
+          variant :unit_with_percent, -> { Orb::NewPlanUnitWithPercentPrice }
 
-        variant :tiered_with_minimum, -> { Orb::NewPlanTieredWithMinimumPrice }
+          variant :package_with_allocation, -> { Orb::NewPlanPackageWithAllocationPrice }
 
-        variant :unit_with_percent, -> { Orb::NewPlanUnitWithPercentPrice }
+          variant :tiered_with_proration, -> { Orb::NewPlanTierWithProrationPrice }
 
-        variant :package_with_allocation, -> { Orb::NewPlanPackageWithAllocationPrice }
+          variant :unit_with_proration, -> { Orb::NewPlanUnitWithProrationPrice }
 
-        variant :tiered_with_proration, -> { Orb::NewPlanTierWithProrationPrice }
+          variant :grouped_allocation, -> { Orb::NewPlanGroupedAllocationPrice }
 
-        variant :unit_with_proration, -> { Orb::NewPlanUnitWithProrationPrice }
+          variant :grouped_with_prorated_minimum, -> { Orb::NewPlanGroupedWithProratedMinimumPrice }
 
-        variant :grouped_allocation, -> { Orb::NewPlanGroupedAllocationPrice }
+          variant :grouped_with_metered_minimum, -> { Orb::NewPlanGroupedWithMeteredMinimumPrice }
 
-        variant :grouped_with_prorated_minimum, -> { Orb::NewPlanGroupedWithProratedMinimumPrice }
+          variant :matrix_with_display_name, -> { Orb::NewPlanMatrixWithDisplayNamePrice }
 
-        variant :grouped_with_metered_minimum, -> { Orb::NewPlanGroupedWithMeteredMinimumPrice }
+          variant :bulk_with_proration, -> { Orb::NewPlanBulkWithProrationPrice }
 
-        variant :matrix_with_display_name, -> { Orb::NewPlanMatrixWithDisplayNamePrice }
+          variant :grouped_tiered_package, -> { Orb::NewPlanGroupedTieredPackagePrice }
 
-        variant :bulk_with_proration, -> { Orb::NewPlanBulkWithProrationPrice }
+          variant :max_group_tiered_package, -> { Orb::NewPlanMaxGroupTieredPackagePrice }
 
-        variant :grouped_tiered_package, -> { Orb::NewPlanGroupedTieredPackagePrice }
+          variant :scalable_matrix_with_unit_pricing, -> { Orb::NewPlanScalableMatrixWithUnitPricingPrice }
 
-        variant :max_group_tiered_package, -> { Orb::NewPlanMaxGroupTieredPackagePrice }
+          variant :scalable_matrix_with_tiered_pricing,
+                  -> {
+                    Orb::NewPlanScalableMatrixWithTieredPricingPrice
+                  }
 
-        variant :scalable_matrix_with_unit_pricing, -> { Orb::NewPlanScalableMatrixWithUnitPricingPrice }
+          variant :cumulative_grouped_bulk, -> { Orb::NewPlanCumulativeGroupedBulkPrice }
 
-        variant :scalable_matrix_with_tiered_pricing, -> { Orb::NewPlanScalableMatrixWithTieredPricingPrice }
+          variant :tiered_package_with_minimum, -> { Orb::NewPlanTieredPackageWithMinimumPrice }
 
-        variant :cumulative_grouped_bulk, -> { Orb::NewPlanCumulativeGroupedBulkPrice }
+          variant :matrix_with_allocation, -> { Orb::NewPlanMatrixWithAllocationPrice }
 
-        variant :tiered_package_with_minimum, -> { Orb::NewPlanTieredPackageWithMinimumPrice }
+          variant :grouped_tiered, -> { Orb::NewPlanGroupedTieredPrice }
 
-        variant :matrix_with_allocation, -> { Orb::NewPlanMatrixWithAllocationPrice }
+          # @!method self.variants
+          #   @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice)]
+        end
+      end
+
+      class Adjustment < Orb::Internal::Type::BaseModel
+        # @!attribute adjustment
+        #   The definition of a new adjustment to create and add to the plan.
+        #
+        #   @return [Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum]
+        required :adjustment, union: -> { Orb::PlanCreateParams::Adjustment::Adjustment }
+
+        # @!attribute plan_phase_order
+        #   The phase to add this adjustment to.
+        #
+        #   @return [Integer, nil]
+        optional :plan_phase_order, Integer, nil?: true
+
+        # @!method initialize(adjustment:, plan_phase_order: nil)
+        #   @param adjustment [Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum] The definition of a new adjustment to create and add to the plan.
+        #
+        #   @param plan_phase_order [Integer, nil] The phase to add this adjustment to.
+
+        # The definition of a new adjustment to create and add to the plan.
+        #
+        # @see Orb::Models::PlanCreateParams::Adjustment#adjustment
+        module Adjustment
+          extend Orb::Internal::Type::Union
+
+          discriminator :adjustment_type
 
-        variant :grouped_tiered, -> { Orb::NewPlanGroupedTieredPrice }
+          variant :percentage_discount, -> { Orb::NewPercentageDiscount }
+
+          variant :usage_discount, -> { Orb::NewUsageDiscount }
+
+          variant :amount_discount, -> { Orb::NewAmountDiscount }
+
+          variant :minimum, -> { Orb::NewMinimum }
+
+          variant :maximum, -> { Orb::NewMaximum }
+
+          # @!method self.variants
+          #   @return [Array(Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum)]
+        end
+      end
 
-        # @!method self.variants
-        #   @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice)]
+      class PlanPhase < Orb::Internal::Type::BaseModel
+        # @!attribute order
+        #   Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
+        #
+        #   @return [Integer]
+        required :order, Integer
+
+        # @!attribute align_billing_with_phase_start_date
+        #   Align billing cycle day with phase start date.
+        #
+        #   @return [Boolean, nil]
+        optional :align_billing_with_phase_start_date, Orb::Internal::Type::Boolean, nil?: true
+
+        # @!attribute duration
+        #   How many terms of length `duration_unit` this phase is active for. If null, this
+        #   phase is evergreen and active indefinitely
+        #
+        #   @return [Integer, nil]
+        optional :duration, Integer, nil?: true
+
+        # @!attribute duration_unit
+        #
+        #   @return [Symbol, Orb::Models::PlanCreateParams::PlanPhase::DurationUnit, nil]
+        optional :duration_unit, enum: -> { Orb::PlanCreateParams::PlanPhase::DurationUnit }, nil?: true
+
+        # @!method initialize(order:, align_billing_with_phase_start_date: nil, duration: nil, duration_unit: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::PlanCreateParams::PlanPhase} for more details.
+        #
+        #   @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
+        #
+        #   @param align_billing_with_phase_start_date [Boolean, nil] Align billing cycle day with phase start date.
+        #
+        #   @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
+        #
+        #   @param duration_unit [Symbol, Orb::Models::PlanCreateParams::PlanPhase::DurationUnit, nil]
+
+        # @see Orb::Models::PlanCreateParams::PlanPhase#duration_unit
+        module DurationUnit
+          extend Orb::Internal::Type::Enum
+
+          DAILY = :daily
+          MONTHLY = :monthly
+          QUARTERLY = :quarterly
+          SEMI_ANNUAL = :semi_annual
+          ANNUAL = :annual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # The status of the plan to create (either active or draft). If not specified,

data/lib/orb/resources/customers/credits/ledger.rb

@@ -250,7 +250,7 @@ module Orb
           # that was originally decremented from, and `amount` indicates how many credits to
           # return to the customer, up to the block's initial balance.
           #
-          # @overload create_entry(customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
+          # @overload create_entry(customer_id, amount:, entry_type:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, expiry_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
           #
           # @param customer_id [String]
           #
@@ -258,8 +258,6 @@ module Orb
           #
           # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType]
           #
-          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
-          #
           # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
           #
           # @param block_id [String] The ID of the block to reverse a decrement from.
@@ -270,6 +268,8 @@ module Orb
           #
           # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
           #
+          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
+          #
           # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
           #
           # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
@@ -409,7 +409,7 @@ module Orb
           # that was originally decremented from, and `amount` indicates how many credits to
           # return to the customer, up to the block's initial balance.
           #
-          # @overload create_entry_by_external_id(external_customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
+          # @overload create_entry_by_external_id(external_customer_id, amount:, entry_type:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, expiry_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
           #
           # @param external_customer_id [String]
           #
@@ -417,8 +417,6 @@ module Orb
           #
           # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
           #
-          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
-          #
           # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
           #
           # @param block_id [String] The ID of the block to reverse a decrement from.
@@ -429,6 +427,8 @@ module Orb
           #
           # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
           #
+          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
+          #
           # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
           #
           # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed

data/lib/orb/resources/plans.rb

@@ -11,13 +11,15 @@ module Orb
       #
       # This endpoint allows creation of plans including their prices.
       #
-      # @overload create(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
+      # @overload create(currency:, name:, prices:, adjustments: nil, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, plan_phases: nil, status: nil, request_options: {})
       #
       # @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan
       #
       # @param name [String]
       #
-      # @param prices [Array<Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      # @param prices [Array<Orb::Models::PlanCreateParams::Price>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      #
+      # @param adjustments [Array<Orb::Models::PlanCreateParams::Adjustment>, nil] Adjustments for this plan. If the plan has phases, this includes adjustments acr
       #
       # @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
       #
@@ -27,6 +29,8 @@ module Orb
       #
       # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
       #
+      # @param plan_phases [Array<Orb::Models::PlanCreateParams::PlanPhase>, nil] Configuration of pre-defined phases, each with their own prices and adjustments.
+      #
       # @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/rbi/orb/errors.rbi

@@ -8,6 +8,22 @@ module Orb
     end
 
     class ConversionError < Orb::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
     end
 
     class APIError < Orb::Errors::Error

data/rbi/orb/internal/type/boolean.rbi

@@ -22,6 +22,8 @@ module Orb
 
         class << self
           # @api private
+          #
+          # Coerce value to Boolean if possible, otherwise return the original value.
           sig do
             override
               .params(