Class: Orb::Models::Plan

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::Plan

Defined in:

lib/orb/models/plan.rb,
sig/orb/models/plan.rbs

Overview

See Also:

• Orb::Resources::Plans#create

Defined Under Namespace

Modules: Adjustment, Status Classes: BasePlan, PlanPhase, Product, TrialConfig

Constant Summary

Orb =

Returns:

• (:PlanPhaseUsageDiscountAdjustment)

Instance Attribute Summary

• #adjustments ⇒ Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>

  Adjustments for this plan.

• #base_plan ⇒ Orb::Models::Plan::BasePlan^? deprecated Deprecated.
• #base_plan_id ⇒ String^? deprecated Deprecated.
• #created_at ⇒ Time
• #currency ⇒ String deprecated Deprecated.
• #default_invoice_memo ⇒ String^?

  The default memo text on the invoices corresponding to subscriptions on this plan.

• #description ⇒ String
• #discount ⇒ Orb::Models::PercentageDiscount, ... deprecated Deprecated.
• #external_plan_id ⇒ String^?

  An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan.

• #id ⇒ String
• #invoicing_currency ⇒ String

  An ISO 4217 currency string for which this plan is billed in.

• #maximum ⇒ Orb::Models::Maximum^? deprecated Deprecated.
• #maximum_amount ⇒ String^? deprecated Deprecated.
• #metadata ⇒ Hash{Symbol=>String}

  User specified key-value pairs for the resource.

• #minimum ⇒ Orb::Models::Minimum^? deprecated Deprecated.
• #minimum_amount ⇒ String^? deprecated Deprecated.
• #name ⇒ String
• #net_terms ⇒ Integer^?

  Determines the difference between the invoice issue date and the due date.

• #plan_phases ⇒ Array<Orb::Models::Plan::PlanPhase>^?
• #prices ⇒ Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>

  Prices for this plan.

• #product ⇒ Orb::Models::Plan::Product
• #status ⇒ Symbol, Orb::Models::Plan::Status
• #trial_config ⇒ Orb::Models::Plan::TrialConfig
• #version ⇒ Integer

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)

Instance Method Summary

• #initialize(id:, created_at:, name:) ⇒ Object constructor
• #to_hash ⇒ {

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:, created_at:, name:) ⇒ Object

Parameters:

• id (String)
• created_at (Time)
• name (String)

# File 'lib/orb/models/plan.rb', line 398

Instance Attribute Details

#adjustments ⇒ Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>

Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan.

Parameters:

• value (::Array[Orb::Models::Plan::adjustment])

Returns:

• (Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>)

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

required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }

#base_plan ⇒ Orb::Models::Plan::BasePlan^?

Deprecated.

Legacy field representing the parent plan if the current plan is a 'child plan', overriding prices from the parent.

Parameters:

• value (Orb::Plan::BasePlan, nil)

Returns:

• (Orb::Models::Plan::BasePlan, nil)

# File 'lib/orb/models/plan.rb', line 26

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

#base_plan_id ⇒ String^?

Deprecated.

Legacy field representing the parent plan ID if the current plan is a 'child plan', overriding prices from the parent.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 35

required :base_plan_id, String, nil?: true

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/orb/models/plan.rb', line 40

required :created_at, Time

#currency ⇒ String

Deprecated.

An ISO 4217 currency string or custom pricing unit (credits) for this plan's prices.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan.rb', line 49

required :currency, String

#default_invoice_memo ⇒ String^?

The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 56

required :default_invoice_memo, String, nil?: true

#description ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan.rb', line 61

required :description, String

#discount ⇒ Orb::Models::PercentageDiscount, ...

Deprecated.

Parameters:

• value (Orb::Models::discount, nil)

Returns:

• (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil)

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

required :discount, union: -> { Orb::Discount }, nil?: true

#external_plan_id ⇒ String^?

An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 75

required :external_plan_id, String, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoicing_currency ⇒ String

An ISO 4217 currency string for which this plan is billed in. Matches currency unless currency is a custom pricing unit.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan.rb', line 82

required :invoicing_currency, String

#maximum ⇒ Orb::Models::Maximum^?

Deprecated.

Parameters:

• value (Orb::Maximum, nil)

Returns:

• (Orb::Models::Maximum, nil)

# File 'lib/orb/models/plan.rb', line 88

required :maximum, -> { Orb::Maximum }, nil?: true

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 94

required :maximum_amount, String, nil?: true

#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.

Parameters:

• value (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String})

# File 'lib/orb/models/plan.rb', line 103

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

#minimum ⇒ Orb::Models::Minimum^?

Deprecated.

Parameters:

• value (Orb::Minimum, nil)

Returns:

• (Orb::Models::Minimum, nil)

# File 'lib/orb/models/plan.rb', line 109

required :minimum, -> { Orb::Minimum }, nil?: true

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 115

required :minimum_amount, String, nil?: true

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan.rb', line 120

required :name, String

#net_terms ⇒ Integer^?

Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/orb/models/plan.rb', line 130

required :net_terms, Integer, nil?: true

#plan_phases ⇒ Array<Orb::Models::Plan::PlanPhase>^?

Parameters:

• value (::Array[Orb::Plan::PlanPhase], nil)

Returns:

• (Array<Orb::Models::Plan::PlanPhase>, nil)

# File 'lib/orb/models/plan.rb', line 135

required :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::PlanPhase] }, nil?: true

#prices ⇒ Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>

Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.

Parameters:

• value (::Array[Orb::Models::price])

Returns:

• (Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>)

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

required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }

#product ⇒ Orb::Models::Plan::Product

Parameters:

• value (Orb::Plan::Product)

Returns:

• (Orb::Models::Plan::Product)

# File 'lib/orb/models/plan.rb', line 147

required :product, -> { Orb::Plan::Product }

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

Parameters:

• value (Orb::Models::Plan::status)

Returns:

• (Symbol, Orb::Models::Plan::Status)

# File 'lib/orb/models/plan.rb', line 152

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

#trial_config ⇒ Orb::Models::Plan::TrialConfig

Parameters:

• value (Orb::Plan::TrialConfig)

Returns:

• (Orb::Models::Plan::TrialConfig)

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

required :trial_config, -> { Orb::Plan::TrialConfig }

#version ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/orb/models/plan.rb', line 162

required :version, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/orb/models/plan.rb', line 551

.variants ⇒ Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)

Returns:

• (Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment))

# File 'lib/orb/models/plan.rb', line 416

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/plan.rbs', line 107

def to_hash: -> {