Class: CloudpaymentsRuby::Models::SubscriptionUpdateParams

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

Overview

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

Parameters:

  • id (String)

    Идентификатор подписки

  • amount (Float) (defaults to: nil)

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

  • culture_name (String) (defaults to: nil)

    Язык уведомлений (ru-RU, en-US)

  • currency (String) (defaults to: nil)

    Валюта

  • customer_receipt (Object) (defaults to: nil)

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

  • description (String) (defaults to: nil)

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

  • interval (String) (defaults to: nil)

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

  • max_periods (Integer) (defaults to: nil)

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

  • period (Integer) (defaults to: nil)

    Период

  • require_confirmation (Boolean) (defaults to: nil)

    Требуется подтверждение

  • start_date (Time) (defaults to: nil)

    Дата и время следующего платежа (UTC)

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


# File 'lib/cloudpayments_ruby/models/subscription_update_params.rb', line 78

Instance Attribute Details

#amountFloat?

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

Returns:

  • (Float, nil)


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

optional :amount, Float, api_name: :Amount

#culture_nameString?

Язык уведомлений (ru-RU, en-US)

Returns:

  • (String, nil)


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

optional :culture_name, String, api_name: :CultureName

#currencyString?

Валюта

Returns:

  • (String, nil)


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

optional :currency, String, api_name: :Currency

#customer_receiptObject?

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

Returns:

  • (Object, nil)


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

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

#descriptionString?

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

Returns:

  • (String, nil)


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

optional :description, String, api_name: :Description

#idString

Идентификатор подписки

Returns:

  • (String)


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

required :id, String, api_name: :Id

#intervalString?

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

Returns:

  • (String, nil)


50
# File 'lib/cloudpayments_ruby/models/subscription_update_params.rb', line 50

optional :interval, String, api_name: :Interval

#max_periodsInteger?

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

Returns:

  • (Integer, nil)


56
# File 'lib/cloudpayments_ruby/models/subscription_update_params.rb', line 56

optional :max_periods, Integer, api_name: :MaxPeriods

#periodInteger?

Период

Returns:

  • (Integer, nil)


62
# File 'lib/cloudpayments_ruby/models/subscription_update_params.rb', line 62

optional :period, Integer, api_name: :Period

#require_confirmationBoolean?

Требуется подтверждение

Returns:

  • (Boolean, nil)


68
69
70
# File 'lib/cloudpayments_ruby/models/subscription_update_params.rb', line 68

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

#start_dateTime?

Дата и время следующего платежа (UTC)

Returns:

  • (Time, nil)


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

optional :start_date, Time, api_name: :StartDate