Class: MetronomeSDK::Models::V1::PackageCreateParams::Subscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/package_create_params.rb

Defined Under Namespace

Modules: CollectionSchedule, QuantityManagementMode Classes: Duration, Proration, SeatConfig, StartingAtOffset, SubscriptionRate

Instance Attribute Summary collapse

Class Method 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(seat_group_key:, initial_unassigned_seats: nil) ⇒ Object

Some parameter documentations has been truncated, see SeatConfig for more details.

Parameters:

  • seat_group_key (String) —

    The property name, sent on usage events, that identifies the seat ID associated

  • initial_unassigned_seats (Float) (defaults to: nil) —

    The initial amount of unassigned seats on this subscription.




# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2325

Instance Attribute Details

#collection_schedule ⇒ Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Subscription::CollectionSchedule

Returns:



2248
2249
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2248

required :collection_schedule,
enum: -> { MetronomeSDK::V1::PackageCreateParams::Subscription::CollectionSchedule }

#custom_fields ⇒ Hash{Symbol=>String}?

Custom fields to be added eg. { “key1”: “value1”, “key2”: “value2” }

Returns:

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


2265
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2265

optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#description ⇒ String?

Returns:

  • (String, nil) 


2270
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2270

optional :description, String

#duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Subscription::Duration?

Lifetime of the subscription from its start. If not provided, subscription inherits contract end date.

Returns:



2277
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2277

optional :duration, -> { MetronomeSDK::V1::PackageCreateParams::Subscription::Duration }

#initial_quantity ⇒ Float?

The initial quantity for the subscription. It must be non-negative value. Required if quantity_management_mode is QUANTITY_ONLY.

Returns:

  • (Float, nil) 


2284
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2284

optional :initial_quantity, Float

#name ⇒ String?

Returns:

  • (String, nil) 


2289
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2289

optional :name, String

#proration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Subscription::Proration

Returns:



2254
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2254

required :proration, -> { MetronomeSDK::V1::PackageCreateParams::Subscription::Proration }

#quantity_management_mode ⇒ Symbol, ...

Determines how the subscription’s quantity is controlled. Defaults to QUANTITY_ONLY. QUANTITY_ONLY: The subscription quantity is specified directly on the subscription. ‘initial_quantity` must be provided with this option. Compatible with recurring commits/credits that use POOLED allocation. SEAT_BASED: Use when you want to pass specific seat identifiers (e.g. add user_123) to increment and decrement a subscription quantity, rather than directly providing the quantity. You must use a SEAT_BASED subscription to use a linked recurring credit with an allocation per seat. `seat_config` must be provided with this option.

Returns:



2303
2304
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2303

optional :quantity_management_mode,
enum: -> { MetronomeSDK::V1::PackageCreateParams::Subscription::QuantityManagementMode }

#seat_config ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Subscription::SeatConfig?

Returns:



2309
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2309

optional :seat_config, -> { MetronomeSDK::V1::PackageCreateParams::Subscription::SeatConfig }

#starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Subscription::StartingAtOffset?

Relative date from contract start date corresponding to the inclusive start time for the subscription. If not provided, defaults to contract start date

Returns:



2316
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2316

optional :starting_at_offset, -> { MetronomeSDK::V1::PackageCreateParams::Subscription::StartingAtOffset }

#subscription_rate ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Subscription::SubscriptionRate

Returns:



2259
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2259

required :subscription_rate, -> { MetronomeSDK::V1::PackageCreateParams::Subscription::SubscriptionRate }

#temporary_id ⇒ String?

A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.

Returns:

  • (String, nil) 


2323
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2323

optional :temporary_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2360