Class: CloudpaymentsRuby::Models::SubscriptionCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cloudpayments_ruby/models/subscription_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(account_id:, amount:, currency:, description:, interval:, period:, require_confirmation:, start_date:, token:, customer_receipt: nil, email: nil, max_periods: nil, request_options: {}) ⇒ Object

Parameters:

  • account_id (String) —

    Идентификатор пользователя

  • amount (Float) —

    Сумма платежа

  • currency (String) —

    Валюта

  • description (String) —

    Описание платежа

  • interval (String) —

    Интервал: Day, Week, Month

  • period (Integer) —

    Период (в сочетании с Interval)

  • require_confirmation (Boolean) —

    Требуется подтверждение (двухстадийная схема)

  • start_date (Time) —

    Дата и время первого платежа (UTC)

  • token (String) —

    Токен карты

  • customer_receipt (Object) (defaults to: nil) —

    Данные для онлайн-чека

  • email (String) (defaults to: nil) —

    Email плательщика

  • max_periods (Integer) (defaults to: nil) —

    Максимальное количество платежей

  • request_options (CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 84

Instance Attribute Details

#account_id ⇒ String

Идентификатор пользователя

Returns:

  • (String) 


14
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 14

required :account_id, String, api_name: :AccountId

#amount ⇒ Float

Сумма платежа

Returns:

  • (Float) 


20
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 20

required :amount, Float, api_name: :Amount

#currency ⇒ String

Валюта

Returns:

  • (String) 


26
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 26

required :currency, String, api_name: :Currency

#customer_receipt ⇒ Object?

Данные для онлайн-чека

Returns:

  • (Object, nil) 


70
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 70

optional :customer_receipt, CloudpaymentsRuby::Internal::Type::Unknown, api_name: :CustomerReceipt

#description ⇒ String

Описание платежа

Returns:

  • (String) 


32
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 32

required :description, String, api_name: :Description

#email ⇒ String?

Email плательщика

Returns:

  • (String, nil) 


76
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 76

optional :email, String, api_name: :Email

#interval ⇒ String

Интервал: Day, Week, Month

Returns:

  • (String) 


38
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 38

required :interval, String, api_name: :Interval

#max_periods ⇒ Integer?

Максимальное количество платежей

Returns:

  • (Integer, nil) 


82
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 82

optional :max_periods, Integer, api_name: :MaxPeriods

#period ⇒ Integer

Период (в сочетании с Interval)

Returns:

  • (Integer) 


44
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 44

required :period, Integer, api_name: :Period

#require_confirmation ⇒ Boolean

Требуется подтверждение (двухстадийная схема)

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 50

required :require_confirmation,
CloudpaymentsRuby::Internal::Type::Boolean,
api_name: :RequireConfirmation

#start_date ⇒ Time

Дата и время первого платежа (UTC)

Returns:

  • (Time) 


58
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 58

required :start_date, Time, api_name: :StartDate

#token ⇒ String

Токен карты

Returns:

  • (String) 


64
 
# File 'lib/cloudpayments_ruby/models/subscription_create_params.rb', line 64

required :token, String, api_name: :Token