dodopayments 2.32.2 → 2.34.0

data/rbi/dodopayments/models/product_collection_update_params.rbi

@@ -332,6 +332,11 @@ module Dodopayments
             :do_not_bill,
             Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnDowngrade::TaggedSymbol
           )
+        PRORATED_IMMEDIATELY_KEEP_CYCLE =
+          T.let(
+            :prorated_immediately_keep_cycle,
+            Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -378,6 +383,11 @@ module Dodopayments
             :do_not_bill,
             Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnUpgrade::TaggedSymbol
           )
+        PRORATED_IMMEDIATELY_KEEP_CYCLE =
+          T.let(
+            :prorated_immediately_keep_cycle,
+            Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/product_collections/group_update_params.rbi

@@ -22,7 +22,8 @@ module Dodopayments
         attr_accessor :group_id
 
         # Optional group name update: Some(Some(name)) = set name, Some(None) = clear
-        # name, None = no change
+        # name, None = no change The API returns 422 if another group in the collection
+        # has no name.
         sig { returns(T.nilable(String)) }
         attr_accessor :group_name
 
@@ -49,7 +50,8 @@ module Dodopayments
           id:,
           group_id:,
           # Optional group name update: Some(Some(name)) = set name, Some(None) = clear
-          # name, None = no change
+          # name, None = no change The API returns 422 if another group in the collection
+          # has no name.
           group_name: nil,
           # Optional new order for products in this group (array of
           # product_collection_group_pdts UUIDs)

data/rbi/dodopayments/models/refund.rbi

@@ -71,6 +71,12 @@ module Dodopayments
       end
       attr_accessor :network_reference_type
 
+      # The time in UTC when `network_reference` became available. It is null when the
+      # reference is not available, or when it became available before this field
+      # existed.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :network_reference_updated_at
+
       # The reason provided for the refund, if any. Optional.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
@@ -91,6 +97,7 @@ module Dodopayments
           network_reference: T.nilable(String),
           network_reference_type:
             T.nilable(Dodopayments::RefundNetworkReferenceType::OrSymbol),
+          network_reference_updated_at: T.nilable(Time),
           reason: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -123,6 +130,10 @@ module Dodopayments
         network_reference: nil,
         # The kind of `network_reference`: ARN, STAN or RRN.
         network_reference_type: nil,
+        # The time in UTC when `network_reference` became available. It is null when the
+        # reference is not available, or when it became available before this field
+        # existed.
+        network_reference_updated_at: nil,
         # The reason provided for the refund, if any. Optional.
         reason: nil
       )
@@ -145,6 +156,7 @@ module Dodopayments
             network_reference: T.nilable(String),
             network_reference_type:
               T.nilable(Dodopayments::RefundNetworkReferenceType::TaggedSymbol),
+            network_reference_updated_at: T.nilable(Time),
             reason: T.nilable(String)
           }
         )

data/rbi/dodopayments/models/refund_list_item.rbi

@@ -54,6 +54,12 @@ module Dodopayments
       end
       attr_accessor :network_reference_type
 
+      # The time in UTC when `network_reference` became available. It is null when the
+      # reference is not available, or when it became available before this field
+      # existed.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :network_reference_updated_at
+
       # The reason provided for the refund, if any. Optional.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
@@ -71,6 +77,7 @@ module Dodopayments
           network_reference: T.nilable(String),
           network_reference_type:
             T.nilable(Dodopayments::RefundNetworkReferenceType::OrSymbol),
+          network_reference_updated_at: T.nilable(Time),
           reason: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -97,6 +104,10 @@ module Dodopayments
         network_reference: nil,
         # The kind of `network_reference`: ARN, STAN or RRN.
         network_reference_type: nil,
+        # The time in UTC when `network_reference` became available. It is null when the
+        # reference is not available, or when it became available before this field
+        # existed.
+        network_reference_updated_at: nil,
         # The reason provided for the refund, if any. Optional.
         reason: nil
       )
@@ -116,6 +127,7 @@ module Dodopayments
             network_reference: T.nilable(String),
             network_reference_type:
               T.nilable(Dodopayments::RefundNetworkReferenceType::TaggedSymbol),
+            network_reference_updated_at: T.nilable(Time),
             reason: T.nilable(String)
           }
         )

data/rbi/dodopayments/models/subscription_active_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_cancelled_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_expired_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_failed_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_on_hold_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_past_due_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_paused_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_plan_changed_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_renewed_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_service_period.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionServicePeriod < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::SubscriptionServicePeriod,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # End of the service period.
+      sig { returns(Time) }
+      attr_accessor :ends_at
+
+      # The part of one full billing period that the plan charge pays for. The value
+      # `"1"` is a full period. A value less than 1 is a partial period, for example
+      # after a plan change that keeps the billing cycle. For a plan change, this is the
+      # value of the new plan. The credit for the old plan is not in this value.
+      sig { returns(String) }
+      attr_accessor :proration_factor
+
+      # Start of the service period. For a renewal, this is the billing date. For a plan
+      # change that applies at the next billing date, this is the time when the change
+      # applied. This time can be some minutes after the billing date.
+      sig { returns(Time) }
+      attr_accessor :starts_at
+
+      # Identifier of the subscription.
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
+      # The service period that a payment pays for, for one subscription.
+      sig do
+        params(
+          ends_at: Time,
+          proration_factor: String,
+          starts_at: Time,
+          subscription_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # End of the service period.
+        ends_at:,
+        # The part of one full billing period that the plan charge pays for. The value
+        # `"1"` is a full period. A value less than 1 is a partial period, for example
+        # after a plan change that keeps the billing cycle. For a plan change, this is the
+        # value of the new plan. The credit for the old plan is not in this value.
+        proration_factor:,
+        # Start of the service period. For a renewal, this is the billing date. For a plan
+        # change that applies at the next billing date, this is the time when the change
+        # applied. This time can be some minutes after the billing date.
+        starts_at:,
+        # Identifier of the subscription.
+        subscription_id:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            ends_at: Time,
+            proration_factor: String,
+            starts_at: Time,
+            subscription_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_unpaused_webhook_event.rbi

@@ -88,10 +88,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -101,11 +109,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end

data/rbi/dodopayments/models/subscription_update_payment_method_webhook_event.rbi

@@ -93,10 +93,18 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :past_due_ends_at
 
+        # Identifier of the payment that caused this event. It is set only for
+        # `subscription.renewed`. It is null for all other subscription events.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
         # Subscription payload sent on a webhook. It carries every field of
         # `SubscriptionResponse`, plus the grace-period deadline.
         sig do
-          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+          params(
+            past_due_ends_at: T.nilable(Time),
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Time when the grace period ends. The subscription moves to `on_hold` or to
@@ -106,11 +114,18 @@ module Dodopayments
           # row snapshot that produced `status`. It is set whenever the subscription sits in
           # a window at that moment. A delayed event of another type therefore carries the
           # deadline too, next to a `past_due` status.
-          past_due_ends_at: nil
+          past_due_ends_at: nil,
+          # Identifier of the payment that caused this event. It is set only for
+          # `subscription.renewed`. It is null for all other subscription events.
+          payment_id: nil
         )
         end
 
-        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        sig do
+          override.returns(
+            { past_due_ends_at: T.nilable(Time), payment_id: T.nilable(String) }
+          )
+        end
         def to_hash
         end
       end