orb-billing 0.5.5 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/README.md +1 -1
- data/lib/orb/internal/type/base_model.rb +2 -2
- data/lib/orb/internal/type/union.rb +6 -6
- data/lib/orb/models/alert.rb +33 -1
- data/lib/orb/models/amount_discount.rb +10 -10
- data/lib/orb/models/credit_note_create_params.rb +9 -9
- data/lib/orb/models/customer_create_params.rb +21 -3
- data/lib/orb/models/customer_update_by_external_id_params.rb +21 -3
- data/lib/orb/models/customer_update_params.rb +21 -3
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_list_response.rb +9 -1
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_create_params.rb +1 -1
- data/lib/orb/models/invoice.rb +626 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +624 -9
- data/lib/orb/models/invoice_line_item_create_response.rb +486 -7
- data/lib/orb/models/item.rb +18 -1
- data/lib/orb/models/item_archive_params.rb +14 -0
- data/lib/orb/models/item_create_params.rb +14 -1
- data/lib/orb/models/item_update_params.rb +16 -1
- data/lib/orb/models/percentage_discount.rb +10 -10
- data/lib/orb/models/plan.rb +618 -9
- data/lib/orb/models/plan_create_params.rb +2066 -30
- data/lib/orb/models/plan_set_default_version_params.rb +22 -0
- data/lib/orb/models/plans/external_plan_id/version_create_params.rb +17948 -0
- data/lib/orb/models/plans/external_plan_id/version_create_response.rb +819 -0
- data/lib/orb/models/plans/external_plan_id/version_retrieve_params.rb +24 -0
- data/lib/orb/models/plans/external_plan_id/version_retrieve_response.rb +819 -0
- data/lib/orb/models/plans/external_plan_id_set_default_version_params.rb +24 -0
- data/lib/orb/models/plans/version_create_params.rb +17794 -0
- data/lib/orb/models/plans/version_create_response.rb +814 -0
- data/lib/orb/models/plans/version_retrieve_params.rb +22 -0
- data/lib/orb/models/plans/version_retrieve_response.rb +814 -0
- data/lib/orb/models/price.rb +4124 -70
- data/lib/orb/models/price_create_params.rb +45 -1
- data/lib/orb/models/price_evaluate_params.rb +8529 -21
- data/lib/orb/models/price_evaluate_response.rb +38 -3
- data/lib/orb/models/subscription.rb +730 -54
- data/lib/orb/models/subscription_cancel_response.rb +706 -54
- data/lib/orb/models/subscription_change_apply_response.rb +728 -54
- data/lib/orb/models/subscription_change_cancel_response.rb +728 -54
- data/lib/orb/models/subscription_change_retrieve_response.rb +728 -54
- data/lib/orb/models/subscription_create_params.rb +5992 -1698
- data/lib/orb/models/subscription_create_response.rb +706 -54
- data/lib/orb/models/subscription_fetch_schedule_response.rb +3 -3
- data/lib/orb/models/subscription_price_intervals_params.rb +1392 -76
- data/lib/orb/models/subscription_price_intervals_response.rb +712 -54
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +6005 -1723
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +716 -54
- data/lib/orb/models/subscription_trigger_phase_response.rb +708 -54
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +720 -54
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +728 -54
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +728 -54
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +1 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +720 -54
- data/lib/orb/models/subscription_update_trial_response.rb +706 -54
- data/lib/orb/models/trial_discount.rb +10 -10
- data/lib/orb/models/usage_discount.rb +10 -10
- data/lib/orb/models.rb +4 -0
- data/lib/orb/resources/credit_notes.rb +3 -3
- data/lib/orb/resources/customers/balance_transactions.rb +0 -7
- data/lib/orb/resources/customers.rb +4 -7
- data/lib/orb/resources/dimensional_price_groups.rb +1 -1
- data/lib/orb/resources/items.rb +34 -2
- data/lib/orb/resources/plans/external_plan_id/versions.rb +88 -0
- data/lib/orb/resources/plans/external_plan_id.rb +32 -1
- data/lib/orb/resources/plans/versions.rb +86 -0
- data/lib/orb/resources/plans.rb +33 -2
- data/lib/orb/resources/prices.rb +23 -17
- data/lib/orb/resources/subscriptions.rb +5 -1
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +13 -0
- data/rbi/orb/models/alert.rbi +50 -3
- data/rbi/orb/models/amount_discount.rbi +8 -8
- data/rbi/orb/models/credit_note_create_params.rbi +8 -8
- data/rbi/orb/models/customer_create_params.rbi +38 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +38 -4
- data/rbi/orb/models/customer_update_params.rbi +38 -4
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +2 -2
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +2 -2
- data/rbi/orb/models/invoice.rbi +1451 -35
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1524 -4
- data/rbi/orb/models/invoice_line_item_create_response.rbi +1184 -2
- data/rbi/orb/models/item.rbi +20 -1
- data/rbi/orb/models/item_archive_params.rbi +25 -0
- data/rbi/orb/models/item_create_params.rbi +18 -1
- data/rbi/orb/models/item_update_params.rbi +17 -1
- data/rbi/orb/models/percentage_discount.rbi +10 -10
- data/rbi/orb/models/plan.rbi +1339 -4
- data/rbi/orb/models/plan_create_params.rbi +3833 -29
- data/rbi/orb/models/plan_set_default_version_params.rbi +40 -0
- data/rbi/orb/models/plans/external_plan_id/version_create_params.rbi +32668 -0
- data/rbi/orb/models/plans/external_plan_id/version_create_response.rbi +1562 -0
- data/rbi/orb/models/plans/external_plan_id/version_retrieve_params.rbi +42 -0
- data/rbi/orb/models/plans/external_plan_id/version_retrieve_response.rbi +1562 -0
- data/rbi/orb/models/plans/external_plan_id_set_default_version_params.rbi +45 -0
- data/rbi/orb/models/plans/version_create_params.rbi +32607 -0
- data/rbi/orb/models/plans/version_create_response.rbi +1556 -0
- data/rbi/orb/models/plans/version_retrieve_params.rbi +37 -0
- data/rbi/orb/models/plans/version_retrieve_response.rbi +1558 -0
- data/rbi/orb/models/price.rbi +9447 -441
- data/rbi/orb/models/price_create_params.rbi +80 -0
- data/rbi/orb/models/price_evaluate_params.rbi +15684 -25
- data/rbi/orb/models/price_evaluate_response.rbi +68 -5
- data/rbi/orb/models/subscription.rbi +1654 -44
- data/rbi/orb/models/subscription_cancel_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_apply_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_cancel_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +1692 -44
- data/rbi/orb/models/subscription_create_params.rbi +10400 -2710
- data/rbi/orb/models/subscription_create_response.rbi +1692 -44
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +13 -4
- data/rbi/orb/models/subscription_price_intervals_params.rbi +2401 -49
- data/rbi/orb/models/subscription_price_intervals_response.rbi +1692 -44
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +10423 -2753
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +1692 -44
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1692 -44
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +2 -2
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1692 -44
- data/rbi/orb/models/subscription_update_trial_response.rbi +1692 -44
- data/rbi/orb/models/trial_discount.rbi +8 -8
- data/rbi/orb/models/usage_discount.rbi +10 -10
- data/rbi/orb/models.rbi +4 -0
- data/rbi/orb/resources/credit_notes.rbi +3 -3
- data/rbi/orb/resources/customers/balance_transactions.rbi +0 -7
- data/rbi/orb/resources/customers/credits/top_ups.rbi +2 -2
- data/rbi/orb/resources/customers.rbi +7 -7
- data/rbi/orb/resources/dimensional_price_groups.rbi +1 -1
- data/rbi/orb/resources/items.rbi +20 -0
- data/rbi/orb/resources/plans/external_plan_id/versions.rbi +103 -0
- data/rbi/orb/resources/plans/external_plan_id.rbi +23 -1
- data/rbi/orb/resources/plans/versions.rbi +91 -0
- data/rbi/orb/resources/plans.rbi +27 -2
- data/rbi/orb/resources/prices.rbi +27 -17
- data/rbi/orb/resources/subscriptions.rbi +9 -1
- data/sig/orb/models/alert.rbs +20 -3
- data/sig/orb/models/amount_discount.rbs +5 -5
- data/sig/orb/models/credit_note_create_params.rbs +6 -6
- data/sig/orb/models/customer_create_params.rbs +13 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +13 -0
- data/sig/orb/models/customer_update_params.rbs +13 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -2
- data/sig/orb/models/invoice.rbs +558 -4
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +558 -4
- data/sig/orb/models/invoice_line_item_create_response.rbs +414 -2
- data/sig/orb/models/item.rbs +5 -0
- data/sig/orb/models/item_archive_params.rbs +14 -0
- data/sig/orb/models/item_create_params.rbs +10 -2
- data/sig/orb/models/item_update_params.rbs +5 -0
- data/sig/orb/models/percentage_discount.rbs +5 -5
- data/sig/orb/models/plan.rbs +538 -4
- data/sig/orb/models/plan_create_params.rbs +1460 -3
- data/sig/orb/models/plan_set_default_version_params.rbs +20 -0
- data/sig/orb/models/plans/external_plan_id/version_create_params.rbs +12923 -0
- data/sig/orb/models/plans/external_plan_id/version_create_response.rbs +664 -0
- data/sig/orb/models/plans/external_plan_id/version_retrieve_params.rbs +27 -0
- data/sig/orb/models/plans/external_plan_id/version_retrieve_response.rbs +664 -0
- data/sig/orb/models/plans/external_plan_id_set_default_version_params.rbs +25 -0
- data/sig/orb/models/plans/version_create_params.rbs +12898 -0
- data/sig/orb/models/plans/version_create_response.rbs +662 -0
- data/sig/orb/models/plans/version_retrieve_params.rbs +25 -0
- data/sig/orb/models/plans/version_retrieve_response.rbs +662 -0
- data/sig/orb/models/price.rbs +3512 -96
- data/sig/orb/models/price_create_params.rbs +32 -0
- data/sig/orb/models/price_evaluate_params.rbs +6187 -10
- data/sig/orb/models/price_evaluate_response.rbs +41 -4
- data/sig/orb/models/subscription.rbs +609 -29
- data/sig/orb/models/subscription_cancel_response.rbs +609 -29
- data/sig/orb/models/subscription_change_apply_response.rbs +621 -29
- data/sig/orb/models/subscription_change_cancel_response.rbs +621 -29
- data/sig/orb/models/subscription_change_retrieve_response.rbs +621 -29
- data/sig/orb/models/subscription_create_params.rbs +4450 -1466
- data/sig/orb/models/subscription_create_response.rbs +609 -29
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +4 -4
- data/sig/orb/models/subscription_price_intervals_params.rbs +920 -24
- data/sig/orb/models/subscription_price_intervals_response.rbs +609 -29
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +4440 -1466
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +609 -29
- data/sig/orb/models/subscription_trigger_phase_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +609 -29
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +609 -29
- data/sig/orb/models/subscription_update_trial_response.rbs +609 -29
- data/sig/orb/models/trial_discount.rbs +5 -5
- data/sig/orb/models/usage_discount.rbs +5 -5
- data/sig/orb/models.rbs +4 -0
- data/sig/orb/resources/credit_notes.rbs +1 -1
- data/sig/orb/resources/items.rbs +7 -0
- data/sig/orb/resources/plans/external_plan_id/versions.rbs +30 -0
- data/sig/orb/resources/plans/external_plan_id.rbs +8 -0
- data/sig/orb/resources/plans/versions.rbs +28 -0
- data/sig/orb/resources/plans.rbs +8 -0
- data/sig/orb/resources/prices.rbs +3 -3
- data/sig/orb/resources/subscriptions.rbs +2 -0
- metadata +40 -1
@@ -99,6 +99,8 @@ module Orb
|
|
99
99
|
required :default_invoice_memo, String, nil?: true
|
100
100
|
|
101
101
|
# @!attribute discount_intervals
|
102
|
+
# @deprecated
|
103
|
+
#
|
102
104
|
# The discount intervals for this subscription sorted by the start_date.
|
103
105
|
#
|
104
106
|
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage>]
|
@@ -123,6 +125,8 @@ module Orb
|
|
123
125
|
required :invoicing_threshold, String, nil?: true
|
124
126
|
|
125
127
|
# @!attribute maximum_intervals
|
128
|
+
# @deprecated
|
129
|
+
#
|
126
130
|
# The maximum intervals for this subscription sorted by the start_date.
|
127
131
|
#
|
128
132
|
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval>]
|
@@ -139,12 +143,20 @@ module Orb
|
|
139
143
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
140
144
|
|
141
145
|
# @!attribute minimum_intervals
|
146
|
+
# @deprecated
|
147
|
+
#
|
142
148
|
# The minimum intervals for this subscription sorted by the start_date.
|
143
149
|
#
|
144
150
|
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval>]
|
145
151
|
required :minimum_intervals,
|
146
152
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval] }
|
147
153
|
|
154
|
+
# @!attribute name
|
155
|
+
# The name of the subscription.
|
156
|
+
#
|
157
|
+
# @return [String]
|
158
|
+
required :name, String
|
159
|
+
|
148
160
|
# @!attribute net_terms
|
149
161
|
# Determines the difference between the invoice issue date for subscription
|
150
162
|
# invoices as the date that they are due. A value of `0` here represents that the
|
@@ -168,8 +180,8 @@ module Orb
|
|
168
180
|
# subscription. You can see more about how to configure prices in the
|
169
181
|
# [Price resource](/reference/price).
|
170
182
|
#
|
171
|
-
# @return [Orb::Models::Plan]
|
172
|
-
required :plan, -> { Orb::Plan }
|
183
|
+
# @return [Orb::Models::Plan, nil]
|
184
|
+
required :plan, -> { Orb::Plan }, nil?: true
|
173
185
|
|
174
186
|
# @!attribute price_intervals
|
175
187
|
# The price intervals for this subscription.
|
@@ -211,7 +223,7 @@ module Orb
|
|
211
223
|
-> { Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources },
|
212
224
|
nil?: true
|
213
225
|
|
214
|
-
# @!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:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
|
226
|
+
# @!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)
|
215
227
|
# Some parameter documentations has been truncated, see
|
216
228
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse} for more details.
|
217
229
|
#
|
@@ -251,11 +263,13 @@ module Orb
|
|
251
263
|
#
|
252
264
|
# @param minimum_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
253
265
|
#
|
266
|
+
# @param name [String] The name of the subscription.
|
267
|
+
#
|
254
268
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
255
269
|
#
|
256
270
|
# @param pending_subscription_change [Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
257
271
|
#
|
258
|
-
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
272
|
+
# @param plan [Orb::Models::Plan, nil] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
259
273
|
#
|
260
274
|
# @param price_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval>] The price intervals for this subscription.
|
261
275
|
#
|
@@ -343,11 +357,20 @@ module Orb
|
|
343
357
|
required :adjustment_type, const: :usage_discount
|
344
358
|
|
345
359
|
# @!attribute applies_to_price_ids
|
360
|
+
# @deprecated
|
361
|
+
#
|
346
362
|
# The price IDs that this adjustment applies to.
|
347
363
|
#
|
348
364
|
# @return [Array<String>]
|
349
365
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
350
366
|
|
367
|
+
# @!attribute filters
|
368
|
+
# The filters that determine which prices to apply this adjustment to.
|
369
|
+
#
|
370
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter>]
|
371
|
+
required :filters,
|
372
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter] }
|
373
|
+
|
351
374
|
# @!attribute is_invoice_level
|
352
375
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
353
376
|
# that apply to only one price.
|
@@ -374,7 +397,7 @@ module Orb
|
|
374
397
|
# @return [Float]
|
375
398
|
required :usage_discount, Float
|
376
399
|
|
377
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
400
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
378
401
|
# Some parameter documentations has been truncated, see
|
379
402
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
380
403
|
# for more details.
|
@@ -383,6 +406,8 @@ module Orb
|
|
383
406
|
#
|
384
407
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
385
408
|
#
|
409
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
410
|
+
#
|
386
411
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
387
412
|
#
|
388
413
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
@@ -392,6 +417,64 @@ module Orb
|
|
392
417
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
393
418
|
#
|
394
419
|
# @param adjustment_type [Symbol, :usage_discount]
|
420
|
+
|
421
|
+
class Filter < Orb::Internal::Type::BaseModel
|
422
|
+
# @!attribute field
|
423
|
+
# The property of the price to filter on.
|
424
|
+
#
|
425
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field]
|
426
|
+
required :field,
|
427
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field }
|
428
|
+
|
429
|
+
# @!attribute operator
|
430
|
+
# Should prices that match the filter be included or excluded.
|
431
|
+
#
|
432
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator]
|
433
|
+
required :operator,
|
434
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator }
|
435
|
+
|
436
|
+
# @!attribute values
|
437
|
+
# The IDs or values that match this filter.
|
438
|
+
#
|
439
|
+
# @return [Array<String>]
|
440
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
441
|
+
|
442
|
+
# @!method initialize(field:, operator:, values:)
|
443
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
|
444
|
+
#
|
445
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
446
|
+
#
|
447
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
448
|
+
|
449
|
+
# The property of the price to filter on.
|
450
|
+
#
|
451
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter#field
|
452
|
+
module Field
|
453
|
+
extend Orb::Internal::Type::Enum
|
454
|
+
|
455
|
+
PRICE_ID = :price_id
|
456
|
+
ITEM_ID = :item_id
|
457
|
+
PRICE_TYPE = :price_type
|
458
|
+
CURRENCY = :currency
|
459
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
460
|
+
|
461
|
+
# @!method self.values
|
462
|
+
# @return [Array<Symbol>]
|
463
|
+
end
|
464
|
+
|
465
|
+
# Should prices that match the filter be included or excluded.
|
466
|
+
#
|
467
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter#operator
|
468
|
+
module Operator
|
469
|
+
extend Orb::Internal::Type::Enum
|
470
|
+
|
471
|
+
INCLUDES = :includes
|
472
|
+
EXCLUDES = :excludes
|
473
|
+
|
474
|
+
# @!method self.values
|
475
|
+
# @return [Array<Symbol>]
|
476
|
+
end
|
477
|
+
end
|
395
478
|
end
|
396
479
|
|
397
480
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
@@ -413,11 +496,24 @@ module Orb
|
|
413
496
|
required :amount_discount, String
|
414
497
|
|
415
498
|
# @!attribute applies_to_price_ids
|
499
|
+
# @deprecated
|
500
|
+
#
|
416
501
|
# The price IDs that this adjustment applies to.
|
417
502
|
#
|
418
503
|
# @return [Array<String>]
|
419
504
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
420
505
|
|
506
|
+
# @!attribute filters
|
507
|
+
# The filters that determine which prices to apply this adjustment to.
|
508
|
+
#
|
509
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter>]
|
510
|
+
required :filters,
|
511
|
+
-> do
|
512
|
+
Orb::Internal::Type::ArrayOf[
|
513
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter
|
514
|
+
]
|
515
|
+
end
|
516
|
+
|
421
517
|
# @!attribute is_invoice_level
|
422
518
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
423
519
|
# that apply to only one price.
|
@@ -437,7 +533,7 @@ module Orb
|
|
437
533
|
# @return [String, nil]
|
438
534
|
required :reason, String, nil?: true
|
439
535
|
|
440
|
-
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
536
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
441
537
|
# Some parameter documentations has been truncated, see
|
442
538
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
443
539
|
# for more details.
|
@@ -448,6 +544,8 @@ module Orb
|
|
448
544
|
#
|
449
545
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
450
546
|
#
|
547
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
548
|
+
#
|
451
549
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
452
550
|
#
|
453
551
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
@@ -455,6 +553,64 @@ module Orb
|
|
455
553
|
# @param reason [String, nil] The reason for the adjustment.
|
456
554
|
#
|
457
555
|
# @param adjustment_type [Symbol, :amount_discount]
|
556
|
+
|
557
|
+
class Filter < Orb::Internal::Type::BaseModel
|
558
|
+
# @!attribute field
|
559
|
+
# The property of the price to filter on.
|
560
|
+
#
|
561
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field]
|
562
|
+
required :field,
|
563
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field }
|
564
|
+
|
565
|
+
# @!attribute operator
|
566
|
+
# Should prices that match the filter be included or excluded.
|
567
|
+
#
|
568
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator]
|
569
|
+
required :operator,
|
570
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator }
|
571
|
+
|
572
|
+
# @!attribute values
|
573
|
+
# The IDs or values that match this filter.
|
574
|
+
#
|
575
|
+
# @return [Array<String>]
|
576
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
577
|
+
|
578
|
+
# @!method initialize(field:, operator:, values:)
|
579
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
|
580
|
+
#
|
581
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
582
|
+
#
|
583
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
584
|
+
|
585
|
+
# The property of the price to filter on.
|
586
|
+
#
|
587
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter#field
|
588
|
+
module Field
|
589
|
+
extend Orb::Internal::Type::Enum
|
590
|
+
|
591
|
+
PRICE_ID = :price_id
|
592
|
+
ITEM_ID = :item_id
|
593
|
+
PRICE_TYPE = :price_type
|
594
|
+
CURRENCY = :currency
|
595
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
596
|
+
|
597
|
+
# @!method self.values
|
598
|
+
# @return [Array<Symbol>]
|
599
|
+
end
|
600
|
+
|
601
|
+
# Should prices that match the filter be included or excluded.
|
602
|
+
#
|
603
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter#operator
|
604
|
+
module Operator
|
605
|
+
extend Orb::Internal::Type::Enum
|
606
|
+
|
607
|
+
INCLUDES = :includes
|
608
|
+
EXCLUDES = :excludes
|
609
|
+
|
610
|
+
# @!method self.values
|
611
|
+
# @return [Array<Symbol>]
|
612
|
+
end
|
613
|
+
end
|
458
614
|
end
|
459
615
|
|
460
616
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
@@ -469,11 +625,24 @@ module Orb
|
|
469
625
|
required :adjustment_type, const: :percentage_discount
|
470
626
|
|
471
627
|
# @!attribute applies_to_price_ids
|
628
|
+
# @deprecated
|
629
|
+
#
|
472
630
|
# The price IDs that this adjustment applies to.
|
473
631
|
#
|
474
632
|
# @return [Array<String>]
|
475
633
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
476
634
|
|
635
|
+
# @!attribute filters
|
636
|
+
# The filters that determine which prices to apply this adjustment to.
|
637
|
+
#
|
638
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>]
|
639
|
+
required :filters,
|
640
|
+
-> do
|
641
|
+
Orb::Internal::Type::ArrayOf[
|
642
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter
|
643
|
+
]
|
644
|
+
end
|
645
|
+
|
477
646
|
# @!attribute is_invoice_level
|
478
647
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
479
648
|
# that apply to only one price.
|
@@ -500,7 +669,7 @@ module Orb
|
|
500
669
|
# @return [String, nil]
|
501
670
|
required :reason, String, nil?: true
|
502
671
|
|
503
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
672
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
504
673
|
# Some parameter documentations has been truncated, see
|
505
674
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
506
675
|
# for more details.
|
@@ -509,6 +678,8 @@ module Orb
|
|
509
678
|
#
|
510
679
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
511
680
|
#
|
681
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
682
|
+
#
|
512
683
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
513
684
|
#
|
514
685
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
@@ -518,6 +689,64 @@ module Orb
|
|
518
689
|
# @param reason [String, nil] The reason for the adjustment.
|
519
690
|
#
|
520
691
|
# @param adjustment_type [Symbol, :percentage_discount]
|
692
|
+
|
693
|
+
class Filter < Orb::Internal::Type::BaseModel
|
694
|
+
# @!attribute field
|
695
|
+
# The property of the price to filter on.
|
696
|
+
#
|
697
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field]
|
698
|
+
required :field,
|
699
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field }
|
700
|
+
|
701
|
+
# @!attribute operator
|
702
|
+
# Should prices that match the filter be included or excluded.
|
703
|
+
#
|
704
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator]
|
705
|
+
required :operator,
|
706
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator }
|
707
|
+
|
708
|
+
# @!attribute values
|
709
|
+
# The IDs or values that match this filter.
|
710
|
+
#
|
711
|
+
# @return [Array<String>]
|
712
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
713
|
+
|
714
|
+
# @!method initialize(field:, operator:, values:)
|
715
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
|
716
|
+
#
|
717
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
718
|
+
#
|
719
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
720
|
+
|
721
|
+
# The property of the price to filter on.
|
722
|
+
#
|
723
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#field
|
724
|
+
module Field
|
725
|
+
extend Orb::Internal::Type::Enum
|
726
|
+
|
727
|
+
PRICE_ID = :price_id
|
728
|
+
ITEM_ID = :item_id
|
729
|
+
PRICE_TYPE = :price_type
|
730
|
+
CURRENCY = :currency
|
731
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
732
|
+
|
733
|
+
# @!method self.values
|
734
|
+
# @return [Array<Symbol>]
|
735
|
+
end
|
736
|
+
|
737
|
+
# Should prices that match the filter be included or excluded.
|
738
|
+
#
|
739
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#operator
|
740
|
+
module Operator
|
741
|
+
extend Orb::Internal::Type::Enum
|
742
|
+
|
743
|
+
INCLUDES = :includes
|
744
|
+
EXCLUDES = :excludes
|
745
|
+
|
746
|
+
# @!method self.values
|
747
|
+
# @return [Array<Symbol>]
|
748
|
+
end
|
749
|
+
end
|
521
750
|
end
|
522
751
|
|
523
752
|
class Minimum < Orb::Internal::Type::BaseModel
|
@@ -532,11 +761,20 @@ module Orb
|
|
532
761
|
required :adjustment_type, const: :minimum
|
533
762
|
|
534
763
|
# @!attribute applies_to_price_ids
|
764
|
+
# @deprecated
|
765
|
+
#
|
535
766
|
# The price IDs that this adjustment applies to.
|
536
767
|
#
|
537
768
|
# @return [Array<String>]
|
538
769
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
539
770
|
|
771
|
+
# @!attribute filters
|
772
|
+
# The filters that determine which prices to apply this adjustment to.
|
773
|
+
#
|
774
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter>]
|
775
|
+
required :filters,
|
776
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter] }
|
777
|
+
|
540
778
|
# @!attribute is_invoice_level
|
541
779
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
542
780
|
# that apply to only one price.
|
@@ -569,7 +807,7 @@ module Orb
|
|
569
807
|
# @return [String, nil]
|
570
808
|
required :reason, String, nil?: true
|
571
809
|
|
572
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
810
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
573
811
|
# Some parameter documentations has been truncated, see
|
574
812
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum}
|
575
813
|
# for more details.
|
@@ -578,6 +816,8 @@ module Orb
|
|
578
816
|
#
|
579
817
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
580
818
|
#
|
819
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
|
820
|
+
#
|
581
821
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
582
822
|
#
|
583
823
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
@@ -589,6 +829,64 @@ module Orb
|
|
589
829
|
# @param reason [String, nil] The reason for the adjustment.
|
590
830
|
#
|
591
831
|
# @param adjustment_type [Symbol, :minimum]
|
832
|
+
|
833
|
+
class Filter < Orb::Internal::Type::BaseModel
|
834
|
+
# @!attribute field
|
835
|
+
# The property of the price to filter on.
|
836
|
+
#
|
837
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field]
|
838
|
+
required :field,
|
839
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field }
|
840
|
+
|
841
|
+
# @!attribute operator
|
842
|
+
# Should prices that match the filter be included or excluded.
|
843
|
+
#
|
844
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator]
|
845
|
+
required :operator,
|
846
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator }
|
847
|
+
|
848
|
+
# @!attribute values
|
849
|
+
# The IDs or values that match this filter.
|
850
|
+
#
|
851
|
+
# @return [Array<String>]
|
852
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
853
|
+
|
854
|
+
# @!method initialize(field:, operator:, values:)
|
855
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
|
856
|
+
#
|
857
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
858
|
+
#
|
859
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
860
|
+
|
861
|
+
# The property of the price to filter on.
|
862
|
+
#
|
863
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter#field
|
864
|
+
module Field
|
865
|
+
extend Orb::Internal::Type::Enum
|
866
|
+
|
867
|
+
PRICE_ID = :price_id
|
868
|
+
ITEM_ID = :item_id
|
869
|
+
PRICE_TYPE = :price_type
|
870
|
+
CURRENCY = :currency
|
871
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
872
|
+
|
873
|
+
# @!method self.values
|
874
|
+
# @return [Array<Symbol>]
|
875
|
+
end
|
876
|
+
|
877
|
+
# Should prices that match the filter be included or excluded.
|
878
|
+
#
|
879
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter#operator
|
880
|
+
module Operator
|
881
|
+
extend Orb::Internal::Type::Enum
|
882
|
+
|
883
|
+
INCLUDES = :includes
|
884
|
+
EXCLUDES = :excludes
|
885
|
+
|
886
|
+
# @!method self.values
|
887
|
+
# @return [Array<Symbol>]
|
888
|
+
end
|
889
|
+
end
|
592
890
|
end
|
593
891
|
|
594
892
|
class Maximum < Orb::Internal::Type::BaseModel
|
@@ -603,11 +901,20 @@ module Orb
|
|
603
901
|
required :adjustment_type, const: :maximum
|
604
902
|
|
605
903
|
# @!attribute applies_to_price_ids
|
904
|
+
# @deprecated
|
905
|
+
#
|
606
906
|
# The price IDs that this adjustment applies to.
|
607
907
|
#
|
608
908
|
# @return [Array<String>]
|
609
909
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
610
910
|
|
911
|
+
# @!attribute filters
|
912
|
+
# The filters that determine which prices to apply this adjustment to.
|
913
|
+
#
|
914
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter>]
|
915
|
+
required :filters,
|
916
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter] }
|
917
|
+
|
611
918
|
# @!attribute is_invoice_level
|
612
919
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
613
920
|
# that apply to only one price.
|
@@ -634,7 +941,7 @@ module Orb
|
|
634
941
|
# @return [String, nil]
|
635
942
|
required :reason, String, nil?: true
|
636
943
|
|
637
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
944
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
638
945
|
# Some parameter documentations has been truncated, see
|
639
946
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum}
|
640
947
|
# for more details.
|
@@ -643,6 +950,8 @@ module Orb
|
|
643
950
|
#
|
644
951
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
645
952
|
#
|
953
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
|
954
|
+
#
|
646
955
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
647
956
|
#
|
648
957
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
@@ -652,6 +961,64 @@ module Orb
|
|
652
961
|
# @param reason [String, nil] The reason for the adjustment.
|
653
962
|
#
|
654
963
|
# @param adjustment_type [Symbol, :maximum]
|
964
|
+
|
965
|
+
class Filter < Orb::Internal::Type::BaseModel
|
966
|
+
# @!attribute field
|
967
|
+
# The property of the price to filter on.
|
968
|
+
#
|
969
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field]
|
970
|
+
required :field,
|
971
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field }
|
972
|
+
|
973
|
+
# @!attribute operator
|
974
|
+
# Should prices that match the filter be included or excluded.
|
975
|
+
#
|
976
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator]
|
977
|
+
required :operator,
|
978
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator }
|
979
|
+
|
980
|
+
# @!attribute values
|
981
|
+
# The IDs or values that match this filter.
|
982
|
+
#
|
983
|
+
# @return [Array<String>]
|
984
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
985
|
+
|
986
|
+
# @!method initialize(field:, operator:, values:)
|
987
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
|
988
|
+
#
|
989
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
990
|
+
#
|
991
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
992
|
+
|
993
|
+
# The property of the price to filter on.
|
994
|
+
#
|
995
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter#field
|
996
|
+
module Field
|
997
|
+
extend Orb::Internal::Type::Enum
|
998
|
+
|
999
|
+
PRICE_ID = :price_id
|
1000
|
+
ITEM_ID = :item_id
|
1001
|
+
PRICE_TYPE = :price_type
|
1002
|
+
CURRENCY = :currency
|
1003
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1004
|
+
|
1005
|
+
# @!method self.values
|
1006
|
+
# @return [Array<Symbol>]
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# Should prices that match the filter be included or excluded.
|
1010
|
+
#
|
1011
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter#operator
|
1012
|
+
module Operator
|
1013
|
+
extend Orb::Internal::Type::Enum
|
1014
|
+
|
1015
|
+
INCLUDES = :includes
|
1016
|
+
EXCLUDES = :excludes
|
1017
|
+
|
1018
|
+
# @!method self.values
|
1019
|
+
# @return [Array<Symbol>]
|
1020
|
+
end
|
1021
|
+
end
|
655
1022
|
end
|
656
1023
|
|
657
1024
|
# @!method self.variants
|
@@ -716,12 +1083,6 @@ module Orb
|
|
716
1083
|
# @return [String]
|
717
1084
|
required :amount_discount, String
|
718
1085
|
|
719
|
-
# @!attribute applies_to_price_ids
|
720
|
-
# The price ids that this discount interval applies to.
|
721
|
-
#
|
722
|
-
# @return [Array<String>]
|
723
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
724
|
-
|
725
1086
|
# @!attribute applies_to_price_interval_ids
|
726
1087
|
# The price interval ids that this discount interval applies to.
|
727
1088
|
#
|
@@ -739,33 +1100,92 @@ module Orb
|
|
739
1100
|
# @return [Time, nil]
|
740
1101
|
required :end_date, Time, nil?: true
|
741
1102
|
|
1103
|
+
# @!attribute filters
|
1104
|
+
# The filters that determine which prices this discount interval applies to.
|
1105
|
+
#
|
1106
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter>]
|
1107
|
+
required :filters,
|
1108
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter] }
|
1109
|
+
|
742
1110
|
# @!attribute start_date
|
743
1111
|
# The start date of the discount interval.
|
744
1112
|
#
|
745
1113
|
# @return [Time]
|
746
1114
|
required :start_date, Time
|
747
1115
|
|
748
|
-
# @!method initialize(amount_discount:,
|
1116
|
+
# @!method initialize(amount_discount:, applies_to_price_interval_ids:, end_date:, filters:, start_date:, discount_type: :amount)
|
749
1117
|
# @param amount_discount [String] Only available if discount_type is `amount`.
|
750
1118
|
#
|
751
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
752
|
-
#
|
753
1119
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
754
1120
|
#
|
755
1121
|
# @param end_date [Time, nil] The end date of the discount interval.
|
756
1122
|
#
|
1123
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter>] The filters that determine which prices this discount interval applies to.
|
1124
|
+
#
|
757
1125
|
# @param start_date [Time] The start date of the discount interval.
|
758
1126
|
#
|
759
1127
|
# @param discount_type [Symbol, :amount]
|
1128
|
+
|
1129
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1130
|
+
# @!attribute field
|
1131
|
+
# The property of the price to filter on.
|
1132
|
+
#
|
1133
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field]
|
1134
|
+
required :field,
|
1135
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field }
|
1136
|
+
|
1137
|
+
# @!attribute operator
|
1138
|
+
# Should prices that match the filter be included or excluded.
|
1139
|
+
#
|
1140
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator]
|
1141
|
+
required :operator,
|
1142
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator }
|
1143
|
+
|
1144
|
+
# @!attribute values
|
1145
|
+
# The IDs or values that match this filter.
|
1146
|
+
#
|
1147
|
+
# @return [Array<String>]
|
1148
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1149
|
+
|
1150
|
+
# @!method initialize(field:, operator:, values:)
|
1151
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field] The property of the price to filter on.
|
1152
|
+
#
|
1153
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator] Should prices that match the filter be included or excluded.
|
1154
|
+
#
|
1155
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1156
|
+
|
1157
|
+
# The property of the price to filter on.
|
1158
|
+
#
|
1159
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter#field
|
1160
|
+
module Field
|
1161
|
+
extend Orb::Internal::Type::Enum
|
1162
|
+
|
1163
|
+
PRICE_ID = :price_id
|
1164
|
+
ITEM_ID = :item_id
|
1165
|
+
PRICE_TYPE = :price_type
|
1166
|
+
CURRENCY = :currency
|
1167
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1168
|
+
|
1169
|
+
# @!method self.values
|
1170
|
+
# @return [Array<Symbol>]
|
1171
|
+
end
|
1172
|
+
|
1173
|
+
# Should prices that match the filter be included or excluded.
|
1174
|
+
#
|
1175
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter#operator
|
1176
|
+
module Operator
|
1177
|
+
extend Orb::Internal::Type::Enum
|
1178
|
+
|
1179
|
+
INCLUDES = :includes
|
1180
|
+
EXCLUDES = :excludes
|
1181
|
+
|
1182
|
+
# @!method self.values
|
1183
|
+
# @return [Array<Symbol>]
|
1184
|
+
end
|
1185
|
+
end
|
760
1186
|
end
|
761
1187
|
|
762
1188
|
class Percentage < Orb::Internal::Type::BaseModel
|
763
|
-
# @!attribute applies_to_price_ids
|
764
|
-
# The price ids that this discount interval applies to.
|
765
|
-
#
|
766
|
-
# @return [Array<String>]
|
767
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
768
|
-
|
769
1189
|
# @!attribute applies_to_price_interval_ids
|
770
1190
|
# The price interval ids that this discount interval applies to.
|
771
1191
|
#
|
@@ -783,6 +1203,13 @@ module Orb
|
|
783
1203
|
# @return [Time, nil]
|
784
1204
|
required :end_date, Time, nil?: true
|
785
1205
|
|
1206
|
+
# @!attribute filters
|
1207
|
+
# The filters that determine which prices this discount interval applies to.
|
1208
|
+
#
|
1209
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter>]
|
1210
|
+
required :filters,
|
1211
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter] }
|
1212
|
+
|
786
1213
|
# @!attribute percentage_discount
|
787
1214
|
# Only available if discount_type is `percentage`.This is a number between 0
|
788
1215
|
# and 1.
|
@@ -796,31 +1223,83 @@ module Orb
|
|
796
1223
|
# @return [Time]
|
797
1224
|
required :start_date, Time
|
798
1225
|
|
799
|
-
# @!method initialize(
|
1226
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, percentage_discount:, start_date:, discount_type: :percentage)
|
800
1227
|
# Some parameter documentations has been truncated, see
|
801
1228
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage}
|
802
1229
|
# for more details.
|
803
1230
|
#
|
804
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
805
|
-
#
|
806
1231
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
807
1232
|
#
|
808
1233
|
# @param end_date [Time, nil] The end date of the discount interval.
|
809
1234
|
#
|
1235
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter>] The filters that determine which prices this discount interval applies to.
|
1236
|
+
#
|
810
1237
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
811
1238
|
#
|
812
1239
|
# @param start_date [Time] The start date of the discount interval.
|
813
1240
|
#
|
814
1241
|
# @param discount_type [Symbol, :percentage]
|
1242
|
+
|
1243
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1244
|
+
# @!attribute field
|
1245
|
+
# The property of the price to filter on.
|
1246
|
+
#
|
1247
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field]
|
1248
|
+
required :field,
|
1249
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field }
|
1250
|
+
|
1251
|
+
# @!attribute operator
|
1252
|
+
# Should prices that match the filter be included or excluded.
|
1253
|
+
#
|
1254
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator]
|
1255
|
+
required :operator,
|
1256
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator }
|
1257
|
+
|
1258
|
+
# @!attribute values
|
1259
|
+
# The IDs or values that match this filter.
|
1260
|
+
#
|
1261
|
+
# @return [Array<String>]
|
1262
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1263
|
+
|
1264
|
+
# @!method initialize(field:, operator:, values:)
|
1265
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field] The property of the price to filter on.
|
1266
|
+
#
|
1267
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator] Should prices that match the filter be included or excluded.
|
1268
|
+
#
|
1269
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1270
|
+
|
1271
|
+
# The property of the price to filter on.
|
1272
|
+
#
|
1273
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter#field
|
1274
|
+
module Field
|
1275
|
+
extend Orb::Internal::Type::Enum
|
1276
|
+
|
1277
|
+
PRICE_ID = :price_id
|
1278
|
+
ITEM_ID = :item_id
|
1279
|
+
PRICE_TYPE = :price_type
|
1280
|
+
CURRENCY = :currency
|
1281
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1282
|
+
|
1283
|
+
# @!method self.values
|
1284
|
+
# @return [Array<Symbol>]
|
1285
|
+
end
|
1286
|
+
|
1287
|
+
# Should prices that match the filter be included or excluded.
|
1288
|
+
#
|
1289
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter#operator
|
1290
|
+
module Operator
|
1291
|
+
extend Orb::Internal::Type::Enum
|
1292
|
+
|
1293
|
+
INCLUDES = :includes
|
1294
|
+
EXCLUDES = :excludes
|
1295
|
+
|
1296
|
+
# @!method self.values
|
1297
|
+
# @return [Array<Symbol>]
|
1298
|
+
end
|
1299
|
+
end
|
815
1300
|
end
|
816
1301
|
|
817
1302
|
class Usage < Orb::Internal::Type::BaseModel
|
818
|
-
# @!attribute applies_to_price_ids
|
819
|
-
# The price ids that this discount interval applies to.
|
820
|
-
#
|
821
|
-
# @return [Array<String>]
|
822
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
823
|
-
|
824
1303
|
# @!attribute applies_to_price_interval_ids
|
825
1304
|
# The price interval ids that this discount interval applies to.
|
826
1305
|
#
|
@@ -838,6 +1317,13 @@ module Orb
|
|
838
1317
|
# @return [Time, nil]
|
839
1318
|
required :end_date, Time, nil?: true
|
840
1319
|
|
1320
|
+
# @!attribute filters
|
1321
|
+
# The filters that determine which prices this discount interval applies to.
|
1322
|
+
#
|
1323
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter>]
|
1324
|
+
required :filters,
|
1325
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter] }
|
1326
|
+
|
841
1327
|
# @!attribute start_date
|
842
1328
|
# The start date of the discount interval.
|
843
1329
|
#
|
@@ -851,22 +1337,80 @@ module Orb
|
|
851
1337
|
# @return [Float]
|
852
1338
|
required :usage_discount, Float
|
853
1339
|
|
854
|
-
# @!method initialize(
|
1340
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, start_date:, usage_discount:, discount_type: :usage)
|
855
1341
|
# Some parameter documentations has been truncated, see
|
856
1342
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage}
|
857
1343
|
# for more details.
|
858
1344
|
#
|
859
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
860
|
-
#
|
861
1345
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
862
1346
|
#
|
863
1347
|
# @param end_date [Time, nil] The end date of the discount interval.
|
864
1348
|
#
|
1349
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter>] The filters that determine which prices this discount interval applies to.
|
1350
|
+
#
|
865
1351
|
# @param start_date [Time] The start date of the discount interval.
|
866
1352
|
#
|
867
1353
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
868
1354
|
#
|
869
1355
|
# @param discount_type [Symbol, :usage]
|
1356
|
+
|
1357
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1358
|
+
# @!attribute field
|
1359
|
+
# The property of the price to filter on.
|
1360
|
+
#
|
1361
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field]
|
1362
|
+
required :field,
|
1363
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field }
|
1364
|
+
|
1365
|
+
# @!attribute operator
|
1366
|
+
# Should prices that match the filter be included or excluded.
|
1367
|
+
#
|
1368
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator]
|
1369
|
+
required :operator,
|
1370
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator }
|
1371
|
+
|
1372
|
+
# @!attribute values
|
1373
|
+
# The IDs or values that match this filter.
|
1374
|
+
#
|
1375
|
+
# @return [Array<String>]
|
1376
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1377
|
+
|
1378
|
+
# @!method initialize(field:, operator:, values:)
|
1379
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field] The property of the price to filter on.
|
1380
|
+
#
|
1381
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator] Should prices that match the filter be included or excluded.
|
1382
|
+
#
|
1383
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1384
|
+
|
1385
|
+
# The property of the price to filter on.
|
1386
|
+
#
|
1387
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter#field
|
1388
|
+
module Field
|
1389
|
+
extend Orb::Internal::Type::Enum
|
1390
|
+
|
1391
|
+
PRICE_ID = :price_id
|
1392
|
+
ITEM_ID = :item_id
|
1393
|
+
PRICE_TYPE = :price_type
|
1394
|
+
CURRENCY = :currency
|
1395
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1396
|
+
|
1397
|
+
# @!method self.values
|
1398
|
+
# @return [Array<Symbol>]
|
1399
|
+
end
|
1400
|
+
|
1401
|
+
# Should prices that match the filter be included or excluded.
|
1402
|
+
#
|
1403
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter#operator
|
1404
|
+
module Operator
|
1405
|
+
extend Orb::Internal::Type::Enum
|
1406
|
+
|
1407
|
+
INCLUDES = :includes
|
1408
|
+
EXCLUDES = :excludes
|
1409
|
+
|
1410
|
+
# @!method self.values
|
1411
|
+
# @return [Array<Symbol>]
|
1412
|
+
end
|
1413
|
+
end
|
870
1414
|
end
|
871
1415
|
|
872
1416
|
# @!method self.variants
|
@@ -902,12 +1446,6 @@ module Orb
|
|
902
1446
|
end
|
903
1447
|
|
904
1448
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
905
|
-
# @!attribute applies_to_price_ids
|
906
|
-
# The price ids that this maximum interval applies to.
|
907
|
-
#
|
908
|
-
# @return [Array<String>]
|
909
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
910
|
-
|
911
1449
|
# @!attribute applies_to_price_interval_ids
|
912
1450
|
# The price interval ids that this maximum interval applies to.
|
913
1451
|
#
|
@@ -920,6 +1458,13 @@ module Orb
|
|
920
1458
|
# @return [Time, nil]
|
921
1459
|
required :end_date, Time, nil?: true
|
922
1460
|
|
1461
|
+
# @!attribute filters
|
1462
|
+
# The filters that determine which prices this maximum interval applies to.
|
1463
|
+
#
|
1464
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter>]
|
1465
|
+
required :filters,
|
1466
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter] }
|
1467
|
+
|
923
1468
|
# @!attribute maximum_amount
|
924
1469
|
# The maximum amount to charge in a given billing period for the price intervals
|
925
1470
|
# this transform applies to.
|
@@ -933,29 +1478,81 @@ module Orb
|
|
933
1478
|
# @return [Time]
|
934
1479
|
required :start_date, Time
|
935
1480
|
|
936
|
-
# @!method initialize(
|
1481
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, maximum_amount:, start_date:)
|
937
1482
|
# Some parameter documentations has been truncated, see
|
938
1483
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval} for more
|
939
1484
|
# details.
|
940
1485
|
#
|
941
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
942
|
-
#
|
943
1486
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
944
1487
|
#
|
945
1488
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
946
1489
|
#
|
1490
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter>] The filters that determine which prices this maximum interval applies to.
|
1491
|
+
#
|
947
1492
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
948
1493
|
#
|
949
1494
|
# @param start_date [Time] The start date of the maximum interval.
|
1495
|
+
|
1496
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1497
|
+
# @!attribute field
|
1498
|
+
# The property of the price to filter on.
|
1499
|
+
#
|
1500
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field]
|
1501
|
+
required :field,
|
1502
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field }
|
1503
|
+
|
1504
|
+
# @!attribute operator
|
1505
|
+
# Should prices that match the filter be included or excluded.
|
1506
|
+
#
|
1507
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator]
|
1508
|
+
required :operator,
|
1509
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator }
|
1510
|
+
|
1511
|
+
# @!attribute values
|
1512
|
+
# The IDs or values that match this filter.
|
1513
|
+
#
|
1514
|
+
# @return [Array<String>]
|
1515
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1516
|
+
|
1517
|
+
# @!method initialize(field:, operator:, values:)
|
1518
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field] The property of the price to filter on.
|
1519
|
+
#
|
1520
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
|
1521
|
+
#
|
1522
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1523
|
+
|
1524
|
+
# The property of the price to filter on.
|
1525
|
+
#
|
1526
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter#field
|
1527
|
+
module Field
|
1528
|
+
extend Orb::Internal::Type::Enum
|
1529
|
+
|
1530
|
+
PRICE_ID = :price_id
|
1531
|
+
ITEM_ID = :item_id
|
1532
|
+
PRICE_TYPE = :price_type
|
1533
|
+
CURRENCY = :currency
|
1534
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1535
|
+
|
1536
|
+
# @!method self.values
|
1537
|
+
# @return [Array<Symbol>]
|
1538
|
+
end
|
1539
|
+
|
1540
|
+
# Should prices that match the filter be included or excluded.
|
1541
|
+
#
|
1542
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter#operator
|
1543
|
+
module Operator
|
1544
|
+
extend Orb::Internal::Type::Enum
|
1545
|
+
|
1546
|
+
INCLUDES = :includes
|
1547
|
+
EXCLUDES = :excludes
|
1548
|
+
|
1549
|
+
# @!method self.values
|
1550
|
+
# @return [Array<Symbol>]
|
1551
|
+
end
|
1552
|
+
end
|
950
1553
|
end
|
951
1554
|
|
952
1555
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
953
|
-
# @!attribute applies_to_price_ids
|
954
|
-
# The price ids that this minimum interval applies to.
|
955
|
-
#
|
956
|
-
# @return [Array<String>]
|
957
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
958
|
-
|
959
1556
|
# @!attribute applies_to_price_interval_ids
|
960
1557
|
# The price interval ids that this minimum interval applies to.
|
961
1558
|
#
|
@@ -968,6 +1565,13 @@ module Orb
|
|
968
1565
|
# @return [Time, nil]
|
969
1566
|
required :end_date, Time, nil?: true
|
970
1567
|
|
1568
|
+
# @!attribute filters
|
1569
|
+
# The filters that determine which prices this minimum interval applies to.
|
1570
|
+
#
|
1571
|
+
# @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter>]
|
1572
|
+
required :filters,
|
1573
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter] }
|
1574
|
+
|
971
1575
|
# @!attribute minimum_amount
|
972
1576
|
# The minimum amount to charge in a given billing period for the price intervals
|
973
1577
|
# this minimum applies to.
|
@@ -981,20 +1585,78 @@ module Orb
|
|
981
1585
|
# @return [Time]
|
982
1586
|
required :start_date, Time
|
983
1587
|
|
984
|
-
# @!method initialize(
|
1588
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, minimum_amount:, start_date:)
|
985
1589
|
# Some parameter documentations has been truncated, see
|
986
1590
|
# {Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval} for more
|
987
1591
|
# details.
|
988
1592
|
#
|
989
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
990
|
-
#
|
991
1593
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
992
1594
|
#
|
993
1595
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
994
1596
|
#
|
1597
|
+
# @param filters [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter>] The filters that determine which prices this minimum interval applies to.
|
1598
|
+
#
|
995
1599
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
996
1600
|
#
|
997
1601
|
# @param start_date [Time] The start date of the minimum interval.
|
1602
|
+
|
1603
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1604
|
+
# @!attribute field
|
1605
|
+
# The property of the price to filter on.
|
1606
|
+
#
|
1607
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field]
|
1608
|
+
required :field,
|
1609
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field }
|
1610
|
+
|
1611
|
+
# @!attribute operator
|
1612
|
+
# Should prices that match the filter be included or excluded.
|
1613
|
+
#
|
1614
|
+
# @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator]
|
1615
|
+
required :operator,
|
1616
|
+
enum: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator }
|
1617
|
+
|
1618
|
+
# @!attribute values
|
1619
|
+
# The IDs or values that match this filter.
|
1620
|
+
#
|
1621
|
+
# @return [Array<String>]
|
1622
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1623
|
+
|
1624
|
+
# @!method initialize(field:, operator:, values:)
|
1625
|
+
# @param field [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field] The property of the price to filter on.
|
1626
|
+
#
|
1627
|
+
# @param operator [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
|
1628
|
+
#
|
1629
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1630
|
+
|
1631
|
+
# The property of the price to filter on.
|
1632
|
+
#
|
1633
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter#field
|
1634
|
+
module Field
|
1635
|
+
extend Orb::Internal::Type::Enum
|
1636
|
+
|
1637
|
+
PRICE_ID = :price_id
|
1638
|
+
ITEM_ID = :item_id
|
1639
|
+
PRICE_TYPE = :price_type
|
1640
|
+
CURRENCY = :currency
|
1641
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1642
|
+
|
1643
|
+
# @!method self.values
|
1644
|
+
# @return [Array<Symbol>]
|
1645
|
+
end
|
1646
|
+
|
1647
|
+
# Should prices that match the filter be included or excluded.
|
1648
|
+
#
|
1649
|
+
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter#operator
|
1650
|
+
module Operator
|
1651
|
+
extend Orb::Internal::Type::Enum
|
1652
|
+
|
1653
|
+
INCLUDES = :includes
|
1654
|
+
EXCLUDES = :excludes
|
1655
|
+
|
1656
|
+
# @!method self.values
|
1657
|
+
# @return [Array<Symbol>]
|
1658
|
+
end
|
1659
|
+
end
|
998
1660
|
end
|
999
1661
|
|
1000
1662
|
# @see Orb::Models::SubscriptionSchedulePlanChangeResponse#pending_subscription_change
|