Class: Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Credit

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/subscription_update_params.rb

Defined Under Namespace

Modules: Cadence

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(id:, amount:, cadence:, type: :CREDIT) ⇒ Object

Credit entitlement configuration for a subscription

Parameters:




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

Instance Attribute Details

#amount ⇒ Float

Credit grant amount

Returns:

  • (Float) 


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

required :amount, Float

#cadence ⇒ Symbol, Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Credit::Cadence

Credit grant cadence (MONTH or YEAR)

Returns:



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

required :cadence, enum: -> { Stigg::V1::SubscriptionUpdateParams::Entitlement::Credit::Cadence }

#id ⇒ String

The custom currency ID for the credit entitlement

Returns:

  • (String) 


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

required :id, String

#type ⇒ Symbol, :CREDIT

SubscriptionCreditEntitlementRequest

Returns:

  • (Symbol, :CREDIT) 


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

required :type, const: :CREDIT