Class: Orb::Models::Subscription

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

Overview

See Also:

Defined Under Namespace

Modules: DiscountInterval, Status

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Orb::Internal::Type::BaseModel

Instance Attribute Details

#active_plan_phase_order ⇒ Integer?

The current plan phase that is active, only if the subscription’s plan has phases.

Returns:

  • (Integer, nil) 


17
 
# File 'lib/orb/models/subscription.rb', line 17

required :active_plan_phase_order, Integer, nil?: true

#adjustment_intervals ⇒ Array<Orb::Models::AdjustmentInterval>

The adjustment intervals for this subscription sorted by the start_date of the adjustment interval.

Returns:



24
 
# File 'lib/orb/models/subscription.rb', line 24

required :adjustment_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::AdjustmentInterval] }

#auto_collection ⇒ Boolean?

Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan’s behavior. If null, defaults to the customer’s setting.

Returns:

  • (Boolean, nil) 


32
 
# File 'lib/orb/models/subscription.rb', line 32

required :auto_collection, Orb::Internal::Type::Boolean, nil?: true

#billing_cycle_anchor_configuration ⇒ Orb::Models::BillingCycleAnchorConfiguration

Returns:



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

required :billing_cycle_anchor_configuration, -> { Orb::BillingCycleAnchorConfiguration }

#billing_cycle_day ⇒ Integer

The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th.

Returns:

  • (Integer) 


46
 
# File 'lib/orb/models/subscription.rb', line 46

required :billing_cycle_day, Integer

#created_at ⇒ Time

Returns:

  • (Time) 


51
 
# File 'lib/orb/models/subscription.rb', line 51

required :created_at, Time

#current_billing_period_end_date ⇒ Time?

The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active.

Returns:

  • (Time, nil) 


59
 
# File 'lib/orb/models/subscription.rb', line 59

required :current_billing_period_end_date, Time, nil?: true

#current_billing_period_start_date ⇒ Time?

The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active.

Returns:

  • (Time, nil) 


67
 
# File 'lib/orb/models/subscription.rb', line 67

required :current_billing_period_start_date, Time, nil?: true

#customer ⇒ Orb::Models::Customer

A customer is a buyer of your products, and the other party to the billing relationship.

In Orb, customers are assigned system generated identifiers automatically, but it’s often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an ‘external_customer_id` with your own identifier. See [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these aliases work in Orb.

In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the ‘payment_provider_id` and the `payment_provider` enum field to express this mapping.

A customer also has a timezone (from the standard [IANA timezone database](www.iana.org/time-zones)), which defaults to your account’s timezone. See [Timezone localization](/essentials/timezones) for information on what this timezone parameter influences within Orb.

Returns:



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

required :customer, -> { Orb::Customer }

#default_invoice_memo ⇒ String?

Determines the default memo on this subscriptions’ invoices. Note that if this is not provided, it is determined by the plan configuration.

Returns:

  • (String, nil) 


97
 
# File 'lib/orb/models/subscription.rb', line 97

required :default_invoice_memo, String, nil?: true

#discount_intervals ⇒ Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>

Deprecated.

The discount intervals for this subscription sorted by the start_date. This field is deprecated in favor of ‘adjustment_intervals`.

Returns:



106
107
 
# File 'lib/orb/models/subscription.rb', line 106

required :discount_intervals,
-> { Orb::Internal::Type::ArrayOf[union: Orb::Subscription::DiscountInterval] }

#end_date ⇒ Time?

The date Orb stops billing for this subscription.

Returns:

  • (Time, nil) 


113
 
# File 'lib/orb/models/subscription.rb', line 113

required :end_date, Time, nil?: true

#fixed_fee_quantity_schedule ⇒ Array<Orb::Models::FixedFeeQuantityScheduleEntry>

Returns:



118
119
 
# File 'lib/orb/models/subscription.rb', line 118

required :fixed_fee_quantity_schedule,
-> { Orb::Internal::Type::ArrayOf[Orb::FixedFeeQuantityScheduleEntry] }

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/orb/models/subscription.rb', line 10

required :id, String

#invoicing_threshold ⇒ String?

Returns:

  • (String, nil) 


124
 
# File 'lib/orb/models/subscription.rb', line 124

required :invoicing_threshold, String, nil?: true

#maximum_intervals ⇒ Array<Orb::Models::MaximumInterval>

Deprecated.

The maximum intervals for this subscription sorted by the start_date. This field is deprecated in favor of ‘adjustment_intervals`.

Returns:



133
 
# File 'lib/orb/models/subscription.rb', line 133

required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MaximumInterval] }

#metadata ⇒ Hash{Symbol=>String}

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to ‘null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.

Returns:

  • (Hash{Symbol=>String}) 


142
 
# File 'lib/orb/models/subscription.rb', line 142

required :metadata, Orb::Internal::Type::HashOf[String]

#minimum_intervals ⇒ Array<Orb::Models::MinimumInterval>

Deprecated.

The minimum intervals for this subscription sorted by the start_date. This field is deprecated in favor of ‘adjustment_intervals`.

Returns:



151
 
# File 'lib/orb/models/subscription.rb', line 151

required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MinimumInterval] }

#name ⇒ String

The name of the subscription.

Returns:

  • (String) 


157
 
# File 'lib/orb/models/subscription.rb', line 157

required :name, String

#net_terms ⇒ Integer

Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of ‘0` here represents that the invoice is due on issue, whereas a value of `30` represents that the customer has a month to pay the invoice.

Returns:

  • (Integer) 


166
 
# File 'lib/orb/models/subscription.rb', line 166

required :net_terms, Integer

#pending_subscription_change ⇒ Orb::Models::SubscriptionChangeMinified?

A pending subscription change if one exists on this subscription.

Returns:



172
 
# File 'lib/orb/models/subscription.rb', line 172

required :pending_subscription_change, -> { Orb::SubscriptionChangeMinified }, nil?: true

#plan ⇒ Orb::Models::Plan?

The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices in the [Price resource](/reference/price).

Returns:



181
 
# File 'lib/orb/models/subscription.rb', line 181

required :plan, -> { Orb::Plan }, nil?: true

#price_intervals ⇒ Array<Orb::Models::PriceInterval>

The price intervals for this subscription.

Returns:



187
 
# File 'lib/orb/models/subscription.rb', line 187

required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::PriceInterval] }

#redeemed_coupon ⇒ Orb::Models::CouponRedemption?

Returns:



192
 
# File 'lib/orb/models/subscription.rb', line 192

required :redeemed_coupon, -> { Orb::CouponRedemption }, nil?: true

#start_date ⇒ Time

The date Orb starts billing for this subscription.

Returns:

  • (Time) 


198
 
# File 'lib/orb/models/subscription.rb', line 198

required :start_date, Time

#status ⇒ Symbol, Orb::Models::Subscription::Status

Returns:



203
 
# File 'lib/orb/models/subscription.rb', line 203

required :status, enum: -> { Orb::Subscription::Status }

#trial_info ⇒ Orb::Models::SubscriptionTrialInfo

Returns:



208
 
# File 'lib/orb/models/subscription.rb', line 208

required :trial_info, -> { Orb::SubscriptionTrialInfo }

Class Method Details

.variants ⇒ Array(Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval)

Returns:




# File 'lib/orb/models/subscription.rb', line 299