dodopayments 2.20.1 → 2.21.0

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,6 +133,8 @@ 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

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

data/sig/dodopayments/models/discount_create_params.rbs

@@ -5,11 +5,15 @@ module Dodopayments
         amount: Integer,
         type: Dodopayments::Models::discount_type,
         code: String?,
+        currency_options: ::Array[Dodopayments::DiscountCreateParams::CurrencyOption]?,
+        customer_eligibility: Dodopayments::Models::DiscountCreateParams::customer_eligibility?,
         expires_at: Time?,
         metadata: Dodopayments::Models::metadata,
         name: String?,
+        per_customer_usage_limit: Integer?,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String]?,
+        starts_at: Time?,
         subscription_cycles: Integer?,
         usage_limit: Integer?
       }
@@ -25,6 +29,10 @@ module Dodopayments
 
       attr_accessor code: String?
 
+      attr_accessor currency_options: ::Array[Dodopayments::DiscountCreateParams::CurrencyOption]?
+
+      attr_accessor customer_eligibility: Dodopayments::Models::DiscountCreateParams::customer_eligibility?
+
       attr_accessor expires_at: Time?
 
       attr_reader metadata: Dodopayments::Models::metadata?
@@ -35,12 +43,16 @@ module Dodopayments
 
       attr_accessor name: String?
 
+      attr_accessor per_customer_usage_limit: Integer?
+
       attr_reader preserve_on_plan_change: bool?
 
       def preserve_on_plan_change=: (bool) -> bool
 
       attr_accessor restricted_to: ::Array[String]?
 
+      attr_accessor starts_at: Time?
+
       attr_accessor subscription_cycles: Integer?
 
       attr_accessor usage_limit: Integer?
@@ -49,11 +61,15 @@ module Dodopayments
         amount: Integer,
         type: Dodopayments::Models::discount_type,
         ?code: String?,
+        ?currency_options: ::Array[Dodopayments::DiscountCreateParams::CurrencyOption]?,
+        ?customer_eligibility: Dodopayments::Models::DiscountCreateParams::customer_eligibility?,
         ?expires_at: Time?,
         ?metadata: Dodopayments::Models::metadata,
         ?name: String?,
+        ?per_customer_usage_limit: Integer?,
         ?preserve_on_plan_change: bool,
         ?restricted_to: ::Array[String]?,
+        ?starts_at: Time?,
         ?subscription_cycles: Integer?,
         ?usage_limit: Integer?,
         ?request_options: Dodopayments::request_opts
@@ -63,15 +79,68 @@ module Dodopayments
         amount: Integer,
         type: Dodopayments::Models::discount_type,
         code: String?,
+        currency_options: ::Array[Dodopayments::DiscountCreateParams::CurrencyOption]?,
+        customer_eligibility: Dodopayments::Models::DiscountCreateParams::customer_eligibility?,
         expires_at: Time?,
         metadata: Dodopayments::Models::metadata,
         name: String?,
+        per_customer_usage_limit: Integer?,
         preserve_on_plan_change: bool,
         restricted_to: ::Array[String]?,
+        starts_at: Time?,
         subscription_cycles: Integer?,
         usage_limit: Integer?,
         request_options: Dodopayments::RequestOptions
       }
+
+      type currency_option =
+        {
+          currency: Dodopayments::Models::currency,
+          is_default: bool,
+          max_amount_possible: Integer?,
+          minimum_subtotal: Integer
+        }
+
+      class CurrencyOption < Dodopayments::Internal::Type::BaseModel
+        attr_accessor currency: Dodopayments::Models::currency
+
+        attr_reader is_default: bool?
+
+        def is_default=: (bool) -> bool
+
+        attr_accessor max_amount_possible: Integer?
+
+        attr_reader minimum_subtotal: Integer?
+
+        def minimum_subtotal=: (Integer) -> Integer
+
+        def initialize: (
+          currency: Dodopayments::Models::currency,
+          ?is_default: bool,
+          ?max_amount_possible: Integer?,
+          ?minimum_subtotal: Integer
+        ) -> void
+
+        def to_hash: -> {
+          currency: Dodopayments::Models::currency,
+          is_default: bool,
+          max_amount_possible: Integer?,
+          minimum_subtotal: Integer
+        }
+      end
+
+      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::DiscountCreateParams::customer_eligibility]
+      end
     end
   end
 end

data/sig/dodopayments/models/discount_type.rbs

@@ -1,10 +1,11 @@
 module Dodopayments
   module Models
-    type discount_type = :percentage
+    type discount_type = :flat | :percentage
 
     module DiscountType
       extend Dodopayments::Internal::Type::Enum
 
+      FLAT: :flat
       PERCENTAGE: :percentage
 
       def self?.values: -> ::Array[Dodopayments::Models::discount_type]

data/sig/dodopayments/models/discount_update_params.rbs

@@ -5,11 +5,15 @@ module Dodopayments
         discount_id: String,
         amount: Integer?,
         code: String?,
+        currency_options: ::Array[Dodopayments::DiscountUpdateParams::CurrencyOption]?,
+        customer_eligibility: Dodopayments::Models::DiscountUpdateParams::customer_eligibility?,
         expires_at: Time?,
         metadata: Dodopayments::Models::metadata?,
         name: String?,
+        per_customer_usage_limit: Integer?,
         preserve_on_plan_change: bool?,
         restricted_to: ::Array[String]?,
+        starts_at: Time?,
         subscription_cycles: Integer?,
         type: Dodopayments::Models::discount_type?,
         usage_limit: Integer?
@@ -26,16 +30,24 @@ module Dodopayments
 
       attr_accessor code: String?
 
+      attr_accessor currency_options: ::Array[Dodopayments::DiscountUpdateParams::CurrencyOption]?
+
+      attr_accessor customer_eligibility: Dodopayments::Models::DiscountUpdateParams::customer_eligibility?
+
       attr_accessor expires_at: Time?
 
       attr_accessor metadata: Dodopayments::Models::metadata?
 
       attr_accessor name: String?
 
+      attr_accessor per_customer_usage_limit: Integer?
+
       attr_accessor preserve_on_plan_change: bool?
 
       attr_accessor restricted_to: ::Array[String]?
 
+      attr_accessor starts_at: Time?
+
       attr_accessor subscription_cycles: Integer?
 
       attr_accessor type: Dodopayments::Models::discount_type?
@@ -46,11 +58,15 @@ module Dodopayments
         discount_id: String,
         ?amount: Integer?,
         ?code: String?,
+        ?currency_options: ::Array[Dodopayments::DiscountUpdateParams::CurrencyOption]?,
+        ?customer_eligibility: Dodopayments::Models::DiscountUpdateParams::customer_eligibility?,
         ?expires_at: Time?,
         ?metadata: Dodopayments::Models::metadata?,
         ?name: String?,
+        ?per_customer_usage_limit: Integer?,
         ?preserve_on_plan_change: bool?,
         ?restricted_to: ::Array[String]?,
+        ?starts_at: Time?,
         ?subscription_cycles: Integer?,
         ?type: Dodopayments::Models::discount_type?,
         ?usage_limit: Integer?,
@@ -61,16 +77,69 @@ module Dodopayments
         discount_id: String,
         amount: Integer?,
         code: String?,
+        currency_options: ::Array[Dodopayments::DiscountUpdateParams::CurrencyOption]?,
+        customer_eligibility: Dodopayments::Models::DiscountUpdateParams::customer_eligibility?,
         expires_at: Time?,
         metadata: Dodopayments::Models::metadata?,
         name: String?,
+        per_customer_usage_limit: Integer?,
         preserve_on_plan_change: bool?,
         restricted_to: ::Array[String]?,
+        starts_at: Time?,
         subscription_cycles: Integer?,
         type: Dodopayments::Models::discount_type?,
         usage_limit: Integer?,
         request_options: Dodopayments::RequestOptions
       }
+
+      type currency_option =
+        {
+          currency: Dodopayments::Models::currency,
+          is_default: bool,
+          max_amount_possible: Integer?,
+          minimum_subtotal: Integer
+        }
+
+      class CurrencyOption < Dodopayments::Internal::Type::BaseModel
+        attr_accessor currency: Dodopayments::Models::currency
+
+        attr_reader is_default: bool?
+
+        def is_default=: (bool) -> bool
+
+        attr_accessor max_amount_possible: Integer?
+
+        attr_reader minimum_subtotal: Integer?
+
+        def minimum_subtotal=: (Integer) -> Integer
+
+        def initialize: (
+          currency: Dodopayments::Models::currency,
+          ?is_default: bool,
+          ?max_amount_possible: Integer?,
+          ?minimum_subtotal: Integer
+        ) -> void
+
+        def to_hash: -> {
+          currency: Dodopayments::Models::currency,
+          is_default: bool,
+          max_amount_possible: Integer?,
+          minimum_subtotal: Integer
+        }
+      end
+
+      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::DiscountUpdateParams::customer_eligibility]
+      end
     end
   end
 end