Class: Stigg::Models::V1::Subscription::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/subscription.rb

Overview

See Also:

Defined Under Namespace

Modules: CancelReason, PaymentCollection, PaymentCollectionMethod, PricingType, Status Classes: Addon, Budget, Coupon, FutureUpdate, LatestInvoice, MinimumSpend, Price, SubscriptionEntitlement, Trial

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(id:) ⇒ Object

Target package for the update

Parameters:

  • id (String) —

    Target package for the update




# File 'lib/stigg/models/v1/subscription.rb', line 223

Instance Attribute Details

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

Returns:



84
 
# File 'lib/stigg/models/v1/subscription.rb', line 84

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

#billing_cycle_anchor ⇒ Time?

Billing cycle anchor date

Returns:

  • (Time, nil) 


90
 
# File 'lib/stigg/models/v1/subscription.rb', line 90

optional :billing_cycle_anchor, Time, api_name: :billingCycleAnchor, nil?: true

#billing_id ⇒ String?

Billing ID

Returns:

  • (String, nil) 


31
 
# File 'lib/stigg/models/v1/subscription.rb', line 31

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

#budget ⇒ Stigg::Models::V1::Subscription::Data::Budget?

Budget configuration

Returns:



96
 
# File 'lib/stigg/models/v1/subscription.rb', line 96

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

#cancel_reason ⇒ Symbol, ...

Subscription cancel reason

Returns:



108
109
110
111
 
# File 'lib/stigg/models/v1/subscription.rb', line 108

optional :cancel_reason,
enum: -> { Stigg::V1::Subscription::Data::CancelReason },
api_name: :cancelReason,
nil?: true

#cancellation_date ⇒ Time?

Subscription cancellation date

Returns:

  • (Time, nil) 


102
 
# File 'lib/stigg/models/v1/subscription.rb', line 102

optional :cancellation_date, Time, api_name: :cancellationDate, nil?: true

#coupons ⇒ Array<Stigg::Models::V1::Subscription::Data::Coupon>?

Coupons applied to the subscription

Returns:



117
 
# File 'lib/stigg/models/v1/subscription.rb', line 117

optional :coupons, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Subscription::Data::Coupon] }

#created_at ⇒ Time

Created at

Returns:

  • (Time) 


37
 
# File 'lib/stigg/models/v1/subscription.rb', line 37

required :created_at, Time, api_name: :createdAt

#current_billing_period_end ⇒ Time?

End of the current billing period

Returns:

  • (Time, nil) 


123
 
# File 'lib/stigg/models/v1/subscription.rb', line 123

optional :current_billing_period_end, Time, api_name: :currentBillingPeriodEnd, nil?: true

#current_billing_period_start ⇒ Time?

Start of the current billing period

Returns:

  • (Time, nil) 


129
 
# File 'lib/stigg/models/v1/subscription.rb', line 129

optional :current_billing_period_start, Time, api_name: :currentBillingPeriodStart, nil?: true

#customer_id ⇒ String

Customer ID

Returns:

  • (String) 


43
 
# File 'lib/stigg/models/v1/subscription.rb', line 43

required :customer_id, String, api_name: :customerId

#effective_end_date ⇒ Time?

Subscription effective end date

Returns:

  • (Time, nil) 


135
 
# File 'lib/stigg/models/v1/subscription.rb', line 135

optional :effective_end_date, Time, api_name: :effectiveEndDate, nil?: true

#end_date ⇒ Time?

Subscription end date

Returns:

  • (Time, nil) 


141
 
# File 'lib/stigg/models/v1/subscription.rb', line 141

optional :end_date, Time, api_name: :endDate, nil?: true

#future_updates ⇒ Array<Stigg::Models::V1::Subscription::Data::FutureUpdate>?

Scheduled future updates for the subscription

Returns:



147
148
149
 
# File 'lib/stigg/models/v1/subscription.rb', line 147

optional :future_updates,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Subscription::Data::FutureUpdate] },
api_name: :futureUpdates

#id ⇒ String

Subscription ID

Returns:

  • (String) 


25
 
# File 'lib/stigg/models/v1/subscription.rb', line 25

required :id, String

#latest_invoice ⇒ Stigg::Models::V1::Subscription::Data::LatestInvoice?

Latest invoice for the subscription

Returns:



155
156
157
158
 
# File 'lib/stigg/models/v1/subscription.rb', line 155

optional :latest_invoice,
-> { Stigg::V1::Subscription::Data::LatestInvoice },
api_name: :latestInvoice,
nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the subscription

Returns:

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


164
 
# File 'lib/stigg/models/v1/subscription.rb', line 164

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

#minimum_spend ⇒ Stigg::Models::V1::Subscription::Data::MinimumSpend?

Minimum spend configuration

Returns:



170
171
172
173
 
# File 'lib/stigg/models/v1/subscription.rb', line 170

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

#paying_customer_id ⇒ String?

Paying customer ID for delegated billing

Returns:

  • (String, nil) 


179
 
# File 'lib/stigg/models/v1/subscription.rb', line 179

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

#payment_collection ⇒ Symbol, Stigg::Models::V1::Subscription::Data::PaymentCollection

Payment collection

Returns:



49
50
51
 
# File 'lib/stigg/models/v1/subscription.rb', line 49

required :payment_collection,
enum: -> { Stigg::V1::Subscription::Data::PaymentCollection },
api_name: :paymentCollection

#payment_collection_method ⇒ Symbol, ...

The method used to collect payments for a subscription

Returns:



185
186
187
188
 
# File 'lib/stigg/models/v1/subscription.rb', line 185

optional :payment_collection_method,
enum: -> { Stigg::V1::Subscription::Data::PaymentCollectionMethod },
api_name: :paymentCollectionMethod,
nil?: true

#plan_id ⇒ String

Plan ID

Returns:

  • (String) 


57
 
# File 'lib/stigg/models/v1/subscription.rb', line 57

required :plan_id, String, api_name: :planId

#prices ⇒ Array<Stigg::Models::V1::Subscription::Data::Price>?

Returns:



193
 
# File 'lib/stigg/models/v1/subscription.rb', line 193

optional :prices, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Subscription::Data::Price] }

#pricing_type ⇒ Symbol, Stigg::Models::V1::Subscription::Data::PricingType

Pricing type

Returns:



63
64
65
66
67
 
# File 'lib/stigg/models/v1/subscription.rb', line 63

required :pricing_type,
enum: -> {
  Stigg::V1::Subscription::Data::PricingType
},
api_name: :pricingType

#resource_id ⇒ String?

Resource ID

Returns:

  • (String, nil) 


199
 
# File 'lib/stigg/models/v1/subscription.rb', line 199

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

#start_date ⇒ Time

Subscription start date

Returns:

  • (Time) 


73
 
# File 'lib/stigg/models/v1/subscription.rb', line 73

required :start_date, Time, api_name: :startDate

#status ⇒ Symbol, Stigg::Models::V1::Subscription::Data::Status

Subscription status

Returns:



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

required :status, enum: -> { Stigg::V1::Subscription::Data::Status }

#subscription_entitlements ⇒ Array<Stigg::Models::V1::Subscription::Data::SubscriptionEntitlement>?

Entitlements associated with the subscription

Returns:



205
206
207
208
209
 
# File 'lib/stigg/models/v1/subscription.rb', line 205

optional :subscription_entitlements,
-> {
  Stigg::Internal::Type::ArrayOf[Stigg::V1::Subscription::Data::SubscriptionEntitlement]
},
api_name: :subscriptionEntitlements

#trial ⇒ Stigg::Models::V1::Subscription::Data::Trial?

Trial configuration

Returns:



215
 
# File 'lib/stigg/models/v1/subscription.rb', line 215

optional :trial, -> { Stigg::V1::Subscription::Data::Trial }, nil?: true

#trial_end_date ⇒ Time?

Subscription trial end date

Returns:

  • (Time, nil) 


221
 
# File 'lib/stigg/models/v1/subscription.rb', line 221

optional :trial_end_date, Time, api_name: :trialEndDate, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/subscription.rb', line 297