Class: WhopSDK::Models::PaymentCreateParams::Body::CreatePaymentInputWithPlanID

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/payment_create_params.rb,
sig/whop_sdk/models/payment_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(company_id:, member_id:, payment_method_id:, plan_id:, metadata: nil, promo_code_id: nil) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::PaymentCreateParams::Body::CreatePaymentInputWithPlanID for more details.

Autogenerated input type of CreatePayment

Parameters:

  • company_id (String) —

    The ID of the company to create the payment for.

  • member_id (String) —

    The ID of the member to create the payment for.

  • payment_method_id (String) —

    The ID of the payment method to use for the payment. It must be connected to the

  • plan_id (String) —

    An ID of an existing plan to use for the payment.

  • metadata (Hash{Symbol=>Object}, nil) (defaults to: nil) —

    Custom metadata to attach to the payment.

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

    The ID of an active promo code to apply to this payment. The promo code must bel




# File 'lib/whop_sdk/models/payment_create_params.rb', line 384

Instance Attribute Details

#company_id ⇒ String

The ID of the company to create the payment for.

Parameters:

  • value (String)

Returns:

  • (String) 


349
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 349

required :company_id, String

#member_id ⇒ String

The ID of the member to create the payment for.

Parameters:

  • value (String)

Returns:

  • (String) 


355
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 355

required :member_id, String

#metadata ⇒ Hash{Symbol=>Object}?

Custom metadata to attach to the payment.

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:

  • (Hash{Symbol=>Object}, nil) 


374
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 374

optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true

#payment_method_id ⇒ String

The ID of the payment method to use for the payment. It must be connected to the Member being charged.

Parameters:

  • value (String)

Returns:

  • (String) 


362
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 362

required :payment_method_id, String

#plan_id ⇒ String

An ID of an existing plan to use for the payment.

Parameters:

  • value (String)

Returns:

  • (String) 


368
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 368

required :plan_id, String

#promo_code_id ⇒ String?

The ID of an active promo code to apply to this payment. The promo code must belong to the company and be valid for the plan being purchased. The plan must be attached to a product — promo codes are not eligible for one-off purchases.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


382
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 382

optional :promo_code_id, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


263
 
# File 'sig/whop_sdk/models/payment_create_params.rbs', line 263

def to_hash: -> {