dodopayments 2.32.2 → 2.34.0

data/lib/dodopayments/models/price.rb

@@ -122,14 +122,16 @@ module Dodopayments
         required :currency, enum: -> { Dodopayments::Currency }
 
         # @!attribute payment_frequency_count
-        #   Number of units for the payment frequency. For example, a value of `1` with a
-        #   `payment_frequency_interval` of `month` represents monthly payments.
+        #   Number of `payment_frequency_interval` units between two charges. This field
+        #   sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+        #   `month` charges the customer every month.
         #
         #   @return [Integer]
         required :payment_frequency_count, Integer
 
         # @!attribute payment_frequency_interval
-        #   The time interval for the payment frequency (e.g., day, month, year).
+        #   The time unit of the billing cycle (e.g., day, month, year). Use it with
+        #   `payment_frequency_count`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }
@@ -142,14 +144,30 @@ module Dodopayments
         required :price, Integer
 
         # @!attribute subscription_period_count
-        #   Number of units for the subscription period. For example, a value of `12` with a
-        #   `subscription_period_interval` of `month` represents a one-year subscription.
+        #   Number of `subscription_period_interval` units for the total duration of the
+        #   subscription. This field does not set the billing cycle. Use
+        #   `payment_frequency_count` for the billing cycle. When this period ends, the
+        #   subscription expires. Dodo Payments does not start a new billing cycle after the
+        #   subscription expires. Dodo Payments can still retry a failed payment for an
+        #   earlier billing cycle.
+        #
+        #   For a subscription that renews until the customer cancels it, set this to `20`
+        #   with a `subscription_period_interval` of `year`. This is the recommended value
+        #   and also the maximum. The subscription expires after 20 years if the customer
+        #   does not cancel it before then.
+        #
+        #   For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+        #   `payment_frequency_interval` of `month`, and a subscription period of `20`
+        #   `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+        #   the subscription then expires after one month.
         #
         #   @return [Integer]
         required :subscription_period_count, Integer
 
         # @!attribute subscription_period_interval
-        #   The time interval for the subscription period (e.g., day, month, year).
+        #   The time unit of the total subscription duration (e.g., day, month, year). Use
+        #   it with `subscription_period_count`. The recommended value is `year`, with a
+        #   `subscription_period_count` of `20`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }
@@ -235,15 +253,15 @@ module Dodopayments
         #
         #   @param currency [Symbol, Dodopayments::Models::Currency] The currency in which the payment is made.
         #
-        #   @param payment_frequency_count [Integer] Number of units for the payment frequency.
+        #   @param payment_frequency_count [Integer] Number of `payment_frequency_interval` units between two charges.
         #
-        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the payment frequency (e.g., day, month, year).
+        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the billing cycle (e.g., day, month, year).
         #
         #   @param price [Integer] The payment amount. Represented in the lowest denomination of the currency (e.g.
         #
-        #   @param subscription_period_count [Integer] Number of units for the subscription period.
+        #   @param subscription_period_count [Integer] Number of `subscription_period_interval` units for the total duration of the sub
         #
-        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
+        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the total subscription duration (e.g., day, month, year).
         #
         #   @param discount [Integer] Deprecated: use `discount_bps` instead.
         #
@@ -281,27 +299,45 @@ module Dodopayments
         required :fixed_price, Integer
 
         # @!attribute payment_frequency_count
-        #   Number of units for the payment frequency. For example, a value of `1` with a
-        #   `payment_frequency_interval` of `month` represents monthly payments.
+        #   Number of `payment_frequency_interval` units between two charges. This field
+        #   sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+        #   `month` charges the customer every month.
         #
         #   @return [Integer]
         required :payment_frequency_count, Integer
 
         # @!attribute payment_frequency_interval
-        #   The time interval for the payment frequency (e.g., day, month, year).
+        #   The time unit of the billing cycle (e.g., day, month, year). Use it with
+        #   `payment_frequency_count`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }
 
         # @!attribute subscription_period_count
-        #   Number of units for the subscription period. For example, a value of `12` with a
-        #   `subscription_period_interval` of `month` represents a one-year subscription.
+        #   Number of `subscription_period_interval` units for the total duration of the
+        #   subscription. This field does not set the billing cycle. Use
+        #   `payment_frequency_count` for the billing cycle. When this period ends, the
+        #   subscription expires. Dodo Payments does not start a new billing cycle after the
+        #   subscription expires. Dodo Payments can still retry a failed payment for an
+        #   earlier billing cycle.
+        #
+        #   For a subscription that renews until the customer cancels it, set this to `20`
+        #   with a `subscription_period_interval` of `year`. This is the recommended value
+        #   and also the maximum. The subscription expires after 20 years if the customer
+        #   does not cancel it before then.
+        #
+        #   For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+        #   `payment_frequency_interval` of `month`, and a subscription period of `20`
+        #   `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+        #   the subscription then expires after one month.
         #
         #   @return [Integer]
         required :subscription_period_count, Integer
 
         # @!attribute subscription_period_interval
-        #   The time interval for the subscription period (e.g., day, month, year).
+        #   The time unit of the total subscription duration (e.g., day, month, year). Use
+        #   it with `subscription_period_count`. The recommended value is `year`, with a
+        #   `subscription_period_count` of `20`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }
@@ -366,13 +402,13 @@ module Dodopayments
         #
         #   @param fixed_price [Integer] The fixed payment amount. Represented in the lowest denomination of the currency
         #
-        #   @param payment_frequency_count [Integer] Number of units for the payment frequency.
+        #   @param payment_frequency_count [Integer] Number of `payment_frequency_interval` units between two charges.
         #
-        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the payment frequency (e.g., day, month, year).
+        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the billing cycle (e.g., day, month, year).
         #
-        #   @param subscription_period_count [Integer] Number of units for the subscription period.
+        #   @param subscription_period_count [Integer] Number of `subscription_period_interval` units for the total duration of the sub
         #
-        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
+        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the total subscription duration (e.g., day, month, year).
         #
         #   @param discount [Integer] Deprecated: use `discount_bps` instead.
         #

data/lib/dodopayments/models/product_collection.rb

@@ -179,6 +179,7 @@ module Dodopayments
         FULL_IMMEDIATELY = :full_immediately
         DIFFERENCE_IMMEDIATELY = :difference_immediately
         DO_NOT_BILL = :do_not_bill
+        PRORATED_IMMEDIATELY_KEEP_CYCLE = :prorated_immediately_keep_cycle
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -195,6 +196,7 @@ module Dodopayments
         FULL_IMMEDIATELY = :full_immediately
         DIFFERENCE_IMMEDIATELY = :difference_immediately
         DO_NOT_BILL = :do_not_bill
+        PRORATED_IMMEDIATELY_KEEP_CYCLE = :prorated_immediately_keep_cycle
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/dodopayments/models/product_collection_create_params.rb

@@ -146,6 +146,7 @@ module Dodopayments
         FULL_IMMEDIATELY = :full_immediately
         DIFFERENCE_IMMEDIATELY = :difference_immediately
         DO_NOT_BILL = :do_not_bill
+        PRORATED_IMMEDIATELY_KEEP_CYCLE = :prorated_immediately_keep_cycle
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -160,6 +161,7 @@ module Dodopayments
         FULL_IMMEDIATELY = :full_immediately
         DIFFERENCE_IMMEDIATELY = :difference_immediately
         DO_NOT_BILL = :do_not_bill
+        PRORATED_IMMEDIATELY_KEEP_CYCLE = :prorated_immediately_keep_cycle
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/dodopayments/models/product_collection_update_params.rb

@@ -160,6 +160,7 @@ module Dodopayments
         FULL_IMMEDIATELY = :full_immediately
         DIFFERENCE_IMMEDIATELY = :difference_immediately
         DO_NOT_BILL = :do_not_bill
+        PRORATED_IMMEDIATELY_KEEP_CYCLE = :prorated_immediately_keep_cycle
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -174,6 +175,7 @@ module Dodopayments
         FULL_IMMEDIATELY = :full_immediately
         DIFFERENCE_IMMEDIATELY = :difference_immediately
         DO_NOT_BILL = :do_not_bill
+        PRORATED_IMMEDIATELY_KEEP_CYCLE = :prorated_immediately_keep_cycle
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/dodopayments/models/product_collections/group_update_params.rb

@@ -20,7 +20,8 @@ module Dodopayments
 
         # @!attribute group_name
         #   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.
         #
         #   @return [String, nil]
         optional :group_name, String, nil?: true

data/lib/dodopayments/models/refund.rb

@@ -84,13 +84,21 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil]
       optional :network_reference_type, enum: -> { Dodopayments::RefundNetworkReferenceType }, nil?: true
 
+      # @!attribute network_reference_updated_at
+      #   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.
+      #
+      #   @return [Time, nil]
+      optional :network_reference_updated_at, Time, nil?: true
+
       # @!attribute reason
       #   The reason provided for the refund, if any. Optional.
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(brand_id:, business_id:, created_at:, customer:, is_partial:, metadata:, payment_id:, refund_id:, status:, amount: nil, currency: nil, network_reference: nil, network_reference_type: nil, reason: nil)
+      # @!method initialize(brand_id:, business_id:, created_at:, customer:, is_partial:, metadata:, payment_id:, refund_id:, status:, amount: nil, currency: nil, network_reference: nil, network_reference_type: nil, network_reference_updated_at: nil, reason: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Refund} for more details.
       #
@@ -120,6 +128,8 @@ module Dodopayments
       #
       #   @param network_reference_type [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil] The kind of `network_reference`: ARN, STAN or RRN.
       #
+      #   @param network_reference_updated_at [Time, nil] The time in UTC when `network_reference` became available. It is null when the
+      #
       #   @param reason [String, nil] The reason provided for the refund, if any. Optional.
     end
   end

data/lib/dodopayments/models/refund_list_item.rb

@@ -65,13 +65,21 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil]
       optional :network_reference_type, enum: -> { Dodopayments::RefundNetworkReferenceType }, nil?: true
 
+      # @!attribute network_reference_updated_at
+      #   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.
+      #
+      #   @return [Time, nil]
+      optional :network_reference_updated_at, Time, nil?: true
+
       # @!attribute reason
       #   The reason provided for the refund, if any. Optional.
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(business_id:, created_at:, is_partial:, payment_id:, refund_id:, status:, amount: nil, currency: nil, network_reference: nil, network_reference_type: nil, reason: nil)
+      # @!method initialize(business_id:, created_at:, is_partial:, payment_id:, refund_id:, status:, amount: nil, currency: nil, network_reference: nil, network_reference_type: nil, network_reference_updated_at: nil, reason: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::RefundListItem} for more details.
       #
@@ -95,6 +103,8 @@ module Dodopayments
       #
       #   @param network_reference_type [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil] The kind of `network_reference`: ARN, STAN or RRN.
       #
+      #   @param network_reference_updated_at [Time, nil] The time in UTC when `network_reference` became available. It is null when the
+      #
       #   @param reason [String, nil] The reason provided for the refund, if any. Optional.
     end
   end

data/lib/dodopayments/models/subscription_active_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionActiveWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_cancelled_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionCancelledWebhookEvent::Data} for more
         #   details.
@@ -63,6 +70,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_expired_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionExpiredWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_failed_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionFailedWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_on_hold_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionOnHoldWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_past_due_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionPastDueWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_paused_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionPausedWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_plan_changed_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionPlanChangedWebhookEvent::Data} for more
         #   details.
@@ -63,6 +70,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_renewed_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionRenewedWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_service_period.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class SubscriptionServicePeriod < Dodopayments::Internal::Type::BaseModel
+      # @!attribute ends_at
+      #   End of the service period.
+      #
+      #   @return [Time]
+      required :ends_at, Time
+
+      # @!attribute proration_factor
+      #   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.
+      #
+      #   @return [String]
+      required :proration_factor, String
+
+      # @!attribute starts_at
+      #   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.
+      #
+      #   @return [Time]
+      required :starts_at, Time
+
+      # @!attribute subscription_id
+      #   Identifier of the subscription.
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(ends_at:, proration_factor:, starts_at:, subscription_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionServicePeriod} for more details.
+      #
+      #   The service period that a payment pays for, for one subscription.
+      #
+      #   @param ends_at [Time] End of the service period.
+      #
+      #   @param proration_factor [String] The part of one full billing period that the plan charge pays for. The value
+      #
+      #   @param starts_at [Time] Start of the service period. For a renewal, this is the billing date. For a
+      #
+      #   @param subscription_id [String] Identifier of the subscription.
+    end
+  end
+end

data/lib/dodopayments/models/subscription_unpaused_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionUnpausedWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_update_payment_method_webhook_event.rb

@@ -55,7 +55,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent::Data} for
         #   more details.
@@ -64,6 +71,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/subscription_updated_webhook_event.rb

@@ -54,7 +54,14 @@ module Dodopayments
         #   @return [Time, nil]
         optional :past_due_ends_at, Time, nil?: true
 
-        # @!method initialize(past_due_ends_at: nil)
+        # @!attribute payment_id
+        #   Identifier of the payment that caused this event. It is set only for
+        #   `subscription.renewed`. It is null for all other subscription events.
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil, payment_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionUpdatedWebhookEvent::Data} for more details.
         #
@@ -62,6 +69,8 @@ module Dodopayments
         #   `SubscriptionResponse`, plus the grace-period deadline.
         #
         #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+        #
+        #   @param payment_id [String, nil] Identifier of the payment that caused this event.
       end
     end
   end

data/lib/dodopayments/models/update_subscription_plan_req.rb

@@ -190,6 +190,7 @@ module Dodopayments
         FULL_IMMEDIATELY = :full_immediately
         DIFFERENCE_IMMEDIATELY = :difference_immediately
         DO_NOT_BILL = :do_not_bill
+        PRORATED_IMMEDIATELY_KEEP_CYCLE = :prorated_immediately_keep_cycle
 
         # @!method self.values
         #   @return [Array<Symbol>]