Class: Dodopayments::Models::SubscriptionUpdatedWebhookEvent::Data

Inherits:
Dodopayments::Models::Subscription show all
Defined in:
lib/dodopayments/models/subscription_updated_webhook_event.rb,
sig/dodopayments/models/subscription_updated_webhook_event.rbs

Overview

See Also:

  • Dodopayments::Models::SubscriptionUpdatedWebhookEvent#data

Instance Attribute Summary collapse

Attributes inherited from Dodopayments::Models::Subscription

#addons, #billing, #brand_id, #cancel_at_next_billing_date, #cancellation_comment, #cancellation_feedback, #cancelled_at, #created_at, #credit_entitlement_cart, #currency, #custom_field_responses, #customer, #customer_business_name, #discount_cycles_remaining, #discount_id, #discounts, #expires_at, #has_payment_method, #metadata, #meter_credit_entitlement_cart, #meters, #next_billing_date, #on_demand, #paused_at, #payment_frequency_count, #payment_frequency_interval, #payment_method_id, #previous_billing_date, #product_id, #quantity, #recurring_pre_tax_amount, #scheduled_change, #status, #subscription_id, #subscription_period_count, #subscription_period_interval, #tax_id, #tax_inclusive, #trial_amount, #trial_period_days

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(past_due_ends_at: nil) ⇒ Data

Some parameter documentations has been truncated, see Dodopayments::Models::SubscriptionUpdatedWebhookEvent::Data for more details.

Subscription payload sent on a webhook. It carries every field of SubscriptionResponse, plus the grace-period deadline.

Parameters:

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

    Time when the grace period ends. The subscription moves to on_hold or

  • past_due_ends_at: (Time, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/subscription_updated_webhook_event.rb', line 57

Instance Attribute Details

#past_due_ends_at ⇒ Time?

Time when the grace period ends. The subscription moves to on_hold or to cancelled at this time.

Read in the same query as the rest of the payload, so it always comes from the row snapshot that produced status. It is set whenever the subscription sits in a window at that moment. A delayed event of another type therefore carries the deadline too, next to a past_due status.

Parameters:

  • _ (Time, nil)

Returns:

  • (Time, nil) 


55
 
# File 'lib/dodopayments/models/subscription_updated_webhook_event.rb', line 55

optional :past_due_ends_at, Time, nil?: true

Instance Method Details

#to_hash ⇒ { past_due_ends_at: Time? }

Returns:

  • ({ past_due_ends_at: Time? }) 


43
 
# File 'sig/dodopayments/models/subscription_updated_webhook_event.rbs', line 43

def to_hash: -> { past_due_ends_at: Time? }