Class: WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID::Plan::CustomField

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/whop_sdk/models/invoice_create_params.rb,
sig/whop_sdk/models/invoice_create_params.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(adaptive_pricing_enabled: nil, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID::Plan for more details.

The plan attributes defining the price, currency, and billing interval for this invoice.

Parameters:

  • adaptive_pricing_enabled (Boolean, nil) (defaults to: nil) —

    Whether this plan accepts local currency payments via adaptive pricing.

  • billing_period (Integer, nil) (defaults to: nil) —

    The interval in days at which the plan charges (renewal plans).

  • currency (Symbol, WhopSDK::Models::Currency, nil) (defaults to: nil) —

    The available currencies on the platform

  • custom_fields (Array<WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID::Plan::CustomField>, nil) (defaults to: nil) —

    An array of custom field objects.

  • description (String, nil) (defaults to: nil) —

    The description of the plan.

  • expiration_days (Integer, nil) (defaults to: nil) —

    The number of days until the membership expires and revokes access (expiration p

  • initial_price (Float, nil) (defaults to: nil) —

    An additional amount charged upon first purchase. Use only if a one time payment

  • internal_notes (String, nil) (defaults to: nil) —

    A personal description or notes section for the business.

  • legacy_payment_method_controls (Boolean, nil) (defaults to: nil) —

    Whether this plan uses legacy payment method controls

  • payment_method_configuration (WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID::Plan::PaymentMethodConfiguration, nil) (defaults to: nil) —

    The explicit payment method configuration for the plan. If not provided, the pla

  • plan_type (Symbol, WhopSDK::Models::PlanType, nil) (defaults to: nil) —

    The type of plan that can be attached to a product

  • release_method (Symbol, WhopSDK::Models::ReleaseMethod, nil) (defaults to: nil) —

    The methods of how a plan can be released.

  • renewal_price (Float, nil) (defaults to: nil) —

    The amount the customer is charged every billing period. Use only if a recurring

  • stock (Integer, nil) (defaults to: nil) —

    The number of units available for purchase.

  • trial_period_days (Integer, nil) (defaults to: nil) —

    The number of free trial days added before a renewal plan.

  • unlimited_stock (Boolean, nil) (defaults to: nil) —

    When true, the plan has unlimited stock (stock field is ignored). When false, pu

  • visibility (Symbol, WhopSDK::Models::Visibility, nil) (defaults to: nil) —

    Visibility of a resource



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/whop_sdk/models/invoice_create_params.rb', line 923

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

Instance Attribute Details

#field_type ⇒ Symbol, :text

The type of the custom field.

Parameters:

  • value (:text)

Returns:

  • (Symbol, :text) 


928
 
# File 'lib/whop_sdk/models/invoice_create_params.rb', line 928

required :field_type, const: :text

#id ⇒ String?

The ID of the custom field (if being updated)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


940
 
# File 'lib/whop_sdk/models/invoice_create_params.rb', line 940

optional :id, String, nil?: true

#name ⇒ String

The name of the custom field.

Parameters:

  • value (String)

Returns:

  • (String) 


934
 
# File 'lib/whop_sdk/models/invoice_create_params.rb', line 934

required :name, String

#order ⇒ Integer?

The order of the field.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


946
 
# File 'lib/whop_sdk/models/invoice_create_params.rb', line 946

optional :order, Integer, nil?: true

#placeholder ⇒ String?

The placeholder value of the field.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


952
 
# File 'lib/whop_sdk/models/invoice_create_params.rb', line 952

optional :placeholder, String, nil?: true

#required ⇒ Boolean?

Whether or not the field is required.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


958
 
# File 'lib/whop_sdk/models/invoice_create_params.rb', line 958

optional :required, WhopSDK::Internal::Type::Boolean, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


617
 
# File 'sig/whop_sdk/models/invoice_create_params.rbs', line 617

def to_hash: -> {