Class: Orb::Models::SubscriptionChangeApplyResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/subscription_change_apply_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id: , expiration_time: , status: , subscription: , applied_at: nil, cancelled_at: nil) ⇒ Object

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

A subscription change represents a desired new subscription / pending change to an existing subscription. It is a way to first preview the effects on the subscription as well as any changes/creation of invoices (see ‘subscription.changed_resources`).

Parameters:

  • id (String) (defaults to: )
  • expiration_time (Time) (defaults to: ) —

    Subscription change will be cancelled at this time and can no longer be applied.

  • status (Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status) (defaults to: )
  • subscription (Orb::Models::MutatedSubscription, nil) (defaults to: )
  • applied_at (Time, nil) (defaults to: nil) —

    When this change was applied.

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

    When this change was cancelled.




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

Instance Attribute Details

#applied_at ⇒ Time?

When this change was applied.

Returns:

  • (Time, nil) 


32
 
# File 'lib/orb/models/subscription_change_apply_response.rb', line 32

optional :applied_at, Time, nil?: true

#cancelled_at ⇒ Time?

When this change was cancelled.

Returns:

  • (Time, nil) 


38
 
# File 'lib/orb/models/subscription_change_apply_response.rb', line 38

optional :cancelled_at, Time, nil?: true

#expiration_time ⇒ Time

Subscription change will be cancelled at this time and can no longer be applied.

Returns:

  • (Time) 


16
 
# File 'lib/orb/models/subscription_change_apply_response.rb', line 16

required :expiration_time, Time

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/orb/models/subscription_change_apply_response.rb', line 10

required :id, String

#status ⇒ Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status

Returns:



21
 
# File 'lib/orb/models/subscription_change_apply_response.rb', line 21

required :status, enum: -> { Orb::Models::SubscriptionChangeApplyResponse::Status }

#subscription ⇒ Orb::Models::MutatedSubscription?

Returns:



26
 
# File 'lib/orb/models/subscription_change_apply_response.rb', line 26

required :subscription, -> { Orb::MutatedSubscription }, nil?: true