Class: MetronomeSDK::Models::V1::PlanListCustomersParams

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

Overview

See Also:

Defined Under Namespace

Modules: Status

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(plan_id: , limit: nil, next_page: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

  • plan_id (String) (defaults to: )
  • limit (Integer) (defaults to: nil) —

    Max number of results that should be returned

  • next_page (String) (defaults to: nil) —

    Cursor that indicates where the next page of results should start.

  • status (Symbol, MetronomeSDK::Models::V1::PlanListCustomersParams::Status) (defaults to: nil) —

    Status of customers on a given plan. Defaults to ‘active`.

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



# File 'lib/metronome_sdk/models/v1/plan_list_customers_params.rb', line 42

Instance Attribute Details

#limit ⇒ Integer?

Max number of results that should be returned

Returns:

  • (Integer, nil) 


20
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_params.rb', line 20

optional :limit, Integer

#next_page ⇒ String?

Cursor that indicates where the next page of results should start.

Returns:

  • (String, nil) 


26
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_params.rb', line 26

optional :next_page, String

#plan_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_params.rb', line 14

required :plan_id, String

#status ⇒ Symbol, ...

Status of customers on a given plan. Defaults to ‘active`.

  • ‘all` - Return current, past, and upcoming customers of the plan.

  • ‘active` - Return current customers of the plan.

  • ‘ended` - Return past customers of the plan.

  • ‘upcoming` - Return upcoming customers of the plan.

Multiple statuses can be OR’d together using commas, e.g. ‘active,ended`. Note: `ended,upcoming` combination is not yet supported.

Returns:



40
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_params.rb', line 40

optional :status, enum: -> { MetronomeSDK::V1::PlanListCustomersParams::Status }