Class: MetronomeSDK::Models::V1::ContractUpdateEndDateParams

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

Overview

See Also:

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(contract_id: , customer_id: , allow_ending_before_finalized_invoice: nil, ending_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::ContractUpdateEndDateParams for more details.

Parameters:

  • contract_id (String) (defaults to: ) —

    ID of the contract to update

  • customer_id (String) (defaults to: ) —

    ID of the customer whose contract is to be updated

  • allow_ending_before_finalized_invoice (Boolean) (defaults to: nil) —

    If true, allows setting the contract end date earlier than the end_timestamp of

  • ending_before (Time) (defaults to: nil) —

    RFC 3339 timestamp indicating when the contract will end (exclusive). If not pro

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



# File 'lib/metronome_sdk/models/v1/contract_update_end_date_params.rb', line 39

Instance Attribute Details

#allow_ending_before_finalized_invoice ⇒ Boolean?

If true, allows setting the contract end date earlier than the end_timestamp of existing finalized invoices. Finalized invoices will be unchanged; if you want to incorporate the new end date, you can void and regenerate finalized usage invoices. Defaults to true.

Returns:

  • (Boolean, nil) 


30
 
# File 'lib/metronome_sdk/models/v1/contract_update_end_date_params.rb', line 30

optional :allow_ending_before_finalized_invoice, MetronomeSDK::Internal::Type::Boolean

#contract_id ⇒ String

ID of the contract to update

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v1/contract_update_end_date_params.rb', line 15

required :contract_id, String

#customer_id ⇒ String

ID of the customer whose contract is to be updated

Returns:

  • (String) 


21
 
# File 'lib/metronome_sdk/models/v1/contract_update_end_date_params.rb', line 21

required :customer_id, String

#ending_before ⇒ Time?

RFC 3339 timestamp indicating when the contract will end (exclusive). If not provided, the contract will be updated to be open-ended.

Returns:

  • (Time, nil) 


37
 
# File 'lib/metronome_sdk/models/v1/contract_update_end_date_params.rb', line 37

optional :ending_before, Time