dodopayments 1.71.1 → 1.74.0

data/rbi/dodopayments/models/checkout_session_request.rbi

@@ -55,6 +55,14 @@ module Dodopayments
       sig { params(confirm: T::Boolean).void }
       attr_writer :confirm
 
+      # Custom fields to collect from customer during checkout (max 5 fields)
+      sig do
+        returns(
+          T.nilable(T::Array[Dodopayments::CheckoutSessionRequest::CustomField])
+        )
+      end
+      attr_accessor :custom_fields
+
       # Customer details for the session
       sig do
         returns(
@@ -120,6 +128,10 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_method_id
 
+      # Product collection ID for collection-based checkout flow
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_collection_id
+
       # The url to redirect after payment failure or success.
       sig { returns(T.nilable(String)) }
       attr_accessor :return_url
@@ -167,6 +179,12 @@ module Dodopayments
             ),
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
           confirm: T::Boolean,
+          custom_fields:
+            T.nilable(
+              T::Array[
+                Dodopayments::CheckoutSessionRequest::CustomField::OrHash
+              ]
+            ),
           customer:
             T.nilable(
               T.any(
@@ -183,6 +201,7 @@ module Dodopayments
           metadata: T.nilable(T::Hash[Symbol, String]),
           minimal_address: T::Boolean,
           payment_method_id: T.nilable(String),
+          product_collection_id: T.nilable(String),
           return_url: T.nilable(String),
           short_link: T::Boolean,
           show_saved_payment_methods: T::Boolean,
@@ -208,6 +227,8 @@ module Dodopayments
         # If confirm is true, all the details will be finalized. If required data is
         # missing, an API error is thrown.
         confirm: nil,
+        # Custom fields to collect from customer during checkout (max 5 fields)
+        custom_fields: nil,
         # Customer details for the session
         customer: nil,
         # Customization for the checkout session page
@@ -225,6 +246,8 @@ module Dodopayments
         # Optional payment method ID to use for this checkout session. Only allowed when
         # `confirm` is true. If provided, existing customer id must also be provided.
         payment_method_id: nil,
+        # Product collection ID for collection-based checkout flow
+        product_collection_id: nil,
         # The url to redirect after payment failure or success.
         return_url: nil,
         # If true, returns a shortened checkout URL. Defaults to false if not specified.
@@ -246,6 +269,10 @@ module Dodopayments
               T.nilable(Dodopayments::CheckoutSessionRequest::BillingAddress),
             billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
             confirm: T::Boolean,
+            custom_fields:
+              T.nilable(
+                T::Array[Dodopayments::CheckoutSessionRequest::CustomField]
+              ),
             customer:
               T.nilable(
                 T.any(
@@ -260,6 +287,7 @@ module Dodopayments
             metadata: T.nilable(T::Hash[Symbol, String]),
             minimal_address: T::Boolean,
             payment_method_id: T.nilable(String),
+            product_collection_id: T.nilable(String),
             return_url: T.nilable(String),
             short_link: T::Boolean,
             show_saved_payment_methods: T::Boolean,
@@ -408,6 +436,161 @@ module Dodopayments
         end
       end
 
+      class CustomField < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::CheckoutSessionRequest::CustomField,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Type of field determining validation rules
+        sig do
+          returns(
+            Dodopayments::CheckoutSessionRequest::CustomField::FieldType::OrSymbol
+          )
+        end
+        attr_accessor :field_type
+
+        # Unique identifier for this field (used as key in responses)
+        sig { returns(String) }
+        attr_accessor :key
+
+        # Display label shown to customer
+        sig { returns(String) }
+        attr_accessor :label
+
+        # Options for dropdown type (required for dropdown, ignored for others)
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :options
+
+        # Placeholder text for the input
+        sig { returns(T.nilable(String)) }
+        attr_accessor :placeholder
+
+        # Whether this field is required
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :required
+
+        sig { params(required: T::Boolean).void }
+        attr_writer :required
+
+        # Definition of a custom field for checkout
+        sig do
+          params(
+            field_type:
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::OrSymbol,
+            key: String,
+            label: String,
+            options: T.nilable(T::Array[String]),
+            placeholder: T.nilable(String),
+            required: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Type of field determining validation rules
+          field_type:,
+          # Unique identifier for this field (used as key in responses)
+          key:,
+          # Display label shown to customer
+          label:,
+          # Options for dropdown type (required for dropdown, ignored for others)
+          options: nil,
+          # Placeholder text for the input
+          placeholder: nil,
+          # Whether this field is required
+          required: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              field_type:
+                Dodopayments::CheckoutSessionRequest::CustomField::FieldType::OrSymbol,
+              key: String,
+              label: String,
+              options: T.nilable(T::Array[String]),
+              placeholder: T.nilable(String),
+              required: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Type of field determining validation rules
+        module FieldType
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::CheckoutSessionRequest::CustomField::FieldType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TEXT =
+            T.let(
+              :text,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          NUMBER =
+            T.let(
+              :number,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          EMAIL =
+            T.let(
+              :email,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          URL =
+            T.let(
+              :url,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          PHONE =
+            T.let(
+              :phone,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          DATE =
+            T.let(
+              :date,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          DATETIME =
+            T.let(
+              :datetime,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          DROPDOWN =
+            T.let(
+              :dropdown,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+          BOOLEAN =
+            T.let(
+              :boolean,
+              Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::CheckoutSessionRequest::CustomField::FieldType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Customization < Dodopayments::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/dodopayments/models/customer_list_params.rbi

@@ -14,6 +14,20 @@ module Dodopayments
           )
         end
 
+      # Filter customers created on or after this timestamp
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at_gte
+
+      sig { params(created_at_gte: Time).void }
+      attr_writer :created_at_gte
+
+      # Filter customers created on or before this timestamp
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at_lte
+
+      sig { params(created_at_lte: Time).void }
+      attr_writer :created_at_lte
+
       # Filter by customer email
       sig { returns(T.nilable(String)) }
       attr_reader :email
@@ -21,6 +35,13 @@ module Dodopayments
       sig { params(email: String).void }
       attr_writer :email
 
+      # Filter by customer name (partial match, case-insensitive)
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
       # Page number default is 0
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -37,15 +58,24 @@ module Dodopayments
 
       sig do
         params(
+          created_at_gte: Time,
+          created_at_lte: Time,
           email: String,
+          name: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # Filter customers created on or after this timestamp
+        created_at_gte: nil,
+        # Filter customers created on or before this timestamp
+        created_at_lte: nil,
         # Filter by customer email
         email: nil,
+        # Filter by customer name (partial match, case-insensitive)
+        name: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100
@@ -57,7 +87,10 @@ module Dodopayments
       sig do
         override.returns(
           {
+            created_at_gte: Time,
+            created_at_lte: Time,
             email: String,
+            name: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Dodopayments::RequestOptions

data/rbi/dodopayments/models/discount_list_params.rbi

@@ -14,6 +14,27 @@ module Dodopayments
           )
         end
 
+      # Filter by active status (true = not expired, false = expired)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :active
+
+      sig { params(active: T::Boolean).void }
+      attr_writer :active
+
+      # Filter by discount code (partial match, case-insensitive)
+      sig { returns(T.nilable(String)) }
+      attr_reader :code
+
+      sig { params(code: String).void }
+      attr_writer :code
+
+      # Filter by discount type (percentage)
+      sig { returns(T.nilable(Dodopayments::DiscountType::OrSymbol)) }
+      attr_reader :discount_type
+
+      sig { params(discount_type: Dodopayments::DiscountType::OrSymbol).void }
+      attr_writer :discount_type
+
       # Page number (default = 0).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -28,18 +49,37 @@ module Dodopayments
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
+      # Filter by product restriction (only discounts that apply to this product)
+      sig { returns(T.nilable(String)) }
+      attr_reader :product_id
+
+      sig { params(product_id: String).void }
+      attr_writer :product_id
+
       sig do
         params(
+          active: T::Boolean,
+          code: String,
+          discount_type: Dodopayments::DiscountType::OrSymbol,
           page_number: Integer,
           page_size: Integer,
+          product_id: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # Filter by active status (true = not expired, false = expired)
+        active: nil,
+        # Filter by discount code (partial match, case-insensitive)
+        code: nil,
+        # Filter by discount type (percentage)
+        discount_type: nil,
         # Page number (default = 0).
         page_number: nil,
         # Page size (default = 10, max = 100).
         page_size: nil,
+        # Filter by product restriction (only discounts that apply to this product)
+        product_id: nil,
         request_options: {}
       )
       end
@@ -47,8 +87,12 @@ module Dodopayments
       sig do
         override.returns(
           {
+            active: T::Boolean,
+            code: String,
+            discount_type: Dodopayments::DiscountType::OrSymbol,
             page_number: Integer,
             page_size: Integer,
+            product_id: String,
             request_options: Dodopayments::RequestOptions
           }
         )

data/rbi/dodopayments/models/discount_retrieve_by_code_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class DiscountRetrieveByCodeParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::DiscountRetrieveByCodeParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: Dodopayments::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/license_key_list_params.rbi

@@ -14,6 +14,20 @@ module Dodopayments
           )
         end
 
+      # Filter license keys created on or after this timestamp
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at_gte
+
+      sig { params(created_at_gte: Time).void }
+      attr_writer :created_at_gte
+
+      # Filter license keys created on or before this timestamp
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at_lte
+
+      sig { params(created_at_lte: Time).void }
+      attr_writer :created_at_lte
+
       # Filter by customer ID
       sig { returns(T.nilable(String)) }
       attr_reader :customer_id
@@ -57,6 +71,8 @@ module Dodopayments
 
       sig do
         params(
+          created_at_gte: Time,
+          created_at_lte: Time,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,
@@ -66,6 +82,10 @@ module Dodopayments
         ).returns(T.attached_class)
       end
       def self.new(
+        # Filter license keys created on or after this timestamp
+        created_at_gte: nil,
+        # Filter license keys created on or before this timestamp
+        created_at_lte: nil,
         # Filter by customer ID
         customer_id: nil,
         # Page number default is 0
@@ -83,6 +103,8 @@ module Dodopayments
       sig do
         override.returns(
           {
+            created_at_gte: Time,
+            created_at_lte: Time,
             customer_id: String,
             page_number: Integer,
             page_size: Integer,

data/rbi/dodopayments/models/payment.rbi

@@ -102,6 +102,12 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :checkout_session_id
 
+      # Customer's responses to custom fields collected during checkout
+      sig do
+        returns(T.nilable(T::Array[Dodopayments::Payment::CustomFieldResponse]))
+      end
+      attr_accessor :custom_field_responses
+
       # The discount id if discount is applied
       sig { returns(T.nilable(String)) }
       attr_accessor :discount_id
@@ -118,6 +124,10 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :invoice_id
 
+      # URL to download the invoice PDF for this payment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :invoice_url
+
       # Checkout URL
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_link
@@ -178,10 +188,15 @@ module Dodopayments
           card_network: T.nilable(String),
           card_type: T.nilable(String),
           checkout_session_id: T.nilable(String),
+          custom_field_responses:
+            T.nilable(
+              T::Array[Dodopayments::Payment::CustomFieldResponse::OrHash]
+            ),
           discount_id: T.nilable(String),
           error_code: T.nilable(String),
           error_message: T.nilable(String),
           invoice_id: T.nilable(String),
+          invoice_url: T.nilable(String),
           payment_link: T.nilable(String),
           payment_method: T.nilable(String),
           payment_method_type: T.nilable(String),
@@ -241,6 +256,8 @@ module Dodopayments
         # If payment is made using a checkout session, this field is set to the id of the
         # session.
         checkout_session_id: nil,
+        # Customer's responses to custom fields collected during checkout
+        custom_field_responses: nil,
         # The discount id if discount is applied
         discount_id: nil,
         # An error code if the payment failed
@@ -249,6 +266,8 @@ module Dodopayments
         error_message: nil,
         # Invoice ID for this payment. Uses India-specific invoice ID if available.
         invoice_id: nil,
+        # URL to download the invoice PDF for this payment.
+        invoice_url: nil,
         # Checkout URL
         payment_link: nil,
         # Payment method used by customer (e.g. "card", "bank_transfer")
@@ -296,10 +315,13 @@ module Dodopayments
             card_network: T.nilable(String),
             card_type: T.nilable(String),
             checkout_session_id: T.nilable(String),
+            custom_field_responses:
+              T.nilable(T::Array[Dodopayments::Payment::CustomFieldResponse]),
             discount_id: T.nilable(String),
             error_code: T.nilable(String),
             error_message: T.nilable(String),
             invoice_id: T.nilable(String),
+            invoice_url: T.nilable(String),
             payment_link: T.nilable(String),
             payment_method: T.nilable(String),
             payment_method_type: T.nilable(String),
@@ -415,6 +437,38 @@ module Dodopayments
         end
       end
 
+      class CustomFieldResponse < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Payment::CustomFieldResponse,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Key matching the custom field definition
+        sig { returns(String) }
+        attr_accessor :key
+
+        # Value provided by customer
+        sig { returns(String) }
+        attr_accessor :value
+
+        # Customer's response to a custom field
+        sig { params(key: String, value: String).returns(T.attached_class) }
+        def self.new(
+          # Key matching the custom field definition
+          key:,
+          # Value provided by customer
+          value:
+        )
+        end
+
+        sig { override.returns({ key: String, value: String }) }
+        def to_hash
+        end
+      end
+
       class ProductCart < Dodopayments::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/dodopayments/models/payment_list_response.rbi

@@ -40,6 +40,14 @@ module Dodopayments
       sig { returns(Integer) }
       attr_accessor :total_amount
 
+      # Invoice ID for this payment. Uses India-specific invoice ID if available.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :invoice_id
+
+      # URL to download the invoice PDF for this payment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :invoice_url
+
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_method
 
@@ -62,6 +70,8 @@ module Dodopayments
           metadata: T::Hash[Symbol, String],
           payment_id: String,
           total_amount: Integer,
+          invoice_id: T.nilable(String),
+          invoice_url: T.nilable(String),
           payment_method: T.nilable(String),
           payment_method_type: T.nilable(String),
           status: T.nilable(Dodopayments::IntentStatus::OrSymbol),
@@ -77,6 +87,10 @@ module Dodopayments
         metadata:,
         payment_id:,
         total_amount:,
+        # Invoice ID for this payment. Uses India-specific invoice ID if available.
+        invoice_id: nil,
+        # URL to download the invoice PDF for this payment.
+        invoice_url: nil,
         payment_method: nil,
         payment_method_type: nil,
         status: nil,
@@ -95,6 +109,8 @@ module Dodopayments
             metadata: T::Hash[Symbol, String],
             payment_id: String,
             total_amount: Integer,
+            invoice_id: T.nilable(String),
+            invoice_url: T.nilable(String),
             payment_method: T.nilable(String),
             payment_method_type: T.nilable(String),
             status: T.nilable(Dodopayments::IntentStatus::TaggedSymbol),