orb-billing 1.47.0 → 1.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d7c98b26b6434d034ca980f43f02584b1899396f1a4e527aafbcf81d7b47616
-  data.tar.gz: d92ce8e10c43f62392c762f01ccae79e520badae4a7f66a6fb91f73f3f53010d
+  metadata.gz: a9de5e66a507e201cfc16aabb8c3b05315d34c90cc18ea4ddd4ec5af2f20397d
+  data.tar.gz: 9ce23da33a1d9052453b788b969f4bd7759cbf336d89bd48737313375870ebce
 SHA512:
-  metadata.gz: d40cf89aa5841db9d6c37dddacd5521aca697e8723a8c6f08fe0514ab201bf06e129831ab244d73687ee674add8265286d6c9cdfb347c77b6491c837ffd342c2
-  data.tar.gz: 608dfcf816e143b4845c999ae90f0e84c7c5cf14157246b0cb61e960be81ceaad1b564a09ccd5ad3cc11d0d3d24b1d77e89010b72f3eedec9ac24d615c99dcc9
+  metadata.gz: 56b985ac015716ca1d328c60cc1d5659dd6f5ea69052bc541aa7a6258d0ad5f5ed685b46dd2b2a9e837d4efb8ea709426ca9773113e1205fa34deb4d383b0611
+  data.tar.gz: ac6d59ad41d20c3878c9531ff2ff899da372cb44a5ce349eea3bbd8ec01144fd199049c5ed31fd309aa2190ed9acdad252cadf0fbf8c892aa6f6e4c1e1e8cb79

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.49.0](https://github.com/orbcorp/orb-ruby/compare/v1.48.0...v1.49.0) (2026-10-27)
+
+
+### Features
+
+* **api:** allow up to 50 spend_exceeded alerts per plan or subscription ([0448a00](https://github.com/orbcorp/orb-ruby/commit/0448a002cbad582b428b77b530b62460e6f96274))
+
+## [1.48.0](https://github.com/orbcorp/orb-ruby/compare/v1.47.0...v1.48.0) (2026-10-24)
+
+
+### Features
+
+* **api:** add list endpoint for lightweight subscription summaries ([7640020](https://github.com/orbcorp/orb-ruby/commit/7640020cab2a3d03c569781bdb51af3ae504fc91))
+
 ## [1.47.0](https://github.com/orbcorp/orb-ruby/compare/v1.46.0...v1.47.0) (2026-10-23)
 
 

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", "~> 1.47.0"
+gem "orb-billing", "~> 1.49.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/credit_block_update_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::CreditBlocks#update
+    class CreditBlockUpdateParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!attribute block_id
+      #
+      #   @return [String]
+      required :block_id, String
+
+      # @!attribute metadata
+      #   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`.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!method initialize(block_id:, metadata: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditBlockUpdateParams} for more details.
+      #
+      #   @param block_id [String]
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/orb/models/credit_block_update_response.rb

@@ -0,0 +1,332 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::CreditBlocks#update
+    class CreditBlockUpdateResponse < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute balance
+      #
+      #   @return [Float]
+      required :balance, Float
+
+      # @!attribute credit_block_source
+      #   How this credit block was created: `allocation` (a subscription's recurring
+      #   credit allocation), `top_up` (an automatic balance-threshold top-up),
+      #   `commitment` (a subscription commitment true-up rolled forward as credit), or
+      #   `manual` (a manual credit ledger increment, including credits voided or expired
+      #   off another block).
+      #
+      #   @return [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditBlockSource]
+      required :credit_block_source, enum: -> { Orb::Models::CreditBlockUpdateResponse::CreditBlockSource }
+
+      # @!attribute effective_date
+      #
+      #   @return [Time, nil]
+      required :effective_date, Time, nil?: true
+
+      # @!attribute expiry_date
+      #
+      #   @return [Time, nil]
+      required :expiry_date, Time, nil?: true
+
+      # @!attribute filters
+      #
+      #   @return [Array<Orb::Models::CreditBlockUpdateResponse::Filter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditBlockUpdateResponse::Filter] }
+
+      # @!attribute maximum_initial_balance
+      #
+      #   @return [Float, nil]
+      required :maximum_initial_balance, Float, nil?: true
+
+      # @!attribute metadata
+      #   User specified key-value pairs for the resource. If not present, this defaults
+      #   to an empty dictionary. Individual keys can be removed by setting the value to
+      #   `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      #   `null`.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Orb::Internal::Type::HashOf[String]
+
+      # @!attribute per_unit_cost_basis
+      #
+      #   @return [String, nil]
+      required :per_unit_cost_basis, String, nil?: true
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Orb::Models::CreditBlockUpdateResponse::Status]
+      required :status, enum: -> { Orb::Models::CreditBlockUpdateResponse::Status }
+
+      # @!attribute credit_allocation
+      #   The credit allocation that funded a block. Extends the allocation resource
+      #   serialized on prices with the catalog-item attribution of the funding price.
+      #
+      #   @return [Orb::Models::CreditBlockUpdateResponse::CreditAllocation, nil]
+      optional :credit_allocation, -> { Orb::Models::CreditBlockUpdateResponse::CreditAllocation }, nil?: true
+
+      # @!attribute credit_commitment
+      #   The subscription commitment whose true-up rolled forward into this credit block.
+      #   Present only when `credit_block_source` is `commitment`.
+      #
+      #   @return [Orb::Models::CreditBlockUpdateResponse::CreditCommitment, nil]
+      optional :credit_commitment, -> { Orb::Models::CreditBlockUpdateResponse::CreditCommitment }, nil?: true
+
+      # @!method initialize(id:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil, credit_commitment: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditBlockUpdateResponse} for more details.
+      #
+      #   The Credit Block resource models prepaid credits within Orb.
+      #
+      #   @param id [String]
+      #
+      #   @param balance [Float]
+      #
+      #   @param credit_block_source [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
+      #
+      #   @param effective_date [Time, nil]
+      #
+      #   @param expiry_date [Time, nil]
+      #
+      #   @param filters [Array<Orb::Models::CreditBlockUpdateResponse::Filter>]
+      #
+      #   @param maximum_initial_balance [Float, nil]
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #
+      #   @param per_unit_cost_basis [String, nil]
+      #
+      #   @param status [Symbol, Orb::Models::CreditBlockUpdateResponse::Status]
+      #
+      #   @param credit_allocation [Orb::Models::CreditBlockUpdateResponse::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
+      #
+      #   @param credit_commitment [Orb::Models::CreditBlockUpdateResponse::CreditCommitment, nil] The subscription commitment whose true-up rolled forward into this credit block.
+
+      # How this credit block was created: `allocation` (a subscription's recurring
+      # credit allocation), `top_up` (an automatic balance-threshold top-up),
+      # `commitment` (a subscription commitment true-up rolled forward as credit), or
+      # `manual` (a manual credit ledger increment, including credits voided or expired
+      # off another block).
+      #
+      # @see Orb::Models::CreditBlockUpdateResponse#credit_block_source
+      module CreditBlockSource
+        extend Orb::Internal::Type::Enum
+
+        ALLOCATION = :allocation
+        TOP_UP = :top_up
+        COMMITMENT = :commitment
+        MANUAL = :manual
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Filter < Orb::Internal::Type::BaseModel
+        # @!attribute field
+        #   The property of the price to filter on.
+        #
+        #   @return [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Field]
+        required :field, enum: -> { Orb::Models::CreditBlockUpdateResponse::Filter::Field }
+
+        # @!attribute operator
+        #   Should prices that match the filter be included or excluded.
+        #
+        #   @return [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Operator]
+        required :operator, enum: -> { Orb::Models::CreditBlockUpdateResponse::Filter::Operator }
+
+        # @!attribute values
+        #   The IDs or values that match this filter.
+        #
+        #   @return [Array<String>]
+        required :values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(field:, operator:, values:)
+        #   @param field [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Field] The property of the price to filter on.
+        #
+        #   @param operator [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Operator] Should prices that match the filter be included or excluded.
+        #
+        #   @param values [Array<String>] The IDs or values that match this filter.
+
+        # The property of the price to filter on.
+        #
+        # @see Orb::Models::CreditBlockUpdateResponse::Filter#field
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID = :price_id
+          ITEM_ID = :item_id
+          PRICE_TYPE = :price_type
+          CURRENCY = :currency
+          PRICING_UNIT_ID = :pricing_unit_id
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Should prices that match the filter be included or excluded.
+        #
+        # @see Orb::Models::CreditBlockUpdateResponse::Filter#operator
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES = :includes
+          EXCLUDES = :excludes
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Orb::Models::CreditBlockUpdateResponse#status
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE = :active
+        PENDING_PAYMENT = :pending_payment
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Orb::Models::CreditBlockUpdateResponse#credit_allocation
+      class CreditAllocation < 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
+
+        # @!attribute item_id
+        #   The ID of the catalog item this block was allocated from, derived from the
+        #   allocation's price.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute filters
+        #
+        #   @return [Array<Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter>, nil]
+        optional :filters,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter] }
+
+        # @!attribute license_type_id
+        #
+        #   @return [String, nil]
+        optional :license_type_id, String, nil?: true
+
+        # @!method initialize(allows_rollover:, currency:, custom_expiration:, item_id:, filters: nil, license_type_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::CreditBlockUpdateResponse::CreditAllocation} for more details.
+        #
+        #   The credit allocation that funded a block. Extends the allocation resource
+        #   serialized on prices with the catalog-item attribution of the funding price.
+        #
+        #   @param allows_rollover [Boolean]
+        #
+        #   @param currency [String]
+        #
+        #   @param custom_expiration [Orb::Models::CustomExpiration, nil]
+        #
+        #   @param item_id [String] The ID of the catalog item this block was allocated from, derived from the alloc
+        #
+        #   @param filters [Array<Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter>]
+        #
+        #   @param license_type_id [String, nil]
+
+        class Filter < Orb::Internal::Type::BaseModel
+          # @!attribute field
+          #   The property of the price to filter on.
+          #
+          #   @return [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Field]
+          required :field, enum: -> { Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Field }
+
+          # @!attribute operator
+          #   Should prices that match the filter be included or excluded.
+          #
+          #   @return [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Operator]
+          required :operator,
+                   enum: -> { Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Operator }
+
+          # @!attribute values
+          #   The IDs or values that match this filter.
+          #
+          #   @return [Array<String>]
+          required :values, Orb::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(field:, operator:, values:)
+          #   @param field [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Field] The property of the price to filter on.
+          #
+          #   @param operator [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Operator] Should prices that match the filter be included or excluded.
+          #
+          #   @param values [Array<String>] The IDs or values that match this filter.
+
+          # The property of the price to filter on.
+          #
+          # @see Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter#field
+          module Field
+            extend Orb::Internal::Type::Enum
+
+            PRICE_ID = :price_id
+            ITEM_ID = :item_id
+            PRICE_TYPE = :price_type
+            CURRENCY = :currency
+            PRICING_UNIT_ID = :pricing_unit_id
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Should prices that match the filter be included or excluded.
+          #
+          # @see Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter#operator
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            INCLUDES = :includes
+            EXCLUDES = :excludes
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      # @see Orb::Models::CreditBlockUpdateResponse#credit_commitment
+      class CreditCommitment < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the subscription commitment this block was rolled forward from.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute subscription_id
+        #   The subscription the commitment belongs to.
+        #
+        #   @return [String, nil]
+        optional :subscription_id, String, nil?: true
+
+        # @!method initialize(id:, subscription_id: nil)
+        #   The subscription commitment whose true-up rolled forward into this credit block.
+        #   Present only when `credit_block_source` is `commitment`.
+        #
+        #   @param id [String] The ID of the subscription commitment this block was rolled forward from.
+        #
+        #   @param subscription_id [String, nil] The subscription the commitment belongs to.
+      end
+    end
+  end
+end

data/lib/orb/models/metric_archive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Metrics#archive
+    class MetricArchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!attribute metric_id
+      #
+      #   @return [String]
+      required :metric_id, String
+
+      # @!method initialize(metric_id:, request_options: {})
+      #   @param metric_id [String]
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/orb/models/metric_unarchive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Metrics#unarchive
+    class MetricUnarchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!attribute metric_id
+      #
+      #   @return [String]
+      required :metric_id, String
+
+      # @!method initialize(metric_id:, request_options: {})
+      #   @param metric_id [String]
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/orb/models/subscription_list_summary_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#list_summary
+    class SubscriptionListSummaryParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!attribute created_at_gt
+      #
+      #   @return [Time, nil]
+      optional :created_at_gt, Time, nil?: true
+
+      # @!attribute created_at_gte
+      #
+      #   @return [Time, nil]
+      optional :created_at_gte, Time, nil?: true
+
+      # @!attribute created_at_lt
+      #
+      #   @return [Time, nil]
+      optional :created_at_lt, Time, nil?: true
+
+      # @!attribute created_at_lte
+      #
+      #   @return [Time, nil]
+      optional :created_at_lte, Time, nil?: true
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #   from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute customer_id
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute external_customer_id
+      #
+      #   @return [String, nil]
+      optional :external_customer_id, String, nil?: true
+
+      # @!attribute external_plan_id
+      #
+      #   @return [String, nil]
+      optional :external_plan_id, String, nil?: true
+
+      # @!attribute limit
+      #   The number of items to fetch. Defaults to 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute plan_id
+      #
+      #   @return [String, nil]
+      optional :plan_id, String, nil?: true
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionListSummaryParams::Status, nil]
+      optional :status, enum: -> { Orb::SubscriptionListSummaryParams::Status }, nil?: true
+
+      # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, external_plan_id: nil, limit: nil, plan_id: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::SubscriptionListSummaryParams} for more details.
+      #
+      #   @param created_at_gt [Time, nil]
+      #
+      #   @param created_at_gte [Time, nil]
+      #
+      #   @param created_at_lt [Time, nil]
+      #
+      #   @param created_at_lte [Time, nil]
+      #
+      #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #
+      #   @param customer_id [String, nil]
+      #
+      #   @param external_customer_id [String, nil]
+      #
+      #   @param external_plan_id [String, nil]
+      #
+      #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      #   @param plan_id [String, nil]
+      #
+      #   @param status [Symbol, Orb::Models::SubscriptionListSummaryParams::Status, nil]
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE = :active
+        ENDED = :ended
+        UPCOMING = :upcoming
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/subscription_list_summary_response.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#list_summary
+    class SubscriptionListSummaryResponse < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute customer
+      #
+      #   @return [Orb::Models::CustomerMinified]
+      required :customer, -> { Orb::CustomerMinified }
+
+      # @!attribute end_date
+      #   The date Orb stops billing for this subscription.
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute metadata
+      #   User specified key-value pairs for the resource. If not present, this defaults
+      #   to an empty dictionary. Individual keys can be removed by setting the value to
+      #   `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      #   `null`.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Orb::Internal::Type::HashOf[String]
+
+      # @!attribute name
+      #   The name of the subscription.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute plan
+      #
+      #   @return [Orb::Models::SubscriptionListSummaryResponse::Plan, nil]
+      required :plan, -> { Orb::Models::SubscriptionListSummaryResponse::Plan }, nil?: true
+
+      # @!attribute start_date
+      #   The date Orb starts billing for this subscription.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionListSummaryResponse::Status]
+      required :status, enum: -> { Orb::Models::SubscriptionListSummaryResponse::Status }
+
+      # @!method initialize(id:, created_at:, customer:, end_date:, metadata:, name:, plan:, start_date:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::SubscriptionListSummaryResponse} for more details.
+      #
+      #   A subscription's own fields, with its plan and customer as references, as listed
+      #   by List subscription summaries and carried in standard webhook payloads. Fetch
+      #   the subscription for its price intervals, billing periods, plan phases and other
+      #   derived fields.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param customer [Orb::Models::CustomerMinified]
+      #
+      #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #
+      #   @param name [String] The name of the subscription.
+      #
+      #   @param plan [Orb::Models::SubscriptionListSummaryResponse::Plan, nil]
+      #
+      #   @param start_date [Time] The date Orb starts billing for this subscription.
+      #
+      #   @param status [Symbol, Orb::Models::SubscriptionListSummaryResponse::Status]
+
+      # @see Orb::Models::SubscriptionListSummaryResponse#plan
+      class Plan < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        required :id, String, nil?: true
+
+        # @!attribute external_plan_id
+        #   An optional user-defined ID for this plan resource, used throughout the system
+        #   as an alias for this Plan. Use this field to identify a plan by an existing
+        #   identifier in your system.
+        #
+        #   @return [String, nil]
+        required :external_plan_id, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!method initialize(id:, external_plan_id:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::SubscriptionListSummaryResponse::Plan} for more details.
+        #
+        #   @param id [String, nil]
+        #
+        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        #
+        #   @param name [String, nil]
+      end
+
+      # @see Orb::Models::SubscriptionListSummaryResponse#status
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE = :active
+        ENDED = :ended
+        UPCOMING = :upcoming
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end