Class: Orb::Models::SubscriptionCreateParams::AddPrice::Price::MeteredAllowance::MeteredAllowanceConfig

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/orb/models/subscription_create_params.rb,
sig/orb/models/subscription_create_params.rbs

Overview

See Also:

  • Orb::Models::SubscriptionCreateParams::AddPrice::Price::MeteredAllowance#metered_allowance_config

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 ⇒ Object 



1748
 
# File 'sig/orb/models/subscription_create_params.rbs', line 1748

def initialize: (

Instance Attribute Details

#allowance_display_name ⇒ String?

Sub-line label for the credit row (e.g. 'Up to 3x free egress').

Parameters:

  • (String)

Returns:

  • (String, nil) 


2556
 
# File 'lib/orb/models/subscription_create_params.rb', line 2556

optional :allowance_display_name, String

#allowance_grouping_value ⇒ String

The grouping_key value whose summed quantity represents the allowance for this period (e.g. 'storage_snapshot' emitting 3 × avg storage). Capped at consumption — credit can never exceed actual usage.

Parameters:

  • value (String)

Returns:

  • (String) 


2529
 
# File 'lib/orb/models/subscription_create_params.rb', line 2529

required :allowance_grouping_value, String

#consumption_display_name ⇒ String?

Sub-line label for the gross consumption row (e.g. 'bytes gotten').

Parameters:

  • (String)

Returns:

  • (String, nil) 


2562
 
# File 'lib/orb/models/subscription_create_params.rb', line 2562

optional :consumption_display_name, String

#consumption_grouping_value ⇒ String

The grouping_key value whose summed quantity represents consumption (e.g. 'download'). Charged at unit_amount.

Parameters:

  • value (String)

Returns:

  • (String) 


2536
 
# File 'lib/orb/models/subscription_create_params.rb', line 2536

required :consumption_grouping_value, String

#grouping_key ⇒ String

Event property used to partition the metric into consumption and allowance quantities (e.g. 'event_name'). The metric is queried with this key and the two values below select which partition is which.

Parameters:

  • value (String)

Returns:

  • (String) 


2544
 
# File 'lib/orb/models/subscription_create_params.rb', line 2544

required :grouping_key, String

#unit_amount ⇒ String

Per-unit price applied to gross consumption and to the allowance credit.

Parameters:

  • value (String)

Returns:

  • (String) 


2550
 
# File 'lib/orb/models/subscription_create_params.rb', line 2550

required :unit_amount, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1757
 
# File 'sig/orb/models/subscription_create_params.rbs', line 1757

def to_hash: -> {