orb-billing 1.14.0 → 1.15.0

data/lib/orb/models/customer_update_params.rb

@@ -56,6 +56,13 @@ module Orb
       #   @return [String, nil]
       optional :currency, String, nil?: true
 
+      # @!attribute default_payment_method_id
+      #   The Orb ID of the payment method to set as this customer's default. Pass `null`
+      #   to clear the customer's default payment method.
+      #
+      #   @return [String, nil]
+      optional :default_payment_method_id, String, nil?: true
+
       # @!attribute email
       #   A valid customer email, to be used for invoicing and notifications.
       #
@@ -196,11 +203,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                                                                                     |
@@ -212,6 +221,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ō_)                                                       |
@@ -242,6 +252,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                                                                                     |
@@ -263,6 +274,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                                                                                  |
@@ -288,7 +300,7 @@ module Orb
       #   @return [Orb::Models::CustomerTaxID, nil]
       optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true
 
-      # @!method initialize(customer_id:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
+      # @!method initialize(customer_id:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::CustomerUpdateParams} for more details.
       #
@@ -306,6 +318,8 @@ module Orb
       #
       #   @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
       #
+      #   @param default_payment_method_id [String, nil] The Orb ID of the payment method to set as this customer's default. Pass `null`
+      #
       #   @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
       #
       #   @param email_delivery [Boolean, nil]
@@ -414,7 +428,7 @@ module Orb
         STRIPE_CHARGE = :stripe_charge
         STRIPE_INVOICE = :stripe_invoice
         NETSUITE = :netsuite
-        NETSUITE_AMPERSAND = :netsuite_ampersand
+        ADYEN = :adyen
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/orb/models/customers/credit_list_by_external_id_response.rb

@@ -15,6 +15,16 @@ module Orb
         #   @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), or
+        #   `manual` (a manual credit ledger increment, including credits voided or expired
+        #   off another block).
+        #
+        #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource]
+        required :credit_block_source,
+                 enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource }
+
         # @!attribute effective_date
         #
         #   @return [Time, nil]
@@ -55,7 +65,16 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
         required :status, enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::Status }
 
-        # @!method initialize(id:, balance:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, 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::Customers::CreditListByExternalIDResponse::CreditAllocation, nil]
+        optional :credit_allocation,
+                 -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation },
+                 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)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Customers::CreditListByExternalIDResponse} for more details.
         #
@@ -63,6 +82,8 @@ module Orb
         #
         #   @param balance [Float]
         #
+        #   @param credit_block_source [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
+        #
         #   @param effective_date [Time, nil]
         #
         #   @param expiry_date [Time, nil]
@@ -76,6 +97,25 @@ module Orb
         #   @param per_unit_cost_basis [String, nil]
         #
         #   @param status [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
+        #
+        #   @param credit_allocation [Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
+
+        # 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).
+        #
+        # @see Orb::Models::Customers::CreditListByExternalIDResponse#credit_block_source
+        module CreditBlockSource
+          extend Orb::Internal::Type::Enum
+
+          ALLOCATION = :allocation
+          TOP_UP = :top_up
+          MANUAL = :manual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
 
         class Filter < Orb::Internal::Type::BaseModel
           # @!attribute field
@@ -141,6 +181,120 @@ module Orb
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see Orb::Models::Customers::CreditListByExternalIDResponse#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::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter>, nil]
+          optional :filters,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CreditListByExternalIDResponse::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::Customers::CreditListByExternalIDResponse::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::Customers::CreditListByExternalIDResponse::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::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field]
+            required :field,
+                     enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field }
+
+            # @!attribute operator
+            #   Should prices that match the filter be included or excluded.
+            #
+            #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator]
+            required :operator,
+                     enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::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::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field] The property of the price to filter on.
+            #
+            #   @param operator [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::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::Customers::CreditListByExternalIDResponse::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::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter#operator
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES = :includes
+              EXCLUDES = :excludes
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
     end
   end

data/lib/orb/models/customers/credit_list_response.rb

@@ -15,6 +15,15 @@ module Orb
         #   @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), or
+        #   `manual` (a manual credit ledger increment, including credits voided or expired
+        #   off another block).
+        #
+        #   @return [Symbol, Orb::Models::Customers::CreditListResponse::CreditBlockSource]
+        required :credit_block_source, enum: -> { Orb::Models::Customers::CreditListResponse::CreditBlockSource }
+
         # @!attribute effective_date
         #
         #   @return [Time, nil]
@@ -54,7 +63,16 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CreditListResponse::Status]
         required :status, enum: -> { Orb::Models::Customers::CreditListResponse::Status }
 
-        # @!method initialize(id:, balance:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, 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::Customers::CreditListResponse::CreditAllocation, nil]
+        optional :credit_allocation,
+                 -> { Orb::Models::Customers::CreditListResponse::CreditAllocation },
+                 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)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Customers::CreditListResponse} for more details.
         #
@@ -62,6 +80,8 @@ module Orb
         #
         #   @param balance [Float]
         #
+        #   @param credit_block_source [Symbol, Orb::Models::Customers::CreditListResponse::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
+        #
         #   @param effective_date [Time, nil]
         #
         #   @param expiry_date [Time, nil]
@@ -75,6 +95,25 @@ module Orb
         #   @param per_unit_cost_basis [String, nil]
         #
         #   @param status [Symbol, Orb::Models::Customers::CreditListResponse::Status]
+        #
+        #   @param credit_allocation [Orb::Models::Customers::CreditListResponse::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
+
+        # 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).
+        #
+        # @see Orb::Models::Customers::CreditListResponse#credit_block_source
+        module CreditBlockSource
+          extend Orb::Internal::Type::Enum
+
+          ALLOCATION = :allocation
+          TOP_UP = :top_up
+          MANUAL = :manual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
 
         class Filter < Orb::Internal::Type::BaseModel
           # @!attribute field
@@ -140,6 +179,118 @@ module Orb
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see Orb::Models::Customers::CreditListResponse#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::Customers::CreditListResponse::CreditAllocation::Filter>, nil]
+          optional :filters,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CreditListResponse::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::Customers::CreditListResponse::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::Customers::CreditListResponse::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::Customers::CreditListResponse::CreditAllocation::Filter::Field]
+            required :field, enum: -> { Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter::Field }
+
+            # @!attribute operator
+            #   Should prices that match the filter be included or excluded.
+            #
+            #   @return [Symbol, Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter::Operator]
+            required :operator,
+                     enum: -> { Orb::Models::Customers::CreditListResponse::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::Customers::CreditListResponse::CreditAllocation::Filter::Field] The property of the price to filter on.
+            #
+            #   @param operator [Symbol, Orb::Models::Customers::CreditListResponse::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::Customers::CreditListResponse::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::Customers::CreditListResponse::CreditAllocation::Filter#operator
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES = :includes
+              EXCLUDES = :excludes
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
     end
   end

data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb

@@ -388,9 +388,9 @@ module Orb
               required :entry_type, const: :expiration_change
 
               # @!attribute target_expiry_date
-              #   A future date (specified in YYYY-MM-DD format) used for expiration change,
-              #   denoting when credits transferred (as part of a partial block expiration) should
-              #   expire.
+              #   A date (specified in YYYY-MM-DD format) used for expiration change, denoting
+              #   when credits transferred (as part of a partial block expiration) should expire.
+              #   This date must be on or after the effective date of the credit block.
               #
               #   @return [Date]
               required :target_expiry_date, Date
@@ -443,7 +443,7 @@ module Orb
               #   {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::ExpirationChange}
               #   for more details.
               #
-              #   @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
+              #   @param target_expiry_date [Date] A date (specified in YYYY-MM-DD format) used for expiration change, denoting whe
               #
               #   @param amount [Float, nil] The number of credits to effect. Note that this is required for increment, decre
               #

data/lib/orb/models/customers/credits/ledger_create_entry_params.rb

@@ -388,9 +388,9 @@ module Orb
               required :entry_type, const: :expiration_change
 
               # @!attribute target_expiry_date
-              #   A future date (specified in YYYY-MM-DD format) used for expiration change,
-              #   denoting when credits transferred (as part of a partial block expiration) should
-              #   expire.
+              #   A date (specified in YYYY-MM-DD format) used for expiration change, denoting
+              #   when credits transferred (as part of a partial block expiration) should expire.
+              #   This date must be on or after the effective date of the credit block.
               #
               #   @return [Date]
               required :target_expiry_date, Date
@@ -443,7 +443,7 @@ module Orb
               #   {Orb::Models::Customers::Credits::LedgerCreateEntryParams::Body::ExpirationChange}
               #   for more details.
               #
-              #   @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
+              #   @param target_expiry_date [Date] A date (specified in YYYY-MM-DD format) used for expiration change, denoting whe
               #
               #   @param amount [Float, nil] The number of credits to effect. Note that this is required for increment, decre
               #

data/lib/orb/models/dimensional_price_group.rb

@@ -49,7 +49,7 @@ module Orb
       #   {Orb::Models::DimensionalPriceGroup} for more details.
       #
       #   A dimensional price group is used to partition the result of a billable metric
-      #   by a set of dimensions. Prices in a price group must specify the parition used
+      #   by a set of dimensions. Prices in a price group must specify the partition used
       #   to derive their usage.
       #
       #   @param id [String]

data/lib/orb/models/discount.rb

@@ -15,8 +15,152 @@ module Orb
 
       variant :amount, -> { Orb::AmountDiscount }
 
+      variant :tiered_percentage, -> { Orb::Discount::TieredPercentage }
+
+      class TieredPercentage < Orb::Internal::Type::BaseModel
+        # @!attribute discount_type
+        #
+        #   @return [Symbol, :tiered_percentage]
+        required :discount_type, const: :tiered_percentage
+
+        # @!attribute tiers
+        #   Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+        #   bands of cumulative eligible spend, each discounted at its own percentage
+        #   (progressive fill-a-tier).
+        #
+        #   @return [Array<Orb::Models::Discount::TieredPercentage::Tier>]
+        required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Discount::TieredPercentage::Tier] }
+
+        # @!attribute applies_to_price_ids
+        #   List of price_ids that this discount applies to. For plan/plan phase discounts,
+        #   this can be a subset of prices.
+        #
+        #   @return [Array<String>, nil]
+        optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute filters
+        #   The filters that determine which prices to apply this discount to.
+        #
+        #   @return [Array<Orb::Models::Discount::TieredPercentage::Filter>, nil]
+        optional :filters,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::Discount::TieredPercentage::Filter] },
+                 nil?: true
+
+        # @!attribute reason
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!method initialize(tiers:, applies_to_price_ids: nil, filters: nil, reason: nil, discount_type: :tiered_percentage)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Discount::TieredPercentage} for more details.
+        #
+        #   @param tiers [Array<Orb::Models::Discount::TieredPercentage::Tier>] Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+        #
+        #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
+        #
+        #   @param filters [Array<Orb::Models::Discount::TieredPercentage::Filter>, nil] The filters that determine which prices to apply this discount to.
+        #
+        #   @param reason [String, nil]
+        #
+        #   @param discount_type [Symbol, :tiered_percentage]
+
+        class Tier < Orb::Internal::Type::BaseModel
+          # @!attribute lower_bound
+          #   Exclusive lower bound of cumulative spend for this tier.
+          #
+          #   @return [Float]
+          required :lower_bound, Float
+
+          # @!attribute percentage
+          #   The percentage (between 0 and 1) discounted from spend that falls within this
+          #   tier.
+          #
+          #   @return [Float]
+          required :percentage, Float
+
+          # @!attribute upper_bound
+          #   Inclusive upper bound of cumulative spend for this tier; null for the final
+          #   open-ended tier.
+          #
+          #   @return [Float, nil]
+          optional :upper_bound, Float, nil?: true
+
+          # @!method initialize(lower_bound:, percentage:, upper_bound: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Discount::TieredPercentage::Tier} for more details.
+          #
+          #   One band of a tiered percentage discount. Bounds are denominated in the
+          #   discount's currency. `lower_bound` is the exclusive start of the band and
+          #   `upper_bound` is the inclusive end; `upper_bound` is null only for the
+          #   open-ended final tier.
+          #
+          #   @param lower_bound [Float] Exclusive lower bound of cumulative spend for this tier.
+          #
+          #   @param percentage [Float] The percentage (between 0 and 1) discounted from spend that falls within this ti
+          #
+          #   @param upper_bound [Float, nil] Inclusive upper bound of cumulative spend for this tier; null for the final open
+        end
+
+        class Filter < Orb::Internal::Type::BaseModel
+          # @!attribute field
+          #   The property of the price to filter on.
+          #
+          #   @return [Symbol, Orb::Models::Discount::TieredPercentage::Filter::Field]
+          required :field, enum: -> { Orb::Discount::TieredPercentage::Filter::Field }
+
+          # @!attribute operator
+          #   Should prices that match the filter be included or excluded.
+          #
+          #   @return [Symbol, Orb::Models::Discount::TieredPercentage::Filter::Operator]
+          required :operator, enum: -> { Orb::Discount::TieredPercentage::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::Discount::TieredPercentage::Filter::Field] The property of the price to filter on.
+          #
+          #   @param operator [Symbol, Orb::Models::Discount::TieredPercentage::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::Discount::TieredPercentage::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::Discount::TieredPercentage::Filter#operator
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            INCLUDES = :includes
+            EXCLUDES = :excludes
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
       # @!method self.variants
-      #   @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)]
+      #   @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage)]
     end
   end
 end