Class: Stigg::Models::V1::SubscriptionListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/subscription_list_response.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_list_response.rb', line 209

Instance Attribute Details

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

Returns:



69
70
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 69

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

#billing_cycle_anchor ⇒ Time?

Billing cycle anchor date

Returns:

  • (Time, nil) 


76
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 76

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

#billing_id ⇒ String?

Billing ID

Returns:

  • (String, nil) 


18
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 18

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

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

Budget configuration

Returns:



82
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 82

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

#cancel_reason ⇒ Symbol, ...

Subscription cancel reason

Returns:



94
95
96
97
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 94

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

#cancellation_date ⇒ Time?

Subscription cancellation date

Returns:

  • (Time, nil) 


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

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

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

Coupons applied to the subscription

Returns:



103
104
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 103

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

#created_at ⇒ Time

Created at

Returns:

  • (Time) 


24
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 24

required :created_at, Time, api_name: :createdAt

#current_billing_period_end ⇒ Time?

End of the current billing period

Returns:

  • (Time, nil) 


110
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 110

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) 


116
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 116

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

#customer_id ⇒ String

Customer ID

Returns:

  • (String) 


30
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 30

required :customer_id, String, api_name: :customerId

#effective_end_date ⇒ Time?

Subscription effective end date

Returns:

  • (Time, nil) 


122
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 122

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

#end_date ⇒ Time?

Subscription end date

Returns:

  • (Time, nil) 


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

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

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

Scheduled future updates for the subscription

Returns:



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

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

#id ⇒ String

Subscription ID

Returns:

  • (String) 


12
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 12

required :id, String

#latest_invoice ⇒ Stigg::Models::V1::SubscriptionListResponse::LatestInvoice?

Latest invoice for the subscription

Returns:



142
143
144
145
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 142

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

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the subscription

Returns:

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


151
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 151

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

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

Minimum spend configuration

Returns:



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

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

#paying_customer_id ⇒ String?

Paying customer ID for delegated billing

Returns:

  • (String, nil) 


166
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 166

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

#payment_collection ⇒ Symbol, Stigg::Models::V1::SubscriptionListResponse::PaymentCollection

Payment collection

Returns:



36
37
38
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 36

required :payment_collection,
enum: -> { Stigg::Models::V1::SubscriptionListResponse::PaymentCollection },
api_name: :paymentCollection

#payment_collection_method ⇒ Symbol, ...

The method used to collect payments for a subscription

Returns:



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

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

#plan_id ⇒ String

Plan ID

Returns:

  • (String) 


44
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 44

required :plan_id, String, api_name: :planId

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

Returns:



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

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

#pricing_type ⇒ Symbol, Stigg::Models::V1::SubscriptionListResponse::PricingType

Pricing type

Returns:



50
51
52
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 50

required :pricing_type,
enum: -> { Stigg::Models::V1::SubscriptionListResponse::PricingType },
api_name: :pricingType

#resource_id ⇒ String?

Resource ID

Returns:

  • (String, nil) 


187
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 187

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

#start_date ⇒ Time

Subscription start date

Returns:

  • (Time) 


58
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 58

required :start_date, Time, api_name: :startDate

#status ⇒ Symbol, Stigg::Models::V1::SubscriptionListResponse::Status

Subscription status

Returns:



64
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 64

required :status, enum: -> { Stigg::Models::V1::SubscriptionListResponse::Status }

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

Entitlements associated with the subscription

Returns:



193
194
195
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 193

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

#trial ⇒ Stigg::Models::V1::SubscriptionListResponse::Trial?

Trial configuration

Returns:



201
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 201

optional :trial, -> { Stigg::Models::V1::SubscriptionListResponse::Trial }, nil?: true

#trial_end_date ⇒ Time?

Subscription trial end date

Returns:

  • (Time, nil) 


207
 
# File 'lib/stigg/models/v1/subscription_list_response.rb', line 207

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_list_response.rb', line 283