orb-billing 0.7.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/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs

@@ -299,7 +299,8 @@ module Orb
               amount: String,
               cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::cadence,
               currency: String,
-              expires_at_end_of_cadence: bool
+              custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?,
+              expires_at_end_of_cadence: bool?
             }
 
           class AllocationPrice < Orb::Internal::Type::BaseModel
@@ -309,20 +310,24 @@ module Orb
 
             attr_accessor currency: String
 
-            attr_accessor expires_at_end_of_cadence: bool
+            attr_accessor custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?
+
+            attr_accessor expires_at_end_of_cadence: bool?
 
             def initialize: (
               amount: String,
               cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::cadence,
               currency: String,
-              expires_at_end_of_cadence: bool
+              ?custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?,
+              ?expires_at_end_of_cadence: bool?
             ) -> void
 
             def to_hash: -> {
               amount: String,
               cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::cadence,
               currency: String,
-              expires_at_end_of_cadence: bool
+              custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?,
+              expires_at_end_of_cadence: bool?
             }
 
             type cadence =
@@ -345,6 +350,39 @@ module Orb
 
               def self?.values: -> ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::cadence]
             end
+
+            type custom_expiration =
+              {
+                duration: Integer,
+                duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+              }
+
+            class CustomExpiration < Orb::Internal::Type::BaseModel
+              attr_accessor duration: Integer
+
+              attr_accessor duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+
+              def initialize: (
+                duration: Integer,
+                duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+              ) -> void
+
+              def to_hash: -> {
+                duration: Integer,
+                duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+              }
+
+              type duration_unit = :day | :month
+
+              module DurationUnit
+                extend Orb::Internal::Type::Enum
+
+                DAY: :day
+                MONTH: :month
+
+                def self?.values: -> ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit]
+              end
+            end
           end
 
           type price =
@@ -6737,7 +6775,8 @@ module Orb
               amount: String,
               cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence,
               currency: String,
-              expires_at_end_of_cadence: bool
+              custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?,
+              expires_at_end_of_cadence: bool?
             }
 
           class AllocationPrice < Orb::Internal::Type::BaseModel
@@ -6747,20 +6786,24 @@ module Orb
 
             attr_accessor currency: String
 
-            attr_accessor expires_at_end_of_cadence: bool
+            attr_accessor custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?
+
+            attr_accessor expires_at_end_of_cadence: bool?
 
             def initialize: (
               amount: String,
               cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence,
               currency: String,
-              expires_at_end_of_cadence: bool
+              ?custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?,
+              ?expires_at_end_of_cadence: bool?
             ) -> void
 
             def to_hash: -> {
               amount: String,
               cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence,
               currency: String,
-              expires_at_end_of_cadence: bool
+              custom_expiration: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?,
+              expires_at_end_of_cadence: bool?
             }
 
             type cadence =
@@ -6783,6 +6826,39 @@ module Orb
 
               def self?.values: -> ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence]
             end
+
+            type custom_expiration =
+              {
+                duration: Integer,
+                duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+              }
+
+            class CustomExpiration < Orb::Internal::Type::BaseModel
+              attr_accessor duration: Integer
+
+              attr_accessor duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+
+              def initialize: (
+                duration: Integer,
+                duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+              ) -> void
+
+              def to_hash: -> {
+                duration: Integer,
+                duration_unit: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+              }
+
+              type duration_unit = :day | :month
+
+              module DurationUnit
+                extend Orb::Internal::Type::Enum
+
+                DAY: :day
+                MONTH: :month
+
+                def self?.values: -> ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit]
+              end
+            end
           end
 
           type price =

data/sig/orb/models/beta_create_plan_version_params.rbs

@@ -298,7 +298,8 @@ module Orb
             amount: String,
             cadence: Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::cadence,
             currency: String,
-            expires_at_end_of_cadence: bool
+            custom_expiration: Orb::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?,
+            expires_at_end_of_cadence: bool?
           }
 
         class AllocationPrice < Orb::Internal::Type::BaseModel
@@ -308,20 +309,24 @@ module Orb
 
           attr_accessor currency: String
 
-          attr_accessor expires_at_end_of_cadence: bool
+          attr_accessor custom_expiration: Orb::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?
+
+          attr_accessor expires_at_end_of_cadence: bool?
 
           def initialize: (
             amount: String,
             cadence: Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::cadence,
             currency: String,
-            expires_at_end_of_cadence: bool
+            ?custom_expiration: Orb::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?,
+            ?expires_at_end_of_cadence: bool?
           ) -> void
 
           def to_hash: -> {
             amount: String,
             cadence: Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::cadence,
             currency: String,
-            expires_at_end_of_cadence: bool
+            custom_expiration: Orb::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration?,
+            expires_at_end_of_cadence: bool?
           }
 
           type cadence =
@@ -339,6 +344,39 @@ module Orb
 
             def self?.values: -> ::Array[Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::cadence]
           end
+
+          type custom_expiration =
+            {
+              duration: Integer,
+              duration_unit: Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+            }
+
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            attr_accessor duration: Integer
+
+            attr_accessor duration_unit: Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+
+            def initialize: (
+              duration: Integer,
+              duration_unit: Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+            ) -> void
+
+            def to_hash: -> {
+              duration: Integer,
+              duration_unit: Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit
+            }
+
+            type duration_unit = :day | :month
+
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              DAY: :day
+              MONTH: :month
+
+              def self?.values: -> ::Array[Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::duration_unit]
+            end
+          end
         end
 
         type price =
@@ -6725,7 +6763,8 @@ module Orb
             amount: String,
             cadence: Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence,
             currency: String,
-            expires_at_end_of_cadence: bool
+            custom_expiration: Orb::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?,
+            expires_at_end_of_cadence: bool?
           }
 
         class AllocationPrice < Orb::Internal::Type::BaseModel
@@ -6735,20 +6774,24 @@ module Orb
 
           attr_accessor currency: String
 
-          attr_accessor expires_at_end_of_cadence: bool
+          attr_accessor custom_expiration: Orb::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?
+
+          attr_accessor expires_at_end_of_cadence: bool?
 
           def initialize: (
             amount: String,
             cadence: Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence,
             currency: String,
-            expires_at_end_of_cadence: bool
+            ?custom_expiration: Orb::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?,
+            ?expires_at_end_of_cadence: bool?
           ) -> void
 
           def to_hash: -> {
             amount: String,
             cadence: Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence,
             currency: String,
-            expires_at_end_of_cadence: bool
+            custom_expiration: Orb::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration?,
+            expires_at_end_of_cadence: bool?
           }
 
           type cadence =
@@ -6766,6 +6809,39 @@ module Orb
 
             def self?.values: -> ::Array[Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::cadence]
           end
+
+          type custom_expiration =
+            {
+              duration: Integer,
+              duration_unit: Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+            }
+
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            attr_accessor duration: Integer
+
+            attr_accessor duration_unit: Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+
+            def initialize: (
+              duration: Integer,
+              duration_unit: Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+            ) -> void
+
+            def to_hash: -> {
+              duration: Integer,
+              duration_unit: Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit
+            }
+
+            type duration_unit = :day | :month
+
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              DAY: :day
+              MONTH: :month
+
+              def self?.values: -> ::Array[Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::duration_unit]
+            end
+          end
         end
 
         type price =