Class: Orb::Models::SubscriptionFetchCostsParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/subscription_fetch_costs_params.rb,
sig/orb/models/subscription_fetch_costs_params.rbs

Overview

See Also:

  • Orb::Resources::Subscriptions#fetch_costs

Defined Under Namespace

Modules: ViewMode

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(subscription_id:, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::SubscriptionFetchCostsParams for more details.

Parameters:

  • subscription_id (String)
  • currency (String, nil) (defaults to: nil) —

    The currency or custom pricing unit to use.

  • timeframe_end (Time, nil) (defaults to: nil) —

    Costs returned are exclusive of timeframe_end.

  • timeframe_start (Time, nil) (defaults to: nil) —

    Costs returned are inclusive of timeframe_start.

  • view_mode (Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil) (defaults to: nil) —

    Controls whether Orb returns cumulative costs since the start of the billing per

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



# File 'lib/orb/models/subscription_fetch_costs_params.rb', line 42

Instance Attribute Details

#currency ⇒ String?

The currency or custom pricing unit to use.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


19
 
# File 'lib/orb/models/subscription_fetch_costs_params.rb', line 19

optional :currency, String, nil?: true

#subscription_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/orb/models/subscription_fetch_costs_params.rb', line 13

required :subscription_id, String

#timeframe_end ⇒ Time?

Costs returned are exclusive of timeframe_end.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


25
 
# File 'lib/orb/models/subscription_fetch_costs_params.rb', line 25

optional :timeframe_end, Time, nil?: true

#timeframe_start ⇒ Time?

Costs returned are inclusive of timeframe_start.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


31
 
# File 'lib/orb/models/subscription_fetch_costs_params.rb', line 31

optional :timeframe_start, Time, nil?: true

#view_mode ⇒ Symbol, ...

Controls whether Orb returns cumulative costs since the start of the billing period, or incremental day-by-day costs. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior.

Parameters:

  • value (Orb::Models::SubscriptionFetchCostsParams::view_mode, nil)

Returns:



40
 
# File 'lib/orb/models/subscription_fetch_costs_params.rb', line 40

optional :view_mode, enum: -> { Orb::SubscriptionFetchCostsParams::ViewMode }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


36
 
# File 'sig/orb/models/subscription_fetch_costs_params.rbs', line 36

def to_hash: -> {