Class: Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/contract_create_params.rb,
sig/stigg/models/v1/contract_create_params.rbs

Overview

See Also:

  • Stigg::Models::V1::ContractCreateParams::Subscription#new_subscription

Defined Under Namespace

Modules: BillingCycleAnchor, BillingPeriod, Entitlement, PaymentCollectionMethod, ScheduleStrategy Classes: Addon, AppliedCoupon, BillingInformation, Budget, Charge, CheckoutOptions, MinimumSpend, PriceOverride, TrialOverrideConfiguration

Instance Attribute Summary collapse

Class Method Summary collapse

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(cancel_url:, success_url:, allow_promo_codes: nil, allow_tax_id_collection: nil, collect_billing_address: nil, collect_phone_number: nil, reference_id: nil) ⇒ Object

Checkout page configuration for payment collection

Parameters:

  • cancel_url (String) —

    URL to redirect to if checkout is canceled

  • success_url (String) —

    URL to redirect to after successful checkout

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

    Allow promotional codes during checkout

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

    Allow tax ID collection during checkout

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

    Collect billing address during checkout

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

    Collect phone number during checkout

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

    Optional reference ID for the checkout session




# File 'lib/stigg/models/v1/contract_create_params.rb', line 390

Instance Attribute Details

#addons ⇒ Array<Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Addon>?

Returns:



142
143
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 142

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

#applied_coupon ⇒ Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::AppliedCoupon?

Coupon configuration

Returns:



149
150
151
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 149

optional :applied_coupon,
-> { Stigg::V1::ContractCreateParams::Subscription::NewSubscription::AppliedCoupon },
api_name: :appliedCoupon

#await_payment_confirmation ⇒ Boolean?

Whether to wait for payment confirmation before returning the subscription

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


157
158
159
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 157

optional :await_payment_confirmation,
Stigg::Internal::Type::Boolean,
api_name: :awaitPaymentConfirmation

#billing_country_code ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


165
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 165

optional :billing_country_code, String, api_name: :billingCountryCode, nil?: true

#billing_cycle_anchor ⇒ Symbol, ...

Billing cycle anchor behavior for the subscription

Returns:



171
172
173
174
175
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 171

optional :billing_cycle_anchor,
enum: -> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::BillingCycleAnchor
},
api_name: :billingCycleAnchor

#billing_id ⇒ String?

External billing system identifier

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


181
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 181

optional :billing_id, String, api_name: :billingId, nil?: true

#billing_information ⇒ Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation?

Returns:



186
187
188
189
190
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 186

optional :billing_information,
-> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation
},
api_name: :billingInformation

#billing_period ⇒ Symbol, ...

Billing period (MONTHLY or ANNUALLY)

Returns:



196
197
198
199
200
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 196

optional :billing_period,
enum: -> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::BillingPeriod
},
api_name: :billingPeriod

#budget ⇒ Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Budget?

Parameters:

  • value (Stigg::V1::ContractCreateParams::Subscription::NewSubscription::Budget, nil)

Returns:



205
206
207
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 205

optional :budget,
-> { Stigg::V1::ContractCreateParams::Subscription::NewSubscription::Budget },
nil?: true

#cancellation_date ⇒ Time?

Subscription cancellation date

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


213
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 213

optional :cancellation_date, Time, api_name: :cancellationDate

#charges ⇒ Array<Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Charge>?

Returns:



218
219
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 218

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

#checkout_options ⇒ Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::CheckoutOptions?

Checkout page configuration for payment collection

Returns:



225
226
227
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 225

optional :checkout_options,
-> { Stigg::V1::ContractCreateParams::Subscription::NewSubscription::CheckoutOptions },
api_name: :checkoutOptions

#customer_id ⇒ String

Customer ID to provision the subscription for

Parameters:

  • value (String)

Returns:

  • (String) 


125
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 125

required :customer_id, String, api_name: :customerId

#entitlements ⇒ Array<Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement::Feature, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement::Credit>?

Returns:



232
233
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 232

optional :entitlements,
-> { Stigg::Internal::Type::ArrayOf[union: Stigg::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement] }

#id ⇒ String?

Unique identifier for the subscription

Parameters:

  • (String)

Returns:

  • (String, nil) 


137
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 137

optional :id, String

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the subscription

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


239
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 239

optional :metadata, Stigg::Internal::Type::HashOf[String]

#minimum_spend ⇒ Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::MinimumSpend?

Minimum spend amount

Parameters:

  • value (Stigg::V1::ContractCreateParams::Subscription::NewSubscription::MinimumSpend, nil)

Returns:



245
246
247
248
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 245

optional :minimum_spend,
-> { Stigg::V1::ContractCreateParams::Subscription::NewSubscription::MinimumSpend },
api_name: :minimumSpend,
nil?: true

#paying_customer_id ⇒ String?

Optional paying customer ID for split billing scenarios

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


254
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 254

optional :paying_customer_id, String, api_name: :payingCustomerId, nil?: true

#payment_collection_method ⇒ Symbol, ...

How payments should be collected for this subscription

Returns:



260
261
262
263
264
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 260

optional :payment_collection_method,
enum: -> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::PaymentCollectionMethod
},
api_name: :paymentCollectionMethod

#plan_id ⇒ String

Plan ID to provision

Parameters:

  • value (String)

Returns:

  • (String) 


131
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 131

required :plan_id, String, api_name: :planId

#price_overrides ⇒ Array<Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::PriceOverride>?

Returns:



269
270
271
272
273
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 269

optional :price_overrides,
-> {
  Stigg::Internal::Type::ArrayOf[Stigg::V1::ContractCreateParams::Subscription::NewSubscription::PriceOverride]
},
api_name: :priceOverrides

#resource_id ⇒ String?

Optional resource ID for multi-instance subscriptions

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


279
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 279

optional :resource_id, String, api_name: :resourceId, nil?: true

#salesforce_id ⇒ String?

Salesforce ID

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


285
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 285

optional :salesforce_id, String, api_name: :salesforceId, nil?: true

#schedule_strategy ⇒ Symbol, ...

Strategy for scheduling subscription changes

Returns:



291
292
293
294
295
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 291

optional :schedule_strategy,
enum: -> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::ScheduleStrategy
},
api_name: :scheduleStrategy

#start_date ⇒ Time?

Subscription start date

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


301
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 301

optional :start_date, Time, api_name: :startDate

#trial_override_configuration ⇒ Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::TrialOverrideConfiguration?

Trial period override settings

Returns:



307
308
309
310
311
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 307

optional :trial_override_configuration,
-> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::TrialOverrideConfiguration
},
api_name: :trialOverrideConfiguration

#unit_quantity ⇒ Integer?

Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


317
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 317

optional :unit_quantity, Integer, api_name: :unitQuantity

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/contract_create_params.rb', line 651

.variants ⇒ Array(Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement::Feature, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement::Credit)

Returns:




# File 'lib/stigg/models/v1/contract_create_params.rb', line 1270

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


279
 
# File 'sig/stigg/models/v1/contract_create_params.rbs', line 279

def to_hash: -> {