dodopayments 2.33.0 → 2.35.0

data/rbi/dodopayments/models/payment_retrieve_line_items_params.rbi

@@ -17,18 +17,37 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :payment_id
 
+      # The currency of the amounts. It must be the currency that the customer paid in.
+      # Without it, the amounts are in the settlement currency.
+      sig { returns(T.nilable(Dodopayments::Currency::OrSymbol)) }
+      attr_reader :currency
+
+      sig { params(currency: Dodopayments::Currency::OrSymbol).void }
+      attr_writer :currency
+
       sig do
         params(
           payment_id: String,
+          currency: Dodopayments::Currency::OrSymbol,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(payment_id:, request_options: {})
+      def self.new(
+        payment_id:,
+        # The currency of the amounts. It must be the currency that the customer paid in.
+        # Without it, the amounts are in the settlement currency.
+        currency: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { payment_id: String, request_options: Dodopayments::RequestOptions }
+          {
+            payment_id: String,
+            currency: Dodopayments::Currency::OrSymbol,
+            request_options: Dodopayments::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/dodopayments/models/payment_retrieve_line_items_response.rbi

@@ -21,16 +21,26 @@ module Dodopayments
       end
       attr_accessor :items
 
+      # False when the payment method does not allow a partial refund of this payment.
+      sig { returns(T::Boolean) }
+      attr_accessor :partial_refund_allowed
+
       sig do
         params(
           currency: Dodopayments::Currency::OrSymbol,
           items:
             T::Array[
               Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item::OrHash
-            ]
+            ],
+          partial_refund_allowed: T::Boolean
         ).returns(T.attached_class)
       end
-      def self.new(currency:, items:)
+      def self.new(
+        currency:,
+        items:,
+        # False when the payment method does not allow a partial refund of this payment.
+        partial_refund_allowed:
+      )
       end
 
       sig do
@@ -40,7 +50,8 @@ module Dodopayments
             items:
               T::Array[
                 Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item
-              ]
+              ],
+            partial_refund_allowed: T::Boolean
           }
         )
       end

data/rbi/dodopayments/models/payouts/breakup/detail_list_response.rbi

@@ -38,7 +38,9 @@ module Dodopayments
           # Amount in the payout's currency, in that currency's smallest unit (cents for
           # USD, yen for JPY, fils for KWD). The entry is converted at the rate the payout
           # settled at. These amounts sum to the value of the entries, which can be less
-          # than the payout: the grouped breakup reports the difference as `unattributed`.
+          # than the payout: the grouped breakup reports the difference as `unattributed`. A
+          # settlement batch payout shows the native amount of a row in the payout's
+          # currency, and 0 for a row in a different currency.
           sig { returns(Integer) }
           attr_accessor :payout_currency_amount
 
@@ -85,7 +87,9 @@ module Dodopayments
             # Amount in the payout's currency, in that currency's smallest unit (cents for
             # USD, yen for JPY, fils for KWD). The entry is converted at the rate the payout
             # settled at. These amounts sum to the value of the entries, which can be less
-            # than the payout: the grouped breakup reports the difference as `unattributed`.
+            # than the payout: the grouped breakup reports the difference as `unattributed`. A
+            # settlement batch payout shows the native amount of a row in the payout's
+            # currency, and 0 for a row in a different currency.
             payout_currency_amount:,
             # USD equivalent of the original amount (in cents).
             usd_equivalent_amount:,

data/rbi/dodopayments/models/payouts/breakup_retrieve_response.rbi

@@ -14,7 +14,8 @@ module Dodopayments
 
         # The type of balance ledger event (e.g., "payment", "refund", "dispute",
         # "payment_fees"), or `unattributed` for the payout amount the entries do not
-        # account for.
+        # account for. A settlement batch payout shows `carried_over` for its opening
+        # balance and the entries dated before that row.
         sig { returns(String) }
         attr_accessor :event_type
 
@@ -45,7 +46,8 @@ module Dodopayments
         def self.new(
           # The type of balance ledger event (e.g., "payment", "refund", "dispute",
           # "payment_fees"), or `unattributed` for the payout amount the entries do not
-          # account for.
+          # account for. A settlement batch payout shows `carried_over` for its opening
+          # balance and the entries dated before that row.
           event_type:,
           # Total amount for this event type in the payout's currency, in that currency's
           # smallest unit (cents for USD, yen for JPY, fils for KWD).

data/rbi/dodopayments/models/price.rbi

@@ -167,12 +167,14 @@ module Dodopayments
         sig { returns(Dodopayments::Currency::OrSymbol) }
         attr_accessor :currency
 
-        # Number of units for the payment frequency. For example, a value of `1` with a
-        # `payment_frequency_interval` of `month` represents monthly payments.
+        # Number of `payment_frequency_interval` units between two charges. This field
+        # sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+        # `month` charges the customer every month.
         sig { returns(Integer) }
         attr_accessor :payment_frequency_count
 
-        # The time interval for the payment frequency (e.g., day, month, year).
+        # The time unit of the billing cycle (e.g., day, month, year). Use it with
+        # `payment_frequency_count`.
         sig { returns(Dodopayments::TimeInterval::OrSymbol) }
         attr_accessor :payment_frequency_interval
 
@@ -181,12 +183,28 @@ module Dodopayments
         sig { returns(Integer) }
         attr_accessor :price
 
-        # 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.
+        # Number of `subscription_period_interval` units for the total duration of the
+        # subscription. This field does not set the billing cycle. Use
+        # `payment_frequency_count` for the billing cycle. When this period ends, the
+        # subscription expires. Dodo Payments does not start a new billing cycle after the
+        # subscription expires. Dodo Payments can still retry a failed payment for an
+        # earlier billing cycle.
+        #
+        # For a subscription that renews until the customer cancels it, set this to `20`
+        # with a `subscription_period_interval` of `year`. This is the recommended value
+        # and also the maximum. The subscription expires after 20 years if the customer
+        # does not cancel it before then.
+        #
+        # For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+        # `payment_frequency_interval` of `month`, and a subscription period of `20`
+        # `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+        # the subscription then expires after one month.
         sig { returns(Integer) }
         attr_accessor :subscription_period_count
 
-        # The time interval for the subscription period (e.g., day, month, year).
+        # The time unit of the total subscription duration (e.g., day, month, year). Use
+        # it with `subscription_period_count`. The recommended value is `year`, with a
+        # `subscription_period_count` of `20`.
         sig { returns(Dodopayments::TimeInterval::OrSymbol) }
         attr_accessor :subscription_period_interval
 
@@ -280,18 +298,36 @@ module Dodopayments
         def self.new(
           # The currency in which the payment is made.
           currency:,
-          # Number of units for the payment frequency. For example, a value of `1` with a
-          # `payment_frequency_interval` of `month` represents monthly payments.
+          # Number of `payment_frequency_interval` units between two charges. This field
+          # sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+          # `month` charges the customer every month.
           payment_frequency_count:,
-          # The time interval for the payment frequency (e.g., day, month, year).
+          # The time unit of the billing cycle (e.g., day, month, year). Use it with
+          # `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:,
-          # 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.
+          # Number of `subscription_period_interval` units for the total duration of the
+          # subscription. This field does not set the billing cycle. Use
+          # `payment_frequency_count` for the billing cycle. When this period ends, the
+          # subscription expires. Dodo Payments does not start a new billing cycle after the
+          # subscription expires. Dodo Payments can still retry a failed payment for an
+          # earlier billing cycle.
+          #
+          # For a subscription that renews until the customer cancels it, set this to `20`
+          # with a `subscription_period_interval` of `year`. This is the recommended value
+          # and also the maximum. The subscription expires after 20 years if the customer
+          # does not cancel it before then.
+          #
+          # For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+          # `payment_frequency_interval` of `month`, and a subscription period of `20`
+          # `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+          # the subscription then expires after one month.
           subscription_period_count:,
-          # The time interval for the subscription period (e.g., day, month, year).
+          # The time unit of the total subscription duration (e.g., day, month, year). Use
+          # it with `subscription_period_count`. The recommended value is `year`, with a
+          # `subscription_period_count` of `20`.
           subscription_period_interval:,
           # Deprecated: use `discount_bps` instead.
           #
@@ -372,21 +408,39 @@ module Dodopayments
         sig { returns(Integer) }
         attr_accessor :fixed_price
 
-        # Number of units for the payment frequency. For example, a value of `1` with a
-        # `payment_frequency_interval` of `month` represents monthly payments.
+        # Number of `payment_frequency_interval` units between two charges. This field
+        # sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+        # `month` charges the customer every month.
         sig { returns(Integer) }
         attr_accessor :payment_frequency_count
 
-        # The time interval for the payment frequency (e.g., day, month, year).
+        # The time unit of the billing cycle (e.g., day, month, year). Use it with
+        # `payment_frequency_count`.
         sig { returns(Dodopayments::TimeInterval::OrSymbol) }
         attr_accessor :payment_frequency_interval
 
-        # 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.
+        # Number of `subscription_period_interval` units for the total duration of the
+        # subscription. This field does not set the billing cycle. Use
+        # `payment_frequency_count` for the billing cycle. When this period ends, the
+        # subscription expires. Dodo Payments does not start a new billing cycle after the
+        # subscription expires. Dodo Payments can still retry a failed payment for an
+        # earlier billing cycle.
+        #
+        # For a subscription that renews until the customer cancels it, set this to `20`
+        # with a `subscription_period_interval` of `year`. This is the recommended value
+        # and also the maximum. The subscription expires after 20 years if the customer
+        # does not cancel it before then.
+        #
+        # For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+        # `payment_frequency_interval` of `month`, and a subscription period of `20`
+        # `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+        # the subscription then expires after one month.
         sig { returns(Integer) }
         attr_accessor :subscription_period_count
 
-        # The time interval for the subscription period (e.g., day, month, year).
+        # The time unit of the total subscription duration (e.g., day, month, year). Use
+        # it with `subscription_period_count`. The recommended value is `year`, with a
+        # `subscription_period_count` of `20`.
         sig { returns(Dodopayments::TimeInterval::OrSymbol) }
         attr_accessor :subscription_period_interval
 
@@ -451,15 +505,33 @@ module Dodopayments
           # The fixed payment amount. Represented in the lowest denomination of the currency
           # (e.g., cents for USD). For example, to charge $1.00, pass `100`.
           fixed_price:,
-          # Number of units for the payment frequency. For example, a value of `1` with a
-          # `payment_frequency_interval` of `month` represents monthly payments.
+          # Number of `payment_frequency_interval` units between two charges. This field
+          # sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+          # `month` charges the customer every month.
           payment_frequency_count:,
-          # The time interval for the payment frequency (e.g., day, month, year).
+          # The time unit of the billing cycle (e.g., day, month, year). Use it with
+          # `payment_frequency_count`.
           payment_frequency_interval:,
-          # 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.
+          # Number of `subscription_period_interval` units for the total duration of the
+          # subscription. This field does not set the billing cycle. Use
+          # `payment_frequency_count` for the billing cycle. When this period ends, the
+          # subscription expires. Dodo Payments does not start a new billing cycle after the
+          # subscription expires. Dodo Payments can still retry a failed payment for an
+          # earlier billing cycle.
+          #
+          # For a subscription that renews until the customer cancels it, set this to `20`
+          # with a `subscription_period_interval` of `year`. This is the recommended value
+          # and also the maximum. The subscription expires after 20 years if the customer
+          # does not cancel it before then.
+          #
+          # For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+          # `payment_frequency_interval` of `month`, and a subscription period of `20`
+          # `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+          # the subscription then expires after one month.
           subscription_period_count:,
-          # The time interval for the subscription period (e.g., day, month, year).
+          # The time unit of the total subscription duration (e.g., day, month, year). Use
+          # it with `subscription_period_count`. The recommended value is `year`, with a
+          # `subscription_period_count` of `20`.
           subscription_period_interval:,
           # Deprecated: use `discount_bps` instead.
           #

data/rbi/dodopayments/models/product_collection_list_params.rbi

@@ -28,6 +28,18 @@ module Dodopayments
       sig { params(brand_id: String).void }
       attr_writer :brand_id
 
+      # Shows the translated name, description and unit of the catalog entities in this
+      # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      # with no translation, an unknown code, or no code shows the base text.
+      #
+      # Do not send a text from a localized response back in a create or update request.
+      # The base text then changes to the translated text.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
       # Page number default is 0
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -46,6 +58,7 @@ module Dodopayments
         params(
           archived: T::Boolean,
           brand_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -56,6 +69,13 @@ module Dodopayments
         archived: nil,
         # Filter by Brand id
         brand_id: nil,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100
@@ -69,6 +89,7 @@ module Dodopayments
           {
             archived: T::Boolean,
             brand_id: String,
+            locale: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Dodopayments::RequestOptions

data/rbi/dodopayments/models/product_collection_retrieve_params.rbi

@@ -17,18 +17,45 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :id
 
+      # Shows the translated name, description and unit of the catalog entities in this
+      # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      # with no translation, an unknown code, or no code shows the base text.
+      #
+      # Do not send a text from a localized response back in a create or update request.
+      # The base text then changes to the translated text.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        id:,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { id: String, request_options: Dodopayments::RequestOptions }
+          {
+            id: String,
+            locale: String,
+            request_options: Dodopayments::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/dodopayments/models/product_collections/group_update_params.rbi

@@ -22,7 +22,8 @@ module Dodopayments
         attr_accessor :group_id
 
         # Optional group name update: Some(Some(name)) = set name, Some(None) = clear
-        # name, None = no change
+        # name, None = no change The API returns 422 if another group in the collection
+        # has no name.
         sig { returns(T.nilable(String)) }
         attr_accessor :group_name
 
@@ -49,7 +50,8 @@ module Dodopayments
           id:,
           group_id:,
           # Optional group name update: Some(Some(name)) = set name, Some(None) = clear
-          # name, None = no change
+          # name, None = no change The API returns 422 if another group in the collection
+          # has no name.
           group_name: nil,
           # Optional new order for products in this group (array of
           # product_collection_group_pdts UUIDs)

data/rbi/dodopayments/models/product_collections/translation_delete_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::ProductCollections::TranslationDeleteParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # A locale that the checkout and the customer portal can show.
+        #
+        # The codes are a copy of the checkout locales. `GET /locales` lists them.
+        sig { returns(Dodopayments::Locale::OrSymbol) }
+        attr_accessor :locale
+
+        sig do
+          params(
+            id: String,
+            locale: Dodopayments::Locale::OrSymbol,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: Dodopayments::Locale::OrSymbol,
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collections/translation_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::ProductCollections::TranslationListParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        # the response has all the locales.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :locale
+
+        sig { params(locale: T::Array[String]).void }
+        attr_writer :locale
+
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+          # the response has all the locales.
+          locale: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: T::Array[String],
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collections/translation_update_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::ProductCollections::TranslationUpdateParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # A locale that the checkout and the customer portal can show.
+        #
+        # The codes are a copy of the checkout locales. `GET /locales` lists them.
+        sig { returns(Dodopayments::Locale::OrSymbol) }
+        attr_accessor :locale
+
+        # The translated description.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The translated name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: String,
+            locale: Dodopayments::Locale::OrSymbol,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale:,
+          # The translated description.
+          description: nil,
+          # The translated name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: Dodopayments::Locale::OrSymbol,
+              description: T.nilable(String),
+              name: T.nilable(String),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_list_params.rbi

@@ -28,6 +28,18 @@ module Dodopayments
       sig { params(brand_id: String).void }
       attr_writer :brand_id
 
+      # Shows the translated name, description and unit of the catalog entities in this
+      # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      # with no translation, an unknown code, or no code shows the base text.
+      #
+      # Do not send a text from a localized response back in a create or update request.
+      # The base text then changes to the translated text.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
       # Page number default is 0
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -57,6 +69,7 @@ module Dodopayments
         params(
           archived: T::Boolean,
           brand_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           recurring: T::Boolean,
@@ -68,6 +81,13 @@ module Dodopayments
         archived: nil,
         # filter by Brand id
         brand_id: nil,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100
@@ -87,6 +107,7 @@ module Dodopayments
           {
             archived: T::Boolean,
             brand_id: String,
+            locale: String,
             page_number: Integer,
             page_size: Integer,
             recurring: T::Boolean,