dodopayments 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d6a141291675cb8c695b5b88364058399a4f477d2f43eb851a80b4c81706f5
-  data.tar.gz: 57e2af01863ba772f020b0fb9a43b5941c04be6b138fcd5f1a78024d8bb19747
+  metadata.gz: 5893887fb8cc4a7d0167f490b1c1a6d70480c05540d8cece0ce556b38688082a
+  data.tar.gz: f96bf3c63b0a72a140e9e5e5cf46168300a4ce4ba03f46b30cdc2c7932ecb5de
 SHA512:
-  metadata.gz: acd5317d471d998c14ada88e83e99d6078bead9ba90108a6055b57040ba905381163339b03341207361aa289f08b4fb282bd5adca29eb7f4964eb3ee78370252
-  data.tar.gz: 633947d1f1d0bfa26a5658f69171ef894120e538e7066e37631a283db8b333d77f7c3ccf24606bc261dd93f6fa208ffa448d258ec6ee5b15ef4f37edfb35b0da
+  metadata.gz: 28a0005ba7b8f0e1a0aca68a9fd63e3cb58f1866de67d622fb99c2cf8fe639981a4a311ceb2e7c43bd2c50cb0809474ee76024c0de649ff310a6795b02dca514
+  data.tar.gz: 4856a6d0cb1e1634089fe7e845a6c1a7a356e5b3fc757744343501db4cd9e5857502daa8b17728c1d3f198c0e2c908809185a3f27583ddd0e830c6accac6c1fa

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.18.0 (2025-04-23)
+
+Full Changelog: [v1.17.0...v1.18.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.17.0...v1.18.0)
+
+### Features
+
+* **api:** added change plan api ([fc2cff8](https://github.com/dodopayments/dodopayments-ruby/commit/fc2cff8003f8e95dcac370e321055f1e28527ce3))
+* **api:** manual updates ([166a9b4](https://github.com/dodopayments/dodopayments-ruby/commit/166a9b4ee8b5321673418e4a50c79e5c80d26295))
+
+
+### Chores
+
+* **ci:** add timeout thresholds for CI jobs ([2bf3878](https://github.com/dodopayments/dodopayments-ruby/commit/2bf3878e437abc08274ded07eff6050685a4bcfd))
+
 ## 1.17.0 (2025-04-22)
 
 Full Changelog: [v1.16.1...v1.17.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.16.1...v1.17.0)

data/README.md

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

data/lib/dodopayments/models/subscription.rb

@@ -31,7 +31,8 @@ module Dodopayments
       required :metadata, Dodopayments::Internal::Type::HashOf[String]
 
       # @!attribute next_billing_date
-      #   Timestamp of the next scheduled billing
+      #   Timestamp of the next scheduled billing. Indicates the end of current billing
+      #   period
       #
       #   @return [Time]
       required :next_billing_date, Time
@@ -47,6 +48,12 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::TimeInterval]
       required :payment_frequency_interval, enum: -> { Dodopayments::Models::TimeInterval }
 
+      # @!attribute previous_billing_date
+      #   Timestamp of the last payment. Indicates the start of current billing period
+      #
+      #   @return [Time]
+      required :previous_billing_date, Time
+
       # @!attribute product_id
       #   Identifier of the product associated with this subscription
       #
@@ -112,7 +119,7 @@ module Dodopayments
       #   @return [String, nil]
       optional :discount_id, String, nil?: true
 
-      # @!method initialize(billing:, created_at:, currency:, customer:, metadata:, next_billing_date:, payment_frequency_count:, payment_frequency_interval:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, discount_id: nil)
+      # @!method initialize(billing:, created_at:, currency:, customer:, metadata:, next_billing_date:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, discount_id: nil)
       #   Response struct representing subscription details
       #
       #   @param billing [Dodopayments::Models::BillingAddress]
@@ -123,6 +130,7 @@ module Dodopayments
       #   @param next_billing_date [Time]
       #   @param payment_frequency_count [Integer]
       #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval]
+      #   @param previous_billing_date [Time]
       #   @param product_id [String]
       #   @param quantity [Integer]
       #   @param recurring_pre_tax_amount [Integer]

data/lib/dodopayments/models/subscription_change_plan_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Subscriptions#change_plan
+    class SubscriptionChangePlanParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute product_id
+      #   Unique identifier of the product to subscribe to
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!attribute proration_billing_mode
+      #
+      #   @return [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
+      required :proration_billing_mode,
+               enum: -> { Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode }
+
+      # @!attribute quantity
+      #   Number of units to subscribe for. Must be at least 1.
+      #
+      #   @return [Integer]
+      required :quantity, Integer
+
+      # @!method initialize(product_id:, proration_billing_mode:, quantity:, request_options: {})
+      #   @param product_id [String]
+      #   @param proration_billing_mode [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
+      #   @param quantity [Integer]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      module ProrationBillingMode
+        extend Dodopayments::Internal::Type::Enum
+
+        PRORATED_IMMEDIATELY = :prorated_immediately
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/subscriptions.rb

@@ -100,6 +100,28 @@ module Dodopayments
         )
       end
 
+      # @overload change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, request_options: {})
+      #
+      # @param subscription_id [String]
+      # @param product_id [String]
+      # @param proration_billing_mode [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
+      # @param quantity [Integer]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dodopayments::Models::SubscriptionChangePlanParams
+      def change_plan(subscription_id, params)
+        parsed, options = Dodopayments::Models::SubscriptionChangePlanParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["subscriptions/%1$s/change-plan", subscription_id],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
       # @overload charge(subscription_id, product_price:, request_options: {})
       #
       # @param subscription_id [String]

data/lib/dodopayments/version.rb

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

data/lib/dodopayments.rb

@@ -115,6 +115,7 @@ require_relative "dodopayments/models/refund_list_params"
 require_relative "dodopayments/models/refund_retrieve_params"
 require_relative "dodopayments/models/refund_status"
 require_relative "dodopayments/models/subscription"
+require_relative "dodopayments/models/subscription_change_plan_params"
 require_relative "dodopayments/models/subscription_charge_params"
 require_relative "dodopayments/models/subscription_charge_response"
 require_relative "dodopayments/models/subscription_create_params"

data/rbi/lib/dodopayments/models/subscription.rbi

@@ -27,7 +27,8 @@ module Dodopayments
       sig { returns(T::Hash[Symbol, String]) }
       attr_accessor :metadata
 
-      # Timestamp of the next scheduled billing
+      # Timestamp of the next scheduled billing. Indicates the end of current billing
+      # period
       sig { returns(Time) }
       attr_accessor :next_billing_date
 
@@ -38,6 +39,10 @@ module Dodopayments
       sig { returns(Dodopayments::Models::TimeInterval::TaggedSymbol) }
       attr_accessor :payment_frequency_interval
 
+      # Timestamp of the last payment. Indicates the start of current billing period
+      sig { returns(Time) }
+      attr_accessor :previous_billing_date
+
       # Identifier of the product associated with this subscription
       sig { returns(String) }
       attr_accessor :product_id
@@ -92,6 +97,7 @@ module Dodopayments
           next_billing_date: Time,
           payment_frequency_count: Integer,
           payment_frequency_interval: Dodopayments::Models::TimeInterval::OrSymbol,
+          previous_billing_date: Time,
           product_id: String,
           quantity: Integer,
           recurring_pre_tax_amount: Integer,
@@ -115,6 +121,7 @@ module Dodopayments
         next_billing_date:,
         payment_frequency_count:,
         payment_frequency_interval:,
+        previous_billing_date:,
         product_id:,
         quantity:,
         recurring_pre_tax_amount:,
@@ -139,6 +146,7 @@ module Dodopayments
               next_billing_date: Time,
               payment_frequency_count: Integer,
               payment_frequency_interval: Dodopayments::Models::TimeInterval::TaggedSymbol,
+              previous_billing_date: Time,
               product_id: String,
               quantity: Integer,
               recurring_pre_tax_amount: Integer,

data/rbi/lib/dodopayments/models/subscription_change_plan_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionChangePlanParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # Unique identifier of the product to subscribe to
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      sig { returns(Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode::OrSymbol) }
+      attr_accessor :proration_billing_mode
+
+      # Number of units to subscribe for. Must be at least 1.
+      sig { returns(Integer) }
+      attr_accessor :quantity
+
+      sig do
+        params(
+          product_id: String,
+          proration_billing_mode: Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode::OrSymbol,
+          quantity: Integer,
+          request_options: T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(product_id:, proration_billing_mode:, quantity:, request_options: {}); end
+
+      sig do
+        override
+          .returns(
+            {
+              product_id: String,
+              proration_billing_mode: Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode::OrSymbol,
+              quantity: Integer,
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+
+      module ProrationBillingMode
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRORATED_IMMEDIATELY =
+          T.let(
+            :prorated_immediately,
+            Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode::TaggedSymbol
+          )
+
+        sig do
+          override
+            .returns(T::Array[Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode::TaggedSymbol])
+        end
+        def self.values; end
+      end
+    end
+  end
+end

data/rbi/lib/dodopayments/resources/subscriptions.rbi

@@ -121,6 +121,26 @@ module Dodopayments
         status: nil,
         request_options: {}
       ); end
+      sig do
+        params(
+          subscription_id: String,
+          product_id: String,
+          proration_billing_mode: Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode::OrSymbol,
+          quantity: Integer,
+          request_options: T.nilable(T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash))
+        )
+          .void
+      end
+      def change_plan(
+        # Subscription Id
+        subscription_id,
+        # Unique identifier of the product to subscribe to
+        product_id:,
+        proration_billing_mode:,
+        # Number of units to subscribe for. Must be at least 1.
+        quantity:,
+        request_options: {}
+      ); end
       sig do
         params(
           subscription_id: String,

data/sig/dodopayments/models/subscription.rbs

@@ -10,6 +10,7 @@ module Dodopayments
         next_billing_date: Time,
         payment_frequency_count: Integer,
         payment_frequency_interval: Dodopayments::Models::time_interval,
+        previous_billing_date: Time,
         product_id: String,
         quantity: Integer,
         recurring_pre_tax_amount: Integer,
@@ -40,6 +41,8 @@ module Dodopayments
 
       attr_accessor payment_frequency_interval: Dodopayments::Models::time_interval
 
+      attr_accessor previous_billing_date: Time
+
       attr_accessor product_id: String
 
       attr_accessor quantity: Integer
@@ -71,6 +74,7 @@ module Dodopayments
         next_billing_date: Time,
         payment_frequency_count: Integer,
         payment_frequency_interval: Dodopayments::Models::time_interval,
+        previous_billing_date: Time,
         product_id: String,
         quantity: Integer,
         recurring_pre_tax_amount: Integer,

data/sig/dodopayments/models/subscription_change_plan_params.rbs

@@ -0,0 +1,41 @@
+module Dodopayments
+  module Models
+    type subscription_change_plan_params =
+      {
+        product_id: String,
+        proration_billing_mode: Dodopayments::Models::SubscriptionChangePlanParams::proration_billing_mode,
+        quantity: Integer
+      }
+      & Dodopayments::Internal::Type::request_parameters
+
+    class SubscriptionChangePlanParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor product_id: String
+
+      attr_accessor proration_billing_mode: Dodopayments::Models::SubscriptionChangePlanParams::proration_billing_mode
+
+      attr_accessor quantity: Integer
+
+      def initialize: (
+        product_id: String,
+        proration_billing_mode: Dodopayments::Models::SubscriptionChangePlanParams::proration_billing_mode,
+        quantity: Integer,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> Dodopayments::Models::subscription_change_plan_params
+
+      type proration_billing_mode = :prorated_immediately
+
+      module ProrationBillingMode
+        extend Dodopayments::Internal::Type::Enum
+
+        PRORATED_IMMEDIATELY: :prorated_immediately
+
+        def self?.values: -> ::Array[Dodopayments::Models::SubscriptionChangePlanParams::proration_billing_mode]
+      end
+    end
+  end
+end

data/sig/dodopayments/resources/subscriptions.rbs

@@ -43,6 +43,14 @@ module Dodopayments
         ?request_options: Dodopayments::request_opts
       ) -> Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::Subscription]
 
+      def change_plan: (
+        String subscription_id,
+        product_id: String,
+        proration_billing_mode: Dodopayments::Models::SubscriptionChangePlanParams::proration_billing_mode,
+        quantity: Integer,
+        ?request_options: Dodopayments::request_opts
+      ) -> nil
+
       def charge: (
         String subscription_id,
         product_price: Integer,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dodopayments
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Dodo Payments
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-22 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -123,6 +123,7 @@ files:
 - lib/dodopayments/models/refund_retrieve_params.rb
 - lib/dodopayments/models/refund_status.rb
 - lib/dodopayments/models/subscription.rb
+- lib/dodopayments/models/subscription_change_plan_params.rb
 - lib/dodopayments/models/subscription_charge_params.rb
 - lib/dodopayments/models/subscription_charge_response.rb
 - lib/dodopayments/models/subscription_create_params.rb
@@ -242,6 +243,7 @@ files:
 - rbi/lib/dodopayments/models/refund_retrieve_params.rbi
 - rbi/lib/dodopayments/models/refund_status.rbi
 - rbi/lib/dodopayments/models/subscription.rbi
+- rbi/lib/dodopayments/models/subscription_change_plan_params.rbi
 - rbi/lib/dodopayments/models/subscription_charge_params.rbi
 - rbi/lib/dodopayments/models/subscription_charge_response.rbi
 - rbi/lib/dodopayments/models/subscription_create_params.rbi
@@ -360,6 +362,7 @@ files:
 - sig/dodopayments/models/refund_retrieve_params.rbs
 - sig/dodopayments/models/refund_status.rbs
 - sig/dodopayments/models/subscription.rbs
+- sig/dodopayments/models/subscription_change_plan_params.rbs
 - sig/dodopayments/models/subscription_charge_params.rbs
 - sig/dodopayments/models/subscription_charge_response.rbs
 - sig/dodopayments/models/subscription_create_params.rbs