dodopayments 2.20.1 → 2.22.0

data/lib/dodopayments/models/unsafe_unwrap_webhook_event.rb

@@ -65,6 +65,16 @@ module Dodopayments
 
       variant :"payment.succeeded", -> { Dodopayments::PaymentSucceededWebhookEvent }
 
+      variant :"payout.created", -> { Dodopayments::PayoutCreatedWebhookEvent }
+
+      variant :"payout.failed", -> { Dodopayments::PayoutFailedWebhookEvent }
+
+      variant :"payout.in_progress", -> { Dodopayments::PayoutInProgressWebhookEvent }
+
+      variant :"payout.on_hold", -> { Dodopayments::PayoutOnHoldWebhookEvent }
+
+      variant :"payout.success", -> { Dodopayments::PayoutSuccessWebhookEvent }
+
       variant :"refund.failed", -> { Dodopayments::RefundFailedWebhookEvent }
 
       variant :"refund.succeeded", -> { Dodopayments::RefundSucceededWebhookEvent }
@@ -89,7 +99,7 @@ module Dodopayments
       variant :"subscription.updated", -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
 
       # @!method self.variants
-      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
+      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
     end
   end
 end

data/lib/dodopayments/models/unwrap_webhook_event.rb

@@ -65,6 +65,16 @@ module Dodopayments
 
       variant :"payment.succeeded", -> { Dodopayments::PaymentSucceededWebhookEvent }
 
+      variant :"payout.created", -> { Dodopayments::PayoutCreatedWebhookEvent }
+
+      variant :"payout.failed", -> { Dodopayments::PayoutFailedWebhookEvent }
+
+      variant :"payout.in_progress", -> { Dodopayments::PayoutInProgressWebhookEvent }
+
+      variant :"payout.on_hold", -> { Dodopayments::PayoutOnHoldWebhookEvent }
+
+      variant :"payout.success", -> { Dodopayments::PayoutSuccessWebhookEvent }
+
       variant :"refund.failed", -> { Dodopayments::RefundFailedWebhookEvent }
 
       variant :"refund.succeeded", -> { Dodopayments::RefundSucceededWebhookEvent }
@@ -89,7 +99,7 @@ module Dodopayments
       variant :"subscription.updated", -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
 
       # @!method self.variants
-      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
+      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
     end
   end
 end

data/lib/dodopayments/models/webhook_event_type.rb

@@ -30,7 +30,7 @@ module Dodopayments
       SUBSCRIPTION_UPDATED = :"subscription.updated"
       SUBSCRIPTION_UPDATE_PAYMENT_METHOD = :"subscription.update_payment_method"
       LICENSE_KEY_CREATED = :"license_key.created"
-      PAYOUT_NOT_INITIATED = :"payout.not_initiated"
+      PAYOUT_CREATED = :"payout.created"
       PAYOUT_ON_HOLD = :"payout.on_hold"
       PAYOUT_IN_PROGRESS = :"payout.in_progress"
       PAYOUT_FAILED = :"payout.failed"

data/lib/dodopayments/models/webhook_payload.rb

@@ -11,7 +11,7 @@ module Dodopayments
       # @!attribute data
       #   The latest data at the time of delivery attempt
       #
-      #   @return [Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey, Dodopayments::Models::WebhookPayload::Data::CreditLedgerEntry, Dodopayments::Models::WebhookPayload::Data::CreditBalanceLow, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout, Dodopayments::Models::WebhookPayload::Data::DunningAttempt, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant]
+      #   @return [Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey, Dodopayments::Models::WebhookPayload::Data::Payout, Dodopayments::Models::WebhookPayload::Data::CreditLedgerEntry, Dodopayments::Models::WebhookPayload::Data::CreditBalanceLow, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout, Dodopayments::Models::WebhookPayload::Data::DunningAttempt, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant]
       required :data, union: -> { Dodopayments::WebhookPayload::Data }
 
       # @!attribute timestamp
@@ -33,7 +33,7 @@ module Dodopayments
       #
       #   @param business_id [String]
       #
-      #   @param data [Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey, Dodopayments::Models::WebhookPayload::Data::CreditLedgerEntry, Dodopayments::Models::WebhookPayload::Data::CreditBalanceLow, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout, Dodopayments::Models::WebhookPayload::Data::DunningAttempt, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant] The latest data at the time of delivery attempt
+      #   @param data [Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey, Dodopayments::Models::WebhookPayload::Data::Payout, Dodopayments::Models::WebhookPayload::Data::CreditLedgerEntry, Dodopayments::Models::WebhookPayload::Data::CreditBalanceLow, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout, Dodopayments::Models::WebhookPayload::Data::DunningAttempt, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant] The latest data at the time of delivery attempt
       #
       #   @param timestamp [Time] The timestamp of when the event occurred (not necessarily the same of when it wa
       #
@@ -58,6 +58,8 @@ module Dodopayments
 
         variant :LicenseKey, -> { Dodopayments::WebhookPayload::Data::LicenseKey }
 
+        variant :Payout, -> { Dodopayments::WebhookPayload::Data::Payout }
+
         # Response for a ledger entry
         variant :CreditLedgerEntry, -> { Dodopayments::WebhookPayload::Data::CreditLedgerEntry }
 
@@ -123,6 +125,161 @@ module Dodopayments
           #   @param payload_type [Symbol, :LicenseKey]
         end
 
+        class Payout < Dodopayments::Internal::Type::BaseModel
+          # @!attribute amount
+          #   The total amount of the payout.
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute business_id
+          #   The unique identifier of the business associated with the payout.
+          #
+          #   @return [String]
+          required :business_id, String
+
+          # @!attribute chargebacks
+          #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+          #   release.
+          #
+          #   The total value of chargebacks associated with the payout.
+          #
+          #   @return [Integer]
+          required :chargebacks, Integer
+
+          # @!attribute created_at
+          #   The timestamp when the payout was created, in UTC.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute currency
+          #   The currency of the payout, represented as an ISO 4217 currency code.
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency]
+          required :currency, enum: -> { Dodopayments::Currency }
+
+          # @!attribute fee
+          #   The fee charged for processing the payout.
+          #
+          #   @return [Integer]
+          required :fee, Integer
+
+          # @!attribute payload_type
+          #
+          #   @return [Symbol, :Payout]
+          required :payload_type, const: :Payout
+
+          # @!attribute payment_method
+          #   The payment method used for the payout (e.g., bank transfer, card, etc.).
+          #
+          #   @return [String]
+          required :payment_method, String
+
+          # @!attribute payout_id
+          #   The unique identifier of the payout.
+          #
+          #   @return [String]
+          required :payout_id, String
+
+          # @!attribute refunds
+          #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+          #   release.
+          #
+          #   The total value of refunds associated with the payout.
+          #
+          #   @return [Integer]
+          required :refunds, Integer
+
+          # @!attribute status
+          #   The current status of the payout.
+          #
+          #   @return [Symbol, Dodopayments::Models::WebhookPayload::Data::Payout::Status]
+          required :status, enum: -> { Dodopayments::WebhookPayload::Data::Payout::Status }
+
+          # @!attribute tax
+          #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+          #   release.
+          #
+          #   The tax applied to the payout.
+          #
+          #   @return [Integer]
+          required :tax, Integer
+
+          # @!attribute updated_at
+          #   The timestamp when the payout was last updated, in UTC.
+          #
+          #   @return [Time]
+          required :updated_at, Time
+
+          # @!attribute name
+          #   The name of the payout recipient or purpose.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute payout_document_url
+          #   The URL of the document associated with the payout.
+          #
+          #   @return [String, nil]
+          optional :payout_document_url, String, nil?: true
+
+          # @!attribute remarks
+          #   Any additional remarks or notes associated with the payout.
+          #
+          #   @return [String, nil]
+          optional :remarks, String, nil?: true
+
+          # @!method initialize(amount:, business_id:, chargebacks:, created_at:, currency:, fee:, payment_method:, payout_id:, refunds:, status:, tax:, updated_at:, name: nil, payout_document_url: nil, remarks: nil, payload_type: :Payout)
+          #   @param amount [Integer] The total amount of the payout.
+          #
+          #   @param business_id [String] The unique identifier of the business associated with the payout.
+          #
+          #   @param chargebacks [Integer] The total value of chargebacks associated with the payout.
+          #
+          #   @param created_at [Time] The timestamp when the payout was created, in UTC.
+          #
+          #   @param currency [Symbol, Dodopayments::Models::Currency] The currency of the payout, represented as an ISO 4217 currency code.
+          #
+          #   @param fee [Integer] The fee charged for processing the payout.
+          #
+          #   @param payment_method [String] The payment method used for the payout (e.g., bank transfer, card, etc.).
+          #
+          #   @param payout_id [String] The unique identifier of the payout.
+          #
+          #   @param refunds [Integer] The total value of refunds associated with the payout.
+          #
+          #   @param status [Symbol, Dodopayments::Models::WebhookPayload::Data::Payout::Status] The current status of the payout.
+          #
+          #   @param tax [Integer] The tax applied to the payout.
+          #
+          #   @param updated_at [Time] The timestamp when the payout was last updated, in UTC.
+          #
+          #   @param name [String, nil] The name of the payout recipient or purpose.
+          #
+          #   @param payout_document_url [String, nil] The URL of the document associated with the payout.
+          #
+          #   @param remarks [String, nil] Any additional remarks or notes associated with the payout.
+          #
+          #   @param payload_type [Symbol, :Payout]
+
+          # The current status of the payout.
+          #
+          # @see Dodopayments::Models::WebhookPayload::Data::Payout#status
+          module Status
+            extend Dodopayments::Internal::Type::Enum
+
+            NOT_INITIATED = :not_initiated
+            IN_PROGRESS = :in_progress
+            ON_HOLD = :on_hold
+            FAILED = :failed
+            SUCCESS = :success
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         class CreditLedgerEntry < Dodopayments::Models::CreditEntitlements::CreditLedgerEntry
           # @!attribute payload_type
           #
@@ -392,7 +549,7 @@ module Dodopayments
         end
 
         # @!method self.variants
-        #   @return [Array(Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey, Dodopayments::Models::WebhookPayload::Data::CreditLedgerEntry, Dodopayments::Models::WebhookPayload::Data::CreditBalanceLow, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout, Dodopayments::Models::WebhookPayload::Data::DunningAttempt, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant)]
+        #   @return [Array(Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey, Dodopayments::Models::WebhookPayload::Data::Payout, Dodopayments::Models::WebhookPayload::Data::CreditLedgerEntry, Dodopayments::Models::WebhookPayload::Data::CreditBalanceLow, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout, Dodopayments::Models::WebhookPayload::Data::DunningAttempt, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant)]
       end
     end
   end

data/lib/dodopayments/models.rb

@@ -370,10 +370,20 @@ module Dodopayments
 
   PaymentSucceededWebhookEvent = Dodopayments::Models::PaymentSucceededWebhookEvent
 
+  PayoutCreatedWebhookEvent = Dodopayments::Models::PayoutCreatedWebhookEvent
+
+  PayoutFailedWebhookEvent = Dodopayments::Models::PayoutFailedWebhookEvent
+
+  PayoutInProgressWebhookEvent = Dodopayments::Models::PayoutInProgressWebhookEvent
+
   PayoutListParams = Dodopayments::Models::PayoutListParams
 
+  PayoutOnHoldWebhookEvent = Dodopayments::Models::PayoutOnHoldWebhookEvent
+
   Payouts = Dodopayments::Models::Payouts
 
+  PayoutSuccessWebhookEvent = Dodopayments::Models::PayoutSuccessWebhookEvent
+
   Price = Dodopayments::Models::Price
 
   Product = Dodopayments::Models::Product

data/lib/dodopayments/resources/credit_entitlements/balances.rb

@@ -136,7 +136,7 @@ module Dodopayments
         #
         # @param credit_entitlement_id [String] Path param: Credit Entitlement ID
         #
-        # @param amount [String] Body param: Amount to credit or debit
+        # @param amount [String] Body param: Amount to credit or debit. Bounded to a `NUMERIC(38,28)` column, so
         #
         # @param entry_type [Symbol, Dodopayments::Models::CreditEntitlements::LedgerEntryType] Body param: Entry type: credit or debit
         #

data/lib/dodopayments/resources/discounts.rb

@@ -9,24 +9,32 @@ module Dodopayments
       # POST /discounts If `code` is omitted or empty, a random 16-char uppercase code
       # is generated.
       #
-      # @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: {})
+      # @overload create(amount:, type:, code: nil, currency_options: nil, customer_eligibility: nil, expires_at: nil, metadata: nil, name: nil, per_customer_usage_limit: nil, preserve_on_plan_change: nil, restricted_to: nil, starts_at: nil, subscription_cycles: nil, usage_limit: nil, request_options: {})
       #
       # @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. Currently only `percentage` is supported.
+      # @param type [Symbol, Dodopayments::Models::DiscountType] The discount type: `percentage` or `flat` (`flat_per_unit` stays blocked).
       #
       # @param code [String, nil] Optionally supply a code (will be uppercased).
       #
+      # @param currency_options [Array<Dodopayments::Models::DiscountCreateParams::CurrencyOption>, nil] Per-currency options (flat deduction / percentage cap + minimum subtotal).
+      #
+      # @param customer_eligibility [Symbol, Dodopayments::Models::DiscountCreateParams::CustomerEligibility, nil] Who may redeem this discount code. Defaults to `any` (unrestricted).
+      #
       # @param expires_at [Time, nil] When the discount expires, if ever.
       #
       # @param metadata [Hash{Symbol=>String, Float, Boolean}] Additional metadata for the discount
       #
       # @param name [String, nil]
       #
+      # @param per_customer_usage_limit [Integer, nil] Maximum number of times a single customer may redeem this discount.
+      #
       # @param preserve_on_plan_change [Boolean] Whether this discount should be preserved when a subscription changes plans.
       #
       # @param restricted_to [Array<String>, nil] List of product IDs to restrict usage (if any).
       #
+      # @param starts_at [Time, nil] When the discount becomes active, if scheduled for the future.
+      #
       # @param subscription_cycles [Integer, nil] Number of subscription billing cycles this discount is valid for.
       #
       # @param usage_limit [Integer, nil] How many times this discount can be used (if any).
@@ -72,7 +80,7 @@ module Dodopayments
       #
       # PATCH /discounts/{discount_id}
       #
-      # @overload update(discount_id, amount: nil, code: nil, expires_at: nil, metadata: nil, name: nil, preserve_on_plan_change: nil, restricted_to: nil, subscription_cycles: nil, type: nil, usage_limit: nil, request_options: {})
+      # @overload update(discount_id, amount: nil, code: nil, currency_options: nil, customer_eligibility: nil, expires_at: nil, metadata: nil, name: nil, per_customer_usage_limit: nil, preserve_on_plan_change: nil, restricted_to: nil, starts_at: nil, subscription_cycles: nil, type: nil, usage_limit: nil, request_options: {})
       #
       # @param discount_id [String] Discount Id
       #
@@ -80,19 +88,27 @@ module Dodopayments
       #
       # @param code [String, nil] If present, update the discount code (uppercase).
       #
+      # @param currency_options [Array<Dodopayments::Models::DiscountUpdateParams::CurrencyOption>, nil] If present, fully replaces the discount's currency options (replace-set
+      #
+      # @param customer_eligibility [Symbol, Dodopayments::Models::DiscountUpdateParams::CustomerEligibility, nil] If present, update who may redeem this discount. Plain field (not
+      #
       # @param expires_at [Time, nil]
       #
       # @param metadata [Hash{Symbol=>String, Float, Boolean}, nil] Additional metadata for the discount
       #
       # @param name [String, nil]
       #
+      # @param per_customer_usage_limit [Integer, nil] If present, update the per-customer usage limit (double-option: send
+      #
       # @param preserve_on_plan_change [Boolean, nil] Whether this discount should be preserved when a subscription changes plans.
       #
       # @param restricted_to [Array<String>, nil] If present, replaces all restricted product IDs with this new set.
       #
+      # @param starts_at [Time, nil] If present, update `starts_at` (double-option: send `null` to clear it).
+      #
       # @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. Currently only `percentage` is supported.
+      # @param type [Symbol, Dodopayments::Models::DiscountType, nil] If present, update the discount type (`percentage` or `flat`).
       #
       # @param usage_limit [Integer, nil]
       #
@@ -112,11 +128,14 @@ module Dodopayments
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::DiscountListParams} for more details.
+      #
       # GET /discounts
       #
       # @overload list(active: nil, code: nil, discount_type: nil, page_number: nil, page_size: nil, product_id: nil, request_options: {})
       #
-      # @param active [Boolean] Filter by active status (true = not expired, false = expired)
+      # @param active [Boolean] Filter by active status. `true` = currently redeemable (started, not
       #
       # @param code [String] Filter by discount code (partial match, case-insensitive)
       #

data/lib/dodopayments/resources/payments.rb

@@ -82,7 +82,10 @@ module Dodopayments
         )
       end
 
-      # @overload list(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, subscription_id: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::PaymentListParams} for more details.
+      #
+      # @overload list(brand_id: nil, created_at_gte: nil, created_at_lte: nil, currency: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, subscription_id: nil, request_options: {})
       #
       # @param brand_id [String] filter by Brand id
       #
@@ -90,9 +93,11 @@ module Dodopayments
       #
       # @param created_at_lte [Time] Get events created before this time
       #
+      # @param currency [Symbol, Dodopayments::Models::PaymentListParams::Currency] Filter by currency
+      #
       # @param customer_id [String] Filter by customer id
       #
-      # @param page_number [Integer] Page number default is 0
+      # @param page_number [Integer] Page number default is 0. Capped to bound OFFSET-based deep pagination,
       #
       # @param page_size [Integer] Page size default is 10 max is 100
       #

data/lib/dodopayments/resources/webhooks.rb

@@ -170,7 +170,7 @@ module Dodopayments
 
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
+      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
       def unsafe_unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         Dodopayments::Internal::Type::Converter.coerce(Dodopayments::Models::UnsafeUnwrapWebhookEvent, parsed)
@@ -182,7 +182,7 @@ module Dodopayments
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
+      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
       def unwrap(payload, headers:, key: @client.webhook_key)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_key or passed in as an argument")

data/lib/dodopayments/version.rb

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

data/lib/dodopayments.rb

@@ -261,13 +261,18 @@ require_relative "dodopayments/models/payment_retrieve_line_items_params"
 require_relative "dodopayments/models/payment_retrieve_line_items_response"
 require_relative "dodopayments/models/payment_retrieve_params"
 require_relative "dodopayments/models/payment_succeeded_webhook_event"
+require_relative "dodopayments/models/payout_created_webhook_event"
+require_relative "dodopayments/models/payout_failed_webhook_event"
+require_relative "dodopayments/models/payout_in_progress_webhook_event"
 require_relative "dodopayments/models/payout_list_params"
 require_relative "dodopayments/models/payout_list_response"
+require_relative "dodopayments/models/payout_on_hold_webhook_event"
 require_relative "dodopayments/models/payouts/breakup/detail_download_csv_params"
 require_relative "dodopayments/models/payouts/breakup/detail_list_params"
 require_relative "dodopayments/models/payouts/breakup/detail_list_response"
 require_relative "dodopayments/models/payouts/breakup_retrieve_params"
 require_relative "dodopayments/models/payouts/breakup_retrieve_response"
+require_relative "dodopayments/models/payout_success_webhook_event"
 require_relative "dodopayments/models/price"
 require_relative "dodopayments/models/product"
 require_relative "dodopayments/models/product_archive_params"

data/rbi/dodopayments/models/checkout_session_preview_response.rbi

@@ -99,6 +99,17 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :total_tax
 
+      # Per-unit trial amount after discounts, in the price currency's minor units
+      # (pre-quantity, pre-tax; see `current_breakup` for the taxed total due today).
+      # Only present for a paid trial; `None` for a free trial or no trial.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :trial_amount
+
+      # Effective trial duration in days for the subscription line, when there's a trial
+      # (free or paid). `None` if no subscription or no trial.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :trial_period_days
+
       # Data returned by the calculate checkout session API
       sig do
         params(
@@ -120,7 +131,9 @@ module Dodopayments
           tax_id_business_name: T.nilable(String),
           tax_id_err_msg: T.nilable(String),
           tax_id_format_name: T.nilable(String),
-          total_tax: T.nilable(Integer)
+          total_tax: T.nilable(Integer),
+          trial_amount: T.nilable(Integer),
+          trial_period_days: T.nilable(Integer)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -153,7 +166,14 @@ module Dodopayments
         # The matched tax ID notation (e.g. "VAT Number", "GSTIN") when valid
         tax_id_format_name: nil,
         # Total tax
-        total_tax: nil
+        total_tax: nil,
+        # Per-unit trial amount after discounts, in the price currency's minor units
+        # (pre-quantity, pre-tax; see `current_breakup` for the taxed total due today).
+        # Only present for a paid trial; `None` for a free trial or no trial.
+        trial_amount: nil,
+        # Effective trial duration in days for the subscription line, when there's a trial
+        # (free or paid). `None` if no subscription or no trial.
+        trial_period_days: nil
       )
       end
 
@@ -178,7 +198,9 @@ module Dodopayments
             tax_id_business_name: T.nilable(String),
             tax_id_err_msg: T.nilable(String),
             tax_id_format_name: T.nilable(String),
-            total_tax: T.nilable(Integer)
+            total_tax: T.nilable(Integer),
+            trial_amount: T.nilable(Integer),
+            trial_period_days: T.nilable(Integer)
           }
         )
       end
@@ -330,7 +352,8 @@ module Dodopayments
         sig { returns(T.nilable(String)) }
         attr_accessor :description
 
-        # discount percentage
+        # Percentage rate (basis points) of the applicable percentage code; null for flat
+        # codes (their deduction is `og_price - discounted_price`).
         sig { returns(T.nilable(Integer)) }
         attr_accessor :discount_amount
 
@@ -407,7 +430,8 @@ module Dodopayments
           tax_rate:,
           addons: nil,
           description: nil,
-          # discount percentage
+          # Percentage rate (basis points) of the applicable percentage code; null for flat
+          # codes (their deduction is `og_price - discounted_price`).
           discount_amount: nil,
           # number of cycles the discount will apply
           discount_cycle: nil,
@@ -619,6 +643,8 @@ module Dodopayments
           sig { returns(T.nilable(String)) }
           attr_accessor :description
 
+          # Percentage rate (basis points) of the applicable percentage code; null for flat
+          # codes (their deduction is `og_price - discounted_price`).
           sig { returns(T.nilable(Integer)) }
           attr_accessor :discount_amount
 
@@ -656,6 +682,8 @@ module Dodopayments
             tax_inclusive:,
             tax_rate:,
             description: nil,
+            # Percentage rate (basis points) of the applicable percentage code; null for flat
+            # codes (their deduction is `og_price - discounted_price`).
             discount_amount: nil,
             tax: nil
           )

data/rbi/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rbi

@@ -21,7 +21,9 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :customer_id
 
-        # Amount to credit or debit
+        # Amount to credit or debit. Bounded to a `NUMERIC(38,28)` column, so the integer
+        # part must have fewer than 10 digits (< 10^10); larger values previously reached
+        # the DB and failed with a 22003 overflow surfaced as a 500.
         sig { returns(String) }
         attr_accessor :amount
 
@@ -70,7 +72,9 @@ module Dodopayments
         def self.new(
           credit_entitlement_id:,
           customer_id:,
-          # Amount to credit or debit
+          # Amount to credit or debit. Bounded to a `NUMERIC(38,28)` column, so the integer
+          # part must have fewer than 10 digits (< 10^10); larger values previously reached
+          # the DB and failed with a 22003 overflow surfaced as a 500.
           amount:,
           # Entry type: credit or debit
           entry_type:,