Module: Dodopayments::Models::SubscriptionUpdateParams::CancelReason

Extended by:

Internal::Type::Enum

Defined in:

lib/dodopayments/models/subscription_update_params.rb,
sig/dodopayments/models/subscription_update_params.rbs

Constant Summary

CANCELLED_BY_CUSTOMER =

Returns:

• (:cancelled_by_customer)

:cancelled_by_customer

CANCELLED_BY_MERCHANT =

Returns:

• (:cancelled_by_merchant)

:cancelled_by_merchant

CANCELLED_BY_MERCHANT_SEND_DUNNING =

Returns:

• (:cancelled_by_merchant_send_dunning)

:cancelled_by_merchant_send_dunning

DODO_TEAM =

Returns:

• (:dodo_team)

:dodo_team

Instance Method Summary

• #initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {}) ⇒ Object

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

• #self?.values ⇒ ::Array[Dodopayments::Models::SubscriptionUpdateParams::cancel_reason]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• subscription_id (String)
• billing (Dodopayments::Models::BillingAddress, nil) (defaults to: nil)
• cancel_at_next_billing_date (Boolean, nil) (defaults to: nil) —

  When set, the subscription will remain active until the end of billing period

• cancel_reason (Symbol, Dodopayments::Models::SubscriptionUpdateParams::CancelReason, nil) (defaults to: nil)
• cancellation_comment (String, nil) (defaults to: nil) —

  Free-text cancellation comment (only valid when cancelling or scheduling cancell

• cancellation_feedback (Symbol, Dodopayments::Models::CancellationFeedback, nil) (defaults to: nil) —

  Customer-supplied churn reason (only valid when cancelling or scheduling cancell

• credit_entitlement_cart (Array<Dodopayments::Models::SubscriptionUpdateParams::CreditEntitlementCart>, nil) (defaults to: nil) —

  Update credit entitlement cart settings

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

  Optional business / legal name associated with the tax id. When provided

• customer_name (String, nil) (defaults to: nil)
• disable_on_demand (Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil) (defaults to: nil)
• metadata (Hash{Symbol=>String, Float, Boolean}, nil) (defaults to: nil) —

  Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

• next_billing_date (Time, nil) (defaults to: nil)
• status (Symbol, Dodopayments::Models::SubscriptionStatus, nil) (defaults to: nil)
• subscription_period_count (Integer, nil) (defaults to: nil) —

  New number of subscription_period_interval units the subscription

• subscription_period_interval (Symbol, Dodopayments::Models::TimeInterval, nil) (defaults to: nil) —

  New interval unit for the subscription period. When changing the period,

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

# File 'lib/dodopayments/models/subscription_update_params.rb', line 152

module CancelReason
  extend Dodopayments::Internal::Type::Enum

  CANCELLED_BY_CUSTOMER = :cancelled_by_customer
  CANCELLED_BY_MERCHANT = :cancelled_by_merchant
  CANCELLED_BY_MERCHANT_SEND_DUNNING = :cancelled_by_merchant_send_dunning
  DODO_TEAM = :dodo_team

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Dodopayments::Models::SubscriptionUpdateParams::cancel_reason]

Returns:

• (::Array[Dodopayments::Models::SubscriptionUpdateParams::cancel_reason])

# File 'sig/dodopayments/models/subscription_update_params.rbs', line 114

def self?.values: -> ::Array[Dodopayments::Models::SubscriptionUpdateParams::cancel_reason]