orb-billing 0.5.5 → 0.7.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 +26 -0
- data/README.md +1 -1
- data/lib/orb/client.rb +4 -0
- 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/beta/external_plan_id_create_plan_version_params.rb +17940 -0
- data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +22 -0
- data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +24 -0
- data/lib/orb/models/beta_create_plan_version_params.rb +17758 -0
- data/lib/orb/models/beta_fetch_plan_version_params.rb +20 -0
- data/lib/orb/models/beta_set_default_plan_version_params.rb +22 -0
- 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_version.rb +735 -0
- data/lib/orb/models/plan_version_phase.rb +70 -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_multiple_params.rb +8620 -0
- data/lib/orb/models/price_evaluate_multiple_response.rb +51 -0
- 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 +16 -0
- data/lib/orb/resources/beta/external_plan_id.rb +113 -0
- data/lib/orb/resources/beta.rb +115 -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.rb +1 -1
- data/lib/orb/resources/plans.rb +2 -2
- data/lib/orb/resources/prices.rb +69 -2
- data/lib/orb/resources/subscriptions.rb +5 -1
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +13 -0
- data/rbi/orb/client.rbi +3 -0
- data/rbi/orb/models/alert.rbi +50 -3
- data/rbi/orb/models/amount_discount.rbi +8 -8
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +32652 -0
- data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +40 -0
- data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +45 -0
- data/rbi/orb/models/beta_create_plan_version_params.rbi +32595 -0
- data/rbi/orb/models/beta_fetch_plan_version_params.rbi +35 -0
- data/rbi/orb/models/beta_set_default_plan_version_params.rbi +40 -0
- 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_version.rbi +1367 -0
- data/rbi/orb/models/plan_version_phase.rbi +99 -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_multiple_params.rbi +15764 -0
- data/rbi/orb/models/price_evaluate_multiple_response.rbi +96 -0
- 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 +16 -0
- data/rbi/orb/resources/beta/external_plan_id.rbi +118 -0
- data/rbi/orb/resources/beta.rbi +111 -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.rbi +1 -1
- data/rbi/orb/resources/plans.rbi +5 -2
- data/rbi/orb/resources/prices.rbi +73 -1
- data/rbi/orb/resources/subscriptions.rbi +9 -1
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/models/alert.rbs +20 -3
- data/sig/orb/models/amount_discount.rbs +5 -5
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +12898 -0
- data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +25 -0
- data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +25 -0
- data/sig/orb/models/beta_create_plan_version_params.rbs +12877 -0
- data/sig/orb/models/beta_fetch_plan_version_params.rbs +20 -0
- data/sig/orb/models/beta_set_default_plan_version_params.rbs +20 -0
- 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_version.rbs +583 -0
- data/sig/orb/models/plan_version_phase.rbs +60 -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_multiple_params.rbs +6230 -0
- data/sig/orb/models/price_evaluate_multiple_response.rbs +50 -0
- 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 +16 -0
- data/sig/orb/resources/beta/external_plan_id.rbs +34 -0
- data/sig/orb/resources/beta.rbs +34 -0
- data/sig/orb/resources/credit_notes.rbs +1 -1
- data/sig/orb/resources/items.rbs +7 -0
- data/sig/orb/resources/prices.rbs +11 -0
- 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::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::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::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::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::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval>]
|
145
151
|
required :minimum_intervals,
|
146
152
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::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::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::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::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse} for more
|
217
229
|
# details.
|
@@ -252,11 +264,13 @@ module Orb
|
|
252
264
|
#
|
253
265
|
# @param minimum_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
254
266
|
#
|
267
|
+
# @param name [String] The name of the subscription.
|
268
|
+
#
|
255
269
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
256
270
|
#
|
257
271
|
# @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
258
272
|
#
|
259
|
-
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
273
|
+
# @param plan [Orb::Models::Plan, nil] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
260
274
|
#
|
261
275
|
# @param price_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval>] The price intervals for this subscription.
|
262
276
|
#
|
@@ -344,11 +358,24 @@ module Orb
|
|
344
358
|
required :adjustment_type, const: :usage_discount
|
345
359
|
|
346
360
|
# @!attribute applies_to_price_ids
|
361
|
+
# @deprecated
|
362
|
+
#
|
347
363
|
# The price IDs that this adjustment applies to.
|
348
364
|
#
|
349
365
|
# @return [Array<String>]
|
350
366
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
351
367
|
|
368
|
+
# @!attribute filters
|
369
|
+
# The filters that determine which prices to apply this adjustment to.
|
370
|
+
#
|
371
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter>]
|
372
|
+
required :filters,
|
373
|
+
-> do
|
374
|
+
Orb::Internal::Type::ArrayOf[
|
375
|
+
Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter
|
376
|
+
]
|
377
|
+
end
|
378
|
+
|
352
379
|
# @!attribute is_invoice_level
|
353
380
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
354
381
|
# that apply to only one price.
|
@@ -375,7 +402,7 @@ module Orb
|
|
375
402
|
# @return [Float]
|
376
403
|
required :usage_discount, Float
|
377
404
|
|
378
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
405
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
379
406
|
# Some parameter documentations has been truncated, see
|
380
407
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
381
408
|
# for more details.
|
@@ -384,6 +411,8 @@ module Orb
|
|
384
411
|
#
|
385
412
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
386
413
|
#
|
414
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
415
|
+
#
|
387
416
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
388
417
|
#
|
389
418
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
@@ -393,6 +422,64 @@ module Orb
|
|
393
422
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
394
423
|
#
|
395
424
|
# @param adjustment_type [Symbol, :usage_discount]
|
425
|
+
|
426
|
+
class Filter < Orb::Internal::Type::BaseModel
|
427
|
+
# @!attribute field
|
428
|
+
# The property of the price to filter on.
|
429
|
+
#
|
430
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field]
|
431
|
+
required :field,
|
432
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field }
|
433
|
+
|
434
|
+
# @!attribute operator
|
435
|
+
# Should prices that match the filter be included or excluded.
|
436
|
+
#
|
437
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator]
|
438
|
+
required :operator,
|
439
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator }
|
440
|
+
|
441
|
+
# @!attribute values
|
442
|
+
# The IDs or values that match this filter.
|
443
|
+
#
|
444
|
+
# @return [Array<String>]
|
445
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
446
|
+
|
447
|
+
# @!method initialize(field:, operator:, values:)
|
448
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
|
449
|
+
#
|
450
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
451
|
+
#
|
452
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
453
|
+
|
454
|
+
# The property of the price to filter on.
|
455
|
+
#
|
456
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter#field
|
457
|
+
module Field
|
458
|
+
extend Orb::Internal::Type::Enum
|
459
|
+
|
460
|
+
PRICE_ID = :price_id
|
461
|
+
ITEM_ID = :item_id
|
462
|
+
PRICE_TYPE = :price_type
|
463
|
+
CURRENCY = :currency
|
464
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
465
|
+
|
466
|
+
# @!method self.values
|
467
|
+
# @return [Array<Symbol>]
|
468
|
+
end
|
469
|
+
|
470
|
+
# Should prices that match the filter be included or excluded.
|
471
|
+
#
|
472
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter#operator
|
473
|
+
module Operator
|
474
|
+
extend Orb::Internal::Type::Enum
|
475
|
+
|
476
|
+
INCLUDES = :includes
|
477
|
+
EXCLUDES = :excludes
|
478
|
+
|
479
|
+
# @!method self.values
|
480
|
+
# @return [Array<Symbol>]
|
481
|
+
end
|
482
|
+
end
|
396
483
|
end
|
397
484
|
|
398
485
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
@@ -414,11 +501,24 @@ module Orb
|
|
414
501
|
required :amount_discount, String
|
415
502
|
|
416
503
|
# @!attribute applies_to_price_ids
|
504
|
+
# @deprecated
|
505
|
+
#
|
417
506
|
# The price IDs that this adjustment applies to.
|
418
507
|
#
|
419
508
|
# @return [Array<String>]
|
420
509
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
421
510
|
|
511
|
+
# @!attribute filters
|
512
|
+
# The filters that determine which prices to apply this adjustment to.
|
513
|
+
#
|
514
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter>]
|
515
|
+
required :filters,
|
516
|
+
-> do
|
517
|
+
Orb::Internal::Type::ArrayOf[
|
518
|
+
Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter
|
519
|
+
]
|
520
|
+
end
|
521
|
+
|
422
522
|
# @!attribute is_invoice_level
|
423
523
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
424
524
|
# that apply to only one price.
|
@@ -438,7 +538,7 @@ module Orb
|
|
438
538
|
# @return [String, nil]
|
439
539
|
required :reason, String, nil?: true
|
440
540
|
|
441
|
-
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
541
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
442
542
|
# Some parameter documentations has been truncated, see
|
443
543
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
444
544
|
# for more details.
|
@@ -449,6 +549,8 @@ module Orb
|
|
449
549
|
#
|
450
550
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
451
551
|
#
|
552
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
553
|
+
#
|
452
554
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
453
555
|
#
|
454
556
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
@@ -456,6 +558,64 @@ module Orb
|
|
456
558
|
# @param reason [String, nil] The reason for the adjustment.
|
457
559
|
#
|
458
560
|
# @param adjustment_type [Symbol, :amount_discount]
|
561
|
+
|
562
|
+
class Filter < Orb::Internal::Type::BaseModel
|
563
|
+
# @!attribute field
|
564
|
+
# The property of the price to filter on.
|
565
|
+
#
|
566
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field]
|
567
|
+
required :field,
|
568
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field }
|
569
|
+
|
570
|
+
# @!attribute operator
|
571
|
+
# Should prices that match the filter be included or excluded.
|
572
|
+
#
|
573
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator]
|
574
|
+
required :operator,
|
575
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator }
|
576
|
+
|
577
|
+
# @!attribute values
|
578
|
+
# The IDs or values that match this filter.
|
579
|
+
#
|
580
|
+
# @return [Array<String>]
|
581
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
582
|
+
|
583
|
+
# @!method initialize(field:, operator:, values:)
|
584
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
|
585
|
+
#
|
586
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
587
|
+
#
|
588
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
589
|
+
|
590
|
+
# The property of the price to filter on.
|
591
|
+
#
|
592
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter#field
|
593
|
+
module Field
|
594
|
+
extend Orb::Internal::Type::Enum
|
595
|
+
|
596
|
+
PRICE_ID = :price_id
|
597
|
+
ITEM_ID = :item_id
|
598
|
+
PRICE_TYPE = :price_type
|
599
|
+
CURRENCY = :currency
|
600
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
601
|
+
|
602
|
+
# @!method self.values
|
603
|
+
# @return [Array<Symbol>]
|
604
|
+
end
|
605
|
+
|
606
|
+
# Should prices that match the filter be included or excluded.
|
607
|
+
#
|
608
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter#operator
|
609
|
+
module Operator
|
610
|
+
extend Orb::Internal::Type::Enum
|
611
|
+
|
612
|
+
INCLUDES = :includes
|
613
|
+
EXCLUDES = :excludes
|
614
|
+
|
615
|
+
# @!method self.values
|
616
|
+
# @return [Array<Symbol>]
|
617
|
+
end
|
618
|
+
end
|
459
619
|
end
|
460
620
|
|
461
621
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
@@ -470,11 +630,24 @@ module Orb
|
|
470
630
|
required :adjustment_type, const: :percentage_discount
|
471
631
|
|
472
632
|
# @!attribute applies_to_price_ids
|
633
|
+
# @deprecated
|
634
|
+
#
|
473
635
|
# The price IDs that this adjustment applies to.
|
474
636
|
#
|
475
637
|
# @return [Array<String>]
|
476
638
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
477
639
|
|
640
|
+
# @!attribute filters
|
641
|
+
# The filters that determine which prices to apply this adjustment to.
|
642
|
+
#
|
643
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>]
|
644
|
+
required :filters,
|
645
|
+
-> do
|
646
|
+
Orb::Internal::Type::ArrayOf[
|
647
|
+
Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter
|
648
|
+
]
|
649
|
+
end
|
650
|
+
|
478
651
|
# @!attribute is_invoice_level
|
479
652
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
480
653
|
# that apply to only one price.
|
@@ -501,7 +674,7 @@ module Orb
|
|
501
674
|
# @return [String, nil]
|
502
675
|
required :reason, String, nil?: true
|
503
676
|
|
504
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
677
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
505
678
|
# Some parameter documentations has been truncated, see
|
506
679
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
507
680
|
# for more details.
|
@@ -510,6 +683,8 @@ module Orb
|
|
510
683
|
#
|
511
684
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
512
685
|
#
|
686
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
687
|
+
#
|
513
688
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
514
689
|
#
|
515
690
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
@@ -519,6 +694,64 @@ module Orb
|
|
519
694
|
# @param reason [String, nil] The reason for the adjustment.
|
520
695
|
#
|
521
696
|
# @param adjustment_type [Symbol, :percentage_discount]
|
697
|
+
|
698
|
+
class Filter < Orb::Internal::Type::BaseModel
|
699
|
+
# @!attribute field
|
700
|
+
# The property of the price to filter on.
|
701
|
+
#
|
702
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field]
|
703
|
+
required :field,
|
704
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field }
|
705
|
+
|
706
|
+
# @!attribute operator
|
707
|
+
# Should prices that match the filter be included or excluded.
|
708
|
+
#
|
709
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator]
|
710
|
+
required :operator,
|
711
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator }
|
712
|
+
|
713
|
+
# @!attribute values
|
714
|
+
# The IDs or values that match this filter.
|
715
|
+
#
|
716
|
+
# @return [Array<String>]
|
717
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
718
|
+
|
719
|
+
# @!method initialize(field:, operator:, values:)
|
720
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
|
721
|
+
#
|
722
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
723
|
+
#
|
724
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
725
|
+
|
726
|
+
# The property of the price to filter on.
|
727
|
+
#
|
728
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#field
|
729
|
+
module Field
|
730
|
+
extend Orb::Internal::Type::Enum
|
731
|
+
|
732
|
+
PRICE_ID = :price_id
|
733
|
+
ITEM_ID = :item_id
|
734
|
+
PRICE_TYPE = :price_type
|
735
|
+
CURRENCY = :currency
|
736
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
737
|
+
|
738
|
+
# @!method self.values
|
739
|
+
# @return [Array<Symbol>]
|
740
|
+
end
|
741
|
+
|
742
|
+
# Should prices that match the filter be included or excluded.
|
743
|
+
#
|
744
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#operator
|
745
|
+
module Operator
|
746
|
+
extend Orb::Internal::Type::Enum
|
747
|
+
|
748
|
+
INCLUDES = :includes
|
749
|
+
EXCLUDES = :excludes
|
750
|
+
|
751
|
+
# @!method self.values
|
752
|
+
# @return [Array<Symbol>]
|
753
|
+
end
|
754
|
+
end
|
522
755
|
end
|
523
756
|
|
524
757
|
class Minimum < Orb::Internal::Type::BaseModel
|
@@ -533,11 +766,24 @@ module Orb
|
|
533
766
|
required :adjustment_type, const: :minimum
|
534
767
|
|
535
768
|
# @!attribute applies_to_price_ids
|
769
|
+
# @deprecated
|
770
|
+
#
|
536
771
|
# The price IDs that this adjustment applies to.
|
537
772
|
#
|
538
773
|
# @return [Array<String>]
|
539
774
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
540
775
|
|
776
|
+
# @!attribute filters
|
777
|
+
# The filters that determine which prices to apply this adjustment to.
|
778
|
+
#
|
779
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter>]
|
780
|
+
required :filters,
|
781
|
+
-> do
|
782
|
+
Orb::Internal::Type::ArrayOf[
|
783
|
+
Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter
|
784
|
+
]
|
785
|
+
end
|
786
|
+
|
541
787
|
# @!attribute is_invoice_level
|
542
788
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
543
789
|
# that apply to only one price.
|
@@ -570,7 +816,7 @@ module Orb
|
|
570
816
|
# @return [String, nil]
|
571
817
|
required :reason, String, nil?: true
|
572
818
|
|
573
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
819
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
574
820
|
# Some parameter documentations has been truncated, see
|
575
821
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum}
|
576
822
|
# for more details.
|
@@ -579,6 +825,8 @@ module Orb
|
|
579
825
|
#
|
580
826
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
581
827
|
#
|
828
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
|
829
|
+
#
|
582
830
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
583
831
|
#
|
584
832
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
@@ -590,6 +838,64 @@ module Orb
|
|
590
838
|
# @param reason [String, nil] The reason for the adjustment.
|
591
839
|
#
|
592
840
|
# @param adjustment_type [Symbol, :minimum]
|
841
|
+
|
842
|
+
class Filter < Orb::Internal::Type::BaseModel
|
843
|
+
# @!attribute field
|
844
|
+
# The property of the price to filter on.
|
845
|
+
#
|
846
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field]
|
847
|
+
required :field,
|
848
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field }
|
849
|
+
|
850
|
+
# @!attribute operator
|
851
|
+
# Should prices that match the filter be included or excluded.
|
852
|
+
#
|
853
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator]
|
854
|
+
required :operator,
|
855
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator }
|
856
|
+
|
857
|
+
# @!attribute values
|
858
|
+
# The IDs or values that match this filter.
|
859
|
+
#
|
860
|
+
# @return [Array<String>]
|
861
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
862
|
+
|
863
|
+
# @!method initialize(field:, operator:, values:)
|
864
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
|
865
|
+
#
|
866
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
867
|
+
#
|
868
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
869
|
+
|
870
|
+
# The property of the price to filter on.
|
871
|
+
#
|
872
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter#field
|
873
|
+
module Field
|
874
|
+
extend Orb::Internal::Type::Enum
|
875
|
+
|
876
|
+
PRICE_ID = :price_id
|
877
|
+
ITEM_ID = :item_id
|
878
|
+
PRICE_TYPE = :price_type
|
879
|
+
CURRENCY = :currency
|
880
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
881
|
+
|
882
|
+
# @!method self.values
|
883
|
+
# @return [Array<Symbol>]
|
884
|
+
end
|
885
|
+
|
886
|
+
# Should prices that match the filter be included or excluded.
|
887
|
+
#
|
888
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum::Filter#operator
|
889
|
+
module Operator
|
890
|
+
extend Orb::Internal::Type::Enum
|
891
|
+
|
892
|
+
INCLUDES = :includes
|
893
|
+
EXCLUDES = :excludes
|
894
|
+
|
895
|
+
# @!method self.values
|
896
|
+
# @return [Array<Symbol>]
|
897
|
+
end
|
898
|
+
end
|
593
899
|
end
|
594
900
|
|
595
901
|
class Maximum < Orb::Internal::Type::BaseModel
|
@@ -604,11 +910,24 @@ module Orb
|
|
604
910
|
required :adjustment_type, const: :maximum
|
605
911
|
|
606
912
|
# @!attribute applies_to_price_ids
|
913
|
+
# @deprecated
|
914
|
+
#
|
607
915
|
# The price IDs that this adjustment applies to.
|
608
916
|
#
|
609
917
|
# @return [Array<String>]
|
610
918
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
611
919
|
|
920
|
+
# @!attribute filters
|
921
|
+
# The filters that determine which prices to apply this adjustment to.
|
922
|
+
#
|
923
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter>]
|
924
|
+
required :filters,
|
925
|
+
-> do
|
926
|
+
Orb::Internal::Type::ArrayOf[
|
927
|
+
Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter
|
928
|
+
]
|
929
|
+
end
|
930
|
+
|
612
931
|
# @!attribute is_invoice_level
|
613
932
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
614
933
|
# that apply to only one price.
|
@@ -635,7 +954,7 @@ module Orb
|
|
635
954
|
# @return [String, nil]
|
636
955
|
required :reason, String, nil?: true
|
637
956
|
|
638
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
957
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
639
958
|
# Some parameter documentations has been truncated, see
|
640
959
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum}
|
641
960
|
# for more details.
|
@@ -644,6 +963,8 @@ module Orb
|
|
644
963
|
#
|
645
964
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
646
965
|
#
|
966
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
|
967
|
+
#
|
647
968
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
648
969
|
#
|
649
970
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
@@ -653,6 +974,64 @@ module Orb
|
|
653
974
|
# @param reason [String, nil] The reason for the adjustment.
|
654
975
|
#
|
655
976
|
# @param adjustment_type [Symbol, :maximum]
|
977
|
+
|
978
|
+
class Filter < Orb::Internal::Type::BaseModel
|
979
|
+
# @!attribute field
|
980
|
+
# The property of the price to filter on.
|
981
|
+
#
|
982
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field]
|
983
|
+
required :field,
|
984
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field }
|
985
|
+
|
986
|
+
# @!attribute operator
|
987
|
+
# Should prices that match the filter be included or excluded.
|
988
|
+
#
|
989
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator]
|
990
|
+
required :operator,
|
991
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator }
|
992
|
+
|
993
|
+
# @!attribute values
|
994
|
+
# The IDs or values that match this filter.
|
995
|
+
#
|
996
|
+
# @return [Array<String>]
|
997
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
998
|
+
|
999
|
+
# @!method initialize(field:, operator:, values:)
|
1000
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
|
1001
|
+
#
|
1002
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
1003
|
+
#
|
1004
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1005
|
+
|
1006
|
+
# The property of the price to filter on.
|
1007
|
+
#
|
1008
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter#field
|
1009
|
+
module Field
|
1010
|
+
extend Orb::Internal::Type::Enum
|
1011
|
+
|
1012
|
+
PRICE_ID = :price_id
|
1013
|
+
ITEM_ID = :item_id
|
1014
|
+
PRICE_TYPE = :price_type
|
1015
|
+
CURRENCY = :currency
|
1016
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1017
|
+
|
1018
|
+
# @!method self.values
|
1019
|
+
# @return [Array<Symbol>]
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
# Should prices that match the filter be included or excluded.
|
1023
|
+
#
|
1024
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum::Filter#operator
|
1025
|
+
module Operator
|
1026
|
+
extend Orb::Internal::Type::Enum
|
1027
|
+
|
1028
|
+
INCLUDES = :includes
|
1029
|
+
EXCLUDES = :excludes
|
1030
|
+
|
1031
|
+
# @!method self.values
|
1032
|
+
# @return [Array<Symbol>]
|
1033
|
+
end
|
1034
|
+
end
|
656
1035
|
end
|
657
1036
|
|
658
1037
|
# @!method self.variants
|
@@ -719,12 +1098,6 @@ module Orb
|
|
719
1098
|
# @return [String]
|
720
1099
|
required :amount_discount, String
|
721
1100
|
|
722
|
-
# @!attribute applies_to_price_ids
|
723
|
-
# The price ids that this discount interval applies to.
|
724
|
-
#
|
725
|
-
# @return [Array<String>]
|
726
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
727
|
-
|
728
1101
|
# @!attribute applies_to_price_interval_ids
|
729
1102
|
# The price interval ids that this discount interval applies to.
|
730
1103
|
#
|
@@ -742,33 +1115,92 @@ module Orb
|
|
742
1115
|
# @return [Time, nil]
|
743
1116
|
required :end_date, Time, nil?: true
|
744
1117
|
|
1118
|
+
# @!attribute filters
|
1119
|
+
# The filters that determine which prices this discount interval applies to.
|
1120
|
+
#
|
1121
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter>]
|
1122
|
+
required :filters,
|
1123
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter] }
|
1124
|
+
|
745
1125
|
# @!attribute start_date
|
746
1126
|
# The start date of the discount interval.
|
747
1127
|
#
|
748
1128
|
# @return [Time]
|
749
1129
|
required :start_date, Time
|
750
1130
|
|
751
|
-
# @!method initialize(amount_discount:,
|
1131
|
+
# @!method initialize(amount_discount:, applies_to_price_interval_ids:, end_date:, filters:, start_date:, discount_type: :amount)
|
752
1132
|
# @param amount_discount [String] Only available if discount_type is `amount`.
|
753
1133
|
#
|
754
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
755
|
-
#
|
756
1134
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
757
1135
|
#
|
758
1136
|
# @param end_date [Time, nil] The end date of the discount interval.
|
759
1137
|
#
|
1138
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter>] The filters that determine which prices this discount interval applies to.
|
1139
|
+
#
|
760
1140
|
# @param start_date [Time] The start date of the discount interval.
|
761
1141
|
#
|
762
1142
|
# @param discount_type [Symbol, :amount]
|
1143
|
+
|
1144
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1145
|
+
# @!attribute field
|
1146
|
+
# The property of the price to filter on.
|
1147
|
+
#
|
1148
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter::Field]
|
1149
|
+
required :field,
|
1150
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter::Field }
|
1151
|
+
|
1152
|
+
# @!attribute operator
|
1153
|
+
# Should prices that match the filter be included or excluded.
|
1154
|
+
#
|
1155
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter::Operator]
|
1156
|
+
required :operator,
|
1157
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter::Operator }
|
1158
|
+
|
1159
|
+
# @!attribute values
|
1160
|
+
# The IDs or values that match this filter.
|
1161
|
+
#
|
1162
|
+
# @return [Array<String>]
|
1163
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1164
|
+
|
1165
|
+
# @!method initialize(field:, operator:, values:)
|
1166
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter::Field] The property of the price to filter on.
|
1167
|
+
#
|
1168
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter::Operator] Should prices that match the filter be included or excluded.
|
1169
|
+
#
|
1170
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1171
|
+
|
1172
|
+
# The property of the price to filter on.
|
1173
|
+
#
|
1174
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter#field
|
1175
|
+
module Field
|
1176
|
+
extend Orb::Internal::Type::Enum
|
1177
|
+
|
1178
|
+
PRICE_ID = :price_id
|
1179
|
+
ITEM_ID = :item_id
|
1180
|
+
PRICE_TYPE = :price_type
|
1181
|
+
CURRENCY = :currency
|
1182
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1183
|
+
|
1184
|
+
# @!method self.values
|
1185
|
+
# @return [Array<Symbol>]
|
1186
|
+
end
|
1187
|
+
|
1188
|
+
# Should prices that match the filter be included or excluded.
|
1189
|
+
#
|
1190
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount::Filter#operator
|
1191
|
+
module Operator
|
1192
|
+
extend Orb::Internal::Type::Enum
|
1193
|
+
|
1194
|
+
INCLUDES = :includes
|
1195
|
+
EXCLUDES = :excludes
|
1196
|
+
|
1197
|
+
# @!method self.values
|
1198
|
+
# @return [Array<Symbol>]
|
1199
|
+
end
|
1200
|
+
end
|
763
1201
|
end
|
764
1202
|
|
765
1203
|
class Percentage < Orb::Internal::Type::BaseModel
|
766
|
-
# @!attribute applies_to_price_ids
|
767
|
-
# The price ids that this discount interval applies to.
|
768
|
-
#
|
769
|
-
# @return [Array<String>]
|
770
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
771
|
-
|
772
1204
|
# @!attribute applies_to_price_interval_ids
|
773
1205
|
# The price interval ids that this discount interval applies to.
|
774
1206
|
#
|
@@ -786,6 +1218,13 @@ module Orb
|
|
786
1218
|
# @return [Time, nil]
|
787
1219
|
required :end_date, Time, nil?: true
|
788
1220
|
|
1221
|
+
# @!attribute filters
|
1222
|
+
# The filters that determine which prices this discount interval applies to.
|
1223
|
+
#
|
1224
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter>]
|
1225
|
+
required :filters,
|
1226
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter] }
|
1227
|
+
|
789
1228
|
# @!attribute percentage_discount
|
790
1229
|
# Only available if discount_type is `percentage`.This is a number between 0
|
791
1230
|
# and 1.
|
@@ -799,31 +1238,83 @@ module Orb
|
|
799
1238
|
# @return [Time]
|
800
1239
|
required :start_date, Time
|
801
1240
|
|
802
|
-
# @!method initialize(
|
1241
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, percentage_discount:, start_date:, discount_type: :percentage)
|
803
1242
|
# Some parameter documentations has been truncated, see
|
804
1243
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage}
|
805
1244
|
# for more details.
|
806
1245
|
#
|
807
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
808
|
-
#
|
809
1246
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
810
1247
|
#
|
811
1248
|
# @param end_date [Time, nil] The end date of the discount interval.
|
812
1249
|
#
|
1250
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter>] The filters that determine which prices this discount interval applies to.
|
1251
|
+
#
|
813
1252
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
814
1253
|
#
|
815
1254
|
# @param start_date [Time] The start date of the discount interval.
|
816
1255
|
#
|
817
1256
|
# @param discount_type [Symbol, :percentage]
|
1257
|
+
|
1258
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1259
|
+
# @!attribute field
|
1260
|
+
# The property of the price to filter on.
|
1261
|
+
#
|
1262
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter::Field]
|
1263
|
+
required :field,
|
1264
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter::Field }
|
1265
|
+
|
1266
|
+
# @!attribute operator
|
1267
|
+
# Should prices that match the filter be included or excluded.
|
1268
|
+
#
|
1269
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter::Operator]
|
1270
|
+
required :operator,
|
1271
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter::Operator }
|
1272
|
+
|
1273
|
+
# @!attribute values
|
1274
|
+
# The IDs or values that match this filter.
|
1275
|
+
#
|
1276
|
+
# @return [Array<String>]
|
1277
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1278
|
+
|
1279
|
+
# @!method initialize(field:, operator:, values:)
|
1280
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter::Field] The property of the price to filter on.
|
1281
|
+
#
|
1282
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter::Operator] Should prices that match the filter be included or excluded.
|
1283
|
+
#
|
1284
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1285
|
+
|
1286
|
+
# The property of the price to filter on.
|
1287
|
+
#
|
1288
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter#field
|
1289
|
+
module Field
|
1290
|
+
extend Orb::Internal::Type::Enum
|
1291
|
+
|
1292
|
+
PRICE_ID = :price_id
|
1293
|
+
ITEM_ID = :item_id
|
1294
|
+
PRICE_TYPE = :price_type
|
1295
|
+
CURRENCY = :currency
|
1296
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1297
|
+
|
1298
|
+
# @!method self.values
|
1299
|
+
# @return [Array<Symbol>]
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
# Should prices that match the filter be included or excluded.
|
1303
|
+
#
|
1304
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage::Filter#operator
|
1305
|
+
module Operator
|
1306
|
+
extend Orb::Internal::Type::Enum
|
1307
|
+
|
1308
|
+
INCLUDES = :includes
|
1309
|
+
EXCLUDES = :excludes
|
1310
|
+
|
1311
|
+
# @!method self.values
|
1312
|
+
# @return [Array<Symbol>]
|
1313
|
+
end
|
1314
|
+
end
|
818
1315
|
end
|
819
1316
|
|
820
1317
|
class Usage < Orb::Internal::Type::BaseModel
|
821
|
-
# @!attribute applies_to_price_ids
|
822
|
-
# The price ids that this discount interval applies to.
|
823
|
-
#
|
824
|
-
# @return [Array<String>]
|
825
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
826
|
-
|
827
1318
|
# @!attribute applies_to_price_interval_ids
|
828
1319
|
# The price interval ids that this discount interval applies to.
|
829
1320
|
#
|
@@ -841,6 +1332,13 @@ module Orb
|
|
841
1332
|
# @return [Time, nil]
|
842
1333
|
required :end_date, Time, nil?: true
|
843
1334
|
|
1335
|
+
# @!attribute filters
|
1336
|
+
# The filters that determine which prices this discount interval applies to.
|
1337
|
+
#
|
1338
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter>]
|
1339
|
+
required :filters,
|
1340
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter] }
|
1341
|
+
|
844
1342
|
# @!attribute start_date
|
845
1343
|
# The start date of the discount interval.
|
846
1344
|
#
|
@@ -854,22 +1352,80 @@ module Orb
|
|
854
1352
|
# @return [Float]
|
855
1353
|
required :usage_discount, Float
|
856
1354
|
|
857
|
-
# @!method initialize(
|
1355
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, start_date:, usage_discount:, discount_type: :usage)
|
858
1356
|
# Some parameter documentations has been truncated, see
|
859
1357
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage}
|
860
1358
|
# for more details.
|
861
1359
|
#
|
862
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
863
|
-
#
|
864
1360
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
865
1361
|
#
|
866
1362
|
# @param end_date [Time, nil] The end date of the discount interval.
|
867
1363
|
#
|
1364
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter>] The filters that determine which prices this discount interval applies to.
|
1365
|
+
#
|
868
1366
|
# @param start_date [Time] The start date of the discount interval.
|
869
1367
|
#
|
870
1368
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
871
1369
|
#
|
872
1370
|
# @param discount_type [Symbol, :usage]
|
1371
|
+
|
1372
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1373
|
+
# @!attribute field
|
1374
|
+
# The property of the price to filter on.
|
1375
|
+
#
|
1376
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter::Field]
|
1377
|
+
required :field,
|
1378
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter::Field }
|
1379
|
+
|
1380
|
+
# @!attribute operator
|
1381
|
+
# Should prices that match the filter be included or excluded.
|
1382
|
+
#
|
1383
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter::Operator]
|
1384
|
+
required :operator,
|
1385
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter::Operator }
|
1386
|
+
|
1387
|
+
# @!attribute values
|
1388
|
+
# The IDs or values that match this filter.
|
1389
|
+
#
|
1390
|
+
# @return [Array<String>]
|
1391
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1392
|
+
|
1393
|
+
# @!method initialize(field:, operator:, values:)
|
1394
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter::Field] The property of the price to filter on.
|
1395
|
+
#
|
1396
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter::Operator] Should prices that match the filter be included or excluded.
|
1397
|
+
#
|
1398
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1399
|
+
|
1400
|
+
# The property of the price to filter on.
|
1401
|
+
#
|
1402
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter#field
|
1403
|
+
module Field
|
1404
|
+
extend Orb::Internal::Type::Enum
|
1405
|
+
|
1406
|
+
PRICE_ID = :price_id
|
1407
|
+
ITEM_ID = :item_id
|
1408
|
+
PRICE_TYPE = :price_type
|
1409
|
+
CURRENCY = :currency
|
1410
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1411
|
+
|
1412
|
+
# @!method self.values
|
1413
|
+
# @return [Array<Symbol>]
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
# Should prices that match the filter be included or excluded.
|
1417
|
+
#
|
1418
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage::Filter#operator
|
1419
|
+
module Operator
|
1420
|
+
extend Orb::Internal::Type::Enum
|
1421
|
+
|
1422
|
+
INCLUDES = :includes
|
1423
|
+
EXCLUDES = :excludes
|
1424
|
+
|
1425
|
+
# @!method self.values
|
1426
|
+
# @return [Array<Symbol>]
|
1427
|
+
end
|
1428
|
+
end
|
873
1429
|
end
|
874
1430
|
|
875
1431
|
# @!method self.variants
|
@@ -905,12 +1461,6 @@ module Orb
|
|
905
1461
|
end
|
906
1462
|
|
907
1463
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
908
|
-
# @!attribute applies_to_price_ids
|
909
|
-
# The price ids that this maximum interval applies to.
|
910
|
-
#
|
911
|
-
# @return [Array<String>]
|
912
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
913
|
-
|
914
1464
|
# @!attribute applies_to_price_interval_ids
|
915
1465
|
# The price interval ids that this maximum interval applies to.
|
916
1466
|
#
|
@@ -923,6 +1473,13 @@ module Orb
|
|
923
1473
|
# @return [Time, nil]
|
924
1474
|
required :end_date, Time, nil?: true
|
925
1475
|
|
1476
|
+
# @!attribute filters
|
1477
|
+
# The filters that determine which prices this maximum interval applies to.
|
1478
|
+
#
|
1479
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter>]
|
1480
|
+
required :filters,
|
1481
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter] }
|
1482
|
+
|
926
1483
|
# @!attribute maximum_amount
|
927
1484
|
# The maximum amount to charge in a given billing period for the price intervals
|
928
1485
|
# this transform applies to.
|
@@ -936,29 +1493,81 @@ module Orb
|
|
936
1493
|
# @return [Time]
|
937
1494
|
required :start_date, Time
|
938
1495
|
|
939
|
-
# @!method initialize(
|
1496
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, maximum_amount:, start_date:)
|
940
1497
|
# Some parameter documentations has been truncated, see
|
941
1498
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval}
|
942
1499
|
# for more details.
|
943
1500
|
#
|
944
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
945
|
-
#
|
946
1501
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
947
1502
|
#
|
948
1503
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
949
1504
|
#
|
1505
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter>] The filters that determine which prices this maximum interval applies to.
|
1506
|
+
#
|
950
1507
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
951
1508
|
#
|
952
1509
|
# @param start_date [Time] The start date of the maximum interval.
|
1510
|
+
|
1511
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1512
|
+
# @!attribute field
|
1513
|
+
# The property of the price to filter on.
|
1514
|
+
#
|
1515
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter::Field]
|
1516
|
+
required :field,
|
1517
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter::Field }
|
1518
|
+
|
1519
|
+
# @!attribute operator
|
1520
|
+
# Should prices that match the filter be included or excluded.
|
1521
|
+
#
|
1522
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter::Operator]
|
1523
|
+
required :operator,
|
1524
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter::Operator }
|
1525
|
+
|
1526
|
+
# @!attribute values
|
1527
|
+
# The IDs or values that match this filter.
|
1528
|
+
#
|
1529
|
+
# @return [Array<String>]
|
1530
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1531
|
+
|
1532
|
+
# @!method initialize(field:, operator:, values:)
|
1533
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter::Field] The property of the price to filter on.
|
1534
|
+
#
|
1535
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
|
1536
|
+
#
|
1537
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1538
|
+
|
1539
|
+
# The property of the price to filter on.
|
1540
|
+
#
|
1541
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter#field
|
1542
|
+
module Field
|
1543
|
+
extend Orb::Internal::Type::Enum
|
1544
|
+
|
1545
|
+
PRICE_ID = :price_id
|
1546
|
+
ITEM_ID = :item_id
|
1547
|
+
PRICE_TYPE = :price_type
|
1548
|
+
CURRENCY = :currency
|
1549
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1550
|
+
|
1551
|
+
# @!method self.values
|
1552
|
+
# @return [Array<Symbol>]
|
1553
|
+
end
|
1554
|
+
|
1555
|
+
# Should prices that match the filter be included or excluded.
|
1556
|
+
#
|
1557
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval::Filter#operator
|
1558
|
+
module Operator
|
1559
|
+
extend Orb::Internal::Type::Enum
|
1560
|
+
|
1561
|
+
INCLUDES = :includes
|
1562
|
+
EXCLUDES = :excludes
|
1563
|
+
|
1564
|
+
# @!method self.values
|
1565
|
+
# @return [Array<Symbol>]
|
1566
|
+
end
|
1567
|
+
end
|
953
1568
|
end
|
954
1569
|
|
955
1570
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
956
|
-
# @!attribute applies_to_price_ids
|
957
|
-
# The price ids that this minimum interval applies to.
|
958
|
-
#
|
959
|
-
# @return [Array<String>]
|
960
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
961
|
-
|
962
1571
|
# @!attribute applies_to_price_interval_ids
|
963
1572
|
# The price interval ids that this minimum interval applies to.
|
964
1573
|
#
|
@@ -971,6 +1580,13 @@ module Orb
|
|
971
1580
|
# @return [Time, nil]
|
972
1581
|
required :end_date, Time, nil?: true
|
973
1582
|
|
1583
|
+
# @!attribute filters
|
1584
|
+
# The filters that determine which prices this minimum interval applies to.
|
1585
|
+
#
|
1586
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter>]
|
1587
|
+
required :filters,
|
1588
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter] }
|
1589
|
+
|
974
1590
|
# @!attribute minimum_amount
|
975
1591
|
# The minimum amount to charge in a given billing period for the price intervals
|
976
1592
|
# this minimum applies to.
|
@@ -984,20 +1600,78 @@ module Orb
|
|
984
1600
|
# @return [Time]
|
985
1601
|
required :start_date, Time
|
986
1602
|
|
987
|
-
# @!method initialize(
|
1603
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, minimum_amount:, start_date:)
|
988
1604
|
# Some parameter documentations has been truncated, see
|
989
1605
|
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval}
|
990
1606
|
# for more details.
|
991
1607
|
#
|
992
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
993
|
-
#
|
994
1608
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
995
1609
|
#
|
996
1610
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
997
1611
|
#
|
1612
|
+
# @param filters [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter>] The filters that determine which prices this minimum interval applies to.
|
1613
|
+
#
|
998
1614
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
999
1615
|
#
|
1000
1616
|
# @param start_date [Time] The start date of the minimum interval.
|
1617
|
+
|
1618
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1619
|
+
# @!attribute field
|
1620
|
+
# The property of the price to filter on.
|
1621
|
+
#
|
1622
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter::Field]
|
1623
|
+
required :field,
|
1624
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter::Field }
|
1625
|
+
|
1626
|
+
# @!attribute operator
|
1627
|
+
# Should prices that match the filter be included or excluded.
|
1628
|
+
#
|
1629
|
+
# @return [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter::Operator]
|
1630
|
+
required :operator,
|
1631
|
+
enum: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter::Operator }
|
1632
|
+
|
1633
|
+
# @!attribute values
|
1634
|
+
# The IDs or values that match this filter.
|
1635
|
+
#
|
1636
|
+
# @return [Array<String>]
|
1637
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1638
|
+
|
1639
|
+
# @!method initialize(field:, operator:, values:)
|
1640
|
+
# @param field [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter::Field] The property of the price to filter on.
|
1641
|
+
#
|
1642
|
+
# @param operator [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
|
1643
|
+
#
|
1644
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1645
|
+
|
1646
|
+
# The property of the price to filter on.
|
1647
|
+
#
|
1648
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter#field
|
1649
|
+
module Field
|
1650
|
+
extend Orb::Internal::Type::Enum
|
1651
|
+
|
1652
|
+
PRICE_ID = :price_id
|
1653
|
+
ITEM_ID = :item_id
|
1654
|
+
PRICE_TYPE = :price_type
|
1655
|
+
CURRENCY = :currency
|
1656
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1657
|
+
|
1658
|
+
# @!method self.values
|
1659
|
+
# @return [Array<Symbol>]
|
1660
|
+
end
|
1661
|
+
|
1662
|
+
# Should prices that match the filter be included or excluded.
|
1663
|
+
#
|
1664
|
+
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval::Filter#operator
|
1665
|
+
module Operator
|
1666
|
+
extend Orb::Internal::Type::Enum
|
1667
|
+
|
1668
|
+
INCLUDES = :includes
|
1669
|
+
EXCLUDES = :excludes
|
1670
|
+
|
1671
|
+
# @!method self.values
|
1672
|
+
# @return [Array<Symbol>]
|
1673
|
+
end
|
1674
|
+
end
|
1001
1675
|
end
|
1002
1676
|
|
1003
1677
|
# @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#pending_subscription_change
|