dodopayments 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a1c544a4176c7c0714185ca6adf9c37fb36def28490b0ab142787bc2b3adf84
-  data.tar.gz: 526d3979f72eb82772a3fdc05d77a8a083a720dc38346e492829e6343491df90
+  metadata.gz: e2cd02edaf02bbba60396ecdaa61838414cc46e8358d17a40e7f1b105dc82dc5
+  data.tar.gz: 57d5217495e2ea04533e49716dbffc5b0407bf17f53610b53de90e7bb13293e8
 SHA512:
-  metadata.gz: fa2892ef06e81edaf152d83e460f117ba34c634984f4321240806f531f2a4f48bcea530b0478961afaa7b6c5e0ff0fe4da306abf55307350ae720cf280d700a2
-  data.tar.gz: e2523d71b90539c1919ea64fb6699e90e324bfdeef17567851a8d1e0fab41783f18095ecec460d02fde838c599f62ae6f633190b40e78a8a2bd819d1e3665b42
+  metadata.gz: c66c1e27ffe9b8b5cf488eff8c2e68fd9014db0d390fd1280f78bca1b033e5cca47a1676c54059cebd7c338f83bc0cc052c55a3c33e27d5d7bcc063df30923ad
+  data.tar.gz: ea64df9520da5a12eb56386bd771376624a4bfcfdda8225d823270d6fb687e5876b53c1435f3d3479197f8df4127f20e4a652357af15b369d24b5a594b406c3a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.20.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.19.0...v2.20.0) (2026-07-06)
+
+
+### Features
+
+* **api:** add subscription period override fields to subscription update ([78fe4eb](https://github.com/dodopayments/dodopayments-ruby/commit/78fe4ebc8d7a9af07327b52ab68dc518d46386bd))
+* **api:** add subscription period override fields to subscription update ([31f78a6](https://github.com/dodopayments/dodopayments-ruby/commit/31f78a62a6a27270e94d785e75ad7c686efba7e8))
+
 ## [2.19.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.18.1...v2.19.0) (2026-07-04)
 
 

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.19.0"
+gem "dodopayments", "~> 2.20.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/models/addon_update_params.rb

@@ -25,7 +25,8 @@ module Dodopayments
       optional :description, String, nil?: true
 
       # @!attribute image_id
-      #   Addon image id after its uploaded to S3
+      #   Addon image id after its uploaded to S3. Pass `null` to remove the existing
+      #   image, omit to keep it unchanged.
       #
       #   @return [String, nil]
       optional :image_id, String, nil?: true
@@ -49,13 +50,16 @@ module Dodopayments
       optional :tax_category, enum: -> { Dodopayments::TaxCategory }, nil?: true
 
       # @!method initialize(id:, currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::AddonUpdateParams} for more details.
+      #
       #   @param id [String]
       #
       #   @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the Addon
       #
       #   @param description [String, nil] Description of the Addon, optional and must be at most 1000 characters.
       #
-      #   @param image_id [String, nil] Addon image id after its uploaded to S3
+      #   @param image_id [String, nil] Addon image id after its uploaded to S3.
       #
       #   @param name [String, nil] Name of the Addon, optional and must be at most 100 characters.
       #

data/lib/dodopayments/models/subscription_update_params.rb

@@ -89,12 +89,29 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
       optional :status, enum: -> { Dodopayments::SubscriptionStatus }, nil?: true
 
+      # @!attribute subscription_period_count
+      #   New number of `subscription_period_interval` units the subscription entitlement
+      #   should span. Used together with `subscription_period_interval` to extend the
+      #   subscription period. The resulting period must not be shorter than the current
+      #   one (this endpoint only extends).
+      #
+      #   @return [Integer, nil]
+      optional :subscription_period_count, Integer, nil?: true
+
+      # @!attribute subscription_period_interval
+      #   New interval unit for the subscription period. When changing the period, this
+      #   may be supplied alongside `subscription_period_count`; if omitted the existing
+      #   interval is retained.
+      #
+      #   @return [Symbol, Dodopayments::Models::TimeInterval, nil]
+      optional :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true
+
       # @!attribute tax_id
       #
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
+      # @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionUpdateParams} for more details.
       #
@@ -124,6 +141,10 @@ module Dodopayments
       #
       #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
       #
+      #   @param subscription_period_count [Integer, nil] New number of `subscription_period_interval` units the subscription
+      #
+      #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval, nil] New interval unit for the subscription period. When changing the period,
+      #
       #   @param tax_id [String, nil]
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]

data/lib/dodopayments/resources/addons.rb

@@ -49,6 +49,9 @@ module Dodopayments
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::AddonUpdateParams} for more details.
+      #
       # @overload update(id, currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
       #
       # @param id [String] Addon Id
@@ -57,7 +60,7 @@ module Dodopayments
       #
       # @param description [String, nil] Description of the Addon, optional and must be at most 1000 characters.
       #
-      # @param image_id [String, nil] Addon image id after its uploaded to S3
+      # @param image_id [String, nil] Addon image id after its uploaded to S3.
       #
       # @param name [String, nil] Name of the Addon, optional and must be at most 100 characters.
       #

data/lib/dodopayments/resources/subscriptions.rb

@@ -95,7 +95,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionUpdateParams} for more details.
       #
-      # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
+      # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -123,6 +123,10 @@ module Dodopayments
       #
       # @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
       #
+      # @param subscription_period_count [Integer, nil] New number of `subscription_period_interval` units the subscription
+      #
+      # @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval, nil] New interval unit for the subscription period. When changing the period,
+      #
       # @param tax_id [String, nil]
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/dodopayments/version.rb

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

data/rbi/dodopayments/models/addon_update_params.rbi

@@ -25,7 +25,8 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
-      # Addon image id after its uploaded to S3
+      # Addon image id after its uploaded to S3. Pass `null` to remove the existing
+      # image, omit to keep it unchanged.
       sig { returns(T.nilable(String)) }
       attr_accessor :image_id
 
@@ -59,7 +60,8 @@ module Dodopayments
         currency: nil,
         # Description of the Addon, optional and must be at most 1000 characters.
         description: nil,
-        # Addon image id after its uploaded to S3
+        # Addon image id after its uploaded to S3. Pass `null` to remove the existing
+        # image, omit to keep it unchanged.
         image_id: nil,
         # Name of the Addon, optional and must be at most 100 characters.
         name: nil,

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -101,6 +101,19 @@ module Dodopayments
       sig { returns(T.nilable(Dodopayments::SubscriptionStatus::OrSymbol)) }
       attr_accessor :status
 
+      # New number of `subscription_period_interval` units the subscription entitlement
+      # should span. Used together with `subscription_period_interval` to extend the
+      # subscription period. The resulting period must not be shorter than the current
+      # one (this endpoint only extends).
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :subscription_period_count
+
+      # New interval unit for the subscription period. When changing the period, this
+      # may be supplied alongside `subscription_period_count`; if omitted the existing
+      # interval is retained.
+      sig { returns(T.nilable(Dodopayments::TimeInterval::OrSymbol)) }
+      attr_accessor :subscription_period_interval
+
       sig { returns(T.nilable(String)) }
       attr_accessor :tax_id
 
@@ -132,6 +145,9 @@ module Dodopayments
             T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           next_billing_date: T.nilable(Time),
           status: T.nilable(Dodopayments::SubscriptionStatus::OrSymbol),
+          subscription_period_count: T.nilable(Integer),
+          subscription_period_interval:
+            T.nilable(Dodopayments::TimeInterval::OrSymbol),
           tax_id: T.nilable(String),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -161,6 +177,15 @@ module Dodopayments
         metadata: nil,
         next_billing_date: nil,
         status: nil,
+        # New number of `subscription_period_interval` units the subscription entitlement
+        # should span. Used together with `subscription_period_interval` to extend the
+        # subscription period. The resulting period must not be shorter than the current
+        # one (this endpoint only extends).
+        subscription_period_count: nil,
+        # New interval unit for the subscription period. When changing the period, this
+        # may be supplied alongside `subscription_period_count`; if omitted the existing
+        # interval is retained.
+        subscription_period_interval: nil,
         tax_id: nil,
         request_options: {}
       )
@@ -195,6 +220,9 @@ module Dodopayments
               T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
             next_billing_date: T.nilable(Time),
             status: T.nilable(Dodopayments::SubscriptionStatus::OrSymbol),
+            subscription_period_count: T.nilable(Integer),
+            subscription_period_interval:
+              T.nilable(Dodopayments::TimeInterval::OrSymbol),
             tax_id: T.nilable(String),
             request_options: Dodopayments::RequestOptions
           }

data/rbi/dodopayments/resources/addons.rbi

@@ -60,7 +60,8 @@ module Dodopayments
         currency: nil,
         # Description of the Addon, optional and must be at most 1000 characters.
         description: nil,
-        # Addon image id after its uploaded to S3
+        # Addon image id after its uploaded to S3. Pass `null` to remove the existing
+        # image, omit to keep it unchanged.
         image_id: nil,
         # Name of the Addon, optional and must be at most 100 characters.
         name: nil,

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -154,6 +154,9 @@ module Dodopayments
             T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           next_billing_date: T.nilable(Time),
           status: T.nilable(Dodopayments::SubscriptionStatus::OrSymbol),
+          subscription_period_count: T.nilable(Integer),
+          subscription_period_interval:
+            T.nilable(Dodopayments::TimeInterval::OrSymbol),
           tax_id: T.nilable(String),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Subscription)
@@ -184,6 +187,15 @@ module Dodopayments
         metadata: nil,
         next_billing_date: nil,
         status: nil,
+        # New number of `subscription_period_interval` units the subscription entitlement
+        # should span. Used together with `subscription_period_interval` to extend the
+        # subscription period. The resulting period must not be shorter than the current
+        # one (this endpoint only extends).
+        subscription_period_count: nil,
+        # New interval unit for the subscription period. When changing the period, this
+        # may be supplied alongside `subscription_period_count`; if omitted the existing
+        # interval is retained.
+        subscription_period_interval: nil,
         tax_id: nil,
         request_options: {}
       )

data/sig/dodopayments/models/subscription_update_params.rbs

@@ -15,6 +15,8 @@ module Dodopayments
         metadata: Dodopayments::Models::metadata?,
         next_billing_date: Time?,
         status: Dodopayments::Models::subscription_status?,
+        subscription_period_count: Integer?,
+        subscription_period_interval: Dodopayments::Models::time_interval?,
         tax_id: String?
       }
       & Dodopayments::Internal::Type::request_parameters
@@ -49,6 +51,10 @@ module Dodopayments
 
       attr_accessor status: Dodopayments::Models::subscription_status?
 
+      attr_accessor subscription_period_count: Integer?
+
+      attr_accessor subscription_period_interval: Dodopayments::Models::time_interval?
+
       attr_accessor tax_id: String?
 
       def initialize: (
@@ -65,6 +71,8 @@ module Dodopayments
         ?metadata: Dodopayments::Models::metadata?,
         ?next_billing_date: Time?,
         ?status: Dodopayments::Models::subscription_status?,
+        ?subscription_period_count: Integer?,
+        ?subscription_period_interval: Dodopayments::Models::time_interval?,
         ?tax_id: String?,
         ?request_options: Dodopayments::request_opts
       ) -> void
@@ -83,6 +91,8 @@ module Dodopayments
         metadata: Dodopayments::Models::metadata?,
         next_billing_date: Time?,
         status: Dodopayments::Models::subscription_status?,
+        subscription_period_count: Integer?,
+        subscription_period_interval: Dodopayments::Models::time_interval?,
         tax_id: String?,
         request_options: Dodopayments::RequestOptions
       }

data/sig/dodopayments/resources/subscriptions.rbs

@@ -48,6 +48,8 @@ module Dodopayments
         ?metadata: Dodopayments::Models::metadata?,
         ?next_billing_date: Time?,
         ?status: Dodopayments::Models::subscription_status?,
+        ?subscription_period_count: Integer?,
+        ?subscription_period_interval: Dodopayments::Models::time_interval?,
         ?tax_id: String?,
         ?request_options: Dodopayments::request_opts
       ) -> Dodopayments::Subscription

metadata

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