orb-billing 1.0.1 → 1.2.0

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.2.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(

data/rbi/orb/internal/type/converter.rbi

@@ -15,12 +15,14 @@ module Orb
         CoerceState =
           T.type_alias do
             {
-              strictness: T.any(T::Boolean, Symbol),
+              translate_names: T::Boolean,
+              strictness: T::Boolean,
               exactness: {
                 yes: Integer,
                 no: Integer,
                 maybe: Integer
               },
+              error: T::Class[StandardError],
               branched: Integer
             }
           end
@@ -84,6 +86,15 @@ module Orb
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(translate_names: T::Boolean).returns(
+              Orb::Internal::Type::Converter::CoerceState
+            )
+          end
+          def self.new_coerce_state(translate_names: true)
+          end
+
           # @api private
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
@@ -105,14 +116,11 @@ module Orb
           def self.coerce(
             target,
             value,
-            # The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-            # coercion strategy when we have to decide between multiple possible conversion
-            # targets:
+            # The `strictness` is one of `true`, `false`. This informs the coercion strategy
+            # when we have to decide between multiple possible conversion targets:
             #
             # - `true`: the conversion must be exact, with minimum coercion.
             # - `false`: the conversion can be approximate, with some coercion.
-            # - `:strong`: the conversion must be exact, with no coercion, and raise an error
-            #   if not possible.
             #
             # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
             # any given conversion attempt, the exactness will be updated based on how closely
@@ -124,15 +132,7 @@ module Orb
             # - `no`: the value cannot be converted to the target type.
             #
             # See implementation below for more details.
-            state: {
-              strictness: true,
-              exactness: {
-                yes: 0,
-                no: 0,
-                maybe: 0
-              },
-              branched: 0
-            }
+            state: Orb::Internal::Type::Converter.new_coerce_state
           )
           end
 

data/rbi/orb/internal/type/union.rbi

@@ -78,6 +78,11 @@ module Orb
         end
 
         # @api private
+        #
+        # Tries to efficiently coerce the given value to one of the known variants.
+        #
+        # If the value cannot match any of the known variants, the coercion is considered
+        # non-viable and returns the original value.
         sig do
           override
             .params(

data/rbi/orb/internal/type/unknown.rbi

@@ -22,6 +22,8 @@ module Orb
 
         class << self
           # @api private
+          #
+          # No coercion needed for Unknown type.
           sig do
             override
               .params(

data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi

@@ -107,12 +107,12 @@ module Orb
               amount: Float,
               entry_type:
                 Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::OrSymbol,
-              expiry_date: T.nilable(Time),
               target_expiry_date: Date,
               block_id: String,
               currency: T.nilable(String),
               description: T.nilable(String),
               effective_date: T.nilable(Time),
+              expiry_date: T.nilable(Time),
               invoice_settings:
                 T.nilable(
                   Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::OrHash
@@ -131,8 +131,6 @@ module Orb
             # decrement or void operations.
             amount:,
             entry_type:,
-            # An ISO 8601 format date that identifies the origination credit block to expire
-            expiry_date:,
             # A future date (specified in YYYY-MM-DD format) used for expiration change,
             # denoting when credits transferred (as part of a partial block expiration) should
             # expire.
@@ -149,6 +147,8 @@ module Orb
             # An ISO 8601 format date that denotes when this credit balance should become
             # available for use.
             effective_date: nil,
+            # An ISO 8601 format date that identifies the origination credit block to expire
+            expiry_date: nil,
             # Passing `invoice_settings` automatically generates an invoice for the newly
             # added credits. If `invoice_settings` is passed, you must specify
             # per_unit_cost_basis, as the calculation of the invoice total is done on that

data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi

@@ -107,12 +107,12 @@ module Orb
               amount: Float,
               entry_type:
                 Orb::Customers::Credits::LedgerCreateEntryParams::EntryType::OrSymbol,
-              expiry_date: T.nilable(Time),
               target_expiry_date: Date,
               block_id: String,
               currency: T.nilable(String),
               description: T.nilable(String),
               effective_date: T.nilable(Time),
+              expiry_date: T.nilable(Time),
               invoice_settings:
                 T.nilable(
                   Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::OrHash
@@ -131,8 +131,6 @@ module Orb
             # decrement or void operations.
             amount:,
             entry_type:,
-            # An ISO 8601 format date that identifies the origination credit block to expire
-            expiry_date:,
             # A future date (specified in YYYY-MM-DD format) used for expiration change,
             # denoting when credits transferred (as part of a partial block expiration) should
             # expire.
@@ -149,6 +147,8 @@ module Orb
             # An ISO 8601 format date that denotes when this credit balance should become
             # available for use.
             effective_date: nil,
+            # An ISO 8601 format date that identifies the origination credit block to expire
+            expiry_date: nil,
             # Passing `invoice_settings` automatically generates an invoice for the newly
             # added credits. If `invoice_settings` is passed, you must specify
             # per_unit_cost_basis, as the calculation of the invoice total is done on that

data/rbi/orb/models/invoice.rbi

@@ -1020,6 +1020,7 @@ module Orb
         sig { returns(String) }
         attr_accessor :credits_applied
 
+        # This field is deprecated in favor of `adjustments`
         sig { returns(T.nilable(Orb::Discount::Variants)) }
         attr_accessor :discount
 
@@ -1201,6 +1202,7 @@ module Orb
           amount:,
           # The number of prepaid credits applied.
           credits_applied:,
+          # This field is deprecated in favor of `adjustments`
           discount:,
           # The end date of the range of time applied for this line item's price.
           end_date:,

data/rbi/orb/models/invoice_fetch_upcoming_response.rbi

@@ -1117,6 +1117,7 @@ module Orb
         sig { returns(String) }
         attr_accessor :credits_applied
 
+        # This field is deprecated in favor of `adjustments`
         sig { returns(T.nilable(Orb::Discount::Variants)) }
         attr_accessor :discount
 
@@ -1304,6 +1305,7 @@ module Orb
           amount:,
           # The number of prepaid credits applied.
           credits_applied:,
+          # This field is deprecated in favor of `adjustments`
           discount:,
           # The end date of the range of time applied for this line item's price.
           end_date:,

data/rbi/orb/models/invoice_line_item_create_response.rbi

@@ -41,6 +41,7 @@ module Orb
       sig { returns(String) }
       attr_accessor :credits_applied
 
+      # This field is deprecated in favor of `adjustments`
       sig { returns(T.nilable(Orb::Discount::Variants)) }
       attr_accessor :discount
 
@@ -228,6 +229,7 @@ module Orb
         amount:,
         # The number of prepaid credits applied.
         credits_applied:,
+        # This field is deprecated in favor of `adjustments`
         discount:,
         # The end date of the range of time applied for this line item's price.
         end_date:,

data/rbi/orb/models/monetary_amount_discount_adjustment.rbi

@@ -44,6 +44,11 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # The adjustment id this adjustment replaces. This adjustment will take the place
+      # of the replaced adjustment in plan version migrations.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :replaces_adjustment_id
+
       sig do
         params(
           id: String,
@@ -54,7 +59,8 @@ module Orb
           applies_to_price_ids: T::Array[String],
           filters: T::Array[Orb::TransformPriceFilter::OrHash],
           is_invoice_level: T::Boolean,
-          reason: T.nilable(String)
+          reason: T.nilable(String),
+          replaces_adjustment_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -73,7 +79,10 @@ module Orb
         # that apply to only one price.
         is_invoice_level:,
         # The reason for the adjustment.
-        reason:
+        reason:,
+        # The adjustment id this adjustment replaces. This adjustment will take the place
+        # of the replaced adjustment in plan version migrations.
+        replaces_adjustment_id:
       )
       end
 
@@ -88,7 +97,8 @@ module Orb
             applies_to_price_ids: T::Array[String],
             filters: T::Array[Orb::TransformPriceFilter],
             is_invoice_level: T::Boolean,
-            reason: T.nilable(String)
+            reason: T.nilable(String),
+            replaces_adjustment_id: T.nilable(String)
           }
         )
       end

data/rbi/orb/models/monetary_maximum_adjustment.rbi

@@ -42,6 +42,11 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # The adjustment id this adjustment replaces. This adjustment will take the place
+      # of the replaced adjustment in plan version migrations.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :replaces_adjustment_id
+
       sig do
         params(
           id: String,
@@ -52,7 +57,8 @@ module Orb
           filters: T::Array[Orb::TransformPriceFilter::OrHash],
           is_invoice_level: T::Boolean,
           maximum_amount: String,
-          reason: T.nilable(String)
+          reason: T.nilable(String),
+          replaces_adjustment_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -71,7 +77,10 @@ module Orb
         # adjustment applies to.
         maximum_amount:,
         # The reason for the adjustment.
-        reason:
+        reason:,
+        # The adjustment id this adjustment replaces. This adjustment will take the place
+        # of the replaced adjustment in plan version migrations.
+        replaces_adjustment_id:
       )
       end
 
@@ -86,7 +95,8 @@ module Orb
             filters: T::Array[Orb::TransformPriceFilter],
             is_invoice_level: T::Boolean,
             maximum_amount: String,
-            reason: T.nilable(String)
+            reason: T.nilable(String),
+            replaces_adjustment_id: T.nilable(String)
           }
         )
       end

data/rbi/orb/models/monetary_minimum_adjustment.rbi

@@ -46,6 +46,11 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # The adjustment id this adjustment replaces. This adjustment will take the place
+      # of the replaced adjustment in plan version migrations.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :replaces_adjustment_id
+
       sig do
         params(
           id: String,
@@ -57,7 +62,8 @@ module Orb
           is_invoice_level: T::Boolean,
           item_id: String,
           minimum_amount: String,
-          reason: T.nilable(String)
+          reason: T.nilable(String),
+          replaces_adjustment_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -78,7 +84,10 @@ module Orb
         # adjustment applies to.
         minimum_amount:,
         # The reason for the adjustment.
-        reason:
+        reason:,
+        # The adjustment id this adjustment replaces. This adjustment will take the place
+        # of the replaced adjustment in plan version migrations.
+        replaces_adjustment_id:
       )
       end
 
@@ -94,7 +103,8 @@ module Orb
             is_invoice_level: T::Boolean,
             item_id: String,
             minimum_amount: String,
-            reason: T.nilable(String)
+            reason: T.nilable(String),
+            replaces_adjustment_id: T.nilable(String)
           }
         )
       end

data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi

@@ -47,6 +47,11 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # The adjustment id this adjustment replaces. This adjustment will take the place
+      # of the replaced adjustment in plan version migrations.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :replaces_adjustment_id
+
       sig do
         params(
           id: String,
@@ -57,7 +62,8 @@ module Orb
           filters: T::Array[Orb::TransformPriceFilter::OrHash],
           is_invoice_level: T::Boolean,
           percentage_discount: Float,
-          reason: T.nilable(String)
+          reason: T.nilable(String),
+          replaces_adjustment_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -76,7 +82,10 @@ module Orb
         # intervals this adjustment applies to in a given billing period.
         percentage_discount:,
         # The reason for the adjustment.
-        reason:
+        reason:,
+        # The adjustment id this adjustment replaces. This adjustment will take the place
+        # of the replaced adjustment in plan version migrations.
+        replaces_adjustment_id:
       )
       end
 
@@ -91,7 +100,8 @@ module Orb
             filters: T::Array[Orb::TransformPriceFilter],
             is_invoice_level: T::Boolean,
             percentage_discount: Float,
-            reason: T.nilable(String)
+            reason: T.nilable(String),
+            replaces_adjustment_id: T.nilable(String)
           }
         )
       end

data/rbi/orb/models/monetary_usage_discount_adjustment.rbi

@@ -39,6 +39,11 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # The adjustment id this adjustment replaces. This adjustment will take the place
+      # of the replaced adjustment in plan version migrations.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :replaces_adjustment_id
+
       # The number of usage units by which to discount the price this adjustment applies
       # to in a given billing period.
       sig { returns(Float) }
@@ -54,6 +59,7 @@ module Orb
           filters: T::Array[Orb::TransformPriceFilter::OrHash],
           is_invoice_level: T::Boolean,
           reason: T.nilable(String),
+          replaces_adjustment_id: T.nilable(String),
           usage_discount: Float
         ).returns(T.attached_class)
       end
@@ -71,6 +77,9 @@ module Orb
         is_invoice_level:,
         # The reason for the adjustment.
         reason:,
+        # The adjustment id this adjustment replaces. This adjustment will take the place
+        # of the replaced adjustment in plan version migrations.
+        replaces_adjustment_id:,
         # The number of usage units by which to discount the price this adjustment applies
         # to in a given billing period.
         usage_discount:
@@ -88,6 +97,7 @@ module Orb
             filters: T::Array[Orb::TransformPriceFilter],
             is_invoice_level: T::Boolean,
             reason: T.nilable(String),
+            replaces_adjustment_id: T.nilable(String),
             usage_discount: Float
           }
         )

data/rbi/orb/models/new_plan_bps_price.rbi

@@ -116,6 +116,11 @@ module Orb
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
       attr_accessor :metadata
 
+      # A transient ID that can be used to reference this price when adding adjustments
+      # in the same API call.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reference_id
+
       sig do
         params(
           bps_config: Orb::BPSConfig::OrHash,
@@ -143,7 +148,8 @@ module Orb
           invoice_grouping_key: T.nilable(String),
           invoicing_cycle_configuration:
             T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
-          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          reference_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -186,7 +192,10 @@ module Orb
         # User-specified key/value pairs for the resource. Individual keys can be removed
         # by setting the value to `null`, and the entire metadata mapping can be cleared
         # by setting `metadata` to `null`.
-        metadata: nil
+        metadata: nil,
+        # A transient ID that can be used to reference this price when adding adjustments
+        # in the same API call.
+        reference_id: nil
       )
       end
 
@@ -218,7 +227,8 @@ module Orb
             invoice_grouping_key: T.nilable(String),
             invoicing_cycle_configuration:
               T.nilable(Orb::NewBillingCycleConfiguration),
-            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            reference_id: T.nilable(String)
           }
         )
       end

data/rbi/orb/models/new_plan_bulk_bps_price.rbi

@@ -116,6 +116,11 @@ module Orb
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
       attr_accessor :metadata
 
+      # A transient ID that can be used to reference this price when adding adjustments
+      # in the same API call.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reference_id
+
       sig do
         params(
           bulk_bps_config: Orb::BulkBPSConfig::OrHash,
@@ -143,7 +148,8 @@ module Orb
           invoice_grouping_key: T.nilable(String),
           invoicing_cycle_configuration:
             T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
-          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          reference_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -186,7 +192,10 @@ module Orb
         # User-specified key/value pairs for the resource. Individual keys can be removed
         # by setting the value to `null`, and the entire metadata mapping can be cleared
         # by setting `metadata` to `null`.
-        metadata: nil
+        metadata: nil,
+        # A transient ID that can be used to reference this price when adding adjustments
+        # in the same API call.
+        reference_id: nil
       )
       end
 
@@ -218,7 +227,8 @@ module Orb
             invoice_grouping_key: T.nilable(String),
             invoicing_cycle_configuration:
               T.nilable(Orb::NewBillingCycleConfiguration),
-            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            reference_id: T.nilable(String)
           }
         )
       end

data/rbi/orb/models/new_plan_bulk_price.rbi

@@ -116,6 +116,11 @@ module Orb
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
       attr_accessor :metadata
 
+      # A transient ID that can be used to reference this price when adding adjustments
+      # in the same API call.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reference_id
+
       sig do
         params(
           bulk_config: Orb::BulkConfig::OrHash,
@@ -143,7 +148,8 @@ module Orb
           invoice_grouping_key: T.nilable(String),
           invoicing_cycle_configuration:
             T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
-          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          reference_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -186,7 +192,10 @@ module Orb
         # User-specified key/value pairs for the resource. Individual keys can be removed
         # by setting the value to `null`, and the entire metadata mapping can be cleared
         # by setting `metadata` to `null`.
-        metadata: nil
+        metadata: nil,
+        # A transient ID that can be used to reference this price when adding adjustments
+        # in the same API call.
+        reference_id: nil
       )
       end
 
@@ -218,7 +227,8 @@ module Orb
             invoice_grouping_key: T.nilable(String),
             invoicing_cycle_configuration:
               T.nilable(Orb::NewBillingCycleConfiguration),
-            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            reference_id: T.nilable(String)
           }
         )
       end