dodopayments 1.17.0 → 1.18.1

data/rbi/lib/dodopayments/models/product.rbi

@@ -95,20 +95,34 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Unique identifier for the business to which the product belongs.
         business_id:,
+        # Timestamp when the product was created.
         created_at:,
+        # Indicates if the product is recurring (e.g., subscriptions).
         is_recurring:,
+        # Indicates whether the product requires a license key.
         license_key_enabled:,
         price:,
+        # Unique identifier for the product.
         product_id:,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
         tax_category:,
+        # Timestamp when the product was last updated.
         updated_at:,
+        # Available Addons for subscription products
         addons: nil,
+        # Description of the product, optional.
         description: nil,
+        # URL of the product image, optional.
         image: nil,
+        # Message sent upon license key activation, if applicable.
         license_key_activation_message: nil,
+        # Limit on the number of activations for the license key, if enabled.
         license_key_activations_limit: nil,
         license_key_duration: nil,
+        # Name of the product, optional.
         name: nil
       ); end
       sig do

data/rbi/lib/dodopayments/models/product_create_params.rbi

@@ -70,13 +70,21 @@ module Dodopayments
       end
       def self.new(
         price:,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
         tax_category:,
+        # Addons available for subscription product
         addons: nil,
+        # Optional description of the product
         description: nil,
+        # Optional message displayed during license key activation
         license_key_activation_message: nil,
+        # The number of times the license key can be activated. Must be 0 or greater
         license_key_activations_limit: nil,
         license_key_duration: nil,
+        # When true, generates and sends a license key to your customer. Defaults to false
         license_key_enabled: nil,
+        # Optional name of the product
         name: nil,
         request_options: {}
       ); end

data/rbi/lib/dodopayments/models/product_list_params.rbi

@@ -39,8 +39,21 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(archived: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {}); end
-
+      def self.new(
+        # List archived products
+        archived: nil,
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        # Filter products by pricing type:
+        #
+        # - `true`: Show only recurring pricing products (e.g. subscriptions)
+        # - `false`: Show only one-time price products
+        # - `null` or absent: Show both types of products
+        recurring: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/product_list_response.rbi

@@ -92,18 +92,39 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Unique identifier for the business to which the product belongs.
         business_id:,
+        # Timestamp when the product was created.
         created_at:,
+        # Indicates if the product is recurring (e.g., subscriptions).
         is_recurring:,
+        # Unique identifier for the product.
         product_id:,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
         tax_category:,
+        # Timestamp when the product was last updated.
         updated_at:,
         currency: nil,
+        # Description of the product, optional.
         description: nil,
+        # URL of the product image, optional.
         image: nil,
+        # Name of the product, optional.
         name: nil,
+        # Price of the product, optional.
+        #
+        # The price is represented in the lowest denomination of the currency. For
+        # example:
+        #
+        # - In USD, a price of `$12.34` would be represented as `1234` (cents).
+        # - In JPY, a price of `¥1500` would be represented as `1500` (yen).
+        # - In INR, a price of `₹1234.56` would be represented as `123456` (paise).
+        #
+        # This ensures precision and avoids floating-point rounding errors.
         price: nil,
         price_detail: nil,
+        # Indicates if the price is tax inclusive
         tax_inclusive: nil
       ); end
       sig do

data/rbi/lib/dodopayments/models/product_update_params.rbi

@@ -89,15 +89,33 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Available Addons for subscription products
         addons: nil,
+        # Description of the product, optional and must be at most 1000 characters.
         description: 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.
         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.
         license_key_activations_limit: nil,
         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.
         license_key_enabled: nil,
+        # Name of the product, optional and must be at most 100 characters.
         name: nil,
         price: nil,
+        # Represents the different categories of taxation applicable to various products
+        # and services.
         tax_category: nil,
         request_options: {}
       ); end

data/rbi/lib/dodopayments/models/refund.rbi

@@ -47,17 +47,21 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # The unique identifier of the business issuing the refund.
         business_id:,
+        # The timestamp of when the refund was created in UTC.
         created_at:,
+        # The unique identifier of the payment associated with the refund.
         payment_id:,
+        # The unique identifier of the refund.
         refund_id:,
         status:,
+        # The refunded amount.
         amount: nil,
         currency: nil,
+        # The reason provided for the refund, if any. Optional.
         reason: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/refund_create_params.rbi

@@ -22,8 +22,13 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(payment_id:, reason: nil, request_options: {}); end
-
+      def self.new(
+        # The unique identifier of the payment to be refunded.
+        payment_id:,
+        # The reason for the refund, if any. Maximum length is 3000 characters. Optional.
+        reason: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns({

data/rbi/lib/dodopayments/models/refund_list_params.rbi

@@ -43,11 +43,17 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Get events after this created time
         created_at_gte: nil,
+        # Get events created before this time
         created_at_lte: nil,
+        # Filter by customer_id
         customer_id: nil,
+        # Page number default is 0
         page_number: nil,
+        # Page size default is 10 max is 100
         page_size: nil,
+        # Filter by status
         status: nil,
         request_options: {}
       ); end

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,
@@ -108,23 +114,39 @@ module Dodopayments
       end
       def self.new(
         billing:,
+        # Timestamp when the subscription was created
         created_at:,
         currency:,
         customer:,
         metadata:,
+        # Timestamp of the next scheduled billing. Indicates the end of current billing
+        # period
         next_billing_date:,
+        # Number of payment frequency intervals
         payment_frequency_count:,
         payment_frequency_interval:,
+        # Timestamp of the last payment. Indicates the start of current billing period
+        previous_billing_date:,
+        # Identifier of the product associated with this subscription
         product_id:,
+        # Number of units/items included in the subscription
         quantity:,
+        # Amount charged before tax for each recurring payment in smallest currency unit
+        # (e.g. cents)
         recurring_pre_tax_amount:,
         status:,
+        # Unique identifier for the subscription
         subscription_id:,
+        # Number of subscription period intervals
         subscription_period_count:,
         subscription_period_interval:,
+        # Indicates if the recurring_pre_tax_amount is tax inclusive
         tax_inclusive:,
+        # Number of days in the trial period (0 if no trial)
         trial_period_days:,
+        # Cancelled timestamp if the subscription is cancelled
         cancelled_at: nil,
+        # The discount id if discount is applied
         discount_id: nil
       ); end
       sig do
@@ -139,6 +161,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,71 @@
+# 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(
+        # 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
+        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/models/subscription_charge_params.rbi

@@ -18,8 +18,12 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(product_price:, request_options: {}); end
-
+      def self.new(
+        # The product price. Represented in the lowest denomination of the currency (e.g.,
+        # cents for USD). For example, to charge $1.00, pass `100`.
+        product_price:,
+        request_options: {}
+      ); end
       sig { override.returns({product_price: Integer, request_options: Dodopayments::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/dodopayments/models/subscription_create_params.rbi

@@ -116,17 +116,33 @@ module Dodopayments
       def self.new(
         billing:,
         customer:,
+        # Unique identifier of the product to subscribe to
         product_id:,
+        # Number of units to subscribe for. Must be at least 1.
         quantity:,
+        # List of payment methods allowed during checkout.
+        #
+        # Customers will **never** see payment methods that are **not** in this list.
+        # However, adding a method here **does not guarantee** customers will see it.
+        # Availability still depends on other factors (e.g., customer location, merchant
+        # settings).
         allowed_payment_method_types: nil,
         billing_currency: nil,
+        # Discount Code to apply to the subscription
         discount_code: nil,
         metadata: nil,
         on_demand: nil,
+        # If true, generates a payment link. Defaults to false if not specified.
         payment_link: nil,
+        # Optional URL to redirect after successful subscription creation
         return_url: nil,
+        # Display saved payment methods of a returning customer False by default
         show_saved_payment_methods: nil,
+        # Tax ID in case the payment is B2B. If tax id validation fails the payment
+        # creation will fail
         tax_id: nil,
+        # Optional trial period in days If specified, this value overrides the trial
+        # period set in the product's price Must be between 0 and 10000 days
         trial_period_days: nil,
         request_options: {}
       ); end
@@ -382,8 +398,15 @@ module Dodopayments
         attr_accessor :product_price
 
         sig { params(mandate_only: T::Boolean, product_price: T.nilable(Integer)).returns(T.attached_class) }
-        def self.new(mandate_only:, product_price: nil); end
-
+        def self.new(
+          # If set as True, does not perform any charge and only authorizes payment method
+          # details for future use.
+          mandate_only:,
+          # Product price for the initial charge to customer If not specified the stored
+          # price of the product will be used Represented in the lowest denomination of the
+          # currency (e.g., cents for USD). For example, to charge $1.00, pass `100`.
+          product_price: nil
+        ); end
         sig { override.returns({mandate_only: T::Boolean, product_price: T.nilable(Integer)}) }
         def to_hash; end
       end

data/rbi/lib/dodopayments/models/subscription_create_response.rbi

@@ -51,10 +51,17 @@ module Dodopayments
       def self.new(
         customer:,
         metadata:,
+        # Tax will be added to the amount and charged to the customer on each billing
+        # cycle
         recurring_pre_tax_amount:,
+        # Unique identifier for the subscription
         subscription_id:,
+        # Client secret used to load Dodo checkout SDK NOTE : Dodo checkout SDK will be
+        # coming soon
         client_secret: nil,
+        # The discount id if discount is applied
         discount_id: nil,
+        # URL to checkout page
         payment_link: nil
       ); end
       sig do

data/rbi/lib/dodopayments/models/subscription_list_params.rbi

@@ -43,11 +43,17 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Get events after this created time
         created_at_gte: nil,
+        # Get events created before this time
         created_at_lte: nil,
+        # Filter by customer id
         customer_id: nil,
+        # Page number default is 0
         page_number: nil,
+        # Page size default is 10 max is 100
         page_size: nil,
+        # Filter by status
         status: nil,
         request_options: {}
       ); end

data/rbi/lib/dodopayments/models/webhook_event_list_params.rbi

@@ -43,11 +43,17 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Get events after this created time
         created_at_gte: nil,
+        # Get events created before this time
         created_at_lte: nil,
+        # Min : 1, Max : 100, default 10
         limit: nil,
+        # Get events history of a specific object like payment/subscription/refund/dispute
         object_id_: nil,
+        # Page number default is 0
         page_number: nil,
+        # Page size default is 10 max is 100
         page_size: nil,
         request_options: {}
       ); 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/file_part.rbs

@@ -0,0 +1,21 @@
+module Dodopayments
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: String?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/dodopayments/internal/transport/base_client.rbs

@@ -11,7 +11,10 @@ module Dodopayments
             | Integer
             | ::Array[(String | Integer)?])?]?,
             body: top?,
-            unwrap: Symbol?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
             page: Class?,
             stream: Class?,
             model: Dodopayments::Internal::Type::Converter::input?,
@@ -53,7 +56,7 @@ module Dodopayments
         ) -> void
 
         # @api private
-        attr_accessor requester: Dodopayments::Internal::Transport::PooledNetRequester
+        attr_reader requester: Dodopayments::Internal::Transport::PooledNetRequester
 
         def initialize: (
           base_url: String,
@@ -96,7 +99,10 @@ module Dodopayments
           | Integer
           | ::Array[(String | Integer)?])?]?,
           ?body: top?,
-          ?unwrap: Symbol?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
           ?page: Class?,
           ?stream: Class?,
           ?model: Dodopayments::Internal::Type::Converter::input?,

data/sig/dodopayments/internal/type/{io_like.rbs → file_input.rbs}

@@ -1,7 +1,7 @@
 module Dodopayments
   module Internal
     module Type
-      class IOLike
+      class FileInput
         extend Dodopayments::Internal::Type::Converter
 
         def self.===: (top other) -> bool

data/sig/dodopayments/internal/util.rbs

@@ -29,8 +29,10 @@ module Dodopayments
 
       def self?.dig: (
         ::Hash[Symbol, top] | ::Array[top] | top data,
-        (Symbol | Integer | ::Array[(Symbol | Integer)])? pick,
-        ?top? sentinel
+        (Symbol
+        | Integer
+        | ::Array[(Symbol | Integer)]
+        | (^(top arg0) -> top))? pick
       ) {
         -> top?
       } -> top?
@@ -73,16 +75,6 @@ module Dodopayments
         | ::Array[(String | Integer)?])?] headers
       ) -> ::Hash[String, String]
 
-      class SerializationAdapter
-        attr_reader inner: Pathname | IO
-
-        def to_json: (*top a) -> String
-
-        def to_yaml: (*top a) -> String
-
-        def initialize: (Pathname | IO inner) -> void
-      end
-
       class ReadIOAdapter
         def close?: -> bool?
 
@@ -103,6 +95,16 @@ module Dodopayments
         (Enumerator::Yielder y) -> void
       } -> Enumerable[String]
 
+      JSON_CONTENT: Regexp
+      JSONL_CONTENT: Regexp
+
+      def self?.write_multipart_content: (
+        Enumerator::Yielder y,
+        val: top,
+        closing: ::Array[^-> void],
+        ?content_type: String?
+      ) -> void
+
       def self?.write_multipart_chunk: (
         Enumerator::Yielder y,
         boundary: 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,