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

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

Overview

See Also:

Defined Under Namespace

Modules: BillingCycleAnchor, BillingPeriod, Entitlement, PaymentCollectionMethod, ScheduleStrategy Classes: Addon, AppliedCoupon, BillingInformation, Budget, Charge, CheckoutOptions, MinimumSpend, PriceOverride, 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(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/subscription_provision_params.rb', line 253

Instance Attribute Details

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

Returns:



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

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

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

Coupon configuration

Returns:



38
39
40
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 38

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

#await_payment_confirmation ⇒ Boolean?

Whether to wait for payment confirmation before returning the subscription

Returns:

  • (Boolean, nil) 


46
47
48
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 46

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

Returns:

  • (String, nil) 


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

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

#billing_cycle_anchor ⇒ Symbol, ...

Billing cycle anchor behavior for the subscription

Returns:



60
61
62
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 60

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

#billing_id ⇒ String?

External billing system identifier

Returns:

  • (String, nil) 


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

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

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

Returns:



73
74
75
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 73

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

#billing_period ⇒ Symbol, ...

Billing period (MONTHLY or ANNUALLY)

Returns:



81
82
83
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 81

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

#budget ⇒ Stigg::Models::V1::SubscriptionProvisionParams::Budget?

Returns:



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

optional :budget, -> { Stigg::V1::SubscriptionProvisionParams::Budget }, nil?: true

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

Returns:



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

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

#checkout_options ⇒ Stigg::Models::V1::SubscriptionProvisionParams::CheckoutOptions?

Checkout page configuration for payment collection

Returns:



99
100
101
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 99

optional :checkout_options,
-> { Stigg::V1::SubscriptionProvisionParams::CheckoutOptions },
api_name: :checkoutOptions

#customer_id ⇒ String

Customer ID to provision the subscription for

Returns:

  • (String) 


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

required :customer_id, String, api_name: :customerId

#entitlements ⇒ Array<Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Feature, Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit>?

Returns:



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

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

#id ⇒ String?

Unique identifier for the subscription

Returns:

  • (String, nil) 


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

optional :id, String

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the subscription

Returns:

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


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

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

#minimum_spend ⇒ Stigg::Models::V1::SubscriptionProvisionParams::MinimumSpend?

Minimum spend amount

Returns:



119
120
121
122
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 119

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

#paying_customer_id ⇒ String?

Optional paying customer ID for split billing scenarios

Returns:

  • (String, nil) 


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

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

#payment_collection_method ⇒ Symbol, ...

How payments should be collected for this subscription

Returns:



134
135
136
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 134

optional :payment_collection_method,
enum: -> { Stigg::V1::SubscriptionProvisionParams::PaymentCollectionMethod },
api_name: :paymentCollectionMethod

#plan_id ⇒ String

Plan ID to provision

Returns:

  • (String) 


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

required :plan_id, String, api_name: :planId

#price_overrides ⇒ Array<Stigg::Models::V1::SubscriptionProvisionParams::PriceOverride>?

Returns:



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

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

#resource_id ⇒ String?

Optional resource ID for multi-instance subscriptions

Returns:

  • (String, nil) 


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

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

#salesforce_id ⇒ String?

Salesforce ID

Returns:

  • (String, nil) 


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

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

#schedule_strategy ⇒ Symbol, ...

Strategy for scheduling subscription changes

Returns:



161
162
163
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 161

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

#start_date ⇒ Time?

Subscription start date

Returns:

  • (Time, nil) 


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

optional :start_date, Time, api_name: :startDate

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

Trial period override settings

Returns:



175
176
177
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 175

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

#unit_quantity ⇒ Integer?

Unit quantity

Returns:

  • (Integer, nil) 


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

optional :unit_quantity, Integer, api_name: :unitQuantity

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

.variants ⇒ Array(Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Feature, Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit)

Returns:




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