dodopayments 2.11.1 → 2.12.0

data/lib/dodopayments/models/product_collection_update_params.rb

@@ -24,6 +24,24 @@ module Dodopayments
       #   @return [String, nil]
       optional :description, String, nil?: true
 
+      # @!attribute effective_at_on_downgrade
+      #   Effective_at setting for downgrades: Some(Some(val)) = set, Some(None) = clear
+      #   (inherit), None = no change
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::EffectiveAtOnDowngrade, nil]
+      optional :effective_at_on_downgrade,
+               enum: -> { Dodopayments::ProductCollectionUpdateParams::EffectiveAtOnDowngrade },
+               nil?: true
+
+      # @!attribute effective_at_on_upgrade
+      #   Effective_at setting for upgrades: Some(Some(val)) = set, Some(None) = clear
+      #   (inherit), None = no change
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::EffectiveAtOnUpgrade, nil]
+      optional :effective_at_on_upgrade,
+               enum: -> { Dodopayments::ProductCollectionUpdateParams::EffectiveAtOnUpgrade },
+               nil?: true
+
       # @!attribute group_order
       #   Optional new order for groups (array of group UUIDs in desired order)
       #
@@ -42,20 +60,124 @@ module Dodopayments
       #   @return [String, nil]
       optional :name, String, nil?: true
 
-      # @!method initialize(id:, brand_id: nil, description: nil, group_order: nil, image_id: nil, name: nil, request_options: {})
+      # @!attribute on_payment_failure
+      #   On payment failure behavior: Some(Some(val)) = set, Some(None) = clear
+      #   (inherit), None = no change
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::OnPaymentFailure, nil]
+      optional :on_payment_failure,
+               enum: -> { Dodopayments::ProductCollectionUpdateParams::OnPaymentFailure },
+               nil?: true
+
+      # @!attribute proration_billing_mode_on_downgrade
+      #   Proration billing mode for downgrades: Some(Some(val)) = set, Some(None) = clear
+      #   (inherit), None = no change
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::ProrationBillingModeOnDowngrade, nil]
+      optional :proration_billing_mode_on_downgrade,
+               enum: -> { Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnDowngrade },
+               nil?: true
+
+      # @!attribute proration_billing_mode_on_upgrade
+      #   Proration billing mode for upgrades: Some(Some(val)) = set, Some(None) = clear
+      #   (inherit), None = no change
+      #
+      #   @return [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::ProrationBillingModeOnUpgrade, nil]
+      optional :proration_billing_mode_on_upgrade,
+               enum: -> { Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnUpgrade },
+               nil?: true
+
+      # @!method initialize(id:, brand_id: nil, description: nil, effective_at_on_downgrade: nil, effective_at_on_upgrade: nil, group_order: nil, image_id: nil, name: nil, on_payment_failure: nil, proration_billing_mode_on_downgrade: nil, proration_billing_mode_on_upgrade: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductCollectionUpdateParams} for more details.
+      #
       #   @param id [String]
       #
       #   @param brand_id [String, nil] Optional brand_id update
       #
       #   @param description [String, nil] Optional description update - pass null to remove, omit to keep unchanged
       #
+      #   @param effective_at_on_downgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::EffectiveAtOnDowngrade, nil] Effective_at setting for downgrades: Some(Some(val)) = set, Some(None) = clear (
+      #
+      #   @param effective_at_on_upgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::EffectiveAtOnUpgrade, nil] Effective_at setting for upgrades: Some(Some(val)) = set, Some(None) = clear (in
+      #
       #   @param group_order [Array<String>, nil] Optional new order for groups (array of group UUIDs in desired order)
       #
       #   @param image_id [String, nil] Optional image update - pass null to remove, omit to keep unchanged
       #
       #   @param name [String, nil] Optional new name for the collection
       #
+      #   @param on_payment_failure [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::OnPaymentFailure, nil] On payment failure behavior: Some(Some(val)) = set, Some(None) = clear (inherit)
+      #
+      #   @param proration_billing_mode_on_downgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::ProrationBillingModeOnDowngrade, nil] Proration billing mode for downgrades: Some(Some(val)) = set, Some(None) = clear
+      #
+      #   @param proration_billing_mode_on_upgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::ProrationBillingModeOnUpgrade, nil] Proration billing mode for upgrades: Some(Some(val)) = set, Some(None) = clear (
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      # Effective_at setting for downgrades: Some(Some(val)) = set, Some(None) = clear
+      # (inherit), None = no change
+      module EffectiveAtOnDowngrade
+        extend Dodopayments::Internal::Type::Enum
+
+        IMMEDIATELY = :immediately
+        NEXT_BILLING_DATE = :next_billing_date
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Effective_at setting for upgrades: Some(Some(val)) = set, Some(None) = clear
+      # (inherit), None = no change
+      module EffectiveAtOnUpgrade
+        extend Dodopayments::Internal::Type::Enum
+
+        IMMEDIATELY = :immediately
+        NEXT_BILLING_DATE = :next_billing_date
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # On payment failure behavior: Some(Some(val)) = set, Some(None) = clear
+      # (inherit), None = no change
+      module OnPaymentFailure
+        extend Dodopayments::Internal::Type::Enum
+
+        PREVENT_CHANGE = :prevent_change
+        APPLY_CHANGE = :apply_change
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Proration billing mode for downgrades: Some(Some(val)) = set, Some(None) = clear
+      # (inherit), None = no change
+      module ProrationBillingModeOnDowngrade
+        extend Dodopayments::Internal::Type::Enum
+
+        PRORATED_IMMEDIATELY = :prorated_immediately
+        FULL_IMMEDIATELY = :full_immediately
+        DIFFERENCE_IMMEDIATELY = :difference_immediately
+        DO_NOT_BILL = :do_not_bill
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Proration billing mode for upgrades: Some(Some(val)) = set, Some(None) = clear
+      # (inherit), None = no change
+      module ProrationBillingModeOnUpgrade
+        extend Dodopayments::Internal::Type::Enum
+
+        PRORATED_IMMEDIATELY = :prorated_immediately
+        FULL_IMMEDIATELY = :full_immediately
+        DIFFERENCE_IMMEDIATELY = :difference_immediately
+        DO_NOT_BILL = :do_not_bill
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/dodopayments/resources/discounts.rb

@@ -11,9 +11,9 @@ module Dodopayments
       #
       # @overload create(amount:, type:, code: nil, expires_at: nil, metadata: nil, name: nil, preserve_on_plan_change: nil, restricted_to: nil, subscription_cycles: nil, usage_limit: nil, request_options: {})
       #
-      # @param amount [Integer] The discount amount.
+      # @param amount [Integer] The discount amount in **basis points** (e.g. `540` means `5.4%`, `10000` means
       #
-      # @param type [Symbol, Dodopayments::Models::DiscountType] The discount type (e.g. `percentage`, `flat`, or `flat_per_unit`).
+      # @param type [Symbol, Dodopayments::Models::DiscountType] The discount type. Currently only `percentage` is supported.
       #
       # @param code [String, nil] Optionally supply a code (will be uppercased).
       #
@@ -76,7 +76,7 @@ module Dodopayments
       #
       # @param discount_id [String] Discount Id
       #
-      # @param amount [Integer, nil] If present, update the discount amount:
+      # @param amount [Integer, nil] If present, update the discount amount in **basis points** (e.g., `540` = `5.4%`
       #
       # @param code [String, nil] If present, update the discount code (uppercase).
       #
@@ -92,7 +92,7 @@ module Dodopayments
       #
       # @param subscription_cycles [Integer, nil] Number of subscription billing cycles this discount is valid for.
       #
-      # @param type [Symbol, Dodopayments::Models::DiscountType, nil] If present, update the discount type.
+      # @param type [Symbol, Dodopayments::Models::DiscountType, nil] If present, update the discount type. Currently only `percentage` is supported.
       #
       # @param usage_limit [Integer, nil]
       #
@@ -120,7 +120,7 @@ module Dodopayments
       #
       # @param code [String] Filter by discount code (partial match, case-insensitive)
       #
-      # @param discount_type [Symbol, Dodopayments::Models::DiscountType] Filter by discount type (percentage)
+      # @param discount_type [Symbol, Dodopayments::Models::DiscountType] Filter by discount type
       #
       # @param page_number [Integer] Page number (default = 0).
       #

data/lib/dodopayments/resources/product_collections.rb

@@ -6,7 +6,10 @@ module Dodopayments
       # @return [Dodopayments::Resources::ProductCollections::Groups]
       attr_reader :groups
 
-      # @overload create(groups:, name:, brand_id: nil, description: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::ProductCollectionCreateParams} for more details.
+      #
+      # @overload create(groups:, name:, brand_id: nil, description: nil, effective_at_on_downgrade: nil, effective_at_on_upgrade: nil, on_payment_failure: nil, proration_billing_mode_on_downgrade: nil, proration_billing_mode_on_upgrade: nil, request_options: {})
       #
       # @param groups [Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails>] Groups of products in this collection
       #
@@ -16,6 +19,16 @@ module Dodopayments
       #
       # @param description [String, nil] Optional description of the product collection
       #
+      # @param effective_at_on_downgrade [Symbol, Dodopayments::Models::ProductCollectionCreateParams::EffectiveAtOnDowngrade, nil] Default effective_at setting for subscription plan downgrades (NULL = inherit fr
+      #
+      # @param effective_at_on_upgrade [Symbol, Dodopayments::Models::ProductCollectionCreateParams::EffectiveAtOnUpgrade, nil] Default effective_at setting for subscription plan upgrades (NULL = inherit from
+      #
+      # @param on_payment_failure [Symbol, Dodopayments::Models::ProductCollectionCreateParams::OnPaymentFailure, nil] Default behavior for subscription plan changes on payment failure (NULL = inheri
+      #
+      # @param proration_billing_mode_on_downgrade [Symbol, Dodopayments::Models::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade, nil] Default proration billing mode for subscription plan downgrades (NULL = inherit
+      #
+      # @param proration_billing_mode_on_upgrade [Symbol, Dodopayments::Models::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade, nil] Default proration billing mode for subscription plan upgrades (NULL = inherit fr
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::ProductCollection]
@@ -50,7 +63,10 @@ module Dodopayments
         )
       end
 
-      # @overload update(id, brand_id: nil, description: nil, group_order: nil, image_id: nil, name: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::ProductCollectionUpdateParams} for more details.
+      #
+      # @overload update(id, brand_id: nil, description: nil, effective_at_on_downgrade: nil, effective_at_on_upgrade: nil, group_order: nil, image_id: nil, name: nil, on_payment_failure: nil, proration_billing_mode_on_downgrade: nil, proration_billing_mode_on_upgrade: nil, request_options: {})
       #
       # @param id [String] Product Collection Id
       #
@@ -58,12 +74,22 @@ module Dodopayments
       #
       # @param description [String, nil] Optional description update - pass null to remove, omit to keep unchanged
       #
+      # @param effective_at_on_downgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::EffectiveAtOnDowngrade, nil] Effective_at setting for downgrades: Some(Some(val)) = set, Some(None) = clear (
+      #
+      # @param effective_at_on_upgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::EffectiveAtOnUpgrade, nil] Effective_at setting for upgrades: Some(Some(val)) = set, Some(None) = clear (in
+      #
       # @param group_order [Array<String>, nil] Optional new order for groups (array of group UUIDs in desired order)
       #
       # @param image_id [String, nil] Optional image update - pass null to remove, omit to keep unchanged
       #
       # @param name [String, nil] Optional new name for the collection
       #
+      # @param on_payment_failure [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::OnPaymentFailure, nil] On payment failure behavior: Some(Some(val)) = set, Some(None) = clear (inherit)
+      #
+      # @param proration_billing_mode_on_downgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::ProrationBillingModeOnDowngrade, nil] Proration billing mode for downgrades: Some(Some(val)) = set, Some(None) = clear
+      #
+      # @param proration_billing_mode_on_upgrade [Symbol, Dodopayments::Models::ProductCollectionUpdateParams::ProrationBillingModeOnUpgrade, nil] Proration billing mode for upgrades: Some(Some(val)) = set, Some(None) = clear (
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "2.11.1"
+  VERSION = "2.12.0"
 end

data/rbi/dodopayments/models/balance_ledger_entry.rbi

@@ -207,6 +207,11 @@ module Dodopayments
             :dunning_fees,
             Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
           )
+        PAYMENT_RETRY_FEE =
+          T.let(
+            :payment_retry_fee,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/balance_retrieve_ledger_params.rbi

@@ -1005,6 +1005,11 @@ module Dodopayments
             :dunning_fees,
             Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
           )
+        PAYMENT_RETRY_FEE =
+          T.let(
+            :payment_retry_fee,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/discount.rbi

@@ -8,11 +8,7 @@ module Dodopayments
           T.any(Dodopayments::Discount, Dodopayments::Internal::AnyHash)
         end
 
-      # 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`).
+      # The discount amount in **basis points** (e.g., 540 => 5.4%).
       sig { returns(Integer) }
       attr_accessor :amount
 
@@ -48,7 +44,7 @@ module Dodopayments
       sig { returns(Integer) }
       attr_accessor :times_used
 
-      # The type of discount, e.g. `percentage`, `flat`, or `flat_per_unit`.
+      # The type of discount. Currently only `percentage` is supported.
       sig { returns(Dodopayments::DiscountType::TaggedSymbol) }
       attr_accessor :type
 
@@ -89,11 +85,7 @@ 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`).
+        # The discount amount in **basis points** (e.g., 540 => 5.4%).
         amount:,
         # The business this discount belongs to.
         business_id:,
@@ -111,7 +103,7 @@ module Dodopayments
         restricted_to:,
         # How many times this discount has been used.
         times_used:,
-        # The type of discount, e.g. `percentage`, `flat`, or `flat_per_unit`.
+        # The type of discount. Currently only `percentage` is supported.
         type:,
         # Optional date/time after which discount is expired.
         expires_at: nil,

data/rbi/dodopayments/models/discount_create_params.rbi

@@ -14,18 +14,14 @@ module Dodopayments
           )
         end
 
-      # 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%`.
+      # The discount amount in **basis points** (e.g. `540` means `5.4%`, `10000` means
+      # `100%`).
       #
       # Must be at least 1.
       sig { returns(Integer) }
       attr_accessor :amount
 
-      # The discount type (e.g. `percentage`, `flat`, or `flat_per_unit`).
+      # The discount type. Currently only `percentage` is supported.
       sig { returns(Dodopayments::DiscountType::OrSymbol) }
       attr_accessor :type
 
@@ -88,16 +84,12 @@ 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%`.
+        # The discount amount in **basis points** (e.g. `540` means `5.4%`, `10000` means
+        # `100%`).
         #
         # Must be at least 1.
         amount:,
-        # The discount type (e.g. `percentage`, `flat`, or `flat_per_unit`).
+        # The discount type. Currently only `percentage` is supported.
         type:,
         # Optionally supply a code (will be uppercased).
         #

data/rbi/dodopayments/models/discount_detail.rbi

@@ -8,7 +8,7 @@ module Dodopayments
           T.any(Dodopayments::DiscountDetail, Dodopayments::Internal::AnyHash)
         end
 
-      # The discount amount (basis points for percentage, USD cents for flat)
+      # The discount amount in **basis points** (e.g., 540 => 5.4%).
       sig { returns(Integer) }
       attr_accessor :amount
 
@@ -96,7 +96,7 @@ module Dodopayments
         ).returns(T.attached_class)
       end
       def self.new(
-        # The discount amount (basis points for percentage, USD cents for flat)
+        # The discount amount in **basis points** (e.g., 540 => 5.4%).
         amount:,
         # The business this discount belongs to
         business_id:,

data/rbi/dodopayments/models/discount_list_params.rbi

@@ -28,7 +28,7 @@ module Dodopayments
       sig { params(code: String).void }
       attr_writer :code
 
-      # Filter by discount type (percentage)
+      # Filter by discount type
       sig { returns(T.nilable(Dodopayments::DiscountType::OrSymbol)) }
       attr_reader :discount_type
 
@@ -72,7 +72,7 @@ module Dodopayments
         active: nil,
         # Filter by discount code (partial match, case-insensitive)
         code: nil,
-        # Filter by discount type (percentage)
+        # Filter by discount type
         discount_type: nil,
         # Page number (default = 0).
         page_number: nil,

data/rbi/dodopayments/models/discount_update_params.rbi

@@ -17,11 +17,8 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :discount_id
 
-      # 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`).
+      # If present, update the discount amount in **basis points** (e.g., `540` =
+      # `5.4%`, `10000` = `100%`).
       #
       # Must be at least 1 if provided.
       sig { returns(T.nilable(Integer)) }
@@ -57,7 +54,7 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :subscription_cycles
 
-      # If present, update the discount type.
+      # If present, update the discount type. Currently only `percentage` is supported.
       sig { returns(T.nilable(Dodopayments::DiscountType::OrSymbol)) }
       attr_accessor :type
 
@@ -82,11 +79,8 @@ module Dodopayments
       end
       def self.new(
         discount_id:,
-        # 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`).
+        # If present, update the discount amount in **basis points** (e.g., `540` =
+        # `5.4%`, `10000` = `100%`).
         #
         # Must be at least 1 if provided.
         amount: nil,
@@ -106,7 +100,7 @@ module Dodopayments
         # provided, the discount will be applied indefinitely to all recurring payments
         # related to the subscription.
         subscription_cycles: nil,
-        # If present, update the discount type.
+        # If present, update the discount type. Currently only `percentage` is supported.
         type: nil,
         usage_limit: nil,
         request_options: {}

data/rbi/dodopayments/models/payment.rbi

@@ -60,6 +60,12 @@ module Dodopayments
       sig { returns(T::Array[Dodopayments::RefundListItem]) }
       attr_accessor :refunds
 
+      # Retry attempt number for subscription renewal payments. `0` for the original
+      # payment, `1`+ for each scheduled off-session retry after a failed renewal.
+      # Always `0` for non-subscription payments.
+      sig { returns(Integer) }
+      attr_accessor :retry_attempt
+
       # 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.
@@ -188,6 +194,7 @@ module Dodopayments
           metadata: T::Hash[Symbol, String],
           payment_id: String,
           refunds: T::Array[Dodopayments::RefundListItem::OrHash],
+          retry_attempt: Integer,
           settlement_amount: Integer,
           settlement_currency: Dodopayments::Currency::OrSymbol,
           total_amount: Integer,
@@ -241,6 +248,10 @@ module Dodopayments
         payment_id:,
         # List of refunds issued for this payment
         refunds:,
+        # Retry attempt number for subscription renewal payments. `0` for the original
+        # payment, `1`+ for each scheduled off-session retry after a failed renewal.
+        # Always `0` for non-subscription payments.
+        retry_attempt:,
         # 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.
@@ -319,6 +330,7 @@ module Dodopayments
             metadata: T::Hash[Symbol, String],
             payment_id: String,
             refunds: T::Array[Dodopayments::RefundListItem],
+            retry_attempt: Integer,
             settlement_amount: Integer,
             settlement_currency: Dodopayments::Currency::TaggedSymbol,
             total_amount: Integer,