Class: Stigg::Models::V1::SubscriptionProvisionParams::Addon

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/stigg/models/v1/subscription_provision_params.rb

Instance Attribute Summary

• #id ⇒ String

  Addon ID.

• #quantity ⇒ Integer

  Number of addon instances.

Instance Method Summary

• #initialize(customer_id:, plan_id:, id: nil, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_country_code: nil, billing_cycle_anchor: nil, billing_id: nil, billing_information: nil, billing_period: nil, budget: nil, charges: nil, checkout_options: nil, entitlements: nil, metadata: nil, minimum_spend: nil, paying_customer_id: nil, payment_collection_method: nil, price_overrides: nil, resource_id: nil, salesforce_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:, id: nil, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_country_code: nil, billing_cycle_anchor: nil, billing_id: nil, billing_information: nil, billing_period: nil, budget: nil, charges: nil, checkout_options: nil, entitlements: nil, metadata: nil, minimum_spend: nil, paying_customer_id: nil, payment_collection_method: nil, price_overrides: nil, resource_id: nil, salesforce_id: nil, schedule_strategy: nil, start_date: nil, trial_override_configuration: nil, unit_quantity: nil, request_options: {}) ⇒ Object

Parameters:

• customer_id (String) —

  Customer ID to provision the subscription for

• plan_id (String) —

  Plan ID to provision

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

  Unique identifier for the subscription

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

  Coupon configuration

• await_payment_confirmation (Boolean) (defaults to: nil) —

  Whether to wait for payment confirmation before returning the subscription

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

  The ISO 3166-1 alpha-2 country code for billing

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

  Billing cycle anchor behavior for the subscription

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

  External billing system identifier

• billing_information (Stigg::Models::V1::SubscriptionProvisionParams::BillingInformation) (defaults to: nil)
• billing_period (Symbol, Stigg::Models::V1::SubscriptionProvisionParams::BillingPeriod) (defaults to: nil) —

  Billing period (MONTHLY or ANNUALLY)

• budget (Stigg::Models::V1::SubscriptionProvisionParams::Budget, nil) (defaults to: nil)
• charges (Array<Stigg::Models::V1::SubscriptionProvisionParams::Charge>) (defaults to: nil)
• checkout_options (Stigg::Models::V1::SubscriptionProvisionParams::CheckoutOptions) (defaults to: nil) —

  Checkout page configuration for payment collection

• entitlements (Array<Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Feature, Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit>) (defaults to: nil)
• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Additional metadata for the subscription

• minimum_spend (Stigg::Models::V1::SubscriptionProvisionParams::MinimumSpend, nil) (defaults to: nil) —

  Minimum spend amount

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

  Optional paying customer ID for split billing scenarios

• payment_collection_method (Symbol, Stigg::Models::V1::SubscriptionProvisionParams::PaymentCollectionMethod) (defaults to: nil) —

  How payments should be collected for this subscription

• price_overrides (Array<Stigg::Models::V1::SubscriptionProvisionParams::PriceOverride>) (defaults to: nil)
• resource_id (String, nil) (defaults to: nil) —

  Optional resource ID for multi-instance subscriptions

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

  Salesforce ID

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

  Strategy for scheduling subscription changes

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

  Subscription start date

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

  Trial period override settings

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

  Unit quantity

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

# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 240

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_provision_params.rb', line 245

required :id, String

#quantity ⇒ Integer

Number of addon instances

Returns:

• (Integer)

# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 251

required :quantity, Integer