dodopayments 2.25.0 → 2.26.0

data/rbi/dodopayments/models/price.rbi

@@ -40,11 +40,6 @@ module Dodopayments
         sig { returns(Integer) }
         attr_accessor :price
 
-        # Indicates if purchasing power parity adjustments are applied to the price.
-        # Purchasing power parity feature is not available as of now.
-        sig { returns(T::Boolean) }
-        attr_accessor :purchasing_power_parity
-
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -56,6 +51,15 @@ module Dodopayments
         sig { params(pay_what_you_want: T::Boolean).void }
         attr_writer :pay_what_you_want
 
+        # Opts this price in to purchasing power parity. The business must also enable
+        # purchasing power parity. The discount percentage per country is always
+        # business-wide. Defaults to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :purchasing_power_parity
+
+        sig { params(purchasing_power_parity: T::Boolean).void }
+        attr_writer :purchasing_power_parity
+
         # A suggested price for the user to pay. This value is only considered if
         # [`pay_what_you_want`](Self::pay_what_you_want) is `true`. Otherwise, it is
         # ignored.
@@ -72,8 +76,8 @@ module Dodopayments
             currency: Dodopayments::Currency::OrSymbol,
             discount: Integer,
             price: Integer,
-            purchasing_power_parity: T::Boolean,
             pay_what_you_want: T::Boolean,
+            purchasing_power_parity: T::Boolean,
             suggested_price: T.nilable(Integer),
             tax_inclusive: T.nilable(T::Boolean),
             type: Symbol
@@ -90,12 +94,13 @@ module Dodopayments
           # If [`pay_what_you_want`](Self::pay_what_you_want) is set to `true`, this field
           # represents the **minimum** amount the customer must pay.
           price:,
-          # Indicates if purchasing power parity adjustments are applied to the price.
-          # Purchasing power parity feature is not available as of now.
-          purchasing_power_parity:,
           # Indicates whether the customer can pay any amount they choose. If set to `true`,
           # the [`price`](Self::price) field is the minimum amount.
           pay_what_you_want: nil,
+          # Opts this price in to purchasing power parity. The business must also enable
+          # purchasing power parity. The discount percentage per country is always
+          # business-wide. Defaults to `false`.
+          purchasing_power_parity: nil,
           # A suggested price for the user to pay. This value is only considered if
           # [`pay_what_you_want`](Self::pay_what_you_want) is `true`. Otherwise, it is
           # ignored.
@@ -112,9 +117,9 @@ module Dodopayments
               currency: Dodopayments::Currency::OrSymbol,
               discount: Integer,
               price: Integer,
-              purchasing_power_parity: T::Boolean,
               type: Symbol,
               pay_what_you_want: T::Boolean,
+              purchasing_power_parity: T::Boolean,
               suggested_price: T.nilable(Integer),
               tax_inclusive: T.nilable(T::Boolean)
             }
@@ -155,11 +160,6 @@ module Dodopayments
         sig { returns(Integer) }
         attr_accessor :price
 
-        # Indicates if purchasing power parity adjustments are applied to the price.
-        # Purchasing power parity feature is not available as of now
-        sig { returns(T::Boolean) }
-        attr_accessor :purchasing_power_parity
-
         # 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.
         sig { returns(Integer) }
@@ -172,6 +172,15 @@ module Dodopayments
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # Opts this price in to purchasing power parity. The business must also enable
+        # purchasing power parity. The discount percentage per country is always
+        # business-wide. Defaults to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :purchasing_power_parity
+
+        sig { params(purchasing_power_parity: T::Boolean).void }
+        attr_writer :purchasing_power_parity
+
         # Indicates if the price is tax inclusive
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :tax_inclusive
@@ -201,9 +210,9 @@ module Dodopayments
             payment_frequency_count: Integer,
             payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
             price: Integer,
-            purchasing_power_parity: T::Boolean,
             subscription_period_count: Integer,
             subscription_period_interval: Dodopayments::TimeInterval::OrSymbol,
+            purchasing_power_parity: T::Boolean,
             tax_inclusive: T.nilable(T::Boolean),
             trial_amount: T.nilable(Integer),
             trial_apply_discounts: T.nilable(T::Boolean),
@@ -224,14 +233,15 @@ module Dodopayments
           # The payment amount. Represented in the lowest denomination of the currency
           # (e.g., cents for USD). For example, to charge $1.00, pass `100`.
           price:,
-          # Indicates if purchasing power parity adjustments are applied to the price.
-          # Purchasing power parity feature is not available as of now
-          purchasing_power_parity:,
           # 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.
           subscription_period_count:,
           # The time interval for the subscription period (e.g., day, month, year).
           subscription_period_interval:,
+          # Opts this price in to purchasing power parity. The business must also enable
+          # purchasing power parity. The discount percentage per country is always
+          # business-wide. Defaults to `false`.
+          purchasing_power_parity: nil,
           # Indicates if the price is tax inclusive
           tax_inclusive: nil,
           # Amount charged today for a paid trial, in the price currency's minor units.
@@ -254,11 +264,11 @@ module Dodopayments
               payment_frequency_count: Integer,
               payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
               price: Integer,
-              purchasing_power_parity: T::Boolean,
               subscription_period_count: Integer,
               subscription_period_interval:
                 Dodopayments::TimeInterval::OrSymbol,
               type: Symbol,
+              purchasing_power_parity: T::Boolean,
               tax_inclusive: T.nilable(T::Boolean),
               trial_amount: T.nilable(Integer),
               trial_apply_discounts: T.nilable(T::Boolean),
@@ -301,11 +311,6 @@ module Dodopayments
         sig { returns(Dodopayments::TimeInterval::OrSymbol) }
         attr_accessor :payment_frequency_interval
 
-        # Indicates if purchasing power parity adjustments are applied to the price.
-        # Purchasing power parity feature is not available as of now
-        sig { returns(T::Boolean) }
-        attr_accessor :purchasing_power_parity
-
         # 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.
         sig { returns(Integer) }
@@ -321,6 +326,16 @@ module Dodopayments
         sig { returns(T.nilable(T::Array[Dodopayments::AddMeterToPrice])) }
         attr_accessor :meters
 
+        # Opts this price in to purchasing power parity. The business must also enable
+        # purchasing power parity. The discount percentage per country is always
+        # business-wide. Applies to the fixed fee only, never to metered usage. Defaults
+        # to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :purchasing_power_parity
+
+        sig { params(purchasing_power_parity: T::Boolean).void }
+        attr_writer :purchasing_power_parity
+
         # Indicates if the price is tax inclusive
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :tax_inclusive
@@ -333,10 +348,10 @@ module Dodopayments
             fixed_price: Integer,
             payment_frequency_count: Integer,
             payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
-            purchasing_power_parity: T::Boolean,
             subscription_period_count: Integer,
             subscription_period_interval: Dodopayments::TimeInterval::OrSymbol,
             meters: T.nilable(T::Array[Dodopayments::AddMeterToPrice::OrHash]),
+            purchasing_power_parity: T::Boolean,
             tax_inclusive: T.nilable(T::Boolean),
             type: Symbol
           ).returns(T.attached_class)
@@ -354,15 +369,17 @@ module Dodopayments
           payment_frequency_count:,
           # The time interval for the payment frequency (e.g., day, month, year).
           payment_frequency_interval:,
-          # Indicates if purchasing power parity adjustments are applied to the price.
-          # Purchasing power parity feature is not available as of now
-          purchasing_power_parity:,
           # 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.
           subscription_period_count:,
           # The time interval for the subscription period (e.g., day, month, year).
           subscription_period_interval:,
           meters: nil,
+          # Opts this price in to purchasing power parity. The business must also enable
+          # purchasing power parity. The discount percentage per country is always
+          # business-wide. Applies to the fixed fee only, never to metered usage. Defaults
+          # to `false`.
+          purchasing_power_parity: nil,
           # Indicates if the price is tax inclusive
           tax_inclusive: nil,
           type: :usage_based_price
@@ -377,12 +394,12 @@ module Dodopayments
               fixed_price: Integer,
               payment_frequency_count: Integer,
               payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
-              purchasing_power_parity: T::Boolean,
               subscription_period_count: Integer,
               subscription_period_interval:
                 Dodopayments::TimeInterval::OrSymbol,
               type: Symbol,
               meters: T.nilable(T::Array[Dodopayments::AddMeterToPrice]),
+              purchasing_power_parity: T::Boolean,
               tax_inclusive: T.nilable(T::Boolean)
             }
           )

data/rbi/dodopayments/models/subscription_change_plan_response.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionChangePlanResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::SubscriptionChangePlanResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Client secret for an embedded checkout.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :client_secret
+
+      # When the link stops working.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_on
+
+      # Id of the payment that settles the plan change.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_id
+
+      # Checkout page URL. Give this to the customer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_link
+
+      # Handles for a hosted checkout page that settles a plan change.
+      #
+      # The four fields repeat `UpdatePaymentMethodResponse` and a subset of
+      # `CreateSubscriptionResponse`. A shared type would rename the generated SDK types
+      # for all three routes, so each route keeps its own.
+      sig do
+        params(
+          client_secret: T.nilable(String),
+          expires_on: T.nilable(Time),
+          payment_id: T.nilable(String),
+          payment_link: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Client secret for an embedded checkout.
+        client_secret: nil,
+        # When the link stops working.
+        expires_on: nil,
+        # Id of the payment that settles the plan change.
+        payment_id: nil,
+        # Checkout page URL. Give this to the customer.
+        payment_link: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            client_secret: T.nilable(String),
+            expires_on: T.nilable(Time),
+            payment_id: T.nilable(String),
+            payment_link: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -98,11 +98,23 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :next_billing_date
 
-      # `Some(true)` pauses an active subscription; `Some(false)` unpauses a `Paused`
-      # (or abandoned `OnHold`) subscription. Exclusive of every other field.
+      # Removed. Use `status: paused` to pause and `status: active` to resume. This
+      # field always fails with 422, so a caller still on it gets a loud error instead
+      # of a silent no-op.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :pause
 
+      # Set to `cancelled` to cancel the subscription. See `cancel_reason`,
+      # `cancellation_feedback`, `cancellation_comment`, and
+      # `cancel_at_next_billing_date` for cancellation options.
+      #
+      # Set to `paused` to pause an active subscription. Set to `active` to resume a
+      # `paused` subscription. `active` also resumes an `on_hold` subscription that has
+      # an unpaid pause invoice. This voids that invoice.
+      #
+      # Send `paused` or `active` alone. A request that combines either with any other
+      # field fails with 422. `cancelled` is not exclusive this way — see
+      # `cancel_reason` and friends below.
       sig { returns(T.nilable(Dodopayments::SubscriptionStatus::OrSymbol)) }
       attr_accessor :status
 
@@ -182,9 +194,21 @@ module Dodopayments
         # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
         metadata: nil,
         next_billing_date: nil,
-        # `Some(true)` pauses an active subscription; `Some(false)` unpauses a `Paused`
-        # (or abandoned `OnHold`) subscription. Exclusive of every other field.
+        # Removed. Use `status: paused` to pause and `status: active` to resume. This
+        # field always fails with 422, so a caller still on it gets a loud error instead
+        # of a silent no-op.
         pause: nil,
+        # Set to `cancelled` to cancel the subscription. See `cancel_reason`,
+        # `cancellation_feedback`, `cancellation_comment`, and
+        # `cancel_at_next_billing_date` for cancellation options.
+        #
+        # Set to `paused` to pause an active subscription. Set to `active` to resume a
+        # `paused` subscription. `active` also resumes an `on_hold` subscription that has
+        # an unpaid pause invoice. This voids that invoice.
+        #
+        # Send `paused` or `active` alone. A request that combines either with any other
+        # field fails with 422. `cancelled` is not exclusive this way — see
+        # `cancel_reason` and friends below.
         status: nil,
         # New number of `subscription_period_interval` units the subscription entitlement
         # should span. Used together with `subscription_period_interval` to extend the

data/rbi/dodopayments/models/update_subscription_plan_req.rbi

@@ -37,6 +37,38 @@ module Dodopayments
       sig { returns(T.nilable(T::Array[Dodopayments::AttachAddon])) }
       attr_accessor :addons
 
+      # Replace a scheduled plan change with this one.
+      #
+      # The scheduled change is cancelled by the transaction that applies this change. A
+      # change that never applies leaves the schedule in place.
+      #
+      # `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+      # old one in the request transaction.
+      #
+      # A pending plan change still gets a `409`. This field does not affect it.
+      #
+      # The preview route shares this request body, so a preview that sets this field
+      # also passes the scheduled-change `409`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :cancel_scheduled_change_plan
+
+      sig { params(cancel_scheduled_change_plan: T::Boolean).void }
+      attr_writer :cancel_scheduled_change_plan
+
+      # Collect the plan-change amount with a payment link. The customer then pays on a
+      # checkout page.
+      #
+      # The business needs the `allow_plan_change_via_payment_link` capability. The
+      # request needs `effective_at: immediately`. The request also needs
+      # `on_payment_failure: prevent_change`.
+      #
+      # The preview route shares this request body and ignores this field.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :collect_via_payment_link
+
+      sig { params(collect_via_payment_link: T::Boolean).void }
+      attr_writer :collect_via_payment_link
+
       # DEPRECATED: Use discount_codes instead. Cannot be used together with
       # discount_codes.
       sig { returns(T.nilable(String)) }
@@ -103,6 +135,8 @@ module Dodopayments
           quantity: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          cancel_scheduled_change_plan: T::Boolean,
+          collect_via_payment_link: T::Boolean,
           discount_code: T.nilable(String),
           discount_codes: T.nilable(T::Array[String]),
           effective_at:
@@ -128,6 +162,28 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # Replace a scheduled plan change with this one.
+        #
+        # The scheduled change is cancelled by the transaction that applies this change. A
+        # change that never applies leaves the schedule in place.
+        #
+        # `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+        # old one in the request transaction.
+        #
+        # A pending plan change still gets a `409`. This field does not affect it.
+        #
+        # The preview route shares this request body, so a preview that sets this field
+        # also passes the scheduled-change `409`.
+        cancel_scheduled_change_plan: nil,
+        # Collect the plan-change amount with a payment link. The customer then pays on a
+        # checkout page.
+        #
+        # The business needs the `allow_plan_change_via_payment_link` capability. The
+        # request needs `effective_at: immediately`. The request also needs
+        # `on_payment_failure: prevent_change`.
+        #
+        # The preview route shares this request body and ignores this field.
+        collect_via_payment_link: nil,
         # DEPRECATED: Use discount_codes instead. Cannot be used together with
         # discount_codes.
         discount_code: nil,
@@ -164,6 +220,8 @@ module Dodopayments
             quantity: Integer,
             adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
             addons: T.nilable(T::Array[Dodopayments::AttachAddon]),
+            cancel_scheduled_change_plan: T::Boolean,
+            collect_via_payment_link: T::Boolean,
             discount_code: T.nilable(String),
             discount_codes: T.nilable(T::Array[String]),
             effective_at:

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -187,9 +187,21 @@ module Dodopayments
         # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
         metadata: nil,
         next_billing_date: nil,
-        # `Some(true)` pauses an active subscription; `Some(false)` unpauses a `Paused`
-        # (or abandoned `OnHold`) subscription. Exclusive of every other field.
+        # Removed. Use `status: paused` to pause and `status: active` to resume. This
+        # field always fails with 422, so a caller still on it gets a loud error instead
+        # of a silent no-op.
         pause: nil,
+        # Set to `cancelled` to cancel the subscription. See `cancel_reason`,
+        # `cancellation_feedback`, `cancellation_comment`, and
+        # `cancel_at_next_billing_date` for cancellation options.
+        #
+        # Set to `paused` to pause an active subscription. Set to `active` to resume a
+        # `paused` subscription. `active` also resumes an `on_hold` subscription that has
+        # an unpaid pause invoice. This voids that invoice.
+        #
+        # Send `paused` or `active` alone. A request that combines either with any other
+        # field fails with 422. `cancelled` is not exclusive this way — see
+        # `cancel_reason` and friends below.
         status: nil,
         # New number of `subscription_period_interval` units the subscription entitlement
         # should span. Used together with `subscription_period_interval` to extend the
@@ -268,6 +280,8 @@ module Dodopayments
           quantity: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          cancel_scheduled_change_plan: T::Boolean,
+          collect_via_payment_link: T::Boolean,
           discount_code: T.nilable(String),
           discount_codes: T.nilable(T::Array[String]),
           effective_at:
@@ -279,7 +293,7 @@ module Dodopayments
               Dodopayments::UpdateSubscriptionPlanReq::OnPaymentFailure::OrSymbol
             ),
           request_options: Dodopayments::RequestOptions::OrHash
-        ).void
+        ).returns(Dodopayments::Models::SubscriptionChangePlanResponse)
       end
       def change_plan(
         # Subscription Id
@@ -296,6 +310,28 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # Replace a scheduled plan change with this one.
+        #
+        # The scheduled change is cancelled by the transaction that applies this change. A
+        # change that never applies leaves the schedule in place.
+        #
+        # `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+        # old one in the request transaction.
+        #
+        # A pending plan change still gets a `409`. This field does not affect it.
+        #
+        # The preview route shares this request body, so a preview that sets this field
+        # also passes the scheduled-change `409`.
+        cancel_scheduled_change_plan: nil,
+        # Collect the plan-change amount with a payment link. The customer then pays on a
+        # checkout page.
+        #
+        # The business needs the `allow_plan_change_via_payment_link` capability. The
+        # request needs `effective_at: immediately`. The request also needs
+        # `on_payment_failure: prevent_change`.
+        #
+        # The preview route shares this request body and ignores this field.
+        collect_via_payment_link: nil,
         # DEPRECATED: Use discount_codes instead. Cannot be used together with
         # discount_codes.
         discount_code: nil,
@@ -374,6 +410,8 @@ module Dodopayments
           quantity: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          cancel_scheduled_change_plan: T::Boolean,
+          collect_via_payment_link: T::Boolean,
           discount_code: T.nilable(String),
           discount_codes: T.nilable(T::Array[String]),
           effective_at:
@@ -402,6 +440,28 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # Replace a scheduled plan change with this one.
+        #
+        # The scheduled change is cancelled by the transaction that applies this change. A
+        # change that never applies leaves the schedule in place.
+        #
+        # `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+        # old one in the request transaction.
+        #
+        # A pending plan change still gets a `409`. This field does not affect it.
+        #
+        # The preview route shares this request body, so a preview that sets this field
+        # also passes the scheduled-change `409`.
+        cancel_scheduled_change_plan: nil,
+        # Collect the plan-change amount with a payment link. The customer then pays on a
+        # checkout page.
+        #
+        # The business needs the `allow_plan_change_via_payment_link` capability. The
+        # request needs `effective_at: immediately`. The request also needs
+        # `on_payment_failure: prevent_change`.
+        #
+        # The preview route shares this request body and ignores this field.
+        collect_via_payment_link: nil,
         # DEPRECATED: Use discount_codes instead. Cannot be used together with
         # discount_codes.
         discount_code: nil,

data/sig/dodopayments/models/entitlements/license_key_grant.rbs

@@ -3,31 +3,41 @@ module Dodopayments
     module Entitlements
       type license_key_grant =
         {
+          id: String,
           activations_used: Integer,
           key: String,
+          status: Dodopayments::Models::license_key_status,
           activations_limit: Integer?,
           expires_at: Time?
         }
 
       class LicenseKeyGrant < Dodopayments::Internal::Type::BaseModel
+        attr_accessor id: String
+
         attr_accessor activations_used: Integer
 
         attr_accessor key: String
 
+        attr_accessor status: Dodopayments::Models::license_key_status
+
         attr_accessor activations_limit: Integer?
 
         attr_accessor expires_at: Time?
 
         def initialize: (
+          id: String,
           activations_used: Integer,
           key: String,
+          status: Dodopayments::Models::license_key_status,
           ?activations_limit: Integer?,
           ?expires_at: Time?
         ) -> void
 
         def to_hash: -> {
+          id: String,
           activations_used: Integer,
           key: String,
+          status: Dodopayments::Models::license_key_status,
           activations_limit: Integer?,
           expires_at: Time?
         }