orb-billing 0.6.0 → 0.8.0

data/rbi/orb/models/subscription_schedule_plan_change_params.rbi

@@ -1185,9 +1185,29 @@ module Orb
           sig { returns(String) }
           attr_accessor :currency
 
+          # The custom expiration for the allocation.
+          sig do
+            returns(
+              T.nilable(
+                Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration
+              )
+            )
+          end
+          attr_reader :custom_expiration
+
+          sig do
+            params(
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::OrHash
+                )
+            ).void
+          end
+          attr_writer :custom_expiration
+
           # Whether the allocated amount should expire at the end of the cadence or roll
-          # over to the next period.
-          sig { returns(T::Boolean) }
+          # over to the next period. Set to null if using custom_expiration.
+          sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :expires_at_end_of_cadence
 
           # The definition of a new allocation price to create and add to the subscription.
@@ -1197,7 +1217,11 @@ module Orb
               cadence:
                 Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence::OrSymbol,
               currency: String,
-              expires_at_end_of_cadence: T::Boolean
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::OrHash
+                ),
+              expires_at_end_of_cadence: T.nilable(T::Boolean)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -1208,9 +1232,11 @@ module Orb
             # An ISO 4217 currency string or a custom pricing unit identifier in which to bill
             # this price.
             currency:,
+            # The custom expiration for the allocation.
+            custom_expiration: nil,
             # Whether the allocated amount should expire at the end of the cadence or roll
-            # over to the next period.
-            expires_at_end_of_cadence:
+            # over to the next period. Set to null if using custom_expiration.
+            expires_at_end_of_cadence: nil
           )
           end
 
@@ -1221,7 +1247,11 @@ module Orb
                 cadence:
                   Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence::OrSymbol,
                 currency: String,
-                expires_at_end_of_cadence: T::Boolean
+                custom_expiration:
+                  T.nilable(
+                    Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration
+                  ),
+                expires_at_end_of_cadence: T.nilable(T::Boolean)
               }
             )
           end
@@ -1282,6 +1312,83 @@ module Orb
             def self.values
             end
           end
+
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Integer) }
+            attr_accessor :duration
+
+            sig do
+              returns(
+                Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              )
+            end
+            attr_accessor :duration_unit
+
+            # The custom expiration for the allocation.
+            sig do
+              params(
+                duration: Integer,
+                duration_unit:
+                  Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(duration:, duration_unit:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  duration: Integer,
+                  duration_unit:
+                    Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              DAY =
+                T.let(
+                  :day,
+                  Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+              MONTH =
+                T.let(
+                  :month,
+                  Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel
@@ -17984,9 +18091,29 @@ module Orb
           sig { returns(String) }
           attr_accessor :currency
 
+          # The custom expiration for the allocation.
+          sig do
+            returns(
+              T.nilable(
+                Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration
+              )
+            )
+          end
+          attr_reader :custom_expiration
+
+          sig do
+            params(
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::OrHash
+                )
+            ).void
+          end
+          attr_writer :custom_expiration
+
           # Whether the allocated amount should expire at the end of the cadence or roll
-          # over to the next period.
-          sig { returns(T::Boolean) }
+          # over to the next period. Set to null if using custom_expiration.
+          sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :expires_at_end_of_cadence
 
           # The definition of a new allocation price to create and add to the subscription.
@@ -17996,7 +18123,11 @@ module Orb
               cadence:
                 Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence::OrSymbol,
               currency: String,
-              expires_at_end_of_cadence: T::Boolean
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::OrHash
+                ),
+              expires_at_end_of_cadence: T.nilable(T::Boolean)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -18007,9 +18138,11 @@ module Orb
             # An ISO 4217 currency string or a custom pricing unit identifier in which to bill
             # this price.
             currency:,
+            # The custom expiration for the allocation.
+            custom_expiration: nil,
             # Whether the allocated amount should expire at the end of the cadence or roll
-            # over to the next period.
-            expires_at_end_of_cadence:
+            # over to the next period. Set to null if using custom_expiration.
+            expires_at_end_of_cadence: nil
           )
           end
 
@@ -18020,7 +18153,11 @@ module Orb
                 cadence:
                   Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence::OrSymbol,
                 currency: String,
-                expires_at_end_of_cadence: T::Boolean
+                custom_expiration:
+                  T.nilable(
+                    Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration
+                  ),
+                expires_at_end_of_cadence: T.nilable(T::Boolean)
               }
             )
           end
@@ -18081,6 +18218,83 @@ module Orb
             def self.values
             end
           end
+
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Integer) }
+            attr_accessor :duration
+
+            sig do
+              returns(
+                Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              )
+            end
+            attr_accessor :duration_unit
+
+            # The custom expiration for the allocation.
+            sig do
+              params(
+                duration: Integer,
+                duration_unit:
+                  Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(duration:, duration_unit:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  duration: Integer,
+                  duration_unit:
+                    Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              DAY =
+                T.let(
+                  :day,
+                  Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+              MONTH =
+                T.let(
+                  :month,
+                  Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel

data/rbi/orb/models.rbi

@@ -23,6 +23,14 @@ module Orb
 
   AmountDiscount = Orb::Models::AmountDiscount
 
+  Beta = Orb::Models::Beta
+
+  BetaCreatePlanVersionParams = Orb::Models::BetaCreatePlanVersionParams
+
+  BetaFetchPlanVersionParams = Orb::Models::BetaFetchPlanVersionParams
+
+  BetaSetDefaultPlanVersionParams = Orb::Models::BetaSetDefaultPlanVersionParams
+
   BillableMetric = Orb::Models::BillableMetric
 
   BillingCycleRelativeDate = Orb::Models::BillingCycleRelativeDate
@@ -158,14 +166,18 @@ module Orb
 
   Plans = Orb::Models::Plans
 
-  PlanSetDefaultVersionParams = Orb::Models::PlanSetDefaultVersionParams
-
   PlanUpdateParams = Orb::Models::PlanUpdateParams
 
+  PlanVersion = Orb::Models::PlanVersion
+
+  PlanVersionPhase = Orb::Models::PlanVersionPhase
+
   Price = Orb::Models::Price
 
   PriceCreateParams = Orb::Models::PriceCreateParams
 
+  PriceEvaluateMultipleParams = Orb::Models::PriceEvaluateMultipleParams
+
   PriceEvaluateParams = Orb::Models::PriceEvaluateParams
 
   PriceFetchParams = Orb::Models::PriceFetchParams

data/rbi/orb/resources/{plans/versions.rbi → beta/external_plan_id.rbi}

@@ -2,50 +2,58 @@
 
 module Orb
   module Resources
-    class Plans
-      class Versions
+    class Beta
+      class ExternalPlanID
         # This API endpoint is in beta and its interface may change. It is recommended for
         # use only in test mode.
         #
         # This endpoint allows the creation of a new plan version for an existing plan.
         sig do
           params(
-            plan_id: String,
+            external_plan_id: String,
             version: Integer,
             add_adjustments:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::AddAdjustment::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddAdjustment::OrHash
+                ]
               ),
             add_prices:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::AddPrice::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::OrHash
+                ]
               ),
             remove_adjustments:
               T.nilable(
                 T::Array[
-                  Orb::Plans::VersionCreateParams::RemoveAdjustment::OrHash
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemoveAdjustment::OrHash
                 ]
               ),
             remove_prices:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::RemovePrice::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemovePrice::OrHash
+                ]
               ),
             replace_adjustments:
               T.nilable(
                 T::Array[
-                  Orb::Plans::VersionCreateParams::ReplaceAdjustment::OrHash
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplaceAdjustment::OrHash
                 ]
               ),
             replace_prices:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::ReplacePrice::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::OrHash
+                ]
               ),
             set_as_default: T.nilable(T::Boolean),
             request_options: Orb::RequestOptions::OrHash
-          ).returns(Orb::Models::Plans::VersionCreateResponse)
+          ).returns(Orb::PlanVersion)
         end
-        def create(
-          plan_id,
+        def create_plan_version(
+          external_plan_id,
           # New version number.
           version:,
           # Additional adjustments to be added to the plan.
@@ -74,11 +82,30 @@ module Orb
         sig do
           params(
             version: String,
-            plan_id: String,
+            external_plan_id: String,
             request_options: Orb::RequestOptions::OrHash
-          ).returns(Orb::Models::Plans::VersionRetrieveResponse)
+          ).returns(Orb::PlanVersion)
+        end
+        def fetch_plan_version(version, external_plan_id:, request_options: {})
         end
-        def retrieve(version, plan_id:, request_options: {})
+
+        # This API endpoint is in beta and its interface may change. It is recommended for
+        # use only in test mode.
+        #
+        # This endpoint allows setting the default version of a plan.
+        sig do
+          params(
+            external_plan_id: String,
+            version: Integer,
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Plan)
+        end
+        def set_default_plan_version(
+          external_plan_id,
+          # Plan version to set as the default.
+          version:,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/orb/resources/beta.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Orb
+  module Resources
+    class Beta
+      sig { returns(Orb::Resources::Beta::ExternalPlanID) }
+      attr_reader :external_plan_id
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint allows the creation of a new plan version for an existing plan.
+      sig do
+        params(
+          plan_id: String,
+          version: Integer,
+          add_adjustments:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::AddAdjustment::OrHash]
+            ),
+          add_prices:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::AddPrice::OrHash]
+            ),
+          remove_adjustments:
+            T.nilable(
+              T::Array[
+                Orb::BetaCreatePlanVersionParams::RemoveAdjustment::OrHash
+              ]
+            ),
+          remove_prices:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::RemovePrice::OrHash]
+            ),
+          replace_adjustments:
+            T.nilable(
+              T::Array[
+                Orb::BetaCreatePlanVersionParams::ReplaceAdjustment::OrHash
+              ]
+            ),
+          replace_prices:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::ReplacePrice::OrHash]
+            ),
+          set_as_default: T.nilable(T::Boolean),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::PlanVersion)
+      end
+      def create_plan_version(
+        plan_id,
+        # New version number.
+        version:,
+        # Additional adjustments to be added to the plan.
+        add_adjustments: nil,
+        # Additional prices to be added to the plan.
+        add_prices: nil,
+        # Adjustments to be removed from the plan.
+        remove_adjustments: nil,
+        # Prices to be removed from the plan.
+        remove_prices: nil,
+        # Adjustments to be replaced with additional adjustments on the plan.
+        replace_adjustments: nil,
+        # Prices to be replaced with additional prices on the plan.
+        replace_prices: nil,
+        # Set this new plan version as the default
+        set_as_default: nil,
+        request_options: {}
+      )
+      end
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint is used to fetch a plan version. It returns the phases, prices,
+      # and adjustments present on this version of the plan.
+      sig do
+        params(
+          version: String,
+          plan_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::PlanVersion)
+      end
+      def fetch_plan_version(version, plan_id:, request_options: {})
+      end
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint allows setting the default version of a plan.
+      sig do
+        params(
+          plan_id: String,
+          version: Integer,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Plan)
+      end
+      def set_default_plan_version(
+        plan_id,
+        # Plan version to set as the default.
+        version:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Orb::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/orb/resources/plans/external_plan_id.rbi

@@ -4,9 +4,6 @@ module Orb
   module Resources
     class Plans
       class ExternalPlanID
-        sig { returns(Orb::Resources::Plans::ExternalPlanID::Versions) }
-        attr_reader :versions
-
         # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
         # existing plan.
         #
@@ -58,25 +55,6 @@ module Orb
         def fetch(external_plan_id, request_options: {})
         end
 
-        # This API endpoint is in beta and its interface may change. It is recommended for
-        # use only in test mode.
-        #
-        # This endpoint allows setting the default version of a plan.
-        sig do
-          params(
-            external_plan_id: String,
-            version: Integer,
-            request_options: Orb::RequestOptions::OrHash
-          ).returns(Orb::Plan)
-        end
-        def set_default_version(
-          external_plan_id,
-          # Plan version to set as the default.
-          version:,
-          request_options: {}
-        )
-        end
-
         # @api private
         sig { params(client: Orb::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/orb/resources/plans.rbi

@@ -6,9 +6,6 @@ module Orb
       sig { returns(Orb::Resources::Plans::ExternalPlanID) }
       attr_reader :external_plan_id
 
-      sig { returns(Orb::Resources::Plans::Versions) }
-      attr_reader :versions
-
       # This endpoint allows creation of plans including their prices.
       sig do
         params(
@@ -166,25 +163,6 @@ module Orb
       def fetch(plan_id, request_options: {})
       end
 
-      # This API endpoint is in beta and its interface may change. It is recommended for
-      # use only in test mode.
-      #
-      # This endpoint allows setting the default version of a plan.
-      sig do
-        params(
-          plan_id: String,
-          version: Integer,
-          request_options: Orb::RequestOptions::OrHash
-        ).returns(Orb::Plan)
-      end
-      def set_default_version(
-        plan_id,
-        # Plan version to set as the default.
-        version:,
-        request_options: {}
-      )
-      end
-
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
       def self.new(client:)