orb-billing 0.11.0 → 1.0.0

data/lib/orb/models/monetary_percentage_discount_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::MonetaryPercentageDiscountAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::MonetaryPercentageDiscountAdjustment::AdjustmentType }
+
+      # @!attribute amount
+      #   The value applied by an adjustment.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   The price IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this adjustment to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute is_invoice_level
+      #   True for adjustments that apply to an entire invocice, false for adjustments
+      #   that apply to only one price.
+      #
+      #   @return [Boolean]
+      required :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute percentage_discount
+      #   The percentage (as a value between 0 and 1) by which to discount the price
+      #   intervals this adjustment applies to in a given billing period.
+      #
+      #   @return [Float]
+      required :percentage_discount, Float
+
+      # @!attribute reason
+      #   The reason for the adjustment.
+      #
+      #   @return [String, nil]
+      required :reason, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, reason:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MonetaryPercentageDiscountAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::MonetaryPercentageDiscountAdjustment::AdjustmentType]
+      #
+      #   @param amount [String] The value applied by an adjustment.
+      #
+      #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this adjustment to.
+      #
+      #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+      #
+      #   @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
+      #
+      #   @param reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::MonetaryPercentageDiscountAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        PERCENTAGE_DISCOUNT = :percentage_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/monetary_usage_discount_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::MonetaryUsageDiscountAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::MonetaryUsageDiscountAdjustment::AdjustmentType }
+
+      # @!attribute amount
+      #   The value applied by an adjustment.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   The price IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this adjustment to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute is_invoice_level
+      #   True for adjustments that apply to an entire invocice, false for adjustments
+      #   that apply to only one price.
+      #
+      #   @return [Boolean]
+      required :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute reason
+      #   The reason for the adjustment.
+      #
+      #   @return [String, nil]
+      required :reason, String, nil?: true
+
+      # @!attribute usage_discount
+      #   The number of usage units by which to discount the price this adjustment applies
+      #   to in a given billing period.
+      #
+      #   @return [Float]
+      required :usage_discount, Float
+
+      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, usage_discount:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MonetaryUsageDiscountAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::MonetaryUsageDiscountAdjustment::AdjustmentType]
+      #
+      #   @param amount [String] The value applied by an adjustment.
+      #
+      #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this adjustment to.
+      #
+      #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+      #
+      #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
+
+      # @see Orb::Models::MonetaryUsageDiscountAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        USAGE_DISCOUNT = :usage_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/mutated_subscription.rb

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MutatedSubscription < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute active_plan_phase_order
+      #   The current plan phase that is active, only if the subscription's plan has
+      #   phases.
+      #
+      #   @return [Integer, nil]
+      required :active_plan_phase_order, Integer, nil?: true
+
+      # @!attribute adjustment_intervals
+      #   The adjustment intervals for this subscription sorted by the start_date of the
+      #   adjustment interval.
+      #
+      #   @return [Array<Orb::Models::AdjustmentInterval>]
+      required :adjustment_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::AdjustmentInterval] }
+
+      # @!attribute auto_collection
+      #   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 [Boolean, nil]
+      required :auto_collection, Orb::Internal::Type::Boolean, nil?: true
+
+      # @!attribute billing_cycle_anchor_configuration
+      #
+      #   @return [Orb::Models::BillingCycleAnchorConfiguration]
+      required :billing_cycle_anchor_configuration, -> { Orb::BillingCycleAnchorConfiguration }
+
+      # @!attribute 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 [Integer]
+      required :billing_cycle_day, Integer
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute 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 [Time, nil]
+      required :current_billing_period_end_date, Time, nil?: true
+
+      # @!attribute current_billing_period_start_date
+      #   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 [Time, nil]
+      required :current_billing_period_start_date, Time, nil?: true
+
+      # @!attribute 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 [Orb::Models::Customer]
+      required :customer, -> { Orb::Customer }
+
+      # @!attribute default_invoice_memo
+      #   Determines the default memo on this subscriptions' invoices. Note that if this
+      #   is not provided, it is determined by the plan configuration.
+      #
+      #   @return [String, nil]
+      required :default_invoice_memo, String, nil?: true
+
+      # @!attribute discount_intervals
+      #   @deprecated
+      #
+      #   The discount intervals for this subscription sorted by the start_date.
+      #
+      #   @return [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>]
+      required :discount_intervals,
+               -> { Orb::Internal::Type::ArrayOf[union: Orb::MutatedSubscription::DiscountInterval] }
+
+      # @!attribute end_date
+      #   The date Orb stops billing for this subscription.
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute fixed_fee_quantity_schedule
+      #
+      #   @return [Array<Orb::Models::FixedFeeQuantityScheduleEntry>]
+      required :fixed_fee_quantity_schedule,
+               -> { Orb::Internal::Type::ArrayOf[Orb::FixedFeeQuantityScheduleEntry] }
+
+      # @!attribute invoicing_threshold
+      #
+      #   @return [String, nil]
+      required :invoicing_threshold, String, nil?: true
+
+      # @!attribute maximum_intervals
+      #   @deprecated
+      #
+      #   The maximum intervals for this subscription sorted by the start_date.
+      #
+      #   @return [Array<Orb::Models::MaximumInterval>]
+      required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MaximumInterval] }
+
+      # @!attribute 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 [Hash{Symbol=>String}]
+      required :metadata, Orb::Internal::Type::HashOf[String]
+
+      # @!attribute minimum_intervals
+      #   @deprecated
+      #
+      #   The minimum intervals for this subscription sorted by the start_date.
+      #
+      #   @return [Array<Orb::Models::MinimumInterval>]
+      required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MinimumInterval] }
+
+      # @!attribute name
+      #   The name of the subscription.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute 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 [Integer]
+      required :net_terms, Integer
+
+      # @!attribute pending_subscription_change
+      #   A pending subscription change if one exists on this subscription.
+      #
+      #   @return [Orb::Models::SubscriptionChangeMinified, nil]
+      required :pending_subscription_change, -> { Orb::SubscriptionChangeMinified }, nil?: true
+
+      # @!attribute 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).
+      #
+      #   @return [Orb::Models::Plan, nil]
+      required :plan, -> { Orb::Plan }, nil?: true
+
+      # @!attribute price_intervals
+      #   The price intervals for this subscription.
+      #
+      #   @return [Array<Orb::Models::PriceInterval>]
+      required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::PriceInterval] }
+
+      # @!attribute redeemed_coupon
+      #
+      #   @return [Orb::Models::CouponRedemption, nil]
+      required :redeemed_coupon, -> { Orb::CouponRedemption }, nil?: true
+
+      # @!attribute start_date
+      #   The date Orb starts billing for this subscription.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Orb::Models::MutatedSubscription::Status]
+      required :status, enum: -> { Orb::MutatedSubscription::Status }
+
+      # @!attribute trial_info
+      #
+      #   @return [Orb::Models::SubscriptionTrialInfo]
+      required :trial_info, -> { Orb::SubscriptionTrialInfo }
+
+      # @!attribute changed_resources
+      #   The resources that were changed as part of this operation. Only present when
+      #   fetched through the subscription changes API or if the
+      #   `include_changed_resources` parameter was passed in the request.
+      #
+      #   @return [Orb::Models::ChangedSubscriptionResources, nil]
+      optional :changed_resources, -> { Orb::ChangedSubscriptionResources }, nil?: true
+
+      # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, name:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MutatedSubscription} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
+      #
+      #   @param adjustment_intervals [Array<Orb::Models::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
+      #
+      #   @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
+      #
+      #   @param billing_cycle_anchor_configuration [Orb::Models::BillingCycleAnchorConfiguration]
+      #
+      #   @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
+      #
+      #   @param created_at [Time]
+      #
+      #   @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
+      #
+      #   @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
+      #
+      #   @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
+      #
+      #   @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
+      #
+      #   @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
+      #
+      #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
+      #
+      #   @param fixed_fee_quantity_schedule [Array<Orb::Models::FixedFeeQuantityScheduleEntry>]
+      #
+      #   @param invoicing_threshold [String, nil]
+      #
+      #   @param maximum_intervals [Array<Orb::Models::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #
+      #   @param minimum_intervals [Array<Orb::Models::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
+      #
+      #   @param name [String] The name of the subscription.
+      #
+      #   @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
+      #
+      #   @param pending_subscription_change [Orb::Models::SubscriptionChangeMinified, nil] A pending subscription change if one exists on this subscription.
+      #
+      #   @param plan [Orb::Models::Plan, nil] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      #
+      #   @param price_intervals [Array<Orb::Models::PriceInterval>] The price intervals for this subscription.
+      #
+      #   @param redeemed_coupon [Orb::Models::CouponRedemption, nil]
+      #
+      #   @param start_date [Time] The date Orb starts billing for this subscription.
+      #
+      #   @param status [Symbol, Orb::Models::MutatedSubscription::Status]
+      #
+      #   @param trial_info [Orb::Models::SubscriptionTrialInfo]
+      #
+      #   @param changed_resources [Orb::Models::ChangedSubscriptionResources, nil] The resources that were changed as part of this operation. Only present when fet
+
+      module DiscountInterval
+        extend Orb::Internal::Type::Union
+
+        discriminator :discount_type
+
+        variant :amount, -> { Orb::AmountDiscountInterval }
+
+        variant :percentage, -> { Orb::PercentageDiscountInterval }
+
+        variant :usage, -> { Orb::UsageDiscountInterval }
+
+        # @!method self.variants
+        #   @return [Array(Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval)]
+      end
+
+      # @see Orb::Models::MutatedSubscription#status
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE = :active
+        ENDED = :ended
+        UPCOMING = :upcoming
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/new_accounting_sync_configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewAccountingSyncConfiguration < Orb::Internal::Type::BaseModel
+      # @!attribute accounting_providers
+      #
+      #   @return [Array<Orb::Models::AccountingProviderConfig>, nil]
+      optional :accounting_providers,
+               -> { Orb::Internal::Type::ArrayOf[Orb::AccountingProviderConfig] },
+               nil?: true
+
+      # @!attribute excluded
+      #
+      #   @return [Boolean, nil]
+      optional :excluded, Orb::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(accounting_providers: nil, excluded: nil)
+      #   @param accounting_providers [Array<Orb::Models::AccountingProviderConfig>, nil]
+      #   @param excluded [Boolean, nil]
+    end
+  end
+end

data/lib/orb/models/new_allocation_price.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewAllocationPrice < Orb::Internal::Type::BaseModel
+      # @!attribute amount
+      #   An amount of the currency to allocate to the customer at the specified cadence.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute cadence
+      #   The cadence at which to allocate the amount to the customer.
+      #
+      #   @return [Symbol, Orb::Models::NewAllocationPrice::Cadence]
+      required :cadence, enum: -> { Orb::NewAllocationPrice::Cadence }
+
+      # @!attribute currency
+      #   An ISO 4217 currency string or a custom pricing unit identifier in which to bill
+      #   this price.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute custom_expiration
+      #   The custom expiration for the allocation.
+      #
+      #   @return [Orb::Models::CustomExpiration, nil]
+      optional :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
+
+      # @!attribute expires_at_end_of_cadence
+      #   Whether the allocated amount should expire at the end of the cadence or roll
+      #   over to the next period. Set to null if using custom_expiration.
+      #
+      #   @return [Boolean, nil]
+      optional :expires_at_end_of_cadence, Orb::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(amount:, cadence:, currency:, custom_expiration: nil, expires_at_end_of_cadence: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::NewAllocationPrice} for more details.
+      #
+      #   @param amount [String] An amount of the currency to allocate to the customer at the specified cadence.
+      #
+      #   @param cadence [Symbol, Orb::Models::NewAllocationPrice::Cadence] The cadence at which to allocate the amount to the customer.
+      #
+      #   @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
+      #
+      #   @param custom_expiration [Orb::Models::CustomExpiration, nil] The custom expiration for the allocation.
+      #
+      #   @param expires_at_end_of_cadence [Boolean, nil] Whether the allocated amount should expire at the end of the cadence or roll ove
+
+      # The cadence at which to allocate the amount to the customer.
+      #
+      # @see Orb::Models::NewAllocationPrice#cadence
+      module Cadence
+        extend Orb::Internal::Type::Enum
+
+        ONE_TIME = :one_time
+        MONTHLY = :monthly
+        QUARTERLY = :quarterly
+        SEMI_ANNUAL = :semi_annual
+        ANNUAL = :annual
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/new_amount_discount.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewAmountDiscount < Orb::Internal::Type::BaseModel
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::NewAmountDiscount::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::NewAmountDiscount::AdjustmentType }
+
+      # @!attribute amount_discount
+      #
+      #   @return [String]
+      required :amount_discount, String
+
+      # @!attribute applies_to_all
+      #   If set, the adjustment will apply to every price on the subscription.
+      #
+      #   @return [Boolean, Orb::Models::NewAmountDiscount::AppliesToAll, nil]
+      optional :applies_to_all, enum: -> { Orb::NewAmountDiscount::AppliesToAll }, nil?: true
+
+      # @!attribute applies_to_item_ids
+      #   The set of item IDs to which this adjustment applies.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_item_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute applies_to_price_ids
+      #   The set of price IDs to which this adjustment applies.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute currency
+      #   If set, only prices in the specified currency will have the adjustment applied.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute filters
+      #   A list of filters that determine which prices this adjustment will apply to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }, nil?: true
+
+      # @!attribute is_invoice_level
+      #   When false, this adjustment will be applied to a single price. Otherwise, it
+      #   will be applied at the invoice level, possibly to multiple prices.
+      #
+      #   @return [Boolean, nil]
+      optional :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute price_type
+      #   If set, only prices of the specified type will have the adjustment applied.
+      #
+      #   @return [Symbol, Orb::Models::NewAmountDiscount::PriceType, nil]
+      optional :price_type, enum: -> { Orb::NewAmountDiscount::PriceType }, nil?: true
+
+      # @!method initialize(adjustment_type:, amount_discount:, applies_to_all: nil, applies_to_item_ids: nil, applies_to_price_ids: nil, currency: nil, filters: nil, is_invoice_level: nil, price_type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::NewAmountDiscount} for more details.
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::NewAmountDiscount::AdjustmentType]
+      #
+      #   @param amount_discount [String]
+      #
+      #   @param applies_to_all [Boolean, Orb::Models::NewAmountDiscount::AppliesToAll, nil] If set, the adjustment will apply to every price on the subscription.
+      #
+      #   @param applies_to_item_ids [Array<String>, nil] The set of item IDs to which this adjustment applies.
+      #
+      #   @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
+      #
+      #   @param currency [String, nil] If set, only prices in the specified currency will have the adjustment applied.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>, nil] A list of filters that determine which prices this adjustment will apply to.
+      #
+      #   @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
+      #
+      #   @param price_type [Symbol, Orb::Models::NewAmountDiscount::PriceType, nil] If set, only prices of the specified type will have the adjustment applied.
+
+      # @see Orb::Models::NewAmountDiscount#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        AMOUNT_DISCOUNT = :amount_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # If set, the adjustment will apply to every price on the subscription.
+      #
+      # @see Orb::Models::NewAmountDiscount#applies_to_all
+      module AppliesToAll
+        extend Orb::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+
+      # If set, only prices of the specified type will have the adjustment applied.
+      #
+      # @see Orb::Models::NewAmountDiscount#price_type
+      module PriceType
+        extend Orb::Internal::Type::Enum
+
+        USAGE = :usage
+        FIXED_IN_ADVANCE = :fixed_in_advance
+        FIXED_IN_ARREARS = :fixed_in_arrears
+        FIXED = :fixed
+        IN_ARREARS = :in_arrears
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end