orb-billing 0.12.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7141a773b4b921917720b072f2380cf9f72c9e9de30497b6cbd74b5b511fb295
-  data.tar.gz: 9c2ce5c3a421d2c09b4025b4b9883a8f082e630a7b2174308957d04ebef89322
+  metadata.gz: 175cacf25dd81d31c7ce9f5df603f0069562ae8e3abd5d9e805d7de8860fa1d2
+  data.tar.gz: 042ad24b0cc07100d1ad5881ef6a4a433c3c799036d93fe6f52c336be9a7d980
 SHA512:
-  metadata.gz: 68d584671e377dc03545e0ebdde30302bfdd4d337058b2e1219ba70247b54300ba2a1a4ba9642fcfedc7a2a0823189b2ed96ba5d5e946cc521a67a657309e8b6
-  data.tar.gz: 61a96ed2e99e24e126da47fbab10a076c410000b2ebebafda00c94776fbe199d053518b74ee7c616ee48375431f9f231469284291f9f0731f8a8f63141bf5b27
+  metadata.gz: 27f9ea79c2811daef25a39870354fd0deb0d0d5504e0b90b6ef662646520e457a29a3e31e65b75eda2a697046d43e5ffbc99aa3be37faf5067edd706cf0316ff
+  data.tar.gz: 3abc8e465966817ddd1ac12571d9d8a5134fa200c000ad1c71e5601b13fb727afdc6b20c3ac8a7f45d454e5eb2d367770758bec41711ec8bcb9bd15cf707af6e

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.0.0 (2025-06-09)
+
+Full Changelog: [v0.12.0...v1.0.0](https://github.com/orbcorp/orb-ruby/compare/v0.12.0...v1.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **client:** breaking change to re-use types
+
+### Features
+
+* **api:** api update ([a04f1e8](https://github.com/orbcorp/orb-ruby/commit/a04f1e89e9188912bf860fc0214f657c2d135b6e))
+* **api:** api update ([bd80319](https://github.com/orbcorp/orb-ruby/commit/bd8031945315e344ca53add3fb00d33ff6453bd0))
+* **api:** manual updates ([c72f634](https://github.com/orbcorp/orb-ruby/commit/c72f6346f566626bc15ee71e218f7aebdbf9f3ff))
+* **client:** breaking change to re-use types ([4988d1c](https://github.com/orbcorp/orb-ruby/commit/4988d1cf7cf2ebdbb78227c8fed3cc63647942a2))
+
+
+### Chores
+
+* **internal:** version bump ([46b439b](https://github.com/orbcorp/orb-ruby/commit/46b439b8d9cb1e7ea8fe97e2d81ec66d60f3aada))
+
 ## 0.12.0 (2025-06-04)
 
 Full Changelog: [v0.11.0...v0.12.0](https://github.com/orbcorp/orb-ruby/compare/v0.11.0...v0.12.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 0.12.0"
+gem "orb-billing", "~> 1.0.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/internal/type/base_model.rb

@@ -395,11 +395,11 @@ module Orb
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `amount_discount` is a `Orb::AmountDiscount`
-        #   amount_discount => {
-        #     amount_discount: amount_discount,
-        #     discount_type: discount_type,
-        #     applies_to_price_ids: applies_to_price_ids
+        #   # `address` is a `Orb::Address`
+        #   address => {
+        #     city: city,
+        #     country: country,
+        #     line1: line1
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/orb/models/accounting_provider_config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class AccountingProviderConfig < Orb::Internal::Type::BaseModel
+      # @!attribute external_provider_id
+      #
+      #   @return [String]
+      required :external_provider_id, String
+
+      # @!attribute provider_type
+      #
+      #   @return [String]
+      required :provider_type, String
+
+      # @!method initialize(external_provider_id:, provider_type:)
+      #   @param external_provider_id [String]
+      #   @param provider_type [String]
+    end
+  end
+end

data/lib/orb/models/address.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class Address < Orb::Internal::Type::BaseModel
+      # @!attribute city
+      #
+      #   @return [String, nil]
+      required :city, String, nil?: true
+
+      # @!attribute country
+      #
+      #   @return [String, nil]
+      required :country, String, nil?: true
+
+      # @!attribute line1
+      #
+      #   @return [String, nil]
+      required :line1, String, nil?: true
+
+      # @!attribute line2
+      #
+      #   @return [String, nil]
+      required :line2, String, nil?: true
+
+      # @!attribute postal_code
+      #
+      #   @return [String, nil]
+      required :postal_code, String, nil?: true
+
+      # @!attribute state
+      #
+      #   @return [String, nil]
+      required :state, String, nil?: true
+
+      # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
+      #   @param city [String, nil]
+      #   @param country [String, nil]
+      #   @param line1 [String, nil]
+      #   @param line2 [String, nil]
+      #   @param postal_code [String, nil]
+      #   @param state [String, nil]
+    end
+  end
+end

data/lib/orb/models/address_input.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class AddressInput < Orb::Internal::Type::BaseModel
+      # @!attribute city
+      #
+      #   @return [String, nil]
+      optional :city, String, nil?: true
+
+      # @!attribute country
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute line1
+      #
+      #   @return [String, nil]
+      optional :line1, String, nil?: true
+
+      # @!attribute line2
+      #
+      #   @return [String, nil]
+      optional :line2, String, nil?: true
+
+      # @!attribute postal_code
+      #
+      #   @return [String, nil]
+      optional :postal_code, String, nil?: true
+
+      # @!attribute state
+      #
+      #   @return [String, nil]
+      optional :state, String, nil?: true
+
+      # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
+      #   @param city [String, nil]
+      #   @param country [String, nil]
+      #   @param line1 [String, nil]
+      #   @param line2 [String, nil]
+      #   @param postal_code [String, nil]
+      #   @param state [String, nil]
+    end
+  end
+end

data/lib/orb/models/adjustment_interval.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class AdjustmentInterval < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment
+      #
+      #   @return [Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment]
+      required :adjustment, union: -> { Orb::AdjustmentInterval::Adjustment }
+
+      # @!attribute applies_to_price_interval_ids
+      #   The price interval IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute end_date
+      #   The end date of the adjustment interval.
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute start_date
+      #   The start date of the adjustment interval.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
+      #   @param id [String]
+      #
+      #   @param adjustment [Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment]
+      #
+      #   @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
+      #
+      #   @param end_date [Time, nil] The end date of the adjustment interval.
+      #
+      #   @param start_date [Time] The start date of the adjustment interval.
+
+      # @see Orb::Models::AdjustmentInterval#adjustment
+      module Adjustment
+        extend Orb::Internal::Type::Union
+
+        discriminator :adjustment_type
+
+        variant :usage_discount, -> { Orb::PlanPhaseUsageDiscountAdjustment }
+
+        variant :amount_discount, -> { Orb::PlanPhaseAmountDiscountAdjustment }
+
+        variant :percentage_discount, -> { Orb::PlanPhasePercentageDiscountAdjustment }
+
+        variant :minimum, -> { Orb::PlanPhaseMinimumAdjustment }
+
+        variant :maximum, -> { Orb::PlanPhaseMaximumAdjustment }
+
+        # @!method self.variants
+        #   @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
+      end
+    end
+  end
+end

data/lib/orb/models/aggregated_cost.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class AggregatedCost < Orb::Internal::Type::BaseModel
+      # @!attribute per_price_costs
+      #
+      #   @return [Array<Orb::Models::PerPriceCost>]
+      required :per_price_costs, -> { Orb::Internal::Type::ArrayOf[Orb::PerPriceCost] }
+
+      # @!attribute subtotal
+      #   Total costs for the timeframe, excluding any minimums and discounts.
+      #
+      #   @return [String]
+      required :subtotal, String
+
+      # @!attribute timeframe_end
+      #
+      #   @return [Time]
+      required :timeframe_end, Time
+
+      # @!attribute timeframe_start
+      #
+      #   @return [Time]
+      required :timeframe_start, Time
+
+      # @!attribute total
+      #   Total costs for the timeframe, including any minimums and discounts.
+      #
+      #   @return [String]
+      required :total, String
+
+      # @!method initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:)
+      #   @param per_price_costs [Array<Orb::Models::PerPriceCost>]
+      #
+      #   @param subtotal [String] Total costs for the timeframe, excluding any minimums and discounts.
+      #
+      #   @param timeframe_end [Time]
+      #
+      #   @param timeframe_start [Time]
+      #
+      #   @param total [String] Total costs for the timeframe, including any minimums and discounts.
+    end
+  end
+end

data/lib/orb/models/alert.rb

@@ -25,8 +25,8 @@ module Orb
       # @!attribute customer
       #   The customer the alert applies to.
       #
-      #   @return [Orb::Models::Alert::Customer, nil]
-      required :customer, -> { Orb::Alert::Customer }, nil?: true
+      #   @return [Orb::Models::CustomerMinified, nil]
+      required :customer, -> { Orb::CustomerMinified }, nil?: true
 
       # @!attribute enabled
       #   Whether the alert is enabled or disabled.
@@ -49,15 +49,15 @@ module Orb
       # @!attribute subscription
       #   The subscription the alert applies to.
       #
-      #   @return [Orb::Models::Alert::Subscription, nil]
-      required :subscription, -> { Orb::Alert::Subscription }, nil?: true
+      #   @return [Orb::Models::SubscriptionMinified, nil]
+      required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
 
       # @!attribute thresholds
       #   The thresholds that define the conditions under which the alert will be
       #   triggered.
       #
-      #   @return [Array<Orb::Models::Alert::Threshold>, nil]
-      required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Alert::Threshold] }, nil?: true
+      #   @return [Array<Orb::Models::Threshold>, nil]
+      required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
 
       # @!attribute type
       #   The type of alert. This must be a valid alert type.
@@ -90,7 +90,7 @@ module Orb
       #
       #   @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
       #
-      #   @param customer [Orb::Models::Alert::Customer, nil] The customer the alert applies to.
+      #   @param customer [Orb::Models::CustomerMinified, nil] The customer the alert applies to.
       #
       #   @param enabled [Boolean] Whether the alert is enabled or disabled.
       #
@@ -98,33 +98,14 @@ module Orb
       #
       #   @param plan [Orb::Models::Alert::Plan, nil] The plan the alert applies to.
       #
-      #   @param subscription [Orb::Models::Alert::Subscription, nil] The subscription the alert applies to.
+      #   @param subscription [Orb::Models::SubscriptionMinified, nil] The subscription the alert applies to.
       #
-      #   @param thresholds [Array<Orb::Models::Alert::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
+      #   @param thresholds [Array<Orb::Models::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
       #
       #   @param type [Symbol, Orb::Models::Alert::Type] The type of alert. This must be a valid alert type.
       #
       #   @param balance_alert_status [Array<Orb::Models::Alert::BalanceAlertStatus>, nil] The current status of the alert. This field is only present for credit balance a
 
-      # @see Orb::Models::Alert#customer
-      class Customer < Orb::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute external_customer_id
-        #
-        #   @return [String, nil]
-        required :external_customer_id, String, nil?: true
-
-        # @!method initialize(id:, external_customer_id:)
-        #   The customer the alert applies to.
-        #
-        #   @param id [String]
-        #   @param external_customer_id [String, nil]
-      end
-
       # @see Orb::Models::Alert#metric
       class Metric < Orb::Internal::Type::BaseModel
         # @!attribute id
@@ -178,38 +159,6 @@ module Orb
         #   @param plan_version [String]
       end
 
-      # @see Orb::Models::Alert#subscription
-      class Subscription < Orb::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!method initialize(id:)
-        #   The subscription the alert applies to.
-        #
-        #   @param id [String]
-      end
-
-      class Threshold < Orb::Internal::Type::BaseModel
-        # @!attribute value
-        #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #   fire at or below this value. For usage and cost alerts, the alert will fire at
-        #   or above this value.
-        #
-        #   @return [Float]
-        required :value, Float
-
-        # @!method initialize(value:)
-        #   Some parameter documentations has been truncated, see
-        #   {Orb::Models::Alert::Threshold} for more details.
-        #
-        #   Thresholds are used to define the conditions under which an alert will be
-        #   triggered.
-        #
-        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
-      end
-
       # The type of alert. This must be a valid alert type.
       #
       # @see Orb::Models::Alert#type

data/lib/orb/models/alert_create_for_customer_params.rb

@@ -22,17 +22,15 @@ module Orb
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
-      #   @return [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil]
-      optional :thresholds,
-               -> { Orb::Internal::Type::ArrayOf[Orb::AlertCreateForCustomerParams::Threshold] },
-               nil?: true
+      #   @return [Array<Orb::Models::Threshold>, nil]
+      optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
 
       # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
       #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
       #
-      #   @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #   @param thresholds [Array<Orb::Models::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
@@ -47,25 +45,6 @@ module Orb
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      class Threshold < Orb::Internal::Type::BaseModel
-        # @!attribute value
-        #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #   fire at or below this value. For usage and cost alerts, the alert will fire at
-        #   or above this value.
-        #
-        #   @return [Float]
-        required :value, Float
-
-        # @!method initialize(value:)
-        #   Some parameter documentations has been truncated, see
-        #   {Orb::Models::AlertCreateForCustomerParams::Threshold} for more details.
-        #
-        #   Thresholds are used to define the conditions under which an alert will be
-        #   triggered.
-        #
-        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
-      end
     end
   end
 end

data/lib/orb/models/alert_create_for_external_customer_params.rb

@@ -22,17 +22,15 @@ module Orb
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
-      #   @return [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil]
-      optional :thresholds,
-               -> { Orb::Internal::Type::ArrayOf[Orb::AlertCreateForExternalCustomerParams::Threshold] },
-               nil?: true
+      #   @return [Array<Orb::Models::Threshold>, nil]
+      optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
 
       # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
       #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
       #
-      #   @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #   @param thresholds [Array<Orb::Models::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
@@ -47,25 +45,6 @@ module Orb
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      class Threshold < Orb::Internal::Type::BaseModel
-        # @!attribute value
-        #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #   fire at or below this value. For usage and cost alerts, the alert will fire at
-        #   or above this value.
-        #
-        #   @return [Float]
-        required :value, Float
-
-        # @!method initialize(value:)
-        #   Some parameter documentations has been truncated, see
-        #   {Orb::Models::AlertCreateForExternalCustomerParams::Threshold} for more details.
-        #
-        #   Thresholds are used to define the conditions under which an alert will be
-        #   triggered.
-        #
-        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
-      end
     end
   end
 end

data/lib/orb/models/alert_create_for_subscription_params.rb

@@ -10,9 +10,8 @@ module Orb
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
-      #   @return [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>]
-      required :thresholds,
-               -> { Orb::Internal::Type::ArrayOf[Orb::AlertCreateForSubscriptionParams::Threshold] }
+      #   @return [Array<Orb::Models::Threshold>]
+      required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
 
       # @!attribute type
       #   The type of alert to create. This must be a valid alert type.
@@ -27,7 +26,7 @@ module Orb
       optional :metric_id, String, nil?: true
 
       # @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
-      #   @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
       #
@@ -35,25 +34,6 @@ module Orb
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
-      class Threshold < Orb::Internal::Type::BaseModel
-        # @!attribute value
-        #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #   fire at or below this value. For usage and cost alerts, the alert will fire at
-        #   or above this value.
-        #
-        #   @return [Float]
-        required :value, Float
-
-        # @!method initialize(value:)
-        #   Some parameter documentations has been truncated, see
-        #   {Orb::Models::AlertCreateForSubscriptionParams::Threshold} for more details.
-        #
-        #   Thresholds are used to define the conditions under which an alert will be
-        #   triggered.
-        #
-        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
-      end
-
       # The type of alert to create. This must be a valid alert type.
       module Type
         extend Orb::Internal::Type::Enum

data/lib/orb/models/alert_update_params.rb

@@ -10,32 +10,13 @@ module Orb
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
-      #   @return [Array<Orb::Models::AlertUpdateParams::Threshold>]
-      required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::AlertUpdateParams::Threshold] }
+      #   @return [Array<Orb::Models::Threshold>]
+      required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
 
       # @!method initialize(thresholds:, request_options: {})
-      #   @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-
-      class Threshold < Orb::Internal::Type::BaseModel
-        # @!attribute value
-        #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #   fire at or below this value. For usage and cost alerts, the alert will fire at
-        #   or above this value.
-        #
-        #   @return [Float]
-        required :value, Float
-
-        # @!method initialize(value:)
-        #   Some parameter documentations has been truncated, see
-        #   {Orb::Models::AlertUpdateParams::Threshold} for more details.
-        #
-        #   Thresholds are used to define the conditions under which an alert will be
-        #   triggered.
-        #
-        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
-      end
     end
   end
 end

data/lib/orb/models/allocation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class Allocation < Orb::Internal::Type::BaseModel
+      # @!attribute allows_rollover
+      #
+      #   @return [Boolean]
+      required :allows_rollover, Orb::Internal::Type::Boolean
+
+      # @!attribute currency
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute custom_expiration
+      #
+      #   @return [Orb::Models::CustomExpiration, nil]
+      required :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
+
+      # @!method initialize(allows_rollover:, currency:, custom_expiration:)
+      #   @param allows_rollover [Boolean]
+      #   @param currency [String]
+      #   @param custom_expiration [Orb::Models::CustomExpiration, nil]
+    end
+  end
+end