dodopayments 2.8.1 → 2.9.1

data/rbi/dodopayments/models/product_update_params.rbi

@@ -36,6 +36,8 @@ module Dodopayments
       attr_accessor :description
 
       # Choose how you would like you digital product delivered
+      #
+      # deprecated: use entitlements instead
       sig do
         returns(
           T.nilable(Dodopayments::ProductUpdateParams::DigitalProductDelivery)
@@ -53,10 +55,12 @@ module Dodopayments
       end
       attr_writer :digital_product_delivery
 
-      # Entitlement IDs to attach (replaces all existing when present) Send empty array
-      # to remove all, omit field to leave unchanged
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_accessor :entitlement_ids
+      # Entitlements to attach (replaces all existing when present) Send empty array to
+      # remove all, omit field to leave unchanged
+      sig do
+        returns(T.nilable(T::Array[Dodopayments::AttachProductEntitlement]))
+      end
+      attr_accessor :entitlements
 
       # Product image id after its uploaded to S3
       sig { returns(T.nilable(String)) }
@@ -66,6 +70,8 @@ module Dodopayments
       #
       # Only applicable if `license_key_enabled` is `true`. This message contains
       # instructions for activating the license key.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(String)) }
       attr_accessor :license_key_activation_message
 
@@ -73,6 +79,8 @@ module Dodopayments
       #
       # Only applicable if `license_key_enabled` is `true`. Represents the maximum
       # number of times the license key can be activated.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(Integer)) }
       attr_accessor :license_key_activations_limit
 
@@ -80,6 +88,8 @@ module Dodopayments
       #
       # Only applicable if `license_key_enabled` is `true`. Represents the duration in
       # days for which the license key is valid.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(Dodopayments::LicenseKeyDuration)) }
       attr_reader :license_key_duration
 
@@ -95,6 +105,8 @@ module Dodopayments
       #
       # If `true`, additional fields related to license key (duration, activations
       # limit, activation message) become applicable.
+      #
+      # deprecated: use entitlements instead
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :license_key_enabled
 
@@ -136,7 +148,8 @@ module Dodopayments
             T.nilable(
               Dodopayments::ProductUpdateParams::DigitalProductDelivery::OrHash
             ),
-          entitlement_ids: T.nilable(T::Array[String]),
+          entitlements:
+            T.nilable(T::Array[Dodopayments::AttachProductEntitlement::OrHash]),
           image_id: T.nilable(String),
           license_key_activation_message: T.nilable(String),
           license_key_activations_limit: T.nilable(Integer),
@@ -168,31 +181,41 @@ module Dodopayments
         # Description of the product, optional and must be at most 1000 characters.
         description: nil,
         # Choose how you would like you digital product delivered
+        #
+        # deprecated: use entitlements instead
         digital_product_delivery: nil,
-        # Entitlement IDs to attach (replaces all existing when present) Send empty array
-        # to remove all, omit field to leave unchanged
-        entitlement_ids: nil,
+        # Entitlements to attach (replaces all existing when present) Send empty array to
+        # remove all, omit field to leave unchanged
+        entitlements: nil,
         # Product image id after its uploaded to S3
         image_id: nil,
         # Message sent to the customer upon license key activation.
         #
         # Only applicable if `license_key_enabled` is `true`. This message contains
         # instructions for activating the license key.
+        #
+        # deprecated: use entitlements instead
         license_key_activation_message: nil,
         # Limit for the number of activations for the license key.
         #
         # Only applicable if `license_key_enabled` is `true`. Represents the maximum
         # number of times the license key can be activated.
+        #
+        # deprecated: use entitlements instead
         license_key_activations_limit: nil,
         # Duration of the license key if enabled.
         #
         # Only applicable if `license_key_enabled` is `true`. Represents the duration in
         # days for which the license key is valid.
+        #
+        # deprecated: use entitlements instead
         license_key_duration: nil,
         # Whether the product requires a license key.
         #
         # If `true`, additional fields related to license key (duration, activations
         # limit, activation message) become applicable.
+        #
+        # deprecated: use entitlements instead
         license_key_enabled: nil,
         # Additional metadata for the product
         metadata: nil,
@@ -219,7 +242,8 @@ module Dodopayments
               T.nilable(
                 Dodopayments::ProductUpdateParams::DigitalProductDelivery
               ),
-            entitlement_ids: T.nilable(T::Array[String]),
+            entitlements:
+              T.nilable(T::Array[Dodopayments::AttachProductEntitlement]),
             image_id: T.nilable(String),
             license_key_activation_message: T.nilable(String),
             license_key_activations_limit: T.nilable(Integer),
@@ -265,6 +289,8 @@ module Dodopayments
         attr_accessor :instructions
 
         # Choose how you would like you digital product delivered
+        #
+        # deprecated: use entitlements instead
         sig do
           params(
             external_url: T.nilable(String),

data/rbi/dodopayments/models/scheduled_plan_change.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ScheduledPlanChange < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ScheduledPlanChange,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The scheduled plan change ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Addons included in the scheduled change
+      sig { returns(T::Array[Dodopayments::ScheduledPlanChange::Addon]) }
+      attr_accessor :addons
+
+      # When this scheduled change was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # When the change will be applied
+      sig { returns(Time) }
+      attr_accessor :effective_at
+
+      # The product ID the subscription will change to
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      # Quantity for the new plan
+      sig { returns(Integer) }
+      attr_accessor :quantity
+
+      # Description of the product being changed to
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_description
+
+      # Name of the product being changed to
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_name
+
+      sig do
+        params(
+          id: String,
+          addons: T::Array[Dodopayments::ScheduledPlanChange::Addon::OrHash],
+          created_at: Time,
+          effective_at: Time,
+          product_id: String,
+          quantity: Integer,
+          product_description: T.nilable(String),
+          product_name: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The scheduled plan change ID
+        id:,
+        # Addons included in the scheduled change
+        addons:,
+        # When this scheduled change was created
+        created_at:,
+        # When the change will be applied
+        effective_at:,
+        # The product ID the subscription will change to
+        product_id:,
+        # Quantity for the new plan
+        quantity:,
+        # Description of the product being changed to
+        product_description: nil,
+        # Name of the product being changed to
+        product_name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            addons: T::Array[Dodopayments::ScheduledPlanChange::Addon],
+            created_at: Time,
+            effective_at: Time,
+            product_id: String,
+            quantity: Integer,
+            product_description: T.nilable(String),
+            product_name: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Addon < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::ScheduledPlanChange::Addon,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The addon ID
+        sig { returns(String) }
+        attr_accessor :addon_id
+
+        # Name of the addon
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Quantity of the addon
+        sig { returns(Integer) }
+        attr_accessor :quantity
+
+        sig do
+          params(addon_id: String, name: String, quantity: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The addon ID
+          addon_id:,
+          # Name of the addon
+          name:,
+          # Quantity of the addon
+          quantity:
+        )
+        end
+
+        sig do
+          override.returns(
+            { addon_id: String, name: String, quantity: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription.rbi

@@ -116,6 +116,16 @@ module Dodopayments
       sig { returns(Integer) }
       attr_accessor :trial_period_days
 
+      # Free-text cancellation comment, if any
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cancellation_comment
+
+      # Customer-supplied churn reason, if any
+      sig do
+        returns(T.nilable(Dodopayments::CancellationFeedback::TaggedSymbol))
+      end
+      attr_accessor :cancellation_feedback
+
       # Cancelled timestamp if the subscription is cancelled
       sig { returns(T.nilable(Time)) }
       attr_accessor :cancelled_at
@@ -141,13 +151,12 @@ module Dodopayments
       attr_accessor :payment_method_id
 
       # Scheduled plan change details, if any
-      sig { returns(T.nilable(Dodopayments::Subscription::ScheduledChange)) }
+      sig { returns(T.nilable(Dodopayments::ScheduledPlanChange)) }
       attr_reader :scheduled_change
 
       sig do
         params(
-          scheduled_change:
-            T.nilable(Dodopayments::Subscription::ScheduledChange::OrHash)
+          scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange::OrHash)
         ).void
       end
       attr_writer :scheduled_change
@@ -185,6 +194,9 @@ module Dodopayments
           subscription_period_interval: Dodopayments::TimeInterval::OrSymbol,
           tax_inclusive: T::Boolean,
           trial_period_days: Integer,
+          cancellation_comment: T.nilable(String),
+          cancellation_feedback:
+            T.nilable(Dodopayments::CancellationFeedback::OrSymbol),
           cancelled_at: T.nilable(Time),
           custom_field_responses:
             T.nilable(T::Array[Dodopayments::CustomFieldResponse::OrHash]),
@@ -193,7 +205,7 @@ module Dodopayments
           expires_at: T.nilable(Time),
           payment_method_id: T.nilable(String),
           scheduled_change:
-            T.nilable(Dodopayments::Subscription::ScheduledChange::OrHash),
+            T.nilable(Dodopayments::ScheduledPlanChange::OrHash),
           tax_id: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -248,6 +260,10 @@ module Dodopayments
         tax_inclusive:,
         # Number of days in the trial period (0 if no trial)
         trial_period_days:,
+        # Free-text cancellation comment, if any
+        cancellation_comment: nil,
+        # Customer-supplied churn reason, if any
+        cancellation_feedback: nil,
         # Cancelled timestamp if the subscription is cancelled
         cancelled_at: nil,
         # Customer's responses to custom fields collected during checkout
@@ -298,6 +314,9 @@ module Dodopayments
               Dodopayments::TimeInterval::TaggedSymbol,
             tax_inclusive: T::Boolean,
             trial_period_days: Integer,
+            cancellation_comment: T.nilable(String),
+            cancellation_feedback:
+              T.nilable(Dodopayments::CancellationFeedback::TaggedSymbol),
             cancelled_at: T.nilable(Time),
             custom_field_responses:
               T.nilable(T::Array[Dodopayments::CustomFieldResponse]),
@@ -305,157 +324,13 @@ module Dodopayments
             discount_id: T.nilable(String),
             expires_at: T.nilable(Time),
             payment_method_id: T.nilable(String),
-            scheduled_change:
-              T.nilable(Dodopayments::Subscription::ScheduledChange),
+            scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange),
             tax_id: T.nilable(String)
           }
         )
       end
       def to_hash
       end
-
-      class ScheduledChange < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::Subscription::ScheduledChange,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        # The scheduled plan change ID
-        sig { returns(String) }
-        attr_accessor :id
-
-        # Addons included in the scheduled change
-        sig do
-          returns(T::Array[Dodopayments::Subscription::ScheduledChange::Addon])
-        end
-        attr_accessor :addons
-
-        # When this scheduled change was created
-        sig { returns(Time) }
-        attr_accessor :created_at
-
-        # When the change will be applied
-        sig { returns(Time) }
-        attr_accessor :effective_at
-
-        # The product ID the subscription will change to
-        sig { returns(String) }
-        attr_accessor :product_id
-
-        # Quantity for the new plan
-        sig { returns(Integer) }
-        attr_accessor :quantity
-
-        # Description of the product being changed to
-        sig { returns(T.nilable(String)) }
-        attr_accessor :product_description
-
-        # Name of the product being changed to
-        sig { returns(T.nilable(String)) }
-        attr_accessor :product_name
-
-        # Scheduled plan change details, if any
-        sig do
-          params(
-            id: String,
-            addons:
-              T::Array[
-                Dodopayments::Subscription::ScheduledChange::Addon::OrHash
-              ],
-            created_at: Time,
-            effective_at: Time,
-            product_id: String,
-            quantity: Integer,
-            product_description: T.nilable(String),
-            product_name: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The scheduled plan change ID
-          id:,
-          # Addons included in the scheduled change
-          addons:,
-          # When this scheduled change was created
-          created_at:,
-          # When the change will be applied
-          effective_at:,
-          # The product ID the subscription will change to
-          product_id:,
-          # Quantity for the new plan
-          quantity:,
-          # Description of the product being changed to
-          product_description: nil,
-          # Name of the product being changed to
-          product_name: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              addons:
-                T::Array[Dodopayments::Subscription::ScheduledChange::Addon],
-              created_at: Time,
-              effective_at: Time,
-              product_id: String,
-              quantity: Integer,
-              product_description: T.nilable(String),
-              product_name: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class Addon < Dodopayments::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Dodopayments::Subscription::ScheduledChange::Addon,
-                Dodopayments::Internal::AnyHash
-              )
-            end
-
-          # The addon ID
-          sig { returns(String) }
-          attr_accessor :addon_id
-
-          # Name of the addon
-          sig { returns(String) }
-          attr_accessor :name
-
-          # Quantity of the addon
-          sig { returns(Integer) }
-          attr_accessor :quantity
-
-          sig do
-            params(addon_id: String, name: String, quantity: Integer).returns(
-              T.attached_class
-            )
-          end
-          def self.new(
-            # The addon ID
-            addon_id:,
-            # Name of the addon
-            name:,
-            # Quantity of the addon
-            quantity:
-          )
-          end
-
-          sig do
-            override.returns(
-              { addon_id: String, name: String, quantity: Integer }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_create_params.rbi

@@ -65,6 +65,15 @@ module Dodopayments
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :force_3ds
 
+      # Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
+      # Indian-card recurring payments. The mandate amount sent to the processor is
+      # `max(this_floor, actual_billing_amount)`, so this is effectively the
+      # customer-facing authorization ceiling whenever billing is lower. When unset, the
+      # merchant setting applies; when that's also unset, the system default of ₹15,000
+      # applies.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :mandate_min_amount_inr_paise
+
       # Additional metadata for the subscription Defaults to empty if not specified
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :metadata
@@ -84,13 +93,7 @@ module Dodopayments
 
       # List of one time products that will be bundled with the first payment for this
       # subscription
-      sig do
-        returns(
-          T.nilable(
-            T::Array[Dodopayments::SubscriptionCreateParams::OneTimeProductCart]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Array[Dodopayments::OneTimeProductCartItem])) }
       attr_accessor :one_time_product_cart
 
       # If true, generates a payment link. Defaults to false if not specified.
@@ -111,6 +114,15 @@ module Dodopayments
       sig { params(redirect_immediately: T::Boolean).void }
       attr_writer :redirect_immediately
 
+      # If true, the customer's phone number is required to create this subscription.
+      # Typically set alongside `payment_link=true` so merchants can enforce phone
+      # collection on the hosted payment page. Defaults to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :require_phone_number
+
+      sig { params(require_phone_number: T::Boolean).void }
+      attr_writer :require_phone_number
+
       # Optional URL to redirect after successful subscription creation
       sig { returns(T.nilable(String)) }
       attr_accessor :return_url
@@ -152,17 +164,15 @@ module Dodopayments
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
           discount_code: T.nilable(String),
           force_3ds: T.nilable(T::Boolean),
+          mandate_min_amount_inr_paise: T.nilable(Integer),
           metadata: T::Hash[Symbol, String],
           on_demand: T.nilable(Dodopayments::OnDemandSubscription::OrHash),
           one_time_product_cart:
-            T.nilable(
-              T::Array[
-                Dodopayments::SubscriptionCreateParams::OneTimeProductCart::OrHash
-              ]
-            ),
+            T.nilable(T::Array[Dodopayments::OneTimeProductCartItem::OrHash]),
           payment_link: T.nilable(T::Boolean),
           payment_method_id: T.nilable(String),
           redirect_immediately: T::Boolean,
+          require_phone_number: T::Boolean,
           return_url: T.nilable(String),
           short_link: T.nilable(T::Boolean),
           show_saved_payment_methods: T::Boolean,
@@ -196,6 +206,13 @@ module Dodopayments
         discount_code: nil,
         # Override merchant default 3DS behaviour for this subscription
         force_3ds: nil,
+        # Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
+        # Indian-card recurring payments. The mandate amount sent to the processor is
+        # `max(this_floor, actual_billing_amount)`, so this is effectively the
+        # customer-facing authorization ceiling whenever billing is lower. When unset, the
+        # merchant setting applies; when that's also unset, the system default of ₹15,000
+        # applies.
+        mandate_min_amount_inr_paise: nil,
         # Additional metadata for the subscription Defaults to empty if not specified
         metadata: nil,
         on_demand: nil,
@@ -211,6 +228,10 @@ module Dodopayments
         # If true, redirects the customer immediately after payment completion False by
         # default
         redirect_immediately: nil,
+        # If true, the customer's phone number is required to create this subscription.
+        # Typically set alongside `payment_link=true` so merchants can enforce phone
+        # collection on the hosted payment page. Defaults to false.
+        require_phone_number: nil,
         # Optional URL to redirect after successful subscription creation
         return_url: nil,
         # If true, returns a shortened payment link. Defaults to false if not specified.
@@ -244,17 +265,15 @@ module Dodopayments
             billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
             discount_code: T.nilable(String),
             force_3ds: T.nilable(T::Boolean),
+            mandate_min_amount_inr_paise: T.nilable(Integer),
             metadata: T::Hash[Symbol, String],
             on_demand: T.nilable(Dodopayments::OnDemandSubscription),
             one_time_product_cart:
-              T.nilable(
-                T::Array[
-                  Dodopayments::SubscriptionCreateParams::OneTimeProductCart
-                ]
-              ),
+              T.nilable(T::Array[Dodopayments::OneTimeProductCartItem]),
             payment_link: T.nilable(T::Boolean),
             payment_method_id: T.nilable(String),
             redirect_immediately: T::Boolean,
+            require_phone_number: T::Boolean,
             return_url: T.nilable(String),
             short_link: T.nilable(T::Boolean),
             show_saved_payment_methods: T::Boolean,
@@ -266,57 +285,6 @@ module Dodopayments
       end
       def to_hash
       end
-
-      class OneTimeProductCart < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::SubscriptionCreateParams::OneTimeProductCart,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :product_id
-
-        sig { returns(Integer) }
-        attr_accessor :quantity
-
-        # Amount the customer pays if pay_what_you_want is enabled. If disabled then
-        # amount will be ignored Represented in the lowest denomination of the currency
-        # (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :amount
-
-        sig do
-          params(
-            product_id: String,
-            quantity: Integer,
-            amount: T.nilable(Integer)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          product_id:,
-          quantity:,
-          # Amount the customer pays if pay_what_you_want is enabled. If disabled then
-          # amount will be ignored Represented in the lowest denomination of the currency
-          # (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-          amount: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              product_id: String,
-              quantity: Integer,
-              amount: T.nilable(Integer)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end