whop_sdk 0.0.2

data/lib/whop_sdk/models/checkout_configuration.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class CheckoutConfiguration < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the checkout configuration
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute affiliate_code
+      #   The affiliate code to use for the checkout configuration
+      #
+      #   @return [String, nil]
+      required :affiliate_code, String, nil?: true
+
+      # @!attribute company_id
+      #   The ID of the company to use for the checkout configuration
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute metadata
+      #   The metadata to use for the checkout configuration
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
+
+      # @!attribute plan
+      #   The plan to use for the checkout configuration
+      #
+      #   @return [WhopSDK::Models::CheckoutConfiguration::Plan]
+      required :plan, -> { WhopSDK::CheckoutConfiguration::Plan }
+
+      # @!attribute purchase_url
+      #   The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @return [String]
+      required :purchase_url, String
+
+      # @!attribute redirect_url
+      #   The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @return [String, nil]
+      required :redirect_url, String, nil?: true
+
+      # @!method initialize(id:, affiliate_code:, company_id:, metadata:, plan:, purchase_url:, redirect_url:)
+      #   A checkout configuration object. Can be used to create a reusable custom
+      #   configuration for a checkout, including attaching plans, affiliates and custom
+      #   metadata to the checkout. This configuration can be re-used by multiple users.
+      #   All successful payments and memberships resulting from a checkout will contain
+      #   the passed metadata.
+      #
+      #   @param id [String] The ID of the checkout configuration
+      #
+      #   @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
+      #
+      #   @param company_id [String] The ID of the company to use for the checkout configuration
+      #
+      #   @param metadata [Hash{Symbol=>Object}] The metadata to use for the checkout configuration
+      #
+      #   @param plan [WhopSDK::Models::CheckoutConfiguration::Plan] The plan to use for the checkout configuration
+      #
+      #   @param purchase_url [String] The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
+
+      # @see WhopSDK::Models::CheckoutConfiguration#plan
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the plan.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute billing_period
+        #   The interval at which the plan charges (renewal plans).
+        #
+        #   @return [Integer, nil]
+        required :billing_period, Integer, nil?: true
+
+        # @!attribute currency
+        #   The respective currency identifier for the plan.
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency]
+        required :currency, enum: -> { WhopSDK::Currency }
+
+        # @!attribute expiration_days
+        #   The interval at which the plan charges (expiration plans).
+        #
+        #   @return [Integer, nil]
+        required :expiration_days, Integer, nil?: true
+
+        # @!attribute initial_price
+        #   The price a person has to pay for a plan on the initial purchase.
+        #
+        #   @return [Float]
+        required :initial_price, Float
+
+        # @!attribute plan_type
+        #   Indicates if the plan is a one time payment or recurring.
+        #
+        #   @return [Symbol, WhopSDK::Models::PlanType]
+        required :plan_type, enum: -> { WhopSDK::PlanType }
+
+        # @!attribute release_method
+        #   This is the release method the business uses to sell this plan.
+        #
+        #   @return [Symbol, WhopSDK::Models::ReleaseMethod]
+        required :release_method, enum: -> { WhopSDK::ReleaseMethod }
+
+        # @!attribute renewal_price
+        #   The price a person has to pay for a plan on the renewal purchase.
+        #
+        #   @return [Float]
+        required :renewal_price, Float
+
+        # @!attribute trial_period_days
+        #   The number of free trial days added before a renewal plan.
+        #
+        #   @return [Integer, nil]
+        required :trial_period_days, Integer, nil?: true
+
+        # @!attribute visibility
+        #   Shows or hides the plan from public/business view.
+        #
+        #   @return [Symbol, WhopSDK::Models::Visibility]
+        required :visibility, enum: -> { WhopSDK::Visibility }
+
+        # @!method initialize(id:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, trial_period_days:, visibility:)
+        #   The plan to use for the checkout configuration
+        #
+        #   @param id [String] The internal ID of the plan.
+        #
+        #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
+        #
+        #   @param currency [Symbol, WhopSDK::Models::Currency] The respective currency identifier for the plan.
+        #
+        #   @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
+        #
+        #   @param initial_price [Float] The price a person has to pay for a plan on the initial purchase.
+        #
+        #   @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
+        #
+        #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod] This is the release method the business uses to sell this plan.
+        #
+        #   @param renewal_price [Float] The price a person has to pay for a plan on the renewal purchase.
+        #
+        #   @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
+        #
+        #   @param visibility [Symbol, WhopSDK::Models::Visibility] Shows or hides the plan from public/business view.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/checkout_configuration_create_params.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CheckoutConfigurations#create
+    class CheckoutConfigurationCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute affiliate_code
+      #   The affiliate code to use for the checkout configuration
+      #
+      #   @return [String, nil]
+      optional :affiliate_code, String, nil?: true
+
+      # @!attribute metadata
+      #   The metadata to use for the checkout configuration
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+      # @!attribute plan
+      #   Pass this object to create a new plan for this checkout configuration
+      #
+      #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil]
+      optional :plan, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan }, nil?: true
+
+      # @!attribute plan_id
+      #   The ID of the plan to use for the checkout configuration
+      #
+      #   @return [String, nil]
+      optional :plan_id, String, nil?: true
+
+      # @!attribute redirect_url
+      #   The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @return [String, nil]
+      optional :redirect_url, String, nil?: true
+
+      # @!method initialize(affiliate_code: nil, metadata: nil, plan: nil, plan_id: nil, redirect_url: nil, request_options: {})
+      #   @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
+      #
+      #   @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil] Pass this object to create a new plan for this checkout configuration
+      #
+      #   @param plan_id [String, nil] The ID of the plan to use for the checkout configuration
+      #
+      #   @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute company_id
+        #   The company the plan should be created for.
+        #
+        #   @return [String]
+        required :company_id, String
+
+        # @!attribute billing_period
+        #   The interval at which the plan charges (renewal plans).
+        #
+        #   @return [Integer, nil]
+        optional :billing_period, Integer, nil?: true
+
+        # @!attribute currency
+        #   The available currencies on the platform
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency, nil]
+        optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+        # @!attribute custom_fields
+        #   An array of custom field objects.
+        #
+        #   @return [Array<WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::CustomField>, nil]
+        optional :custom_fields,
+                 -> {
+                   WhopSDK::Internal::Type::ArrayOf[WhopSDK::CheckoutConfigurationCreateParams::Plan::CustomField]
+                 },
+                 nil?: true
+
+        # @!attribute description
+        #   The description of the plan.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute expiration_days
+        #   The interval at which the plan charges (expiration plans).
+        #
+        #   @return [Integer, nil]
+        optional :expiration_days, Integer, nil?: true
+
+        # @!attribute force_create_new_plan
+        #   Whether to force the creation of a new plan even if one with the same attributes
+        #   already exists.
+        #
+        #   @return [Boolean, nil]
+        optional :force_create_new_plan, WhopSDK::Internal::Type::Boolean, nil?: true
+
+        # @!attribute image
+        #   An image for the plan. This will be visible on the product page to customers.
+        #
+        #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image, nil]
+        optional :image, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image }, nil?: true
+
+        # @!attribute initial_price
+        #   An additional amount charged upon first purchase.
+        #
+        #   @return [Float, nil]
+        optional :initial_price, Float, nil?: true
+
+        # @!attribute internal_notes
+        #   A personal description or notes section for the business.
+        #
+        #   @return [String, nil]
+        optional :internal_notes, String, nil?: true
+
+        # @!attribute override_tax_type
+        #   Whether or not the tax is included in a plan's price (or if it hasn't been set
+        #   up)
+        #
+        #   @return [Symbol, WhopSDK::Models::TaxType, nil]
+        optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
+
+        # @!attribute plan_type
+        #   The type of plan that can be attached to an access pass
+        #
+        #   @return [Symbol, WhopSDK::Models::PlanType, nil]
+        optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
+
+        # @!attribute product_id
+        #   The product the plan is related to.
+        #
+        #   @return [String, nil]
+        optional :product_id, String, nil?: true
+
+        # @!attribute release_method
+        #   The methods of how a plan can be released.
+        #
+        #   @return [Symbol, WhopSDK::Models::ReleaseMethod, nil]
+        optional :release_method, enum: -> { WhopSDK::ReleaseMethod }, nil?: true
+
+        # @!attribute renewal_price
+        #   The amount the customer is charged every billing period.
+        #
+        #   @return [Float, nil]
+        optional :renewal_price, Float, nil?: true
+
+        # @!attribute title
+        #   The title of the plan. This will be visible on the product page to customers.
+        #
+        #   @return [String, nil]
+        optional :title, String, nil?: true
+
+        # @!attribute trial_period_days
+        #   The number of free trial days added before a renewal plan.
+        #
+        #   @return [Integer, nil]
+        optional :trial_period_days, Integer, nil?: true
+
+        # @!attribute visibility
+        #   Visibility of a resource
+        #
+        #   @return [Symbol, WhopSDK::Models::Visibility, nil]
+        optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+
+        # @!method initialize(company_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, product_id: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan} for more details.
+        #
+        #   Pass this object to create a new plan for this checkout configuration
+        #
+        #   @param company_id [String] The company the plan should be created for.
+        #
+        #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
+        #
+        #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+        #
+        #   @param custom_fields [Array<WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::CustomField>, nil] An array of custom field objects.
+        #
+        #   @param description [String, nil] The description of the plan.
+        #
+        #   @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
+        #
+        #   @param force_create_new_plan [Boolean, nil] Whether to force the creation of a new plan even if one with the same attributes
+        #
+        #   @param image [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image, nil] An image for the plan. This will be visible on the product page to customers.
+        #
+        #   @param initial_price [Float, nil] An additional amount charged upon first purchase.
+        #
+        #   @param internal_notes [String, nil] A personal description or notes section for the business.
+        #
+        #   @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
+        #
+        #   @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
+        #
+        #   @param product_id [String, nil] The product the plan is related to.
+        #
+        #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
+        #
+        #   @param renewal_price [Float, nil] The amount the customer is charged every billing period.
+        #
+        #   @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
+        #
+        #   @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
+        #
+        #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+
+        class CustomField < WhopSDK::Internal::Type::BaseModel
+          # @!attribute field_type
+          #   The type of the custom field.
+          #
+          #   @return [Symbol, :text]
+          required :field_type, const: :text
+
+          # @!attribute name
+          #   The name of the custom field.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute id
+          #   The ID of the custom field (if being updated)
+          #
+          #   @return [String, nil]
+          optional :id, String, nil?: true
+
+          # @!attribute order
+          #   The order of the field.
+          #
+          #   @return [Integer, nil]
+          optional :order, Integer, nil?: true
+
+          # @!attribute placeholder
+          #   The placeholder value of the field.
+          #
+          #   @return [String, nil]
+          optional :placeholder, String, nil?: true
+
+          # @!attribute required
+          #   Whether or not the field is required.
+          #
+          #   @return [Boolean, nil]
+          optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
+
+          # @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
+          #   @param name [String] The name of the custom field.
+          #
+          #   @param id [String, nil] The ID of the custom field (if being updated)
+          #
+          #   @param order [Integer, nil] The order of the field.
+          #
+          #   @param placeholder [String, nil] The placeholder value of the field.
+          #
+          #   @param required [Boolean, nil] Whether or not the field is required.
+          #
+          #   @param field_type [Symbol, :text] The type of the custom field.
+        end
+
+        # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#image
+        class Image < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of an existing attachment object. Use this when updating a resource and
+          #   keeping a subset of the attachments. Don't use this unless you know what you're
+          #   doing.
+          #
+          #   @return [String, nil]
+          optional :id, String, nil?: true
+
+          # @!attribute direct_upload_id
+          #   This ID should be used the first time you upload an attachment. It is the ID of
+          #   the direct upload that was created when uploading the file to S3 via the
+          #   mediaDirectUpload mutation.
+          #
+          #   @return [String, nil]
+          optional :direct_upload_id, String, nil?: true
+
+          # @!method initialize(id: nil, direct_upload_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image} for more
+          #   details.
+          #
+          #   An image for the plan. This will be visible on the product page to customers.
+          #
+          #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
+          #
+          #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/checkout_configuration_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CheckoutConfigurations#list
+    class CheckoutConfigurationListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list checkout configurations for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute direction
+      #   The direction of the sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute plan_id
+      #   The ID of the plan to filter checkout configurations by
+      #
+      #   @return [String, nil]
+      optional :plan_id, String, nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, plan_id: nil, request_options: {})
+      #   @param company_id [String] The ID of the company to list checkout configurations for
+      #
+      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      #   @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      #   @param plan_id [String, nil] The ID of the plan to filter checkout configurations by
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/checkout_configuration_list_response.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CheckoutConfigurations#list
+    class CheckoutConfigurationListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the checkout configuration
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute affiliate_code
+      #   The affiliate code to use for the checkout configuration
+      #
+      #   @return [String, nil]
+      required :affiliate_code, String, nil?: true
+
+      # @!attribute company_id
+      #   The ID of the company to use for the checkout configuration
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute metadata
+      #   The metadata to use for the checkout configuration
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
+
+      # @!attribute plan
+      #   The plan to use for the checkout configuration
+      #
+      #   @return [WhopSDK::Models::CheckoutConfigurationListResponse::Plan]
+      required :plan, -> { WhopSDK::Models::CheckoutConfigurationListResponse::Plan }
+
+      # @!attribute purchase_url
+      #   The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @return [String]
+      required :purchase_url, String
+
+      # @!attribute redirect_url
+      #   The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @return [String, nil]
+      required :redirect_url, String, nil?: true
+
+      # @!method initialize(id:, affiliate_code:, company_id:, metadata:, plan:, purchase_url:, redirect_url:)
+      #   A checkout configuration object. Can be used to create a reusable custom
+      #   configuration for a checkout, including attaching plans, affiliates and custom
+      #   metadata to the checkout. This configuration can be re-used by multiple users.
+      #   All successful payments and memberships resulting from a checkout will contain
+      #   the passed metadata.
+      #
+      #   @param id [String] The ID of the checkout configuration
+      #
+      #   @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
+      #
+      #   @param company_id [String] The ID of the company to use for the checkout configuration
+      #
+      #   @param metadata [Hash{Symbol=>Object}] The metadata to use for the checkout configuration
+      #
+      #   @param plan [WhopSDK::Models::CheckoutConfigurationListResponse::Plan] The plan to use for the checkout configuration
+      #
+      #   @param purchase_url [String] The URL to redirect the user to after the checkout configuration is created
+      #
+      #   @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
+
+      # @see WhopSDK::Models::CheckoutConfigurationListResponse#plan
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the plan.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute billing_period
+        #   The interval at which the plan charges (renewal plans).
+        #
+        #   @return [Integer, nil]
+        required :billing_period, Integer, nil?: true
+
+        # @!attribute currency
+        #   The respective currency identifier for the plan.
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency]
+        required :currency, enum: -> { WhopSDK::Currency }
+
+        # @!attribute expiration_days
+        #   The interval at which the plan charges (expiration plans).
+        #
+        #   @return [Integer, nil]
+        required :expiration_days, Integer, nil?: true
+
+        # @!attribute initial_price
+        #   The price a person has to pay for a plan on the initial purchase.
+        #
+        #   @return [Float]
+        required :initial_price, Float
+
+        # @!attribute plan_type
+        #   Indicates if the plan is a one time payment or recurring.
+        #
+        #   @return [Symbol, WhopSDK::Models::PlanType]
+        required :plan_type, enum: -> { WhopSDK::PlanType }
+
+        # @!attribute release_method
+        #   This is the release method the business uses to sell this plan.
+        #
+        #   @return [Symbol, WhopSDK::Models::ReleaseMethod]
+        required :release_method, enum: -> { WhopSDK::ReleaseMethod }
+
+        # @!attribute renewal_price
+        #   The price a person has to pay for a plan on the renewal purchase.
+        #
+        #   @return [Float]
+        required :renewal_price, Float
+
+        # @!attribute trial_period_days
+        #   The number of free trial days added before a renewal plan.
+        #
+        #   @return [Integer, nil]
+        required :trial_period_days, Integer, nil?: true
+
+        # @!attribute visibility
+        #   Shows or hides the plan from public/business view.
+        #
+        #   @return [Symbol, WhopSDK::Models::Visibility]
+        required :visibility, enum: -> { WhopSDK::Visibility }
+
+        # @!method initialize(id:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, trial_period_days:, visibility:)
+        #   The plan to use for the checkout configuration
+        #
+        #   @param id [String] The internal ID of the plan.
+        #
+        #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
+        #
+        #   @param currency [Symbol, WhopSDK::Models::Currency] The respective currency identifier for the plan.
+        #
+        #   @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
+        #
+        #   @param initial_price [Float] The price a person has to pay for a plan on the initial purchase.
+        #
+        #   @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
+        #
+        #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod] This is the release method the business uses to sell this plan.
+        #
+        #   @param renewal_price [Float] The price a person has to pay for a plan on the renewal purchase.
+        #
+        #   @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
+        #
+        #   @param visibility [Symbol, WhopSDK::Models::Visibility] Shows or hides the plan from public/business view.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/checkout_configuration_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CheckoutConfigurations#retrieve
+    class CheckoutConfigurationRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end