Class: Orb::Models::SubscriptionListParams

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

Overview

See Also:

  • Orb::Resources::Subscriptions#list

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 ⇒ Object 



47
 
# File 'sig/orb/models/subscription_list_params.rbs', line 47

def initialize: (

Instance Attribute Details

#created_at_gt ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


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

optional :created_at_gt, Time, nil?: true

#created_at_gte ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


18
 
# File 'lib/orb/models/subscription_list_params.rb', line 18

optional :created_at_gte, Time, nil?: true

#created_at_lt ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


23
 
# File 'lib/orb/models/subscription_list_params.rb', line 23

optional :created_at_lt, Time, nil?: true

#created_at_lte ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


28
 
# File 'lib/orb/models/subscription_list_params.rb', line 28

optional :created_at_lte, Time, nil?: true

#cursor ⇒ String?

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


35
 
# File 'lib/orb/models/subscription_list_params.rb', line 35

optional :cursor, String, nil?: true

#customer_id ⇒ Array<String>?

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


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

optional :customer_id, Orb::Internal::Type::ArrayOf[String], nil?: true

#external_customer_id ⇒ Array<String>?

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


45
 
# File 'lib/orb/models/subscription_list_params.rb', line 45

optional :external_customer_id, Orb::Internal::Type::ArrayOf[String], nil?: true

#external_plan_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


50
 
# File 'lib/orb/models/subscription_list_params.rb', line 50

optional :external_plan_id, String, nil?: true

#limit ⇒ Integer?

The number of items to fetch. Defaults to 20.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


56
 
# File 'lib/orb/models/subscription_list_params.rb', line 56

optional :limit, Integer

#plan_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/orb/models/subscription_list_params.rb', line 61

optional :plan_id, String, nil?: true

#status ⇒ Symbol, ...

Parameters:

  • value (Orb::Models::SubscriptionListParams::status, nil)

Returns:



66
 
# File 'lib/orb/models/subscription_list_params.rb', line 66

optional :status, enum: -> { Orb::SubscriptionListParams::Status }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


62
 
# File 'sig/orb/models/subscription_list_params.rbs', line 62

def to_hash: -> {