dodopayments 1.18.0 → 1.18.3

data/rbi/lib/dodopayments/models/customer_limited_details.rbi

@@ -16,8 +16,14 @@ module Dodopayments
       attr_accessor :name
 
       sig { params(customer_id: String, email: String, name: String).returns(T.attached_class) }
-      def self.new(customer_id:, email:, name:); end
-
+      def self.new(
+        # Unique identifier for the customer
+        customer_id:,
+        # Email address of the customer
+        email:,
+        # Full name of the customer
+        name:
+      ); end
       sig { override.returns({customer_id: String, email: String, name: String}) }
       def to_hash; end
     end

data/rbi/lib/dodopayments/models/customer_list_params.rbi

@@ -22,8 +22,13 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(page_number: nil, page_size: nil, request_options: {}); end
-
+      def self.new(
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/customers/customer_portal_create_params.rbi

@@ -18,8 +18,11 @@ module Dodopayments
           )
             .returns(T.attached_class)
         end
-        def self.new(send_email: nil, request_options: {}); end
-
+        def self.new(
+          # If true, will send link to user.
+          send_email: nil,
+          request_options: {}
+        ); end
         sig do
           override.returns({send_email: T.nilable(T::Boolean), request_options: Dodopayments::RequestOptions})
         end

data/rbi/lib/dodopayments/models/discount.rbi

@@ -67,16 +67,30 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # The discount amount.
+        #
+        # - If `discount_type` is `percentage`, this is in **basis points** (e.g., 540 =>
+        #   5.4%).
+        # - Otherwise, this is **USD cents** (e.g., 100 => `$1.00`).
         amount:,
+        # The business this discount belongs to.
         business_id:,
+        # The discount code (up to 16 chars).
         code:,
+        # Timestamp when the discount is created
         created_at:,
+        # The unique discount ID
         discount_id:,
+        # List of product IDs to which this discount is restricted.
         restricted_to:,
+        # How many times this discount has been used.
         times_used:,
         type:,
+        # Optional date/time after which discount is expired.
         expires_at: nil,
+        # Name for the Discount
         name: nil,
+        # Usage limit for this discount, if any.
         usage_limit: nil
       ); end
       sig do

data/rbi/lib/dodopayments/models/discount_create_params.rbi

@@ -56,12 +56,27 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # The discount amount.
+        #
+        # - If `discount_type` is **not** `percentage`, `amount` is in **USD cents**. For
+        #   example, `100` means `$1.00`. Only USD is allowed.
+        # - If `discount_type` **is** `percentage`, `amount` is in **basis points**. For
+        #   example, `540` means `5.4%`.
+        #
+        # Must be at least 1.
         amount:,
         type:,
+        # Optionally supply a code (will be uppercased).
+        #
+        # - Must be at least 3 characters if provided.
+        # - If omitted, a random 16-character code is generated.
         code: nil,
+        # When the discount expires, if ever.
         expires_at: nil,
         name: nil,
+        # List of product IDs to restrict usage (if any).
         restricted_to: nil,
+        # How many times this discount can be used (if any). Must be >= 1 if provided.
         usage_limit: nil,
         request_options: {}
       ); end

data/rbi/lib/dodopayments/models/discount_list_params.rbi

@@ -22,8 +22,13 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(page_number: nil, page_size: nil, request_options: {}); end
-
+      def self.new(
+        # Page number (default = 0).
+        page_number: nil,
+        # Page size (default = 10, max = 100).
+        page_size: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/discount_update_params.rbi

@@ -51,10 +51,20 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # If present, update the discount amount:
+        #
+        # - If `discount_type` is `percentage`, this represents **basis points** (e.g.,
+        #   `540` = `5.4%`).
+        # - Otherwise, this represents **USD cents** (e.g., `100` = `$1.00`).
+        #
+        # Must be at least 1 if provided.
         amount: nil,
+        # If present, update the discount code (uppercase).
         code: nil,
         expires_at: nil,
         name: nil,
+        # If present, replaces all restricted product IDs with this new set. To remove all
+        # restrictions, send empty array
         restricted_to: nil,
         type: nil,
         usage_limit: nil,

data/rbi/lib/dodopayments/models/dispute.rbi

@@ -48,17 +48,22 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # The amount involved in the dispute, represented as a string to accommodate
+        # precision.
         amount:,
+        # The unique identifier of the business involved in the dispute.
         business_id:,
+        # The timestamp of when the dispute was created, in UTC.
         created_at:,
+        # The currency of the disputed amount, represented as an ISO 4217 currency code.
         currency:,
+        # The unique identifier of the dispute.
         dispute_id:,
         dispute_stage:,
         dispute_status:,
+        # The unique identifier of the payment associated with the dispute.
         payment_id:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/dispute_list_params.rbi

@@ -48,12 +48,19 @@ 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,
+        # Filter by dispute stage
         dispute_stage: nil,
+        # Filter by dispute status
         dispute_status: 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/models/license_key.rbi

@@ -69,17 +69,29 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # The unique identifier of the license key.
         id:,
+        # The unique identifier of the business associated with the license key.
         business_id:,
+        # The timestamp indicating when the license key was created, in UTC.
         created_at:,
+        # The unique identifier of the customer associated with the license key.
         customer_id:,
+        # The current number of instances activated for this license key.
         instances_count:,
+        # The license key string.
         key:,
+        # The unique identifier of the payment associated with the license key.
         payment_id:,
+        # The unique identifier of the product associated with the license key.
         product_id:,
         status:,
+        # The maximum number of activations allowed for this license key.
         activations_limit: nil,
+        # The timestamp indicating when the license key expires, in UTC.
         expires_at: nil,
+        # The unique identifier of the subscription associated with the license key, if
+        # any.
         subscription_id: nil
       ); end
       sig do

data/rbi/lib/dodopayments/models/license_key_instance_list_params.rbi

@@ -27,8 +27,15 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(license_key_id: nil, page_number: nil, page_size: nil, request_options: {}); end
-
+      def self.new(
+        # Filter by license key ID
+        license_key_id: nil,
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/license_key_list_params.rbi

@@ -38,15 +38,18 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # 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 product ID
         product_id: nil,
+        # Filter by license key status
         status: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/license_key_update_params.rbi

@@ -30,8 +30,18 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(activations_limit: nil, disabled: nil, expires_at: nil, request_options: {}); end
-
+      def self.new(
+        # The updated activation limit for the license key. Use `null` to remove the
+        # limit, or omit this field to leave it unchanged.
+        activations_limit: nil,
+        # Indicates whether the license key should be disabled. A value of `true` disables
+        # the key, while `false` enables it. Omit this field to leave it unchanged.
+        disabled: nil,
+        # The updated expiration timestamp for the license key in UTC. Use `null` to
+        # remove the expiration date, or omit this field to leave it unchanged.
+        expires_at: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/one_time_product_cart_item.rbi

@@ -18,8 +18,14 @@ module Dodopayments
       sig do
         params(product_id: String, quantity: Integer, amount: T.nilable(Integer)).returns(T.attached_class)
       end
-      def self.new(product_id:, quantity:, amount: nil); 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 { override.returns({product_id: String, quantity: Integer, amount: T.nilable(Integer)}) }
       def to_hash; end
     end

data/rbi/lib/dodopayments/models/payment.rbi

@@ -75,6 +75,12 @@ module Dodopayments
       sig { returns(T.nilable(T::Array[Dodopayments::Models::Payment::ProductCart])) }
       attr_accessor :product_cart
 
+      # This represents the portion of settlement_amount that corresponds to taxes
+      # collected. Especially relevant for adaptive pricing where the tax component must
+      # be tracked separately in your Dodo balance.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :settlement_tax
+
       sig { returns(T.nilable(Dodopayments::Models::IntentStatus::TaggedSymbol)) }
       attr_accessor :status
 
@@ -109,6 +115,7 @@ module Dodopayments
           payment_method: T.nilable(String),
           payment_method_type: T.nilable(String),
           product_cart: T.nilable(T::Array[T.any(Dodopayments::Models::Payment::ProductCart, Dodopayments::Internal::AnyHash)]),
+          settlement_tax: T.nilable(Integer),
           status: T.nilable(Dodopayments::Models::IntentStatus::OrSymbol),
           subscription_id: T.nilable(String),
           tax: T.nilable(Integer),
@@ -117,26 +124,49 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Identifier of the business associated with the payment
         business_id:,
+        # Timestamp when the payment was created
         created_at:,
         currency:,
         customer:,
+        # List of disputes associated with this payment
         disputes:,
         metadata:,
+        # Unique identifier for the payment
         payment_id:,
+        # List of refunds issued for this payment
         refunds:,
+        # The amount that will be credited to your Dodo balance after currency conversion
+        # and processing. Especially relevant for adaptive pricing where the customer's
+        # payment currency differs from your settlement currency.
         settlement_amount:,
         settlement_currency:,
+        # Total amount charged to the customer including tax, in smallest currency unit
+        # (e.g. cents)
         total_amount:,
+        # The discount id if discount is applied
         discount_id: nil,
+        # An error message if the payment failed
         error_message: nil,
+        # Checkout URL
         payment_link: nil,
+        # Payment method used by customer (e.g. "card", "bank_transfer")
         payment_method: nil,
+        # Specific type of payment method (e.g. "visa", "mastercard")
         payment_method_type: nil,
+        # List of products purchased in a one-time payment
         product_cart: nil,
+        # This represents the portion of settlement_amount that corresponds to taxes
+        # collected. Especially relevant for adaptive pricing where the tax component must
+        # be tracked separately in your Dodo balance.
+        settlement_tax: nil,
         status: nil,
+        # Identifier of the subscription if payment is part of a subscription
         subscription_id: nil,
+        # Amount of tax collected in smallest currency unit (e.g. cents)
         tax: nil,
+        # Timestamp when the payment was last updated
         updated_at: nil
       ); end
       sig do
@@ -160,6 +190,7 @@ module Dodopayments
               payment_method: T.nilable(String),
               payment_method_type: T.nilable(String),
               product_cart: T.nilable(T::Array[Dodopayments::Models::Payment::ProductCart]),
+              settlement_tax: T.nilable(Integer),
               status: T.nilable(Dodopayments::Models::IntentStatus::TaggedSymbol),
               subscription_id: T.nilable(String),
               tax: T.nilable(Integer),

data/rbi/lib/dodopayments/models/payment_create_params.rbi

@@ -90,14 +90,28 @@ module Dodopayments
       def self.new(
         billing:,
         customer:,
+        # List of products in the cart. Must contain at least 1 and at most 100 items.
         product_cart:,
+        # 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 transaction
         discount_code: nil,
         metadata: nil,
+        # Whether to generate a payment link. Defaults to false if not specified.
         payment_link: nil,
+        # Optional URL to redirect the customer after payment. Must be a valid URL if
+        # provided.
         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,
         request_options: {}
       ); end

data/rbi/lib/dodopayments/models/payment_create_response.rbi

@@ -53,13 +53,20 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # Client secret used to load Dodo checkout SDK NOTE : Dodo checkout SDK will be
+        # coming soon
         client_secret:,
         customer:,
         metadata:,
+        # Unique identifier for the payment
         payment_id:,
+        # Total amount of the payment in smallest currency unit (e.g. cents)
         total_amount:,
+        # The discount id if discount is applied
         discount_id: nil,
+        # Optional URL to a hosted payment page
         payment_link: nil,
+        # Optional list of products included in the payment
         product_cart: nil
       ); end
       sig do

data/rbi/lib/dodopayments/models/payment_list_params.rbi

@@ -48,12 +48,19 @@ 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,
+        # Filter by subscription id
         subscription_id: nil,
         request_options: {}
       ); end

data/rbi/lib/dodopayments/models/payout_list_params.rbi

@@ -22,8 +22,13 @@ module Dodopayments
         )
           .returns(T.attached_class)
       end
-      def self.new(page_number: nil, page_size: nil, request_options: {}); end
-
+      def self.new(
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/dodopayments/models/payout_list_response.rbi

@@ -82,20 +82,33 @@ module Dodopayments
           .returns(T.attached_class)
       end
       def self.new(
+        # The total amount of the payout.
         amount:,
+        # The unique identifier of the business associated with the payout.
         business_id:,
+        # The total value of chargebacks associated with the payout.
         chargebacks:,
+        # The timestamp when the payout was created, in UTC.
         created_at:,
         currency:,
+        # The fee charged for processing the payout.
         fee:,
+        # The payment method used for the payout (e.g., bank transfer, card, etc.).
         payment_method:,
+        # The unique identifier of the payout.
         payout_id:,
+        # The total value of refunds associated with the payout.
         refunds:,
         status:,
+        # The tax applied to the payout.
         tax:,
+        # The timestamp when the payout was last updated, in UTC.
         updated_at:,
+        # The name of the payout recipient or purpose.
         name: nil,
+        # The URL of the document associated with the payout.
         payout_document_url: nil,
+        # Any additional remarks or notes associated with the payout.
         remarks: nil
       ); end
       sig do

data/rbi/lib/dodopayments/models/price.rbi

@@ -62,11 +62,25 @@ module Dodopayments
         end
         def self.new(
           currency:,
+          # Discount applied to the price, represented as a percentage (0 to 100).
           discount:,
+          # The payment amount, in the smallest denomination of the currency (e.g., cents
+          # for USD). For example, to charge $1.00, pass `100`.
+          #
+          # If [`pay_what_you_want`](Self::pay_what_you_want) is set to `true`, this field
+          # represents the **minimum** amount the customer must pay.
           price:,
+          # Indicates if purchasing power parity adjustments are applied to the price.
+          # Purchasing power parity feature is not available as of now.
           purchasing_power_parity:,
+          # Indicates whether the customer can pay any amount they choose. If set to `true`,
+          # the [`price`](Self::price) field is the minimum amount.
           pay_what_you_want: nil,
+          # A suggested price for the user to pay. This value is only considered if
+          # [`pay_what_you_want`](Self::pay_what_you_want) is `true`. Otherwise, it is
+          # ignored.
           suggested_price: nil,
+          # Indicates if the price is tax inclusive.
           tax_inclusive: nil,
           type: :one_time_price
         ); end
@@ -310,14 +324,25 @@ module Dodopayments
         end
         def self.new(
           currency:,
+          # Discount applied to the price, represented as a percentage (0 to 100).
           discount:,
+          # Number of units for the payment frequency. For example, a value of `1` with a
+          # `payment_frequency_interval` of `month` represents monthly payments.
           payment_frequency_count:,
           payment_frequency_interval:,
+          # The payment amount. Represented in the lowest denomination of the currency
+          # (e.g., cents for USD). For example, to charge $1.00, pass `100`.
           price:,
+          # Indicates if purchasing power parity adjustments are applied to the price.
+          # Purchasing power parity feature is not available as of now
           purchasing_power_parity:,
+          # Number of units for the subscription period. For example, a value of `12` with a
+          # `subscription_period_interval` of `month` represents a one-year subscription.
           subscription_period_count:,
           subscription_period_interval:,
+          # Indicates if the price is tax inclusive
           tax_inclusive: nil,
+          # Number of days for the trial period. A value of `0` indicates no trial period.
           trial_period_days: nil,
           type: :recurring_price
         ); end

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(