Class: Dodopayments::Models::SubscriptionRetrieveUsageHistoryParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::SubscriptionRetrieveUsageHistoryParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/subscription_retrieve_usage_history_params.rb

Overview

See Also:

• Resources::Subscriptions#retrieve_usage_history

Instance Attribute Summary

• #end_date ⇒ Time^?

  Filter by end date (inclusive).

• #meter_id ⇒ String^?

  Filter by specific meter ID.

• #page_number ⇒ Integer^?

  Page number (default: 0).

• #page_size ⇒ Integer^?

  Page size (default: 10, max: 100).

• #start_date ⇒ Time^?

  Filter by start date (inclusive).

• #subscription_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(subscription_id:, end_date: nil, meter_id: nil, page_number: nil, page_size: nil, start_date: nil, request_options: {}) ⇒ Object constructor

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:, end_date: nil, meter_id: nil, page_number: nil, page_size: nil, start_date: nil, request_options: {}) ⇒ Object

Parameters:

• subscription_id (String)
• end_date (Time, nil) (defaults to: nil) —

  Filter by end date (inclusive)

• meter_id (String, nil) (defaults to: nil) —

  Filter by specific meter ID

• page_number (Integer, nil) (defaults to: nil) —

  Page number (default: 0)

• page_size (Integer, nil) (defaults to: nil) —

  Page size (default: 10, max: 100)

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

  Filter by start date (inclusive)

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

# File 'lib/dodopayments/models/subscription_retrieve_usage_history_params.rb', line 45

Instance Attribute Details

#end_date ⇒ Time^?

Filter by end date (inclusive)

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/subscription_retrieve_usage_history_params.rb', line 19

optional :end_date, Time, nil?: true

#meter_id ⇒ String^?

Filter by specific meter ID

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_retrieve_usage_history_params.rb', line 25

optional :meter_id, String, nil?: true

#page_number ⇒ Integer^?

Page number (default: 0)

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/subscription_retrieve_usage_history_params.rb', line 31

optional :page_number, Integer, nil?: true

#page_size ⇒ Integer^?

Page size (default: 10, max: 100)

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/subscription_retrieve_usage_history_params.rb', line 37

optional :page_size, Integer, nil?: true

#start_date ⇒ Time^?

Filter by start date (inclusive)

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/subscription_retrieve_usage_history_params.rb', line 43

optional :start_date, Time, nil?: true

#subscription_id ⇒ String

Returns:

• (String)

# File 'lib/dodopayments/models/subscription_retrieve_usage_history_params.rb', line 13

required :subscription_id, String