dodopayments 2.18.0 → 2.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de3e90e0a4cd35644cd9c8ef51c44c19ba4f9af2f0bbded7530ed6a95b082f60
-  data.tar.gz: 731dedea649eb1136b5b7c1b02b7ea1f42cbbcb619d606a90f9150b5dad2b4b9
+  metadata.gz: 53e205dc9f7e8ee7ebdaeb422170dbc186e5a6f7e06d1c3cfb535351c9aded9b
+  data.tar.gz: 889f3b95deae7e7e27703e2792a42c7eacca334b62f077aaea57882b5d26efc8
 SHA512:
-  metadata.gz: 6ce146d98b0c8613c4a02177dc943c15444914e56d7ba545f6ee96becc372d67150f0b513d43254fe5b834ff1b3008b9998c9b4ced5295e06afea36925fbc9b8
-  data.tar.gz: 3530fa58411532a1f9afe760b06b11bce5f9d60c75b06d1b9be49572a758358663040a1cd24a70914ef3883760b75c47c98f4101aadfbb0bd0f414c1f64ecf16
+  metadata.gz: 9921852a50435bbccfead823afd4b085c8872a4c1b52fec15f7956a9dfe216faea6d93ad7f054dcf24339d062f2fad55f91cb4464f13470782c47288fa011187
+  data.tar.gz: 7376387a8df94f986e4e8a0fdcef6df3ce6f0b4b5048e30cddb4758e3414aaecdb538765bcae277086a143fdff466a37740cc42925792816add2c23f6f201f8f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.18.1](https://github.com/dodopayments/dodopayments-ruby/compare/v2.18.0...v2.18.1) (2026-06-27)
+
+
+### Bug Fixes
+
+* **api:** add allow_editing_addons checkout flag and refine schema descriptions ([bb29016](https://github.com/dodopayments/dodopayments-ruby/commit/bb29016fe5ae1b7d8cfca80131645f699f99f928))
+* **api:** add allow_editing_addons checkout flag and refine schema descriptions ([c8bca49](https://github.com/dodopayments/dodopayments-ruby/commit/c8bca49c58066c378d071a2a353e24986d6c6134))
+
 ## [2.18.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.17.1...v2.18.0) (2026-06-23)
 
 

data/README.md

@@ -23,7 +23,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "dodopayments", "~> 2.18.0"
+gem "dodopayments", "~> 2.18.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/models/attach_addon.rb

@@ -9,13 +9,15 @@ module Dodopayments
       required :addon_id, String
 
       # @!attribute quantity
+      #   Number of units of this addon.
       #
       #   @return [Integer]
       required :quantity, Integer
 
       # @!method initialize(addon_id:, quantity:)
       #   @param addon_id [String]
-      #   @param quantity [Integer]
+      #
+      #   @param quantity [Integer] Number of units of this addon.
     end
   end
 end

data/lib/dodopayments/models/checkout_session_flags.rb

@@ -71,6 +71,15 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :allow_discount_code, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute allow_editing_addons
+      #   If true, the customer can add or remove addons on a subscription product during
+      #   checkout.
+      #
+      #   Default is false
+      #
+      #   @return [Boolean, nil]
+      optional :allow_editing_addons, Dodopayments::Internal::Type::Boolean
+
       # @!attribute allow_phone_number_collection
       #   If phone number is collected from customer, set it to rue
       #
@@ -113,7 +122,7 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :require_phone_number, Dodopayments::Internal::Type::Boolean
 
-      # @!method initialize(allow_currency_selection: nil, allow_customer_editing_business_name: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_tax_id: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil, require_phone_number: nil)
+      # @!method initialize(allow_currency_selection: nil, allow_customer_editing_business_name: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_tax_id: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_editing_addons: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil, require_phone_number: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::CheckoutSessionFlags} for more details.
       #
@@ -139,6 +148,8 @@ module Dodopayments
       #
       #   @param allow_discount_code [Boolean] If the customer is allowed to apply discount code, set it to true.
       #
+      #   @param allow_editing_addons [Boolean] If true, the customer can add or remove addons on a subscription product
+      #
       #   @param allow_phone_number_collection [Boolean] If phone number is collected from customer, set it to rue
       #
       #   @param allow_tax_id [Boolean] If the customer is allowed to add tax id, set it to true

data/lib/dodopayments/models/credit_entitlement.rb

@@ -97,6 +97,7 @@ module Dodopayments
       optional :rollover_timeframe_count, Integer, nil?: true
 
       # @!attribute rollover_timeframe_interval
+      #   Unit of a duration count (e.g. license-key validity period).
       #
       #   @return [Symbol, Dodopayments::Models::TimeInterval, nil]
       optional :rollover_timeframe_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true
@@ -138,7 +139,7 @@ module Dodopayments
       #
       #   @param rollover_timeframe_count [Integer, nil]
       #
-      #   @param rollover_timeframe_interval [Symbol, Dodopayments::Models::TimeInterval, nil]
+      #   @param rollover_timeframe_interval [Symbol, Dodopayments::Models::TimeInterval, nil] Unit of a duration count (e.g. license-key validity period).
     end
   end
 end

data/lib/dodopayments/models/credit_entitlement_cart_response.rb

@@ -95,6 +95,7 @@ module Dodopayments
       optional :rollover_timeframe_count, Integer, nil?: true
 
       # @!attribute rollover_timeframe_interval
+      #   Unit of a duration count (e.g. license-key validity period).
       #
       #   @return [Symbol, Dodopayments::Models::TimeInterval, nil]
       optional :rollover_timeframe_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true
@@ -137,7 +138,7 @@ module Dodopayments
       #
       #   @param rollover_timeframe_count [Integer, nil]
       #
-      #   @param rollover_timeframe_interval [Symbol, Dodopayments::Models::TimeInterval, nil]
+      #   @param rollover_timeframe_interval [Symbol, Dodopayments::Models::TimeInterval, nil] Unit of a duration count (e.g. license-key validity period).
     end
   end
 end

data/lib/dodopayments/models/license_key_duration.rb

@@ -9,13 +9,15 @@ module Dodopayments
       required :count, Integer
 
       # @!attribute interval
+      #   Unit of a duration count (e.g. license-key validity period).
       #
       #   @return [Symbol, Dodopayments::Models::TimeInterval]
       required :interval, enum: -> { Dodopayments::TimeInterval }
 
       # @!method initialize(count:, interval:)
       #   @param count [Integer]
-      #   @param interval [Symbol, Dodopayments::Models::TimeInterval]
+      #
+      #   @param interval [Symbol, Dodopayments::Models::TimeInterval] Unit of a duration count (e.g. license-key validity period).
     end
   end
 end

data/lib/dodopayments/models/payment.rb

@@ -41,7 +41,7 @@ module Dodopayments
       required :customer, -> { Dodopayments::CustomerLimitedDetails }
 
       # @!attribute digital_products_delivered
-      #   brand id this payment belongs to
+      #   Whether the digital products purchased in this payment have been delivered.
       #
       #   @return [Boolean]
       required :digital_products_delivered, Dodopayments::Internal::Type::Boolean
@@ -276,7 +276,7 @@ module Dodopayments
       #
       #   @param customer [Dodopayments::Models::CustomerLimitedDetails] Details about the customer who made the payment
       #
-      #   @param digital_products_delivered [Boolean] brand id this payment belongs to
+      #   @param digital_products_delivered [Boolean] Whether the digital products purchased in this payment have been delivered.
       #
       #   @param disputes [Array<Dodopayments::Models::Dispute>] List of disputes associated with this payment
       #

data/lib/dodopayments/models/subscription_update_params.rb

@@ -189,22 +189,33 @@ module Dodopayments
         optional :rollover_timeframe_count, Integer, nil?: true
 
         # @!attribute rollover_timeframe_interval
+        #   Unit of a duration count (e.g. license-key validity period).
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval, nil]
         optional :rollover_timeframe_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true
 
         # @!method initialize(credit_entitlement_id:, credits_amount: nil, expires_after_days: nil, low_balance_threshold_percent: nil, max_rollover_count: nil, overage_enabled: nil, overage_limit: nil, rollover_enabled: nil, rollover_percentage: nil, rollover_timeframe_count: nil, rollover_timeframe_interval: nil)
         #   @param credit_entitlement_id [String]
+        #
         #   @param credits_amount [String, nil]
+        #
         #   @param expires_after_days [Integer, nil]
+        #
         #   @param low_balance_threshold_percent [Integer, nil]
+        #
         #   @param max_rollover_count [Integer, nil]
+        #
         #   @param overage_enabled [Boolean, nil]
+        #
         #   @param overage_limit [String, nil]
+        #
         #   @param rollover_enabled [Boolean, nil]
+        #
         #   @param rollover_percentage [Integer, nil]
+        #
         #   @param rollover_timeframe_count [Integer, nil]
-        #   @param rollover_timeframe_interval [Symbol, Dodopayments::Models::TimeInterval, nil]
+        #
+        #   @param rollover_timeframe_interval [Symbol, Dodopayments::Models::TimeInterval, nil] Unit of a duration count (e.g. license-key validity period).
       end
 
       class DisableOnDemand < Dodopayments::Internal::Type::BaseModel

data/lib/dodopayments/models/time_interval.rb

@@ -2,6 +2,7 @@
 
 module Dodopayments
   module Models
+    # Unit of a duration count (e.g. license-key validity period).
     module TimeInterval
       extend Dodopayments::Internal::Type::Enum
 

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "2.18.0"
+  VERSION = "2.18.1"
 end

data/rbi/dodopayments/models/attach_addon.rbi

@@ -11,13 +11,18 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :addon_id
 
+      # Number of units of this addon.
       sig { returns(Integer) }
       attr_accessor :quantity
 
       sig do
         params(addon_id: String, quantity: Integer).returns(T.attached_class)
       end
-      def self.new(addon_id:, quantity:)
+      def self.new(
+        addon_id:,
+        # Number of units of this addon.
+        quantity:
+      )
       end
 
       sig { override.returns({ addon_id: String, quantity: Integer }) }

data/rbi/dodopayments/models/checkout_session_flags.rbi

@@ -90,6 +90,16 @@ module Dodopayments
       sig { params(allow_discount_code: T::Boolean).void }
       attr_writer :allow_discount_code
 
+      # If true, the customer can add or remove addons on a subscription product during
+      # checkout.
+      #
+      # Default is false
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :allow_editing_addons
+
+      sig { params(allow_editing_addons: T::Boolean).void }
+      attr_writer :allow_editing_addons
+
       # If phone number is collected from customer, set it to rue
       #
       # Default is true
@@ -150,6 +160,7 @@ module Dodopayments
           allow_customer_editing_tax_id: T::Boolean,
           allow_customer_editing_zipcode: T::Boolean,
           allow_discount_code: T::Boolean,
+          allow_editing_addons: T::Boolean,
           allow_phone_number_collection: T::Boolean,
           allow_tax_id: T::Boolean,
           always_create_new_customer: T::Boolean,
@@ -182,6 +193,11 @@ module Dodopayments
         #
         # Default is true
         allow_discount_code: nil,
+        # If true, the customer can add or remove addons on a subscription product during
+        # checkout.
+        #
+        # Default is false
+        allow_editing_addons: nil,
         # If phone number is collected from customer, set it to rue
         #
         # Default is true
@@ -221,6 +237,7 @@ module Dodopayments
             allow_customer_editing_tax_id: T::Boolean,
             allow_customer_editing_zipcode: T::Boolean,
             allow_discount_code: T::Boolean,
+            allow_editing_addons: T::Boolean,
             allow_phone_number_collection: T::Boolean,
             allow_tax_id: T::Boolean,
             always_create_new_customer: T::Boolean,

data/rbi/dodopayments/models/credit_entitlement.rbi

@@ -67,6 +67,7 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :rollover_timeframe_count
 
+      # Unit of a duration count (e.g. license-key validity period).
       sig { returns(T.nilable(Dodopayments::TimeInterval::TaggedSymbol)) }
       attr_accessor :rollover_timeframe_interval
 
@@ -115,6 +116,7 @@ module Dodopayments
         price_per_unit: nil,
         rollover_percentage: nil,
         rollover_timeframe_count: nil,
+        # Unit of a duration count (e.g. license-key validity period).
         rollover_timeframe_interval: nil
       )
       end

data/rbi/dodopayments/models/credit_entitlement_cart_response.rbi

@@ -70,6 +70,7 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :rollover_timeframe_count
 
+      # Unit of a duration count (e.g. license-key validity period).
       sig { returns(T.nilable(Dodopayments::TimeInterval::TaggedSymbol)) }
       attr_accessor :rollover_timeframe_interval
 
@@ -124,6 +125,7 @@ module Dodopayments
         overage_limit: nil,
         rollover_percentage: nil,
         rollover_timeframe_count: nil,
+        # Unit of a duration count (e.g. license-key validity period).
         rollover_timeframe_interval: nil
       )
       end

data/rbi/dodopayments/models/license_key_duration.rbi

@@ -14,6 +14,7 @@ module Dodopayments
       sig { returns(Integer) }
       attr_accessor :count
 
+      # Unit of a duration count (e.g. license-key validity period).
       sig { returns(Dodopayments::TimeInterval::OrSymbol) }
       attr_accessor :interval
 
@@ -23,7 +24,11 @@ module Dodopayments
           interval: Dodopayments::TimeInterval::OrSymbol
         ).returns(T.attached_class)
       end
-      def self.new(count:, interval:)
+      def self.new(
+        count:,
+        # Unit of a duration count (e.g. license-key validity period).
+        interval:
+      )
       end
 
       sig do

data/rbi/dodopayments/models/payment.rbi

@@ -40,7 +40,7 @@ module Dodopayments
       end
       attr_writer :customer
 
-      # brand id this payment belongs to
+      # Whether the digital products purchased in this payment have been delivered.
       sig { returns(T::Boolean) }
       attr_accessor :digital_products_delivered
 
@@ -246,7 +246,7 @@ module Dodopayments
         currency:,
         # Details about the customer who made the payment
         customer:,
-        # brand id this payment belongs to
+        # Whether the digital products purchased in this payment have been delivered.
         digital_products_delivered:,
         # List of disputes associated with this payment
         disputes:,

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -275,6 +275,7 @@ module Dodopayments
         sig { returns(T.nilable(Integer)) }
         attr_accessor :rollover_timeframe_count
 
+        # Unit of a duration count (e.g. license-key validity period).
         sig { returns(T.nilable(Dodopayments::TimeInterval::OrSymbol)) }
         attr_accessor :rollover_timeframe_interval
 
@@ -305,6 +306,7 @@ module Dodopayments
           rollover_enabled: nil,
           rollover_percentage: nil,
           rollover_timeframe_count: nil,
+          # Unit of a duration count (e.g. license-key validity period).
           rollover_timeframe_interval: nil
         )
         end

data/rbi/dodopayments/models/time_interval.rbi

@@ -2,6 +2,7 @@
 
 module Dodopayments
   module Models
+    # Unit of a duration count (e.g. license-key validity period).
     module TimeInterval
       extend Dodopayments::Internal::Type::Enum
 

data/sig/dodopayments/models/checkout_session_flags.rbs

@@ -13,6 +13,7 @@ module Dodopayments
         allow_customer_editing_tax_id: bool,
         allow_customer_editing_zipcode: bool,
         allow_discount_code: bool,
+        allow_editing_addons: bool,
         allow_phone_number_collection: bool,
         allow_tax_id: bool,
         always_create_new_customer: bool,
@@ -65,6 +66,10 @@ module Dodopayments
 
       def allow_discount_code=: (bool) -> bool
 
+      attr_reader allow_editing_addons: bool?
+
+      def allow_editing_addons=: (bool) -> bool
+
       attr_reader allow_phone_number_collection: bool?
 
       def allow_phone_number_collection=: (bool) -> bool
@@ -97,6 +102,7 @@ module Dodopayments
         ?allow_customer_editing_tax_id: bool,
         ?allow_customer_editing_zipcode: bool,
         ?allow_discount_code: bool,
+        ?allow_editing_addons: bool,
         ?allow_phone_number_collection: bool,
         ?allow_tax_id: bool,
         ?always_create_new_customer: bool,
@@ -116,6 +122,7 @@ module Dodopayments
         allow_customer_editing_tax_id: bool,
         allow_customer_editing_zipcode: bool,
         allow_discount_code: bool,
+        allow_editing_addons: bool,
         allow_phone_number_collection: bool,
         allow_tax_id: bool,
         always_create_new_customer: bool,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dodopayments
 version: !ruby/object:Gem::Version
-  version: 2.18.0
+  version: 2.18.1
 platform: ruby
 authors:
 - Dodo Payments
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-23 00:00:00.000000000 Z
+date: 2026-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi