orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/subscription.rb

@@ -0,0 +1,680 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # A [subscription](/core-concepts#subscription) represents the purchase of a
+  # plan by a customer. By default, subscriptions begin on the day that they're
+  # created and renew automatically for each billing cycle at the cadence that's
+  # configured in the plan definition. Subscriptions also default to **beginning
+  # of month alignment**, which means the first invoice issued for the
+  # subscription will have pro-rated charges between the `start_date` and the
+  # first of the following month. Subsequent billing periods will always start
+  # and end on a month boundary (e.g. subsequent month starts for monthly
+  # billing). Depending on the plan configuration, any _flat_ recurring fees
+  # will be billed either at the beginning (in-advance) or end (in-arrears) of
+  # each billing cycle. Plans default to **in-advance billing**. Usage-based
+  # fees are billed in arrears as usage is accumulated. In the normal course of
+  # events, you can expect an invoice to contain usage-based charges for the
+  # previous period, and a recurring fee for the following period.
+  class Subscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # 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`.
+    # @return [String]
+    attr_accessor :id
+
+    # 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](https://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.
+    # @return [Customer]
+    attr_accessor :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](https://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.
+    # @return [Plan]
+    attr_accessor :plan
+
+    # The name of the subscription.
+    # @return [String]
+    attr_accessor :name
+
+    # The date Orb starts billing for this subscription.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The date Orb stops billing for this subscription.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The date Orb stops billing for this subscription.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # 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.
+    # @return [DateTime]
+    attr_accessor :current_billing_period_start_date
+
+    # 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.
+    # @return [DateTime]
+    attr_accessor :current_billing_period_end_date
+
+    # 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.
+    # @return [Status13]
+    attr_accessor :status
+
+    # 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.
+    # @return [SubscriptionTrialInfo]
+    attr_accessor :trial_info
+
+    # The current plan phase that is active, only if the subscription's plan has
+    # phases.
+    # @return [Integer]
+    attr_accessor :active_plan_phase_order
+
+    # The current plan phase that is active, only if the subscription's plan has
+    # phases.
+    # @return [Array[FixedFeeQuantityScheduleEntry]]
+    attr_accessor :fixed_fee_quantity_schedule
+
+    # Determines the default memo on this subscriptions' invoices. Note that if
+    # this is not provided, it is determined by the plan configuration.
+    # @return [String]
+    attr_accessor :default_invoice_memo
+
+    # 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.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # Determines whether invoices for this subscription will be automatically
+    # issued. This resolves the effective setting for the subscription: a
+    # subscription-level override if set, otherwise the customer-level setting,
+    # otherwise the account-level default.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_issuance
+
+    # 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.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # 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.
+    # @return [CouponRedemption]
+    attr_accessor :redeemed_coupon
+
+    # 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.
+    # @return [Integer]
+    attr_accessor :billing_cycle_day
+
+    # 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.
+    # @return [BillingCycleAnchorConfiguration]
+    attr_accessor :billing_cycle_anchor_configuration
+
+    # 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.
+    # @return [String]
+    attr_accessor :invoicing_threshold
+
+    # The price intervals for this subscription.
+    # @return [Array[PriceInterval]]
+    attr_accessor :price_intervals
+
+    # The adjustment intervals for this subscription sorted by the start_date of
+    # the adjustment interval.
+    # @return [Array[AdjustmentInterval]]
+    attr_accessor :adjustment_intervals
+
+    # The discount intervals for this subscription sorted by the start_date.
+    # This field is deprecated in favor of `adjustment_intervals`.
+    # @return [Array[Object]]
+    attr_accessor :discount_intervals
+
+    # The minimum intervals for this subscription sorted by the start_date. This
+    # field is deprecated in favor of `adjustment_intervals`.
+    # @return [Array[MinimumInterval]]
+    attr_accessor :minimum_intervals
+
+    # The maximum intervals for this subscription sorted by the start_date. This
+    # field is deprecated in favor of `adjustment_intervals`.
+    # @return [Array[MaximumInterval]]
+    attr_accessor :maximum_intervals
+
+    # A pending subscription change if one exists on this subscription.
+    # @return [SubscriptionChangeMinified]
+    attr_accessor :pending_subscription_change
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['id'] = 'id'
+      @_hash['customer'] = 'customer'
+      @_hash['plan'] = 'plan'
+      @_hash['name'] = 'name'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['created_at'] = 'created_at'
+      @_hash['current_billing_period_start_date'] =
+        'current_billing_period_start_date'
+      @_hash['current_billing_period_end_date'] =
+        'current_billing_period_end_date'
+      @_hash['status'] = 'status'
+      @_hash['trial_info'] = 'trial_info'
+      @_hash['active_plan_phase_order'] = 'active_plan_phase_order'
+      @_hash['fixed_fee_quantity_schedule'] = 'fixed_fee_quantity_schedule'
+      @_hash['default_invoice_memo'] = 'default_invoice_memo'
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['auto_issuance'] = 'auto_issuance'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['redeemed_coupon'] = 'redeemed_coupon'
+      @_hash['billing_cycle_day'] = 'billing_cycle_day'
+      @_hash['billing_cycle_anchor_configuration'] =
+        'billing_cycle_anchor_configuration'
+      @_hash['invoicing_threshold'] = 'invoicing_threshold'
+      @_hash['price_intervals'] = 'price_intervals'
+      @_hash['adjustment_intervals'] = 'adjustment_intervals'
+      @_hash['discount_intervals'] = 'discount_intervals'
+      @_hash['minimum_intervals'] = 'minimum_intervals'
+      @_hash['maximum_intervals'] = 'maximum_intervals'
+      @_hash['pending_subscription_change'] = 'pending_subscription_change'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        plan
+        end_date
+        current_billing_period_start_date
+        current_billing_period_end_date
+        active_plan_phase_order
+        default_invoice_memo
+        auto_collection
+        auto_issuance
+        redeemed_coupon
+        invoicing_threshold
+        pending_subscription_change
+      ]
+    end
+
+    def initialize(metadata:, id:, customer:, plan:, name:, start_date:,
+                   end_date:, created_at:, current_billing_period_start_date:,
+                   current_billing_period_end_date:, status:, trial_info:,
+                   active_plan_phase_order:, fixed_fee_quantity_schedule:,
+                   default_invoice_memo:, auto_collection:, auto_issuance:,
+                   net_terms:, redeemed_coupon:, billing_cycle_day:,
+                   billing_cycle_anchor_configuration:, invoicing_threshold:,
+                   price_intervals:, adjustment_intervals:, discount_intervals:,
+                   minimum_intervals:, maximum_intervals:,
+                   pending_subscription_change:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @id = id
+      @customer = customer
+      @plan = plan
+      @name = name
+      @start_date = start_date
+      @end_date = end_date
+      @created_at = created_at
+      @current_billing_period_start_date = current_billing_period_start_date
+      @current_billing_period_end_date = current_billing_period_end_date
+      @status = status
+      @trial_info = trial_info
+      @active_plan_phase_order = active_plan_phase_order
+      @fixed_fee_quantity_schedule = fixed_fee_quantity_schedule
+      @default_invoice_memo = default_invoice_memo
+      @auto_collection = auto_collection
+      @auto_issuance = auto_issuance
+      @net_terms = net_terms
+      @redeemed_coupon = redeemed_coupon
+      @billing_cycle_day = billing_cycle_day
+      @billing_cycle_anchor_configuration = billing_cycle_anchor_configuration
+      @invoicing_threshold = invoicing_threshold
+      @price_intervals = price_intervals
+      @adjustment_intervals = adjustment_intervals
+      @discount_intervals = discount_intervals
+      @minimum_intervals = minimum_intervals
+      @maximum_intervals = maximum_intervals
+      @pending_subscription_change = pending_subscription_change
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      customer = Customer.from_hash(hash['customer']) if hash['customer']
+      plan = Plan.from_hash(hash['plan']) if hash['plan']
+      name = hash.key?('name') ? hash['name'] : nil
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      current_billing_period_start_date = if hash.key?('current_billing_period_start_date')
+                                            (DateTimeHelper.from_rfc3339(hash['current_billing_period_start_date']) if hash['current_billing_period_start_date'])
+                                          end
+      current_billing_period_end_date = if hash.key?('current_billing_period_end_date')
+                                          (DateTimeHelper.from_rfc3339(hash['current_billing_period_end_date']) if hash['current_billing_period_end_date'])
+                                        end
+      status = hash.key?('status') ? hash['status'] : nil
+      trial_info = SubscriptionTrialInfo.from_hash(hash['trial_info']) if hash['trial_info']
+      active_plan_phase_order =
+        hash.key?('active_plan_phase_order') ? hash['active_plan_phase_order'] : nil
+      # Parameter is an array, so we need to iterate through it
+      fixed_fee_quantity_schedule = nil
+      unless hash['fixed_fee_quantity_schedule'].nil?
+        fixed_fee_quantity_schedule = []
+        hash['fixed_fee_quantity_schedule'].each do |structure|
+          fixed_fee_quantity_schedule << (FixedFeeQuantityScheduleEntry.from_hash(structure) if structure)
+        end
+      end
+
+      fixed_fee_quantity_schedule = nil unless hash.key?('fixed_fee_quantity_schedule')
+      default_invoice_memo =
+        hash.key?('default_invoice_memo') ? hash['default_invoice_memo'] : nil
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : nil
+      auto_issuance = hash.key?('auto_issuance') ? hash['auto_issuance'] : nil
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : nil
+      redeemed_coupon = CouponRedemption.from_hash(hash['redeemed_coupon']) if
+        hash['redeemed_coupon']
+      billing_cycle_day =
+        hash.key?('billing_cycle_day') ? hash['billing_cycle_day'] : nil
+      if hash['billing_cycle_anchor_configuration']
+        billing_cycle_anchor_configuration = BillingCycleAnchorConfiguration.from_hash(hash['billing_cycle_anchor_configuration'])
+      end
+      invoicing_threshold =
+        hash.key?('invoicing_threshold') ? hash['invoicing_threshold'] : nil
+      # Parameter is an array, so we need to iterate through it
+      price_intervals = nil
+      unless hash['price_intervals'].nil?
+        price_intervals = []
+        hash['price_intervals'].each do |structure|
+          price_intervals << (PriceInterval.from_hash(structure) if structure)
+        end
+      end
+
+      price_intervals = nil unless hash.key?('price_intervals')
+      # Parameter is an array, so we need to iterate through it
+      adjustment_intervals = nil
+      unless hash['adjustment_intervals'].nil?
+        adjustment_intervals = []
+        hash['adjustment_intervals'].each do |structure|
+          adjustment_intervals << (AdjustmentInterval.from_hash(structure) if structure)
+        end
+      end
+
+      adjustment_intervals = nil unless hash.key?('adjustment_intervals')
+      discount_intervals = hash.key?('discount_intervals') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SubscriptionDiscountIntervals), hash['discount_intervals']
+      ) : nil
+      # Parameter is an array, so we need to iterate through it
+      minimum_intervals = nil
+      unless hash['minimum_intervals'].nil?
+        minimum_intervals = []
+        hash['minimum_intervals'].each do |structure|
+          minimum_intervals << (MinimumInterval.from_hash(structure) if structure)
+        end
+      end
+
+      minimum_intervals = nil unless hash.key?('minimum_intervals')
+      # Parameter is an array, so we need to iterate through it
+      maximum_intervals = nil
+      unless hash['maximum_intervals'].nil?
+        maximum_intervals = []
+        hash['maximum_intervals'].each do |structure|
+          maximum_intervals << (MaximumInterval.from_hash(structure) if structure)
+        end
+      end
+
+      maximum_intervals = nil unless hash.key?('maximum_intervals')
+      if hash['pending_subscription_change']
+        pending_subscription_change = SubscriptionChangeMinified.from_hash(hash['pending_subscription_change'])
+      end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Subscription.new(metadata: metadata,
+                       id: id,
+                       customer: customer,
+                       plan: plan,
+                       name: name,
+                       start_date: start_date,
+                       end_date: end_date,
+                       created_at: created_at,
+                       current_billing_period_start_date: current_billing_period_start_date,
+                       current_billing_period_end_date: current_billing_period_end_date,
+                       status: status,
+                       trial_info: trial_info,
+                       active_plan_phase_order: active_plan_phase_order,
+                       fixed_fee_quantity_schedule: fixed_fee_quantity_schedule,
+                       default_invoice_memo: default_invoice_memo,
+                       auto_collection: auto_collection,
+                       auto_issuance: auto_issuance,
+                       net_terms: net_terms,
+                       redeemed_coupon: redeemed_coupon,
+                       billing_cycle_day: billing_cycle_day,
+                       billing_cycle_anchor_configuration: billing_cycle_anchor_configuration,
+                       invoicing_threshold: invoicing_threshold,
+                       price_intervals: price_intervals,
+                       adjustment_intervals: adjustment_intervals,
+                       discount_intervals: discount_intervals,
+                       minimum_intervals: minimum_intervals,
+                       maximum_intervals: maximum_intervals,
+                       pending_subscription_change: pending_subscription_change,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_current_billing_period_start_date
+      DateTimeHelper.to_rfc3339(current_billing_period_start_date)
+    end
+
+    def to_custom_current_billing_period_end_date
+      DateTimeHelper.to_rfc3339(current_billing_period_end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Subscription | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.metadata,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { Customer.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.plan,
+                                  ->(val) { Plan.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.current_billing_period_start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.current_billing_period_end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { Status13.validate(val) }) and
+            APIHelper.valid_type?(value.trial_info,
+                                  ->(val) { SubscriptionTrialInfo.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.active_plan_phase_order,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.fixed_fee_quantity_schedule,
+                                  ->(val) { FixedFeeQuantityScheduleEntry.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.default_invoice_memo,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.auto_collection,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.auto_issuance,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.net_terms,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.redeemed_coupon,
+                                  ->(val) { CouponRedemption.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.billing_cycle_day,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.billing_cycle_anchor_configuration,
+                                  ->(val) { BillingCycleAnchorConfiguration.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.invoicing_threshold,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.price_intervals,
+                                  ->(val) { PriceInterval.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.adjustment_intervals,
+                                  ->(val) { AdjustmentInterval.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            UnionTypeLookUp.get(:SubscriptionDiscountIntervals)
+                           .validate(value.discount_intervals) and
+            APIHelper.valid_type?(value.minimum_intervals,
+                                  ->(val) { MinimumInterval.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.maximum_intervals,
+                                  ->(val) { MaximumInterval.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.pending_subscription_change,
+                                  ->(val) { SubscriptionChangeMinified.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['metadata'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { Customer.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['plan'],
+                                ->(val) { Plan.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['start_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['current_billing_period_start_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['current_billing_period_end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { Status13.validate(val) }) and
+          APIHelper.valid_type?(value['trial_info'],
+                                ->(val) { SubscriptionTrialInfo.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['active_plan_phase_order'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['fixed_fee_quantity_schedule'],
+                                ->(val) { FixedFeeQuantityScheduleEntry.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['default_invoice_memo'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['auto_collection'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['auto_issuance'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['net_terms'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['redeemed_coupon'],
+                                ->(val) { CouponRedemption.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['billing_cycle_day'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['billing_cycle_anchor_configuration'],
+                                ->(val) { BillingCycleAnchorConfiguration.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['invoicing_threshold'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['price_intervals'],
+                                ->(val) { PriceInterval.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['adjustment_intervals'],
+                                ->(val) { AdjustmentInterval.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          UnionTypeLookUp.get(:SubscriptionDiscountIntervals)
+                         .validate(value['discount_intervals']) and
+          APIHelper.valid_type?(value['minimum_intervals'],
+                                ->(val) { MinimumInterval.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['maximum_intervals'],
+                                ->(val) { MaximumInterval.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['pending_subscription_change'],
+                                ->(val) { SubscriptionChangeMinified.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, id: #{@id}, customer: #{@customer}, plan: #{@plan},"\
+      " name: #{@name}, start_date: #{@start_date}, end_date: #{@end_date}, created_at:"\
+      " #{@created_at}, current_billing_period_start_date: #{@current_billing_period_start_date},"\
+      " current_billing_period_end_date: #{@current_billing_period_end_date}, status: #{@status},"\
+      " trial_info: #{@trial_info}, active_plan_phase_order: #{@active_plan_phase_order},"\
+      " fixed_fee_quantity_schedule: #{@fixed_fee_quantity_schedule}, default_invoice_memo:"\
+      " #{@default_invoice_memo}, auto_collection: #{@auto_collection}, auto_issuance:"\
+      " #{@auto_issuance}, net_terms: #{@net_terms}, redeemed_coupon: #{@redeemed_coupon},"\
+      " billing_cycle_day: #{@billing_cycle_day}, billing_cycle_anchor_configuration:"\
+      " #{@billing_cycle_anchor_configuration}, invoicing_threshold: #{@invoicing_threshold},"\
+      " price_intervals: #{@price_intervals}, adjustment_intervals: #{@adjustment_intervals},"\
+      " discount_intervals: #{@discount_intervals}, minimum_intervals: #{@minimum_intervals},"\
+      " maximum_intervals: #{@maximum_intervals}, pending_subscription_change:"\
+      " #{@pending_subscription_change}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, id: #{@id.inspect}, customer:"\
+      " #{@customer.inspect}, plan: #{@plan.inspect}, name: #{@name.inspect}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, created_at:"\
+      " #{@created_at.inspect}, current_billing_period_start_date:"\
+      " #{@current_billing_period_start_date.inspect}, current_billing_period_end_date:"\
+      " #{@current_billing_period_end_date.inspect}, status: #{@status.inspect}, trial_info:"\
+      " #{@trial_info.inspect}, active_plan_phase_order: #{@active_plan_phase_order.inspect},"\
+      " fixed_fee_quantity_schedule: #{@fixed_fee_quantity_schedule.inspect},"\
+      " default_invoice_memo: #{@default_invoice_memo.inspect}, auto_collection:"\
+      " #{@auto_collection.inspect}, auto_issuance: #{@auto_issuance.inspect}, net_terms:"\
+      " #{@net_terms.inspect}, redeemed_coupon: #{@redeemed_coupon.inspect}, billing_cycle_day:"\
+      " #{@billing_cycle_day.inspect}, billing_cycle_anchor_configuration:"\
+      " #{@billing_cycle_anchor_configuration.inspect}, invoicing_threshold:"\
+      " #{@invoicing_threshold.inspect}, price_intervals: #{@price_intervals.inspect},"\
+      " adjustment_intervals: #{@adjustment_intervals.inspect}, discount_intervals:"\
+      " #{@discount_intervals.inspect}, minimum_intervals: #{@minimum_intervals.inspect},"\
+      " maximum_intervals: #{@maximum_intervals.inspect}, pending_subscription_change:"\
+      " #{@pending_subscription_change.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end