# This file is automatically created by Recurly's OpenAPI generation process
# and thus any edits you make by hand will be lost. If you wish to make a
# change to this file, please create a Github issue explaining the changes you
# need and we will usher them to the appropriate places.
module Recurly
  module Resources
    class SubscriptionChangePreview < Resource

      # @!attribute activate_at
      #   @return [DateTime] Activated at
      define_attribute :activate_at, DateTime

      # @!attribute activated
      #   @return [Boolean] Returns `true` if the subscription change is activated.
      define_attribute :activated, :Boolean

      # @!attribute add_ons
      #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }

      # @!attribute billing_info
      #   @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
      define_attribute :billing_info, :SubscriptionChangeBillingInfo

      # @!attribute created_at
      #   @return [DateTime] Created at
      define_attribute :created_at, DateTime

      # @!attribute custom_fields
      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
      define_attribute :custom_fields, Array, { :item_type => :CustomField }

      # @!attribute deleted_at
      #   @return [DateTime] Deleted at
      define_attribute :deleted_at, DateTime

      # @!attribute id
      #   @return [String] The ID of the Subscription Change.
      define_attribute :id, String

      # @!attribute invoice_collection
      #   @return [InvoiceCollection] Invoice Collection
      define_attribute :invoice_collection, :InvoiceCollection

      # @!attribute object
      #   @return [String] Object type
      define_attribute :object, String

      # @!attribute plan
      #   @return [PlanMini] Just the important parts.
      define_attribute :plan, :PlanMini

      # @!attribute quantity
      #   @return [Integer] Subscription quantity
      define_attribute :quantity, Integer

      # @!attribute revenue_schedule_type
      #   @return [String] Revenue schedule type
      define_attribute :revenue_schedule_type, String

      # @!attribute setup_fee_revenue_schedule_type
      #   @return [String] Setup fee revenue schedule type
      define_attribute :setup_fee_revenue_schedule_type, String

      # @!attribute shipping
      #   @return [SubscriptionShipping] Subscription shipping details
      define_attribute :shipping, :SubscriptionShipping

      # @!attribute subscription_id
      #   @return [String] The ID of the subscription that is going to be changed.
      define_attribute :subscription_id, String

      # @!attribute tax_inclusive
      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
      define_attribute :tax_inclusive, :Boolean

      # @!attribute unit_amount
      #   @return [Float] Unit amount
      define_attribute :unit_amount, Float

      # @!attribute updated_at
      #   @return [DateTime] Updated at
      define_attribute :updated_at, DateTime
    end
  end
end