orb-billing 1.14.0 → 1.15.0

data/rbi/orb/models/customer_update_by_external_id_params.rbi

@@ -57,6 +57,11 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
 
+      # The Orb ID of the payment method to set as this customer's default. Pass `null`
+      # to clear the customer's default payment method.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :default_payment_method_id
+
       # A valid customer email, to be used for invoicing and notifications.
       sig { returns(T.nilable(String)) }
       attr_accessor :email
@@ -223,11 +228,13 @@ module Orb
       # | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
       # | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
       # | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+      # | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
       # | Finland                | `eu_vat`     | European VAT Number                                                                                     |
       # | France                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
       # | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
       # | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+      # | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
       # | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
       # | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -239,6 +246,7 @@ module Orb
       # | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
       # | Israel                 | `il_vat`     | Israel VAT                                                                                              |
       # | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+      # | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
       # | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
       # | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
       # | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -269,6 +277,7 @@ module Orb
       # | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
       # | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
       # | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+      # | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
       # | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
       # | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
       # | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -290,6 +299,7 @@ module Orb
       # | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
       # | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
       # | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+      # | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
       # | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
       # | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -327,6 +337,7 @@ module Orb
           auto_issuance: T.nilable(T::Boolean),
           billing_address: T.nilable(Orb::AddressInput::OrHash),
           currency: T.nilable(String),
+          default_payment_method_id: T.nilable(String),
           email: T.nilable(String),
           email_delivery: T.nilable(T::Boolean),
           external_customer_id: T.nilable(String),
@@ -382,6 +393,9 @@ module Orb
         # not set at creation or update time, it will be set at subscription creation
         # time.
         currency: nil,
+        # The Orb ID of the payment method to set as this customer's default. Pass `null`
+        # to clear the customer's default payment method.
+        default_payment_method_id: nil,
         # A valid customer email, to be used for invoicing and notifications.
         email: nil,
         email_delivery: nil,
@@ -473,11 +487,13 @@ module Orb
         # | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
         # | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
         # | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+        # | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
         # | Finland                | `eu_vat`     | European VAT Number                                                                                     |
         # | France                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
         # | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
         # | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+        # | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
         # | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
         # | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -489,6 +505,7 @@ module Orb
         # | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
         # | Israel                 | `il_vat`     | Israel VAT                                                                                              |
         # | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+        # | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
         # | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
         # | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
         # | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -519,6 +536,7 @@ module Orb
         # | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
         # | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
         # | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+        # | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
         # | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
         # | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
         # | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -540,6 +558,7 @@ module Orb
         # | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
         # | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
         # | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+        # | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
         # | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
         # | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -577,6 +596,7 @@ module Orb
             auto_issuance: T.nilable(T::Boolean),
             billing_address: T.nilable(Orb::AddressInput),
             currency: T.nilable(String),
+            default_payment_method_id: T.nilable(String),
             email: T.nilable(String),
             email_delivery: T.nilable(T::Boolean),
             external_customer_id: T.nilable(String),
@@ -820,9 +840,9 @@ module Orb
             :netsuite,
             Orb::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol
           )
-        NETSUITE_AMPERSAND =
+        ADYEN =
           T.let(
-            :netsuite_ampersand,
+            :adyen,
             Orb::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol
           )
 

data/rbi/orb/models/customer_update_params.rbi

@@ -57,6 +57,11 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
 
+      # The Orb ID of the payment method to set as this customer's default. Pass `null`
+      # to clear the customer's default payment method.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :default_payment_method_id
+
       # A valid customer email, to be used for invoicing and notifications.
       sig { returns(T.nilable(String)) }
       attr_accessor :email
@@ -215,11 +220,13 @@ module Orb
       # | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
       # | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
       # | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+      # | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
       # | Finland                | `eu_vat`     | European VAT Number                                                                                     |
       # | France                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
       # | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
       # | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+      # | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
       # | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
       # | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -231,6 +238,7 @@ module Orb
       # | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
       # | Israel                 | `il_vat`     | Israel VAT                                                                                              |
       # | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+      # | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
       # | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
       # | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
       # | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -261,6 +269,7 @@ module Orb
       # | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
       # | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
       # | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+      # | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
       # | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
       # | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
       # | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -282,6 +291,7 @@ module Orb
       # | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
       # | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
       # | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+      # | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
       # | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
       # | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -319,6 +329,7 @@ module Orb
           auto_issuance: T.nilable(T::Boolean),
           billing_address: T.nilable(Orb::AddressInput::OrHash),
           currency: T.nilable(String),
+          default_payment_method_id: T.nilable(String),
           email: T.nilable(String),
           email_delivery: T.nilable(T::Boolean),
           external_customer_id: T.nilable(String),
@@ -370,6 +381,9 @@ module Orb
         # not set at creation or update time, it will be set at subscription creation
         # time.
         currency: nil,
+        # The Orb ID of the payment method to set as this customer's default. Pass `null`
+        # to clear the customer's default payment method.
+        default_payment_method_id: nil,
         # A valid customer email, to be used for invoicing and notifications.
         email: nil,
         email_delivery: nil,
@@ -461,11 +475,13 @@ module Orb
         # | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
         # | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
         # | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+        # | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
         # | Finland                | `eu_vat`     | European VAT Number                                                                                     |
         # | France                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
         # | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
         # | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+        # | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
         # | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
         # | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -477,6 +493,7 @@ module Orb
         # | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
         # | Israel                 | `il_vat`     | Israel VAT                                                                                              |
         # | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+        # | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
         # | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
         # | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
         # | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -507,6 +524,7 @@ module Orb
         # | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
         # | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
         # | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+        # | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
         # | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
         # | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
         # | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -528,6 +546,7 @@ module Orb
         # | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
         # | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
         # | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+        # | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
         # | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
         # | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -565,6 +584,7 @@ module Orb
             auto_issuance: T.nilable(T::Boolean),
             billing_address: T.nilable(Orb::AddressInput),
             currency: T.nilable(String),
+            default_payment_method_id: T.nilable(String),
             email: T.nilable(String),
             email_delivery: T.nilable(T::Boolean),
             external_customer_id: T.nilable(String),
@@ -801,9 +821,9 @@ module Orb
             :netsuite,
             Orb::CustomerUpdateParams::PaymentProvider::TaggedSymbol
           )
-        NETSUITE_AMPERSAND =
+        ADYEN =
           T.let(
-            :netsuite_ampersand,
+            :adyen,
             Orb::CustomerUpdateParams::PaymentProvider::TaggedSymbol
           )
 

data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi

@@ -18,6 +18,17 @@ module Orb
         sig { returns(Float) }
         attr_accessor :balance
 
+        # How this credit block was created: `allocation` (a subscription's recurring
+        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # `manual` (a manual credit ledger increment, including credits voided or expired
+        # off another block).
+        sig do
+          returns(
+            Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+          )
+        end
+        attr_accessor :credit_block_source
+
         sig { returns(T.nilable(Time)) }
         attr_accessor :effective_date
 
@@ -53,10 +64,33 @@ module Orb
         end
         attr_accessor :status
 
+        # The credit allocation that funded a block. Extends the allocation resource
+        # serialized on prices with the catalog-item attribution of the funding price.
+        sig do
+          returns(
+            T.nilable(
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation
+            )
+          )
+        end
+        attr_reader :credit_allocation
+
+        sig do
+          params(
+            credit_allocation:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::OrHash
+              )
+          ).void
+        end
+        attr_writer :credit_allocation
+
         sig do
           params(
             id: String,
             balance: Float,
+            credit_block_source:
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::OrSymbol,
             effective_date: T.nilable(Time),
             expiry_date: T.nilable(Time),
             filters:
@@ -67,12 +101,21 @@ module Orb
             metadata: T::Hash[Symbol, String],
             per_unit_cost_basis: T.nilable(String),
             status:
-              Orb::Models::Customers::CreditListByExternalIDResponse::Status::OrSymbol
+              Orb::Models::Customers::CreditListByExternalIDResponse::Status::OrSymbol,
+            credit_allocation:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::OrHash
+              )
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
           balance:,
+          # How this credit block was created: `allocation` (a subscription's recurring
+          # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+          # `manual` (a manual credit ledger increment, including credits voided or expired
+          # off another block).
+          credit_block_source:,
           effective_date:,
           expiry_date:,
           filters:,
@@ -83,7 +126,10 @@ module Orb
           # `null`.
           metadata:,
           per_unit_cost_basis:,
-          status:
+          status:,
+          # The credit allocation that funded a block. Extends the allocation resource
+          # serialized on prices with the catalog-item attribution of the funding price.
+          credit_allocation: nil
         )
         end
 
@@ -92,6 +138,8 @@ module Orb
             {
               id: String,
               balance: Float,
+              credit_block_source:
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol,
               effective_date: T.nilable(Time),
               expiry_date: T.nilable(Time),
               filters:
@@ -102,13 +150,60 @@ module Orb
               metadata: T::Hash[Symbol, String],
               per_unit_cost_basis: T.nilable(String),
               status:
-                Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol
+                Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol,
+              credit_allocation:
+                T.nilable(
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation
+                )
             }
           )
         end
         def to_hash
         end
 
+        # How this credit block was created: `allocation` (a subscription's recurring
+        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # `manual` (a manual credit ledger increment, including credits voided or expired
+        # off another block).
+        module CreditBlockSource
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALLOCATION =
+            T.let(
+              :allocation,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
+          TOP_UP =
+            T.let(
+              :top_up,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
+          MANUAL =
+            T.let(
+              :manual,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Filter < Orb::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -271,6 +366,254 @@ module Orb
           def self.values
           end
         end
+
+        class CreditAllocation < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Boolean) }
+          attr_accessor :allows_rollover
+
+          sig { returns(String) }
+          attr_accessor :currency
+
+          sig { returns(T.nilable(Orb::CustomExpiration)) }
+          attr_reader :custom_expiration
+
+          sig do
+            params(
+              custom_expiration: T.nilable(Orb::CustomExpiration::OrHash)
+            ).void
+          end
+          attr_writer :custom_expiration
+
+          # The ID of the catalog item this block was allocated from, derived from the
+          # allocation's price.
+          sig { returns(String) }
+          attr_accessor :item_id
+
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter
+                ]
+              )
+            )
+          end
+          attr_reader :filters
+
+          sig do
+            params(
+              filters:
+                T::Array[
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::OrHash
+                ]
+            ).void
+          end
+          attr_writer :filters
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :license_type_id
+
+          # The credit allocation that funded a block. Extends the allocation resource
+          # serialized on prices with the catalog-item attribution of the funding price.
+          sig do
+            params(
+              allows_rollover: T::Boolean,
+              currency: String,
+              custom_expiration: T.nilable(Orb::CustomExpiration::OrHash),
+              item_id: String,
+              filters:
+                T::Array[
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::OrHash
+                ],
+              license_type_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            allows_rollover:,
+            currency:,
+            custom_expiration:,
+            # The ID of the catalog item this block was allocated from, derived from the
+            # allocation's price.
+            item_id:,
+            filters: nil,
+            license_type_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                allows_rollover: T::Boolean,
+                currency: String,
+                custom_expiration: T.nilable(Orb::CustomExpiration),
+                item_id: String,
+                filters:
+                  T::Array[
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter
+                  ],
+                license_type_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Filter < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # The property of the price to filter on.
+            sig do
+              returns(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+              )
+            end
+            attr_accessor :field
+
+            # Should prices that match the filter be included or excluded.
+            sig do
+              returns(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+              )
+            end
+            attr_accessor :operator
+
+            # The IDs or values that match this filter.
+            sig { returns(T::Array[String]) }
+            attr_accessor :values
+
+            sig do
+              params(
+                field:
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::OrSymbol,
+                operator:
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::OrSymbol,
+                values: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The property of the price to filter on.
+              field:,
+              # Should prices that match the filter be included or excluded.
+              operator:,
+              # The IDs or values that match this filter.
+              values:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  field:
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol,
+                  operator:
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol,
+                  values: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The property of the price to filter on.
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PRICE_ID =
+                T.let(
+                  :price_id,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              ITEM_ID =
+                T.let(
+                  :item_id,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              PRICE_TYPE =
+                T.let(
+                  :price_type,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              CURRENCY =
+                T.let(
+                  :currency,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              PRICING_UNIT_ID =
+                T.let(
+                  :pricing_unit_id,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # Should prices that match the filter be included or excluded.
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              INCLUDES =
+                T.let(
+                  :includes,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+                )
+              EXCLUDES =
+                T.let(
+                  :excludes,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
       end
     end
   end