Class: Stigg::Models::V1::SubscriptionUpdateParams

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

Overview

See Also:

Defined Under Namespace

Modules: BillingCycleAnchor, BillingPeriod, Entitlement, ScheduleStrategy Classes: Addon, AppliedCoupon, BillingInformation, Budget, Charge, MinimumSpend, PriceOverride

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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(has_soft_limit:, limit:) ⇒ Object

Parameters:

  • has_soft_limit (Boolean) —

    Whether the budget is a soft limit

  • limit (Float) —

    Maximum spending limit




# File 'lib/stigg/models/v1/subscription_update_params.rb', line 170

Instance Attribute Details

#addons ⇒ Array<Stigg::Models::V1::SubscriptionUpdateParams::Addon>?

Returns:



19
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 19

optional :addons, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionUpdateParams::Addon] }

#applied_coupon ⇒ Stigg::Models::V1::SubscriptionUpdateParams::AppliedCoupon?

Returns:



24
25
26
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 24

optional :applied_coupon,
-> { Stigg::V1::SubscriptionUpdateParams::AppliedCoupon },
api_name: :appliedCoupon

#await_payment_confirmation ⇒ Boolean?

Await payment confirmation

Returns:

  • (Boolean, nil) 


32
33
34
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 32

optional :await_payment_confirmation,
Stigg::Internal::Type::Boolean,
api_name: :awaitPaymentConfirmation

#billing_cycle_anchor ⇒ Symbol, ...

Returns:



39
40
41
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 39

optional :billing_cycle_anchor,
enum: -> { Stigg::V1::SubscriptionUpdateParams::BillingCycleAnchor },
api_name: :billingCycleAnchor

#billing_information ⇒ Stigg::Models::V1::SubscriptionUpdateParams::BillingInformation?

Returns:



46
47
48
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 46

optional :billing_information,
-> { Stigg::V1::SubscriptionUpdateParams::BillingInformation },
api_name: :billingInformation

#billing_period ⇒ Symbol, ...

Returns:



53
54
55
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 53

optional :billing_period,
enum: -> { Stigg::V1::SubscriptionUpdateParams::BillingPeriod },
api_name: :billingPeriod

#budget ⇒ Stigg::Models::V1::SubscriptionUpdateParams::Budget?

Returns:



60
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 60

optional :budget, -> { Stigg::V1::SubscriptionUpdateParams::Budget }, nil?: true

#cancellation_date ⇒ Time?

Subscription cancellation date

Returns:

  • (Time, nil) 


66
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 66

optional :cancellation_date, Time, api_name: :cancellationDate, nil?: true

#charges ⇒ Array<Stigg::Models::V1::SubscriptionUpdateParams::Charge>?

Returns:



71
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 71

optional :charges, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionUpdateParams::Charge] }

#entitlements ⇒ Array<Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Feature, Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Credit>?

Returns:



76
77
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 76

optional :entitlements,
-> { Stigg::Internal::Type::ArrayOf[union: Stigg::V1::SubscriptionUpdateParams::Entitlement] }

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the subscription

Returns:

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


83
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 83

optional :metadata, Stigg::Internal::Type::HashOf[String]

#minimum_spend ⇒ Stigg::Models::V1::SubscriptionUpdateParams::MinimumSpend?

Minimum spend amount

Returns:



89
90
91
92
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 89

optional :minimum_spend,
-> { Stigg::V1::SubscriptionUpdateParams::MinimumSpend },
api_name: :minimumSpend,
nil?: true

#price_overrides ⇒ Array<Stigg::Models::V1::SubscriptionUpdateParams::PriceOverride>?

Returns:



97
98
99
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 97

optional :price_overrides,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionUpdateParams::PriceOverride] },
api_name: :priceOverrides

#promotion_code ⇒ String?

Promotion code

Returns:

  • (String, nil) 


105
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 105

optional :promotion_code, String, api_name: :promotionCode

#schedule_strategy ⇒ Symbol, ...

Returns:



110
111
112
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 110

optional :schedule_strategy,
enum: -> { Stigg::V1::SubscriptionUpdateParams::ScheduleStrategy },
api_name: :scheduleStrategy

#trial_end_date ⇒ Time?

Subscription trial end date

Returns:

  • (Time, nil) 


118
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 118

optional :trial_end_date, Time, api_name: :trialEndDate

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/subscription_update_params.rb', line 411

.variants ⇒ Array(Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Feature, Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Credit)

Returns:




# File 'lib/stigg/models/v1/subscription_update_params.rb', line 942