dodopayments 2.20.1 → 2.22.0

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -20,6 +20,7 @@ module Dodopayments
             Dodopayments::WebhookPayload::Data::Refund,
             Dodopayments::WebhookPayload::Data::Dispute,
             Dodopayments::WebhookPayload::Data::LicenseKey,
+            Dodopayments::WebhookPayload::Data::Payout,
             Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
             Dodopayments::WebhookPayload::Data::CreditBalanceLow,
             Dodopayments::WebhookPayload::Data::AbandonedCheckout,
@@ -49,6 +50,7 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::Refund::OrHash,
               Dodopayments::WebhookPayload::Data::Dispute::OrHash,
               Dodopayments::WebhookPayload::Data::LicenseKey::OrHash,
+              Dodopayments::WebhookPayload::Data::Payout::OrHash,
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry::OrHash,
               Dodopayments::WebhookPayload::Data::CreditBalanceLow::OrHash,
               Dodopayments::WebhookPayload::Data::AbandonedCheckout::OrHash,
@@ -82,6 +84,7 @@ module Dodopayments
                 Dodopayments::WebhookPayload::Data::Refund,
                 Dodopayments::WebhookPayload::Data::Dispute,
                 Dodopayments::WebhookPayload::Data::LicenseKey,
+                Dodopayments::WebhookPayload::Data::Payout,
                 Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
                 Dodopayments::WebhookPayload::Data::CreditBalanceLow,
                 Dodopayments::WebhookPayload::Data::AbandonedCheckout,
@@ -108,6 +111,7 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::Refund,
               Dodopayments::WebhookPayload::Data::Dispute,
               Dodopayments::WebhookPayload::Data::LicenseKey,
+              Dodopayments::WebhookPayload::Data::Payout,
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
               Dodopayments::WebhookPayload::Data::CreditBalanceLow,
               Dodopayments::WebhookPayload::Data::AbandonedCheckout,
@@ -222,6 +226,215 @@ module Dodopayments
           end
         end
 
+        class Payout < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::WebhookPayload::Data::Payout,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          # The total amount of the payout.
+          sig { returns(Integer) }
+          attr_accessor :amount
+
+          # The unique identifier of the business associated with the payout.
+          sig { returns(String) }
+          attr_accessor :business_id
+
+          # The total value of chargebacks associated with the payout.
+          sig { returns(Integer) }
+          attr_accessor :chargebacks
+
+          # The timestamp when the payout was created, in UTC.
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # The currency of the payout, represented as an ISO 4217 currency code.
+          sig { returns(Dodopayments::Currency::OrSymbol) }
+          attr_accessor :currency
+
+          # The fee charged for processing the payout.
+          sig { returns(Integer) }
+          attr_accessor :fee
+
+          sig { returns(Symbol) }
+          attr_accessor :payload_type
+
+          # The payment method used for the payout (e.g., bank transfer, card, etc.).
+          sig { returns(String) }
+          attr_accessor :payment_method
+
+          # The unique identifier of the payout.
+          sig { returns(String) }
+          attr_accessor :payout_id
+
+          # The total value of refunds associated with the payout.
+          sig { returns(Integer) }
+          attr_accessor :refunds
+
+          # The current status of the payout.
+          sig do
+            returns(
+              Dodopayments::WebhookPayload::Data::Payout::Status::OrSymbol
+            )
+          end
+          attr_accessor :status
+
+          # The tax applied to the payout.
+          sig { returns(Integer) }
+          attr_accessor :tax
+
+          # The timestamp when the payout was last updated, in UTC.
+          sig { returns(Time) }
+          attr_accessor :updated_at
+
+          # The name of the payout recipient or purpose.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # The URL of the document associated with the payout.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :payout_document_url
+
+          # Any additional remarks or notes associated with the payout.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :remarks
+
+          sig do
+            params(
+              amount: Integer,
+              business_id: String,
+              chargebacks: Integer,
+              created_at: Time,
+              currency: Dodopayments::Currency::OrSymbol,
+              fee: Integer,
+              payment_method: String,
+              payout_id: String,
+              refunds: Integer,
+              status:
+                Dodopayments::WebhookPayload::Data::Payout::Status::OrSymbol,
+              tax: Integer,
+              updated_at: Time,
+              name: T.nilable(String),
+              payout_document_url: T.nilable(String),
+              remarks: T.nilable(String),
+              payload_type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The total amount of the payout.
+            amount:,
+            # The unique identifier of the business associated with the payout.
+            business_id:,
+            # The total value of chargebacks associated with the payout.
+            chargebacks:,
+            # The timestamp when the payout was created, in UTC.
+            created_at:,
+            # The currency of the payout, represented as an ISO 4217 currency code.
+            currency:,
+            # The fee charged for processing the payout.
+            fee:,
+            # The payment method used for the payout (e.g., bank transfer, card, etc.).
+            payment_method:,
+            # The unique identifier of the payout.
+            payout_id:,
+            # The total value of refunds associated with the payout.
+            refunds:,
+            # The current status of the payout.
+            status:,
+            # The tax applied to the payout.
+            tax:,
+            # The timestamp when the payout was last updated, in UTC.
+            updated_at:,
+            # The name of the payout recipient or purpose.
+            name: nil,
+            # The URL of the document associated with the payout.
+            payout_document_url: nil,
+            # Any additional remarks or notes associated with the payout.
+            remarks: nil,
+            payload_type: :Payout
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Integer,
+                business_id: String,
+                chargebacks: Integer,
+                created_at: Time,
+                currency: Dodopayments::Currency::OrSymbol,
+                fee: Integer,
+                payload_type: Symbol,
+                payment_method: String,
+                payout_id: String,
+                refunds: Integer,
+                status:
+                  Dodopayments::WebhookPayload::Data::Payout::Status::OrSymbol,
+                tax: Integer,
+                updated_at: Time,
+                name: T.nilable(String),
+                payout_document_url: T.nilable(String),
+                remarks: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The current status of the payout.
+          module Status
+            extend Dodopayments::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Dodopayments::WebhookPayload::Data::Payout::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NOT_INITIATED =
+              T.let(
+                :not_initiated,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            ON_HOLD =
+              T.let(
+                :on_hold,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            SUCCESS =
+              T.let(
+                :success,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class CreditLedgerEntry < Dodopayments::Models::CreditEntitlements::CreditLedgerEntry
           OrHash =
             T.type_alias do

data/rbi/dodopayments/models.rbi

@@ -381,10 +381,21 @@ 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/rbi/dodopayments/resources/credit_entitlements/balances.rbi

@@ -134,7 +134,9 @@ module Dodopayments
           customer_id,
           # Path param: Credit Entitlement ID
           credit_entitlement_id:,
-          # Body param: Amount to credit or debit
+          # Body param: 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:,
           # Body param: Entry type: credit or debit
           entry_type:,

data/rbi/dodopayments/resources/discounts.rbi

@@ -10,11 +10,23 @@ module Dodopayments
           amount: Integer,
           type: Dodopayments::DiscountType::OrSymbol,
           code: T.nilable(String),
+          currency_options:
+            T.nilable(
+              T::Array[
+                Dodopayments::DiscountCreateParams::CurrencyOption::OrHash
+              ]
+            ),
+          customer_eligibility:
+            T.nilable(
+              Dodopayments::DiscountCreateParams::CustomerEligibility::OrSymbol
+            ),
           expires_at: T.nilable(Time),
           metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           name: T.nilable(String),
+          per_customer_usage_limit: T.nilable(Integer),
           preserve_on_plan_change: T::Boolean,
           restricted_to: T.nilable(T::Array[String]),
+          starts_at: T.nilable(Time),
           subscription_cycles: T.nilable(Integer),
           usage_limit: T.nilable(Integer),
           request_options: Dodopayments::RequestOptions::OrHash
@@ -26,23 +38,38 @@ module Dodopayments
         #
         # Must be at least 1.
         amount:,
-        # The discount type. Currently only `percentage` is supported.
+        # The discount type: `percentage` or `flat` (`flat_per_unit` stays blocked).
         type:,
         # Optionally supply a code (will be uppercased).
         #
         # - Must be at least 3 characters if provided.
         # - If omitted, a random 16-character code is generated.
         code: nil,
+        # Per-currency options (flat deduction / percentage cap + minimum subtotal).
+        # Required for `flat` codes (must include a resolvable default); optional
+        # per-currency caps for `percentage` codes. Per-row invariants are checked in
+        # `normalize_currency_options`, not via `#[validate(nested)]`.
+        currency_options: nil,
+        # Who may redeem this discount code. Defaults to `any` (unrestricted). `specific`
+        # starts with zero attached customers (fails closed) until customers are attached
+        # via `POST /discounts/{id}/customers`.
+        customer_eligibility: nil,
         # When the discount expires, if ever.
         expires_at: nil,
         # Additional metadata for the discount
         metadata: nil,
         name: nil,
+        # Maximum number of times a single customer may redeem this discount. Must be
+        # `<= usage_limit` when both are set.
+        per_customer_usage_limit: nil,
         # Whether this discount should be preserved when a subscription changes plans.
         # Default: false (discount is removed on plan change)
         preserve_on_plan_change: nil,
         # List of product IDs to restrict usage (if any).
         restricted_to: nil,
+        # When the discount becomes active, if scheduled for the future. NULL = active
+        # immediately. Must be strictly before `expires_at` when both are set.
+        starts_at: nil,
         # Number of subscription billing cycles this discount is valid for. If not
         # provided, the discount will be applied indefinitely to all recurring payments
         # related to the subscription.
@@ -73,12 +100,24 @@ module Dodopayments
           discount_id: String,
           amount: T.nilable(Integer),
           code: T.nilable(String),
+          currency_options:
+            T.nilable(
+              T::Array[
+                Dodopayments::DiscountUpdateParams::CurrencyOption::OrHash
+              ]
+            ),
+          customer_eligibility:
+            T.nilable(
+              Dodopayments::DiscountUpdateParams::CustomerEligibility::OrSymbol
+            ),
           expires_at: T.nilable(Time),
           metadata:
             T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           name: T.nilable(String),
+          per_customer_usage_limit: T.nilable(Integer),
           preserve_on_plan_change: T.nilable(T::Boolean),
           restricted_to: T.nilable(T::Array[String]),
+          starts_at: T.nilable(Time),
           subscription_cycles: T.nilable(Integer),
           type: T.nilable(Dodopayments::DiscountType::OrSymbol),
           usage_limit: T.nilable(Integer),
@@ -95,21 +134,34 @@ module Dodopayments
         amount: nil,
         # If present, update the discount code (uppercase).
         code: nil,
+        # If present, fully replaces the discount's currency options (replace-set
+        # semantics, like `restricted_to`). Send an empty array to clear them.
+        currency_options: nil,
+        # If present, update who may redeem this discount. Plain field (not
+        # double-option): the DB column is `NOT NULL`, so it can never be cleared back to
+        # unset, only changed to another `CustomerEligibility` value.
+        customer_eligibility: nil,
         expires_at: nil,
         # Additional metadata for the discount
         metadata: nil,
         name: nil,
+        # If present, update the per-customer usage limit (double-option: send `null` to
+        # clear it back to unlimited). Must be `<= usage_limit` (the value in effect after
+        # this patch) when both are set.
+        per_customer_usage_limit: nil,
         # Whether this discount should be preserved when a subscription changes plans. If
         # not provided, the existing value is kept.
         preserve_on_plan_change: nil,
         # If present, replaces all restricted product IDs with this new set. To remove all
         # restrictions, send empty array
         restricted_to: nil,
+        # If present, update `starts_at` (double-option: send `null` to clear it).
+        starts_at: nil,
         # Number of subscription billing cycles this discount is valid for. If not
         # provided, the discount will be applied indefinitely to all recurring payments
         # related to the subscription.
         subscription_cycles: nil,
-        # If present, update the discount type. Currently only `percentage` is supported.
+        # If present, update the discount type (`percentage` or `flat`).
         type: nil,
         usage_limit: nil,
         request_options: {}
@@ -133,7 +185,9 @@ module Dodopayments
         )
       end
       def list(
-        # Filter by active status (true = not expired, false = expired)
+        # Filter by active status. `true` = currently redeemable (started, not expired,
+        # not usage-exhausted). `false` = not currently redeemable (expired,
+        # usage-exhausted, or pending a future `starts_at`).
         active: nil,
         # Filter by discount code (partial match, case-insensitive)
         code: nil,

data/rbi/dodopayments/resources/payments.rbi

@@ -112,6 +112,7 @@ module Dodopayments
           brand_id: String,
           created_at_gte: Time,
           created_at_lte: Time,
+          currency: Dodopayments::PaymentListParams::Currency::OrSymbol,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,
@@ -132,9 +133,12 @@ module Dodopayments
         created_at_gte: nil,
         # Get events created before this time
         created_at_lte: nil,
+        # Filter by currency
+        currency: nil,
         # Filter by customer id
         customer_id: nil,
-        # Page number default is 0
+        # Page number default is 0. Capped to bound OFFSET-based deep pagination, which
+        # forces Postgres to scan and discard every preceding row.
         page_number: nil,
         # Page size default is 10 max is 100
         page_size: nil,

data/rbi/dodopayments/resources/webhooks.rbi

@@ -173,6 +173,11 @@ module Dodopayments
             Dodopayments::PaymentFailedWebhookEvent,
             Dodopayments::PaymentProcessingWebhookEvent,
             Dodopayments::PaymentSucceededWebhookEvent,
+            Dodopayments::PayoutCreatedWebhookEvent,
+            Dodopayments::PayoutFailedWebhookEvent,
+            Dodopayments::PayoutInProgressWebhookEvent,
+            Dodopayments::PayoutOnHoldWebhookEvent,
+            Dodopayments::PayoutSuccessWebhookEvent,
             Dodopayments::RefundFailedWebhookEvent,
             Dodopayments::RefundSucceededWebhookEvent,
             Dodopayments::SubscriptionActiveWebhookEvent,
@@ -229,6 +234,11 @@ module Dodopayments
             Dodopayments::PaymentFailedWebhookEvent,
             Dodopayments::PaymentProcessingWebhookEvent,
             Dodopayments::PaymentSucceededWebhookEvent,
+            Dodopayments::PayoutCreatedWebhookEvent,
+            Dodopayments::PayoutFailedWebhookEvent,
+            Dodopayments::PayoutInProgressWebhookEvent,
+            Dodopayments::PayoutOnHoldWebhookEvent,
+            Dodopayments::PayoutSuccessWebhookEvent,
             Dodopayments::RefundFailedWebhookEvent,
             Dodopayments::RefundSucceededWebhookEvent,
             Dodopayments::SubscriptionActiveWebhookEvent,

data/sig/dodopayments/models/checkout_session_preview_response.rbs

@@ -13,7 +13,9 @@ module Dodopayments
         tax_id_business_name: String?,
         tax_id_err_msg: String?,
         tax_id_format_name: String?,
-        total_tax: Integer?
+        total_tax: Integer?,
+        trial_amount: Integer?,
+        trial_period_days: Integer?
       }
 
     class CheckoutSessionPreviewResponse < Dodopayments::Internal::Type::BaseModel
@@ -41,6 +43,10 @@ module Dodopayments
 
       attr_accessor total_tax: Integer?
 
+      attr_accessor trial_amount: Integer?
+
+      attr_accessor trial_period_days: Integer?
+
       def initialize: (
         billing_country: Dodopayments::Models::country_code,
         currency: Dodopayments::Models::currency,
@@ -53,7 +59,9 @@ module Dodopayments
         ?tax_id_business_name: String?,
         ?tax_id_err_msg: String?,
         ?tax_id_format_name: String?,
-        ?total_tax: Integer?
+        ?total_tax: Integer?,
+        ?trial_amount: Integer?,
+        ?trial_period_days: Integer?
       ) -> void
 
       def to_hash: -> {
@@ -68,7 +76,9 @@ module Dodopayments
         tax_id_business_name: String?,
         tax_id_err_msg: String?,
         tax_id_format_name: String?,
-        total_tax: Integer?
+        total_tax: Integer?,
+        trial_amount: Integer?,
+        trial_period_days: Integer?
       }
 
       type current_breakup =

data/sig/dodopayments/models/discount.rbs

@@ -6,14 +6,18 @@ module Dodopayments
         business_id: String,
         code: String,
         created_at: Time,
+        customer_eligibility: Dodopayments::Models::Discount::customer_eligibility,
         discount_id: String,
         metadata: Dodopayments::Models::metadata,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
         times_used: Integer,
         type: Dodopayments::Models::discount_type,
+        currency_options: ::Array[Dodopayments::Discount::CurrencyOption],
         expires_at: Time?,
         name: String?,
+        per_customer_usage_limit: Integer?,
+        starts_at: Time?,
         subscription_cycles: Integer?,
         usage_limit: Integer?
       }
@@ -27,6 +31,8 @@ module Dodopayments
 
       attr_accessor created_at: Time
 
+      attr_accessor customer_eligibility: Dodopayments::Models::Discount::customer_eligibility
+
       attr_accessor discount_id: String
 
       attr_accessor metadata: Dodopayments::Models::metadata
@@ -39,10 +45,20 @@ module Dodopayments
 
       attr_accessor type: Dodopayments::Models::discount_type
 
+      attr_reader currency_options: ::Array[Dodopayments::Discount::CurrencyOption]?
+
+      def currency_options=: (
+        ::Array[Dodopayments::Discount::CurrencyOption]
+      ) -> ::Array[Dodopayments::Discount::CurrencyOption]
+
       attr_accessor expires_at: Time?
 
       attr_accessor name: String?
 
+      attr_accessor per_customer_usage_limit: Integer?
+
+      attr_accessor starts_at: Time?
+
       attr_accessor subscription_cycles: Integer?
 
       attr_accessor usage_limit: Integer?
@@ -52,14 +68,18 @@ module Dodopayments
         business_id: String,
         code: String,
         created_at: Time,
+        customer_eligibility: Dodopayments::Models::Discount::customer_eligibility,
         discount_id: String,
         metadata: Dodopayments::Models::metadata,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
         times_used: Integer,
         type: Dodopayments::Models::discount_type,
+        ?currency_options: ::Array[Dodopayments::Discount::CurrencyOption],
         ?expires_at: Time?,
         ?name: String?,
+        ?per_customer_usage_limit: Integer?,
+        ?starts_at: Time?,
         ?subscription_cycles: Integer?,
         ?usage_limit: Integer?
       ) -> void
@@ -69,17 +89,66 @@ module Dodopayments
         business_id: String,
         code: String,
         created_at: Time,
+        customer_eligibility: Dodopayments::Models::Discount::customer_eligibility,
         discount_id: String,
         metadata: Dodopayments::Models::metadata,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String],
         times_used: Integer,
         type: Dodopayments::Models::discount_type,
+        currency_options: ::Array[Dodopayments::Discount::CurrencyOption],
         expires_at: Time?,
         name: String?,
+        per_customer_usage_limit: Integer?,
+        starts_at: Time?,
         subscription_cycles: Integer?,
         usage_limit: Integer?
       }
+
+      type customer_eligibility = :any | :first_time | :existing | :specific
+
+      module CustomerEligibility
+        extend Dodopayments::Internal::Type::Enum
+
+        ANY: :any
+        FIRST_TIME: :first_time
+        EXISTING: :existing
+        SPECIFIC: :specific
+
+        def self?.values: -> ::Array[Dodopayments::Models::Discount::customer_eligibility]
+      end
+
+      type currency_option =
+        {
+          currency: Dodopayments::Models::currency,
+          is_default: bool,
+          minimum_subtotal: Integer,
+          max_amount_possible: Integer?
+        }
+
+      class CurrencyOption < Dodopayments::Internal::Type::BaseModel
+        attr_accessor currency: Dodopayments::Models::currency
+
+        attr_accessor is_default: bool
+
+        attr_accessor minimum_subtotal: Integer
+
+        attr_accessor max_amount_possible: Integer?
+
+        def initialize: (
+          currency: Dodopayments::Models::currency,
+          is_default: bool,
+          minimum_subtotal: Integer,
+          ?max_amount_possible: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          currency: Dodopayments::Models::currency,
+          is_default: bool,
+          minimum_subtotal: Integer,
+          max_amount_possible: Integer?
+        }
+      end
     end
   end
 end