Class: Stigg::Models::V1::SubscriptionPreviewParams::Addon

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::SubscriptionPreviewParams::Addon

Defined in:

lib/stigg/models/v1/subscription_preview_params.rb

Instance Attribute Summary

• #id ⇒ String

  Addon ID.

• #quantity ⇒ Integer

  Number of addon instances.

Instance Method Summary

• #initialize(customer_id:, plan_id:, addons: nil, applied_coupon: nil, billable_features: nil, billing_country_code: nil, billing_cycle_anchor: nil, billing_information: nil, billing_period: nil, charges: nil, paying_customer_id: nil, resource_id: nil, schedule_strategy: nil, start_date: nil, trial_override_configuration: nil, unit_quantity: nil, request_options: {}) ⇒ Object constructor

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(customer_id:, plan_id:, addons: nil, applied_coupon: nil, billable_features: nil, billing_country_code: nil, billing_cycle_anchor: nil, billing_information: nil, billing_period: nil, charges: nil, paying_customer_id: nil, resource_id: nil, schedule_strategy: nil, start_date: nil, trial_override_configuration: nil, unit_quantity: nil, request_options: {}) ⇒ Object

Parameters:

• customer_id (String) —

  Customer ID

• plan_id (String) —

  Plan ID

• addons (Array<Stigg::Models::V1::SubscriptionPreviewParams::Addon>) (defaults to: nil) —

  Addons to include

• applied_coupon (Stigg::Models::V1::SubscriptionPreviewParams::AppliedCoupon) (defaults to: nil) —

  Coupon or discount to apply

• billable_features (Array<Stigg::Models::V1::SubscriptionPreviewParams::BillableFeature>) (defaults to: nil) —

  Billable features with quantities

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

  ISO 3166-1 country code for localization

• billing_cycle_anchor (Symbol, Stigg::Models::V1::SubscriptionPreviewParams::BillingCycleAnchor) (defaults to: nil) —

  Billing cycle anchor behavior for the subscription

• billing_information (Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation) (defaults to: nil) —

  Billing and tax configuration

• billing_period (Symbol, Stigg::Models::V1::SubscriptionPreviewParams::BillingPeriod) (defaults to: nil) —

  Billing period (MONTHLY or ANNUALLY)

• charges (Array<Stigg::Models::V1::SubscriptionPreviewParams::Charge>) (defaults to: nil) —

  One-time or recurring charges

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

  Paying customer ID for delegated billing

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

  Resource ID for multi-instance subscriptions

• schedule_strategy (Symbol, Stigg::Models::V1::SubscriptionPreviewParams::ScheduleStrategy) (defaults to: nil) —

  When to apply subscription changes

• start_date (Time) (defaults to: nil) —

  Subscription start date

• trial_override_configuration (Stigg::Models::V1::SubscriptionPreviewParams::TrialOverrideConfiguration) (defaults to: nil) —

  Trial period override settings

• unit_quantity (Integer) (defaults to: nil) —

  Unit quantity for per-unit pricing

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

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 156

class Addon < Stigg::Internal::Type::BaseModel
  # @!attribute id
  #   Addon ID
  #
  #   @return [String]
  required :id, String

  # @!attribute quantity
  #   Number of addon instances
  #
  #   @return [Integer]
  required :quantity, Integer

  # @!method initialize(id:, quantity:)
  #   Addon configuration
  #
  #   @param id [String] Addon ID
  #
  #   @param quantity [Integer] Number of addon instances
end

Instance Attribute Details

#id ⇒ String

Addon ID

Returns:

• (String)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 161

required :id, String

#quantity ⇒ Integer

Number of addon instances

Returns:

• (Integer)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 167

required :quantity, Integer