dodopayments 2.4.1 → 2.6.0

data/rbi/dodopayments/models/webhook_event_type.rbi

@@ -143,6 +143,27 @@ module Dodopayments
           :"credit.balance_low",
           Dodopayments::WebhookEventType::TaggedSymbol
         )
+      ABANDONED_CHECKOUT_DETECTED =
+        T.let(
+          :"abandoned_checkout.detected",
+          Dodopayments::WebhookEventType::TaggedSymbol
+        )
+      ABANDONED_CHECKOUT_RECOVERED =
+        T.let(
+          :"abandoned_checkout.recovered",
+          Dodopayments::WebhookEventType::TaggedSymbol
+        )
+      DUNNING_STARTED =
+        T.let(:"dunning.started", Dodopayments::WebhookEventType::TaggedSymbol)
+      DUNNING_RECOVERED =
+        T.let(
+          :"dunning.recovered",
+          Dodopayments::WebhookEventType::TaggedSymbol
+        )
+      ACR_EMAIL =
+        T.let(:"acr.email", Dodopayments::WebhookEventType::TaggedSymbol)
+      DUNNING_EMAIL =
+        T.let(:"dunning.email", Dodopayments::WebhookEventType::TaggedSymbol)
 
       sig do
         override.returns(T::Array[Dodopayments::WebhookEventType::TaggedSymbol])

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -21,7 +21,9 @@ module Dodopayments
             Dodopayments::WebhookPayload::Data::Dispute,
             Dodopayments::WebhookPayload::Data::LicenseKey,
             Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
-            Dodopayments::WebhookPayload::Data::CreditBalanceLow
+            Dodopayments::WebhookPayload::Data::CreditBalanceLow,
+            Dodopayments::WebhookPayload::Data::AbandonedCheckout,
+            Dodopayments::WebhookPayload::Data::DunningAttempt
           )
         )
       end
@@ -47,7 +49,9 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::Dispute::OrHash,
               Dodopayments::WebhookPayload::Data::LicenseKey::OrHash,
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry::OrHash,
-              Dodopayments::WebhookPayload::Data::CreditBalanceLow::OrHash
+              Dodopayments::WebhookPayload::Data::CreditBalanceLow::OrHash,
+              Dodopayments::WebhookPayload::Data::AbandonedCheckout::OrHash,
+              Dodopayments::WebhookPayload::Data::DunningAttempt::OrHash
             ),
           timestamp: Time,
           type: Dodopayments::WebhookEventType::OrSymbol
@@ -77,7 +81,9 @@ module Dodopayments
                 Dodopayments::WebhookPayload::Data::Dispute,
                 Dodopayments::WebhookPayload::Data::LicenseKey,
                 Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
-                Dodopayments::WebhookPayload::Data::CreditBalanceLow
+                Dodopayments::WebhookPayload::Data::CreditBalanceLow,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout,
+                Dodopayments::WebhookPayload::Data::DunningAttempt
               ),
             timestamp: Time,
             type: Dodopayments::WebhookEventType::OrSymbol
@@ -100,7 +106,9 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::Dispute,
               Dodopayments::WebhookPayload::Data::LicenseKey,
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
-              Dodopayments::WebhookPayload::Data::CreditBalanceLow
+              Dodopayments::WebhookPayload::Data::CreditBalanceLow,
+              Dodopayments::WebhookPayload::Data::AbandonedCheckout,
+              Dodopayments::WebhookPayload::Data::DunningAttempt
             )
           end
 
@@ -618,6 +626,394 @@ module Dodopayments
           end
         end
 
+        class AbandonedCheckout < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Time) }
+          attr_accessor :abandoned_at
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason::OrSymbol
+            )
+          end
+          attr_accessor :abandonment_reason
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::AbandonedCheckout::PayloadType::OrSymbol
+            )
+          end
+          attr_accessor :payload_type
+
+          sig { returns(String) }
+          attr_accessor :payment_id
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::OrSymbol
+            )
+          end
+          attr_accessor :status
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :recovered_payment_id
+
+          sig do
+            params(
+              abandoned_at: Time,
+              abandonment_reason:
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason::OrSymbol,
+              customer_id: String,
+              payload_type:
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::PayloadType::OrSymbol,
+              payment_id: String,
+              status:
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::OrSymbol,
+              recovered_payment_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            abandoned_at:,
+            abandonment_reason:,
+            customer_id:,
+            payload_type:,
+            payment_id:,
+            status:,
+            recovered_payment_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                abandoned_at: Time,
+                abandonment_reason:
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason::OrSymbol,
+                customer_id: String,
+                payload_type:
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::PayloadType::OrSymbol,
+                payment_id: String,
+                status:
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::OrSymbol,
+                recovered_payment_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module AbandonmentReason
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PAYMENT_FAILED =
+              T.let(
+                :payment_failed,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason::TaggedSymbol
+              )
+            CHECKOUT_INCOMPLETE =
+              T.let(
+                :checkout_incomplete,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::PayloadType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ABANDONED_CHECKOUT =
+              T.let(
+                :AbandonedCheckout,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::PayloadType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::PayloadType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Status
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ABANDONED =
+              T.let(
+                :abandoned,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::TaggedSymbol
+              )
+            RECOVERING =
+              T.let(
+                :recovering,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::TaggedSymbol
+              )
+            RECOVERED =
+              T.let(
+                :recovered,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::TaggedSymbol
+              )
+            EXHAUSTED =
+              T.let(
+                :exhausted,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::TaggedSymbol
+              )
+            OPTED_OUT =
+              T.let(
+                :opted_out,
+                Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::AbandonedCheckout::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        class DunningAttempt < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::WebhookPayload::Data::DunningAttempt,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::DunningAttempt::PayloadType::OrSymbol
+            )
+          end
+          attr_accessor :payload_type
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::DunningAttempt::Status::OrSymbol
+            )
+          end
+          attr_accessor :status
+
+          sig { returns(String) }
+          attr_accessor :subscription_id
+
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::OrSymbol
+            )
+          end
+          attr_accessor :trigger_state
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :payment_id
+
+          sig do
+            params(
+              created_at: Time,
+              customer_id: String,
+              payload_type:
+                Dodopayments::WebhookPayload::Data::DunningAttempt::PayloadType::OrSymbol,
+              status:
+                Dodopayments::WebhookPayload::Data::DunningAttempt::Status::OrSymbol,
+              subscription_id: String,
+              trigger_state:
+                Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::OrSymbol,
+              payment_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            created_at:,
+            customer_id:,
+            payload_type:,
+            status:,
+            subscription_id:,
+            trigger_state:,
+            payment_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                created_at: Time,
+                customer_id: String,
+                payload_type:
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::PayloadType::OrSymbol,
+                status:
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::Status::OrSymbol,
+                subscription_id: String,
+                trigger_state:
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::OrSymbol,
+                payment_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::PayloadType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DUNNING_ATTEMPT =
+              T.let(
+                :DunningAttempt,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::PayloadType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::PayloadType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Status
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            RECOVERING =
+              T.let(
+                :recovering,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::Status::TaggedSymbol
+              )
+            RECOVERED =
+              T.let(
+                :recovered,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::Status::TaggedSymbol
+              )
+            EXHAUSTED =
+              T.let(
+                :exhausted,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module TriggerState
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ON_HOLD =
+              T.let(
+                :on_hold,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::TaggedSymbol
+              )
+            CANCELLED =
+              T.let(
+                :cancelled,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         sig do
           override.returns(
             T::Array[Dodopayments::WebhookPayload::Data::Variants]

data/rbi/dodopayments/models.rbi

@@ -1,6 +1,12 @@
 # typed: strong
 
 module Dodopayments
+  AbandonedCheckoutDetectedWebhookEvent =
+    Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent
+
+  AbandonedCheckoutRecoveredWebhookEvent =
+    Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent
+
   AddMeterToPrice = Dodopayments::Models::AddMeterToPrice
 
   AddonCartResponseItem = Dodopayments::Models::AddonCartResponseItem
@@ -205,6 +211,11 @@ module Dodopayments
 
   DisputeWonWebhookEvent = Dodopayments::Models::DisputeWonWebhookEvent
 
+  DunningRecoveredWebhookEvent =
+    Dodopayments::Models::DunningRecoveredWebhookEvent
+
+  DunningStartedWebhookEvent = Dodopayments::Models::DunningStartedWebhookEvent
+
   Event = Dodopayments::Models::Event
 
   EventInput = Dodopayments::Models::EventInput
@@ -307,6 +318,8 @@ module Dodopayments
 
   PayoutListParams = Dodopayments::Models::PayoutListParams
 
+  Payouts = Dodopayments::Models::Payouts
+
   Price = Dodopayments::Models::Price
 
   Product = Dodopayments::Models::Product

data/rbi/dodopayments/resources/discounts.rbi

@@ -11,6 +11,7 @@ module Dodopayments
           type: Dodopayments::DiscountType::OrSymbol,
           code: T.nilable(String),
           expires_at: T.nilable(Time),
+          metadata: T::Hash[Symbol, String],
           name: T.nilable(String),
           preserve_on_plan_change: T::Boolean,
           restricted_to: T.nilable(T::Array[String]),
@@ -38,6 +39,8 @@ module Dodopayments
         code: nil,
         # When the discount expires, if ever.
         expires_at: nil,
+        # Additional metadata for the discount
+        metadata: nil,
         name: nil,
         # Whether this discount should be preserved when a subscription changes plans.
         # Default: false (discount is removed on plan change)
@@ -75,6 +78,7 @@ module Dodopayments
           amount: T.nilable(Integer),
           code: T.nilable(String),
           expires_at: T.nilable(Time),
+          metadata: T.nilable(T::Hash[Symbol, String]),
           name: T.nilable(String),
           preserve_on_plan_change: T.nilable(T::Boolean),
           restricted_to: T.nilable(T::Array[String]),
@@ -98,6 +102,8 @@ module Dodopayments
         # If present, update the discount code (uppercase).
         code: nil,
         expires_at: nil,
+        # Additional metadata for the discount
+        metadata: nil,
         name: nil,
         # Whether this discount should be preserved when a subscription changes plans. If
         # not provided, the existing value is kept.

data/rbi/dodopayments/resources/payouts/breakup/details.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Payouts
+      class Breakup
+        class Details
+          # Returns paginated individual balance ledger entries for a payout, with each
+          # entry's amount pro-rated into the payout's currency. Supports pagination via
+          # `page_size` (default 10, max 100) and `page_number` (default 0) query
+          # parameters.
+          sig do
+            params(
+              payout_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(
+              Dodopayments::Internal::DefaultPageNumberPagination[
+                Dodopayments::Models::Payouts::Breakup::DetailListResponse
+              ]
+            )
+          end
+          def list(
+            # Id of the Payout to get breakup for
+            payout_id,
+            # Page number (0-indexed). Default: 0.
+            page_number: nil,
+            # Number of items per page. Default: 10, Max: 100.
+            page_size: nil,
+            request_options: {}
+          )
+          end
+
+          # Downloads the complete payout breakup as a CSV file. Each row represents a
+          # balance ledger entry with columns: Ledger ID, Event Type, Original Amount,
+          # Original Currency, Reference Object ID, Description, Created At, USD Equivalent
+          # Amount, and Payout Currency Amount.
+          sig do
+            params(
+              payout_id: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).void
+          end
+          def download_csv(
+            # Id of the Payout to get breakup for
+            payout_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/payouts/breakup.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Payouts
+      class Breakup
+        sig { returns(Dodopayments::Resources::Payouts::Breakup::Details) }
+        attr_reader :details
+
+        # Returns the breakdown of a payout by event type (payments, refunds, disputes,
+        # fees, etc.) in the payout's currency. Each amount is proportionally allocated
+        # based on USD equivalent values, ensuring the total sums exactly to the payout
+        # amount.
+        sig do
+          params(
+            payout_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            T::Array[Dodopayments::Models::Payouts::BreakupRetrieveResponseItem]
+          )
+        end
+        def retrieve(
+          # Id of the Payout to get breakup for
+          payout_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/payouts.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Payouts
+      sig { returns(Dodopayments::Resources::Payouts::Breakup) }
+      attr_reader :breakup
+
       sig do
         params(
           created_at_gte: Time,

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -112,6 +112,10 @@ module Dodopayments
           subscription_id: String,
           billing: T.nilable(Dodopayments::BillingAddress::OrHash),
           cancel_at_next_billing_date: T.nilable(T::Boolean),
+          cancel_reason:
+            T.nilable(
+              Dodopayments::SubscriptionUpdateParams::CancelReason::OrSymbol
+            ),
           credit_entitlement_cart:
             T.nilable(
               T::Array[
@@ -136,6 +140,7 @@ module Dodopayments
         billing: nil,
         # When set, the subscription will remain active until the end of billing period
         cancel_at_next_billing_date: nil,
+        cancel_reason: nil,
         # Update credit entitlement cart settings
         credit_entitlement_cart: nil,
         customer_name: nil,

data/rbi/dodopayments/resources/webhooks.rbi

@@ -131,6 +131,8 @@ module Dodopayments
       sig do
         params(payload: String).returns(
           T.any(
+            Dodopayments::AbandonedCheckoutDetectedWebhookEvent,
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent,
             Dodopayments::CreditAddedWebhookEvent,
             Dodopayments::CreditBalanceLowWebhookEvent,
             Dodopayments::CreditDeductedWebhookEvent,
@@ -146,6 +148,8 @@ module Dodopayments
             Dodopayments::DisputeLostWebhookEvent,
             Dodopayments::DisputeOpenedWebhookEvent,
             Dodopayments::DisputeWonWebhookEvent,
+            Dodopayments::DunningRecoveredWebhookEvent,
+            Dodopayments::DunningStartedWebhookEvent,
             Dodopayments::LicenseKeyCreatedWebhookEvent,
             Dodopayments::PaymentCancelledWebhookEvent,
             Dodopayments::PaymentFailedWebhookEvent,
@@ -177,6 +181,8 @@ module Dodopayments
           key: T.nilable(String)
         ).returns(
           T.any(
+            Dodopayments::AbandonedCheckoutDetectedWebhookEvent,
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent,
             Dodopayments::CreditAddedWebhookEvent,
             Dodopayments::CreditBalanceLowWebhookEvent,
             Dodopayments::CreditDeductedWebhookEvent,
@@ -192,6 +198,8 @@ module Dodopayments
             Dodopayments::DisputeLostWebhookEvent,
             Dodopayments::DisputeOpenedWebhookEvent,
             Dodopayments::DisputeWonWebhookEvent,
+            Dodopayments::DunningRecoveredWebhookEvent,
+            Dodopayments::DunningStartedWebhookEvent,
             Dodopayments::LicenseKeyCreatedWebhookEvent,
             Dodopayments::PaymentCancelledWebhookEvent,
             Dodopayments::PaymentFailedWebhookEvent,