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

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/stigg/models/v1/subscription_preview_params.rb

Overview

See Also:

Defined Under Namespace

Modules: BillingCycleAnchor, BillingPeriod, ScheduleStrategy Classes: Addon, AppliedCoupon, BillableFeature, BillingInformation, Charge, TrialOverrideConfiguration

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(type:, value:) ⇒ Object

Tax exemption identifier

Parameters:

  • type (String) —

    Tax exemption type (e.g., vat, gst)

  • value (String) —

    Tax exemption identifier value




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

Instance Attribute Details

#addons ⇒ Array<Stigg::Models::V1::SubscriptionPreviewParams::Addon>?

Addons to include

Returns:



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

optional :addons, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionPreviewParams::Addon] }

#applied_coupon ⇒ Stigg::Models::V1::SubscriptionPreviewParams::AppliedCoupon?

Coupon or discount to apply

Returns:



33
34
35
 
# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 33

optional :applied_coupon,
-> { Stigg::V1::SubscriptionPreviewParams::AppliedCoupon },
api_name: :appliedCoupon

#billable_features ⇒ Array<Stigg::Models::V1::SubscriptionPreviewParams::BillableFeature>?

Billable features with quantities

Returns:



41
42
43
 
# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 41

optional :billable_features,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionPreviewParams::BillableFeature] },
api_name: :billableFeatures

#billing_country_code ⇒ String?

ISO 3166-1 country code for localization

Returns:

  • (String, nil) 


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

optional :billing_country_code, String, api_name: :billingCountryCode

#billing_cycle_anchor ⇒ Symbol, ...

Billing cycle anchor behavior for the subscription

Returns:



55
56
57
 
# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 55

optional :billing_cycle_anchor,
enum: -> { Stigg::V1::SubscriptionPreviewParams::BillingCycleAnchor },
api_name: :billingCycleAnchor

#billing_information ⇒ Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation?

Billing and tax configuration

Returns:



63
64
65
 
# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 63

optional :billing_information,
-> { Stigg::V1::SubscriptionPreviewParams::BillingInformation },
api_name: :billingInformation

#billing_period ⇒ Symbol, ...

Billing period (MONTHLY or ANNUALLY)

Returns:



71
72
73
 
# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 71

optional :billing_period,
enum: -> { Stigg::V1::SubscriptionPreviewParams::BillingPeriod },
api_name: :billingPeriod

#charges ⇒ Array<Stigg::Models::V1::SubscriptionPreviewParams::Charge>?

One-time or recurring charges

Returns:



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

optional :charges, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionPreviewParams::Charge] }

#customer_id ⇒ String

Customer ID

Returns:

  • (String) 


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

required :customer_id, String, api_name: :customerId

#paying_customer_id ⇒ String?

Paying customer ID for delegated billing

Returns:

  • (String, nil) 


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

optional :paying_customer_id, String, api_name: :payingCustomerId

#plan_id ⇒ String

Plan ID

Returns:

  • (String) 


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

required :plan_id, String, api_name: :planId

#resource_id ⇒ String?

Resource ID for multi-instance subscriptions

Returns:

  • (String, nil) 


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

optional :resource_id, String, api_name: :resourceId

#schedule_strategy ⇒ Symbol, ...

When to apply subscription changes

Returns:



97
98
99
 
# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 97

optional :schedule_strategy,
enum: -> { Stigg::V1::SubscriptionPreviewParams::ScheduleStrategy },
api_name: :scheduleStrategy

#start_date ⇒ Time?

Subscription start date

Returns:

  • (Time, nil) 


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

optional :start_date, Time, api_name: :startDate

#trial_override_configuration ⇒ Stigg::Models::V1::SubscriptionPreviewParams::TrialOverrideConfiguration?

Trial period override settings

Returns:



111
112
113
 
# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 111

optional :trial_override_configuration,
-> { Stigg::V1::SubscriptionPreviewParams::TrialOverrideConfiguration },
api_name: :trialOverrideConfiguration

#unit_quantity ⇒ Integer?

Unit quantity for per-unit pricing

Returns:

  • (Integer, nil) 


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

optional :unit_quantity, Integer, api_name: :unitQuantity

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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