Class: MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig

Defined in:

lib/metronome_sdk/models/v1/contract_create_params.rb

Overview

See Also:

• #stripe_config

Defined Under Namespace

Modules: PaymentType

Instance Attribute Summary

• #invoice_metadata ⇒ Hash{Symbol=>String}^?

  Metadata to be added to the Stripe invoice.

• #on_session_payment ⇒ Boolean^?

  If true, the payment will be made assuming the customer is present (i.e. on session).

• #payment_type ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType

  If left blank, will default to INVOICE.

Instance Method Summary

• #initialize(payment_type: , invoice_metadata: nil, on_session_payment: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see StripeConfig for more details.

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(payment_type: , invoice_metadata: nil, on_session_payment: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig for more details.

Only applicable if using STRIPE as your payment gate type.

Parameters:

• payment_type (Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType) (defaults to: ) —

  If left blank, will default to INVOICE

• invoice_metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as

• on_session_payment (Boolean) (defaults to: nil) —

  If true, the payment will be made assuming the customer is present (i.e. on sess

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 892

Instance Attribute Details

#invoice_metadata ⇒ Hash{Symbol=>String}^?

Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 877

optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]

#on_session_payment ⇒ Boolean^?

If true, the payment will be made assuming the customer is present (i.e. on session).

If false, the payment will be made assuming the customer is not present (i.e. off session). For cardholders from a country with an e-mandate requirement (e.g. India), the payment may be declined.

If left blank, will default to false.

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 890

optional :on_session_payment, MetronomeSDK::Internal::Type::Boolean

#payment_type ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType

If left blank, will default to INVOICE

Returns:

• (Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 869

required :payment_type,
enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType }