dodopayments 2.20.0 → 2.21.0

data/lib/dodopayments/models/subscription_list_params.rb

@@ -13,6 +13,12 @@ module Dodopayments
       #   @return [String, nil]
       optional :brand_id, String
 
+      # @!attribute cancel_at_next_billing_date
+      #   Filter by cancel_at_next_billing_date (subscriptions scheduled for cancellation)
+      #
+      #   @return [Boolean, nil]
+      optional :cancel_at_next_billing_date, Dodopayments::Internal::Type::Boolean
+
       # @!attribute created_at_gte
       #   Get events after this created time
       #
@@ -55,9 +61,14 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::SubscriptionListParams::Status, nil]
       optional :status, enum: -> { Dodopayments::SubscriptionListParams::Status }
 
-      # @!method initialize(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, request_options: {})
+      # @!method initialize(brand_id: nil, cancel_at_next_billing_date: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionListParams} for more details.
+      #
       #   @param brand_id [String] filter by Brand id
       #
+      #   @param cancel_at_next_billing_date [Boolean] Filter by cancel_at_next_billing_date (subscriptions scheduled for cancellation)
+      #
       #   @param created_at_gte [Time] Get events after this created time
       #
       #   @param created_at_lte [Time] Get events created before this time

data/lib/dodopayments/models/subscription_list_response.rb

@@ -182,7 +182,15 @@ module Dodopayments
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, discounts:, metadata:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, payment_method_id: nil, product_name: nil, scheduled_change: nil, tax_id: nil)
+      # @!attribute trial_amount
+      #   Per-unit trial amount after discounts, snapshotted at subscription creation
+      #   (price currency minor units, pre-quantity, pre-tax). Null for a free trial or no
+      #   trial.
+      #
+      #   @return [Integer, nil]
+      optional :trial_amount, Integer, nil?: true
+
+      # @!method initialize(billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, discounts:, metadata:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, payment_method_id: nil, product_name: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionListResponse} for more details.
       #
@@ -245,6 +253,8 @@ module Dodopayments
       #   @param scheduled_change [Dodopayments::Models::ScheduledPlanChange, nil] Scheduled plan change details, if any
       #
       #   @param tax_id [String, nil] Tax identifier provided for this subscription (if applicable)
+      #
+      #   @param trial_amount [Integer, nil] Per-unit trial amount after discounts, snapshotted at subscription creation
 
       class Discount < Dodopayments::Internal::Type::BaseModel
         # @!attribute discount_id

data/lib/dodopayments/models/subscription_update_payment_method_webhook_event.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class SubscriptionUpdatePaymentMethodWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #   Response struct representing subscription details
+      #
+      #   @return [Dodopayments::Models::Subscription]
+      required :data, -> { Dodopayments::Subscription }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, :"subscription.update_payment_method"]
+      required :type, const: :"subscription.update_payment_method"
+
+      # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.update_payment_method")
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, :"subscription.update_payment_method"] The event type
+    end
+  end
+end

data/lib/dodopayments/models/unsafe_unwrap_webhook_event.rb

@@ -83,10 +83,13 @@ module Dodopayments
 
       variant :"subscription.renewed", -> { Dodopayments::SubscriptionRenewedWebhookEvent }
 
+      variant :"subscription.update_payment_method",
+              -> { Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent }
+
       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::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::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

@@ -83,10 +83,13 @@ module Dodopayments
 
       variant :"subscription.renewed", -> { Dodopayments::SubscriptionRenewedWebhookEvent }
 
+      variant :"subscription.update_payment_method",
+              -> { Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent }
+
       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::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::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

@@ -28,6 +28,7 @@ module Dodopayments
       SUBSCRIPTION_EXPIRED = :"subscription.expired"
       SUBSCRIPTION_PLAN_CHANGED = :"subscription.plan_changed"
       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_ON_HOLD = :"payout.on_hold"

data/lib/dodopayments/models.rb

@@ -478,6 +478,9 @@ module Dodopayments
 
   SubscriptionUpdatePaymentMethodParams = Dodopayments::Models::SubscriptionUpdatePaymentMethodParams
 
+  SubscriptionUpdatePaymentMethodWebhookEvent =
+    Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent
+
   TaxCategory = Dodopayments::Models::TaxCategory
 
   ThemeConfig = Dodopayments::Models::ThemeConfig

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,7 @@ 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: {})
+      # @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,6 +90,8 @@ 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

data/lib/dodopayments/resources/subscriptions.rb

@@ -145,10 +145,15 @@ 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, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::SubscriptionListParams} for more details.
+      #
+      # @overload list(brand_id: nil, cancel_at_next_billing_date: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
       #
       # @param brand_id [String] filter by Brand id
       #
+      # @param cancel_at_next_billing_date [Boolean] Filter by cancel_at_next_billing_date (subscriptions scheduled for cancellation)
+      #
       # @param created_at_gte [Time] Get events after this created time
       #
       # @param created_at_lte [Time] Get events created before this time

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::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::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::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::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.0"
+  VERSION = "2.21.0"
 end

data/lib/dodopayments.rb

@@ -352,6 +352,7 @@ require_relative "dodopayments/models/subscription_updated_webhook_event"
 require_relative "dodopayments/models/subscription_update_params"
 require_relative "dodopayments/models/subscription_update_payment_method_params"
 require_relative "dodopayments/models/subscription_update_payment_method_response"
+require_relative "dodopayments/models/subscription_update_payment_method_webhook_event"
 require_relative "dodopayments/models/tax_category"
 require_relative "dodopayments/models/theme_config"
 require_relative "dodopayments/models/theme_mode_config"

data/rbi/dodopayments/models/checkout_session_preview_response.rbi

@@ -56,6 +56,13 @@ module Dodopayments
       sig { returns(Integer) }
       attr_accessor :total_price
 
+      # The upcoming billing date for subscriptions, computed relative to now: with a
+      # trial it is `now + trial_period_days`, otherwise `now + payment frequency`.
+      # `None` for one-time-only carts. This is a preview estimate; the authoritative
+      # value is set when the subscription activates.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :next_billing_date
+
       # Breakup of recurring payments (None for one-time only)
       sig do
         returns(
@@ -92,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(
@@ -105,6 +123,7 @@ module Dodopayments
               Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::OrHash
             ],
           total_price: Integer,
+          next_billing_date: T.nilable(Time),
           recurring_breakup:
             T.nilable(
               Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup::OrHash
@@ -112,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(
@@ -131,6 +152,11 @@ module Dodopayments
         product_cart:,
         # Total calculate price of the product cart
         total_price:,
+        # The upcoming billing date for subscriptions, computed relative to now: with a
+        # trial it is `now + trial_period_days`, otherwise `now + payment frequency`.
+        # `None` for one-time-only carts. This is a preview estimate; the authoritative
+        # value is set when the subscription activates.
+        next_billing_date: nil,
         # Breakup of recurring payments (None for one-time only)
         recurring_breakup: nil,
         # Registered business name from the official registry (EU/GB/AU) when found
@@ -140,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
 
@@ -157,6 +190,7 @@ module Dodopayments
                 Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart
               ],
             total_price: Integer,
+            next_billing_date: T.nilable(Time),
             recurring_breakup:
               T.nilable(
                 Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup
@@ -164,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
@@ -316,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
 
@@ -393,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,
@@ -605,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
 
@@ -642,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:,