dodopayments 1.47.0 → 1.51.0

data/rbi/dodopayments/models.rbi

@@ -33,6 +33,13 @@ module Dodopayments
 
   BrandUpdateParams = Dodopayments::Models::BrandUpdateParams
 
+  CheckoutSessionCreateParams =
+    Dodopayments::Models::CheckoutSessionCreateParams
+
+  CheckoutSessionRequest = Dodopayments::Models::CheckoutSessionRequest
+
+  CheckoutSessionResponse = Dodopayments::Models::CheckoutSessionResponse
+
   CountryCode = Dodopayments::Models::CountryCode
 
   CreateNewCustomer = Dodopayments::Models::CreateNewCustomer
@@ -121,6 +128,8 @@ module Dodopayments
 
   NewCustomer = Dodopayments::Models::NewCustomer
 
+  OnDemandSubscription = Dodopayments::Models::OnDemandSubscription
+
   OneTimeProductCartItem = Dodopayments::Models::OneTimeProductCartItem
 
   Payment = Dodopayments::Models::Payment
@@ -193,6 +202,8 @@ module Dodopayments
 
   WebhookDeleteParams = Dodopayments::Models::WebhookDeleteParams
 
+  WebhookDetails = Dodopayments::Models::WebhookDetails
+
   WebhookEventType = Dodopayments::Models::WebhookEventType
 
   WebhookListParams = Dodopayments::Models::WebhookListParams
@@ -201,9 +212,10 @@ module Dodopayments
 
   WebhookRetrieveParams = Dodopayments::Models::WebhookRetrieveParams
 
+  WebhookRetrieveSecretParams =
+    Dodopayments::Models::WebhookRetrieveSecretParams
+
   Webhooks = Dodopayments::Models::Webhooks
 
   WebhookUpdateParams = Dodopayments::Models::WebhookUpdateParams
-
-  YourWebhookURLCreateParams = Dodopayments::Models::YourWebhookURLCreateParams
 end

data/rbi/dodopayments/resources/checkout_sessions.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class CheckoutSessions
+      sig do
+        params(
+          product_cart:
+            T::Array[Dodopayments::CheckoutSessionRequest::ProductCart::OrHash],
+          allowed_payment_method_types:
+            T.nilable(T::Array[Dodopayments::PaymentMethodTypes::OrSymbol]),
+          billing_address:
+            T.nilable(
+              Dodopayments::CheckoutSessionRequest::BillingAddress::OrHash
+            ),
+          billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
+          confirm: T::Boolean,
+          customer:
+            T.nilable(
+              T.any(
+                Dodopayments::AttachExistingCustomer::OrHash,
+                Dodopayments::NewCustomer::OrHash
+              )
+            ),
+          customization:
+            Dodopayments::CheckoutSessionRequest::Customization::OrHash,
+          discount_code: T.nilable(String),
+          feature_flags:
+            Dodopayments::CheckoutSessionRequest::FeatureFlags::OrHash,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          return_url: T.nilable(String),
+          show_saved_payment_methods: T::Boolean,
+          subscription_data:
+            T.nilable(
+              Dodopayments::CheckoutSessionRequest::SubscriptionData::OrHash
+            ),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::CheckoutSessionResponse)
+      end
+      def create(
+        product_cart:,
+        # Customers will never see payment methods that are not in this list. However,
+        # adding a method here does not guarantee customers will see it. Availability
+        # still depends on other factors (e.g., customer location, merchant settings).
+        #
+        # Disclaimar: Always provide 'credit' and 'debit' as a fallback. If all payment
+        # methods are unavailable, checkout session will fail.
+        allowed_payment_method_types: nil,
+        # Billing address information for the session
+        billing_address: nil,
+        # This field is ingored if adaptive pricing is disabled
+        billing_currency: nil,
+        # If confirm is true, all the details will be finalized. If required data is
+        # missing, an API error is thrown.
+        confirm: nil,
+        # Customer details for the session
+        customer: nil,
+        # Customization for the checkout session page
+        customization: nil,
+        discount_code: nil,
+        feature_flags: nil,
+        # Additional metadata associated with the payment. Defaults to empty if not
+        # provided.
+        metadata: nil,
+        # The url to redirect after payment failure or success.
+        return_url: nil,
+        # Display saved payment methods of a returning customer False by default
+        show_saved_payment_methods: nil,
+        subscription_data: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -19,8 +19,7 @@ module Dodopayments
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
           discount_code: T.nilable(String),
           metadata: T::Hash[Symbol, String],
-          on_demand:
-            T.nilable(Dodopayments::SubscriptionCreateParams::OnDemand::OrHash),
+          on_demand: T.nilable(Dodopayments::OnDemandSubscription::OrHash),
           payment_link: T.nilable(T::Boolean),
           return_url: T.nilable(String),
           show_saved_payment_methods: T::Boolean,
@@ -94,6 +93,7 @@ module Dodopayments
               Dodopayments::SubscriptionUpdateParams::DisableOnDemand::OrHash
             ),
           metadata: T.nilable(T::Hash[Symbol, String]),
+          next_billing_date: T.nilable(Time),
           status: T.nilable(Dodopayments::SubscriptionStatus::OrSymbol),
           tax_id: T.nilable(String),
           request_options: Dodopayments::RequestOptions::OrHash
@@ -103,9 +103,11 @@ module Dodopayments
         # Subscription Id
         subscription_id,
         billing: nil,
+        # When set, the subscription will remain active until the end of billing period
         cancel_at_next_billing_date: nil,
         disable_on_demand: nil,
         metadata: nil,
+        next_billing_date: nil,
         status: nil,
         tax_id: nil,
         request_options: {}

data/rbi/dodopayments/resources/webhooks.rbi

@@ -18,19 +18,19 @@ module Dodopayments
           metadata: T.nilable(T::Hash[Symbol, String]),
           rate_limit: T.nilable(Integer),
           request_options: Dodopayments::RequestOptions::OrHash
-        ).returns(Dodopayments::Models::WebhookCreateResponse)
+        ).returns(Dodopayments::WebhookDetails)
       end
       def create(
         # Url of the webhook
         url:,
-        # Filter events to the webhook.
-        #
-        # Webhook event will only be sent for events in the list.
         description: nil,
         # Create the webhook in a disabled state.
         #
         # Default is false
         disabled: nil,
+        # Filter events to the webhook.
+        #
+        # Webhook event will only be sent for events in the list.
         filter_types: nil,
         # Custom headers to be passed
         headers: nil,
@@ -48,7 +48,7 @@ module Dodopayments
         params(
           webhook_id: String,
           request_options: Dodopayments::RequestOptions::OrHash
-        ).returns(Dodopayments::Models::WebhookRetrieveResponse)
+        ).returns(Dodopayments::WebhookDetails)
       end
       def retrieve(webhook_id, request_options: {})
       end
@@ -65,7 +65,7 @@ module Dodopayments
           rate_limit: T.nilable(Integer),
           url: T.nilable(String),
           request_options: Dodopayments::RequestOptions::OrHash
-        ).returns(Dodopayments::Models::WebhookUpdateResponse)
+        ).returns(Dodopayments::WebhookDetails)
       end
       def update(
         webhook_id,
@@ -95,7 +95,7 @@ module Dodopayments
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(
           Dodopayments::Internal::CursorPagePagination[
-            Dodopayments::Models::WebhookListResponse
+            Dodopayments::WebhookDetails
           ]
         )
       end
@@ -118,6 +118,16 @@ module Dodopayments
       def delete(webhook_id, request_options: {})
       end
 
+      # Get webhook secret by id
+      sig do
+        params(
+          webhook_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::WebhookRetrieveSecretResponse)
+      end
+      def retrieve_secret(webhook_id, request_options: {})
+      end
+
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/dodopayments/client.rbs

@@ -15,6 +15,8 @@ module Dodopayments
 
     attr_reader bearer_token: String
 
+    attr_reader checkout_sessions: Dodopayments::Resources::CheckoutSessions
+
     attr_reader payments: Dodopayments::Resources::Payments
 
     attr_reader subscriptions: Dodopayments::Resources::Subscriptions
@@ -49,8 +51,6 @@ module Dodopayments
 
     attr_reader webhooks: Dodopayments::Resources::Webhooks
 
-    attr_reader your_webhook_url: Dodopayments::Resources::YourWebhookURL
-
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/dodopayments/models/checkout_session_create_params.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    type checkout_session_create_params =
+      {  } & Dodopayments::Internal::Type::request_parameters
+
+    class CheckoutSessionCreateParams < Dodopayments::Models::CheckoutSessionRequest
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Dodopayments::request_opts) -> void
+
+      def to_hash: -> { request_options: Dodopayments::RequestOptions }
+    end
+  end
+end

data/sig/dodopayments/models/checkout_session_request.rbs

@@ -0,0 +1,277 @@
+module Dodopayments
+  module Models
+    type checkout_session_request =
+      {
+        product_cart: ::Array[Dodopayments::CheckoutSessionRequest::ProductCart],
+        allowed_payment_method_types: ::Array[Dodopayments::Models::payment_method_types]?,
+        billing_address: Dodopayments::CheckoutSessionRequest::BillingAddress?,
+        billing_currency: Dodopayments::Models::currency?,
+        confirm: bool,
+        customer: Dodopayments::Models::customer_request?,
+        customization: Dodopayments::CheckoutSessionRequest::Customization,
+        discount_code: String?,
+        feature_flags: Dodopayments::CheckoutSessionRequest::FeatureFlags,
+        metadata: ::Hash[Symbol, String]?,
+        return_url: String?,
+        show_saved_payment_methods: bool,
+        subscription_data: Dodopayments::CheckoutSessionRequest::SubscriptionData?
+      }
+
+    class CheckoutSessionRequest < Dodopayments::Internal::Type::BaseModel
+      attr_accessor product_cart: ::Array[Dodopayments::CheckoutSessionRequest::ProductCart]
+
+      attr_accessor allowed_payment_method_types: ::Array[Dodopayments::Models::payment_method_types]?
+
+      attr_accessor billing_address: Dodopayments::CheckoutSessionRequest::BillingAddress?
+
+      attr_accessor billing_currency: Dodopayments::Models::currency?
+
+      attr_reader confirm: bool?
+
+      def confirm=: (bool) -> bool
+
+      attr_accessor customer: Dodopayments::Models::customer_request?
+
+      attr_reader customization: Dodopayments::CheckoutSessionRequest::Customization?
+
+      def customization=: (
+        Dodopayments::CheckoutSessionRequest::Customization
+      ) -> Dodopayments::CheckoutSessionRequest::Customization
+
+      attr_accessor discount_code: String?
+
+      attr_reader feature_flags: Dodopayments::CheckoutSessionRequest::FeatureFlags?
+
+      def feature_flags=: (
+        Dodopayments::CheckoutSessionRequest::FeatureFlags
+      ) -> Dodopayments::CheckoutSessionRequest::FeatureFlags
+
+      attr_accessor metadata: ::Hash[Symbol, String]?
+
+      attr_accessor return_url: String?
+
+      attr_reader show_saved_payment_methods: bool?
+
+      def show_saved_payment_methods=: (bool) -> bool
+
+      attr_accessor subscription_data: Dodopayments::CheckoutSessionRequest::SubscriptionData?
+
+      def initialize: (
+        product_cart: ::Array[Dodopayments::CheckoutSessionRequest::ProductCart],
+        ?allowed_payment_method_types: ::Array[Dodopayments::Models::payment_method_types]?,
+        ?billing_address: Dodopayments::CheckoutSessionRequest::BillingAddress?,
+        ?billing_currency: Dodopayments::Models::currency?,
+        ?confirm: bool,
+        ?customer: Dodopayments::Models::customer_request?,
+        ?customization: Dodopayments::CheckoutSessionRequest::Customization,
+        ?discount_code: String?,
+        ?feature_flags: Dodopayments::CheckoutSessionRequest::FeatureFlags,
+        ?metadata: ::Hash[Symbol, String]?,
+        ?return_url: String?,
+        ?show_saved_payment_methods: bool,
+        ?subscription_data: Dodopayments::CheckoutSessionRequest::SubscriptionData?
+      ) -> void
+
+      def to_hash: -> {
+        product_cart: ::Array[Dodopayments::CheckoutSessionRequest::ProductCart],
+        allowed_payment_method_types: ::Array[Dodopayments::Models::payment_method_types]?,
+        billing_address: Dodopayments::CheckoutSessionRequest::BillingAddress?,
+        billing_currency: Dodopayments::Models::currency?,
+        confirm: bool,
+        customer: Dodopayments::Models::customer_request?,
+        customization: Dodopayments::CheckoutSessionRequest::Customization,
+        discount_code: String?,
+        feature_flags: Dodopayments::CheckoutSessionRequest::FeatureFlags,
+        metadata: ::Hash[Symbol, String]?,
+        return_url: String?,
+        show_saved_payment_methods: bool,
+        subscription_data: Dodopayments::CheckoutSessionRequest::SubscriptionData?
+      }
+
+      type product_cart =
+        {
+          product_id: String,
+          quantity: Integer,
+          addons: ::Array[Dodopayments::AttachAddon]?,
+          amount: Integer?
+        }
+
+      class ProductCart < Dodopayments::Internal::Type::BaseModel
+        attr_accessor product_id: String
+
+        attr_accessor quantity: Integer
+
+        attr_accessor addons: ::Array[Dodopayments::AttachAddon]?
+
+        attr_accessor amount: Integer?
+
+        def initialize: (
+          product_id: String,
+          quantity: Integer,
+          ?addons: ::Array[Dodopayments::AttachAddon]?,
+          ?amount: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          product_id: String,
+          quantity: Integer,
+          addons: ::Array[Dodopayments::AttachAddon]?,
+          amount: Integer?
+        }
+      end
+
+      type billing_address =
+        {
+          country: Dodopayments::Models::country_code,
+          city: String?,
+          state: String?,
+          street: String?,
+          zipcode: String?
+        }
+
+      class BillingAddress < Dodopayments::Internal::Type::BaseModel
+        attr_accessor country: Dodopayments::Models::country_code
+
+        attr_accessor city: String?
+
+        attr_accessor state: String?
+
+        attr_accessor street: String?
+
+        attr_accessor zipcode: String?
+
+        def initialize: (
+          country: Dodopayments::Models::country_code,
+          ?city: String?,
+          ?state: String?,
+          ?street: String?,
+          ?zipcode: String?
+        ) -> void
+
+        def to_hash: -> {
+          country: Dodopayments::Models::country_code,
+          city: String?,
+          state: String?,
+          street: String?,
+          zipcode: String?
+        }
+      end
+
+      type customization =
+        {
+          show_on_demand_tag: bool,
+          show_order_details: bool,
+          theme: Dodopayments::Models::CheckoutSessionRequest::Customization::theme
+        }
+
+      class Customization < Dodopayments::Internal::Type::BaseModel
+        attr_reader show_on_demand_tag: bool?
+
+        def show_on_demand_tag=: (bool) -> bool
+
+        attr_reader show_order_details: bool?
+
+        def show_order_details=: (bool) -> bool
+
+        attr_reader theme: Dodopayments::Models::CheckoutSessionRequest::Customization::theme?
+
+        def theme=: (
+          Dodopayments::Models::CheckoutSessionRequest::Customization::theme
+        ) -> Dodopayments::Models::CheckoutSessionRequest::Customization::theme
+
+        def initialize: (
+          ?show_on_demand_tag: bool,
+          ?show_order_details: bool,
+          ?theme: Dodopayments::Models::CheckoutSessionRequest::Customization::theme
+        ) -> void
+
+        def to_hash: -> {
+          show_on_demand_tag: bool,
+          show_order_details: bool,
+          theme: Dodopayments::Models::CheckoutSessionRequest::Customization::theme
+        }
+
+        type theme = :dark | :light | :system
+
+        module Theme
+          extend Dodopayments::Internal::Type::Enum
+
+          DARK: :dark
+          LIGHT: :light
+          SYSTEM: :system
+
+          def self?.values: -> ::Array[Dodopayments::Models::CheckoutSessionRequest::Customization::theme]
+        end
+      end
+
+      type feature_flags =
+        {
+          allow_currency_selection: bool,
+          allow_discount_code: bool,
+          allow_phone_number_collection: bool,
+          allow_tax_id: bool,
+          always_create_new_customer: bool
+        }
+
+      class FeatureFlags < Dodopayments::Internal::Type::BaseModel
+        attr_reader allow_currency_selection: bool?
+
+        def allow_currency_selection=: (bool) -> bool
+
+        attr_reader allow_discount_code: bool?
+
+        def allow_discount_code=: (bool) -> bool
+
+        attr_reader allow_phone_number_collection: bool?
+
+        def allow_phone_number_collection=: (bool) -> bool
+
+        attr_reader allow_tax_id: bool?
+
+        def allow_tax_id=: (bool) -> bool
+
+        attr_reader always_create_new_customer: bool?
+
+        def always_create_new_customer=: (bool) -> bool
+
+        def initialize: (
+          ?allow_currency_selection: bool,
+          ?allow_discount_code: bool,
+          ?allow_phone_number_collection: bool,
+          ?allow_tax_id: bool,
+          ?always_create_new_customer: bool
+        ) -> void
+
+        def to_hash: -> {
+          allow_currency_selection: bool,
+          allow_discount_code: bool,
+          allow_phone_number_collection: bool,
+          allow_tax_id: bool,
+          always_create_new_customer: bool
+        }
+      end
+
+      type subscription_data =
+        {
+          on_demand: Dodopayments::OnDemandSubscription?,
+          trial_period_days: Integer?
+        }
+
+      class SubscriptionData < Dodopayments::Internal::Type::BaseModel
+        attr_accessor on_demand: Dodopayments::OnDemandSubscription?
+
+        attr_accessor trial_period_days: Integer?
+
+        def initialize: (
+          ?on_demand: Dodopayments::OnDemandSubscription?,
+          ?trial_period_days: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          on_demand: Dodopayments::OnDemandSubscription?,
+          trial_period_days: Integer?
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/checkout_session_response.rbs

@@ -0,0 +1,16 @@
+module Dodopayments
+  module Models
+    type checkout_session_response =
+      { checkout_url: String, session_id: String }
+
+    class CheckoutSessionResponse < Dodopayments::Internal::Type::BaseModel
+      attr_accessor checkout_url: String
+
+      attr_accessor session_id: String
+
+      def initialize: (checkout_url: String, session_id: String) -> void
+
+      def to_hash: -> { checkout_url: String, session_id: String }
+    end
+  end
+end

data/sig/dodopayments/models/on_demand_subscription.rbs

@@ -0,0 +1,40 @@
+module Dodopayments
+  module Models
+    type on_demand_subscription =
+      {
+        mandate_only: bool,
+        adaptive_currency_fees_inclusive: bool?,
+        product_currency: Dodopayments::Models::currency?,
+        product_description: String?,
+        product_price: Integer?
+      }
+
+    class OnDemandSubscription < Dodopayments::Internal::Type::BaseModel
+      attr_accessor mandate_only: bool
+
+      attr_accessor adaptive_currency_fees_inclusive: bool?
+
+      attr_accessor product_currency: Dodopayments::Models::currency?
+
+      attr_accessor product_description: String?
+
+      attr_accessor product_price: Integer?
+
+      def initialize: (
+        mandate_only: bool,
+        ?adaptive_currency_fees_inclusive: bool?,
+        ?product_currency: Dodopayments::Models::currency?,
+        ?product_description: String?,
+        ?product_price: Integer?
+      ) -> void
+
+      def to_hash: -> {
+        mandate_only: bool,
+        adaptive_currency_fees_inclusive: bool?,
+        product_currency: Dodopayments::Models::currency?,
+        product_description: String?,
+        product_price: Integer?
+      }
+    end
+  end
+end

data/sig/dodopayments/models/subscription.rbs

@@ -25,7 +25,8 @@ module Dodopayments
         trial_period_days: Integer,
         cancelled_at: Time?,
         discount_cycles_remaining: Integer?,
-        discount_id: String?
+        discount_id: String?,
+        expires_at: Time?
       }
 
     class Subscription < Dodopayments::Internal::Type::BaseModel
@@ -77,6 +78,8 @@ module Dodopayments
 
       attr_accessor discount_id: String?
 
+      attr_accessor expires_at: Time?
+
       def initialize: (
         addons: ::Array[Dodopayments::AddonCartResponseItem],
         billing: Dodopayments::BillingAddress,
@@ -101,7 +104,8 @@ module Dodopayments
         trial_period_days: Integer,
         ?cancelled_at: Time?,
         ?discount_cycles_remaining: Integer?,
-        ?discount_id: String?
+        ?discount_id: String?,
+        ?expires_at: Time?
       ) -> void
 
       def to_hash: -> {
@@ -128,7 +132,8 @@ module Dodopayments
         trial_period_days: Integer,
         cancelled_at: Time?,
         discount_cycles_remaining: Integer?,
-        discount_id: String?
+        discount_id: String?,
+        expires_at: Time?
       }
     end
   end