orb-billing 0.1.0.pre.alpha.37 → 0.1.0.pre.alpha.38
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/README.md +29 -5
- data/lib/orb/internal/page.rb +6 -2
- data/lib/orb/internal/transport/base_client.rb +2 -2
- data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/orb/internal/type/array_of.rb +5 -3
- data/lib/orb/internal/type/base_model.rb +12 -6
- data/lib/orb/internal/type/base_page.rb +4 -1
- data/lib/orb/internal/type/{boolean_model.rb → boolean.rb} +2 -2
- data/lib/orb/internal/type/converter.rb +6 -1
- data/lib/orb/internal/type/enum.rb +2 -0
- data/lib/orb/internal/type/hash_of.rb +3 -1
- data/lib/orb/internal/util.rb +28 -45
- data/lib/orb/models/alert.rb +1 -1
- data/lib/orb/models/coupon_list_params.rb +1 -1
- data/lib/orb/models/customer.rb +5 -5
- data/lib/orb/models/customer_create_params.rb +6 -6
- data/lib/orb/models/customer_update_by_external_id_params.rb +6 -6
- data/lib/orb/models/customer_update_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credit_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_params.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_response.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_list_response.rb +2 -2
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +1 -1
- data/lib/orb/models/event_search_response.rb +1 -1
- data/lib/orb/models/events/backfill_close_response.rb +1 -1
- data/lib/orb/models/events/backfill_create_params.rb +1 -1
- data/lib/orb/models/events/backfill_create_response.rb +1 -1
- data/lib/orb/models/events/backfill_fetch_response.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +1 -1
- data/lib/orb/models/events/backfill_revert_response.rb +1 -1
- data/lib/orb/models/invoice.rb +8 -8
- data/lib/orb/models/invoice_create_params.rb +1 -1
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +8 -8
- data/lib/orb/models/invoice_issue_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +5 -5
- data/lib/orb/models/invoice_list_params.rb +1 -1
- data/lib/orb/models/pagination_metadata.rb +1 -1
- data/lib/orb/models/plan.rb +5 -5
- data/lib/orb/models/plan_create_params.rb +25 -25
- data/lib/orb/models/price.rb +28 -28
- data/lib/orb/models/price_create_params.rb +1 -1
- data/lib/orb/models/subscription.rb +6 -6
- data/lib/orb/models/subscription_cancel_params.rb +1 -1
- data/lib/orb/models/subscription_cancel_response.rb +6 -6
- data/lib/orb/models/subscription_create_params.rb +64 -64
- data/lib/orb/models/subscription_create_response.rb +6 -6
- data/lib/orb/models/subscription_price_intervals_params.rb +35 -35
- data/lib/orb/models/subscription_price_intervals_response.rb +6 -6
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +64 -64
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +6 -6
- data/lib/orb/models/subscription_trigger_phase_params.rb +1 -1
- data/lib/orb/models/subscription_trigger_phase_response.rb +6 -6
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +6 -6
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +6 -6
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +6 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +1 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +6 -6
- data/lib/orb/models/subscription_update_params.rb +1 -1
- data/lib/orb/models/subscription_update_trial_params.rb +1 -1
- data/lib/orb/models/subscription_update_trial_response.rb +6 -6
- data/lib/orb/resources/alerts.rb +6 -1
- data/lib/orb/resources/credit_notes.rb +6 -1
- data/lib/orb/resources/customers/balance_transactions.rb +6 -1
- data/lib/orb/resources/customers/credits/ledger.rb +12 -2
- data/lib/orb/resources/customers.rb +6 -1
- data/lib/orb/resources/invoices.rb +10 -1
- data/lib/orb/resources/metrics.rb +6 -1
- data/lib/orb/resources/plans.rb +6 -1
- data/lib/orb/resources/subscriptions.rb +12 -2
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -1
- data/rbi/lib/orb/internal/type/array_of.rbi +2 -2
- data/rbi/lib/orb/internal/type/{boolean_model.rbi → boolean.rbi} +1 -1
- data/rbi/lib/orb/internal/util.rbi +7 -5
- data/rbi/lib/orb/version.rbi +1 -1
- data/sig/orb/internal/type/array_of.rbs +2 -2
- data/sig/orb/internal/type/{boolean_model.rbs → boolean.rbs} +1 -1
- data/sig/orb/internal/util.rbs +5 -5
- data/sig/orb/version.rbs +1 -1
- metadata +5 -5
@@ -36,7 +36,7 @@ module Orb
|
|
36
36
|
# aligned with the plan change's effective date.
|
37
37
|
#
|
38
38
|
# @return [Boolean, nil]
|
39
|
-
optional :align_billing_with_plan_change_date, Orb::Internal::Type::
|
39
|
+
optional :align_billing_with_plan_change_date, Orb::Internal::Type::Boolean, nil?: true
|
40
40
|
|
41
41
|
# @!attribute auto_collection
|
42
42
|
# Determines whether issued invoices for this subscription will automatically be
|
@@ -44,7 +44,7 @@ module Orb
|
|
44
44
|
# defaults to the behavior configured for this customer.
|
45
45
|
#
|
46
46
|
# @return [Boolean, nil]
|
47
|
-
optional :auto_collection, Orb::Internal::Type::
|
47
|
+
optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
|
48
48
|
|
49
49
|
# @!attribute billing_cycle_alignment
|
50
50
|
# Reset billing periods to be aligned with the plan change's effective date or
|
@@ -372,7 +372,7 @@ module Orb
|
|
372
372
|
# will be applied at the invoice level, possibly to multiple prices.
|
373
373
|
#
|
374
374
|
# @return [Boolean, nil]
|
375
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
375
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
376
376
|
|
377
377
|
# @!parse
|
378
378
|
# # @return [Boolean]
|
@@ -419,7 +419,7 @@ module Orb
|
|
419
419
|
# will be applied at the invoice level, possibly to multiple prices.
|
420
420
|
#
|
421
421
|
# @return [Boolean, nil]
|
422
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
422
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
423
423
|
|
424
424
|
# @!parse
|
425
425
|
# # @return [Boolean]
|
@@ -458,7 +458,7 @@ module Orb
|
|
458
458
|
# will be applied at the invoice level, possibly to multiple prices.
|
459
459
|
#
|
460
460
|
# @return [Boolean, nil]
|
461
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
461
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
462
462
|
|
463
463
|
# @!parse
|
464
464
|
# # @return [Boolean]
|
@@ -503,7 +503,7 @@ module Orb
|
|
503
503
|
# will be applied at the invoice level, possibly to multiple prices.
|
504
504
|
#
|
505
505
|
# @return [Boolean, nil]
|
506
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
506
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
507
507
|
|
508
508
|
# @!parse
|
509
509
|
# # @return [Boolean]
|
@@ -543,7 +543,7 @@ module Orb
|
|
543
543
|
# will be applied at the invoice level, possibly to multiple prices.
|
544
544
|
#
|
545
545
|
# @return [Boolean, nil]
|
546
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
546
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
547
547
|
|
548
548
|
# @!parse
|
549
549
|
# # @return [Boolean]
|
@@ -697,7 +697,7 @@ module Orb
|
|
697
697
|
# over to the next period.
|
698
698
|
#
|
699
699
|
# @return [Boolean]
|
700
|
-
required :expires_at_end_of_cadence, Orb::Internal::Type::
|
700
|
+
required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
|
701
701
|
|
702
702
|
# @!parse
|
703
703
|
# # The definition of a new allocation price to create and add to the subscription.
|
@@ -911,7 +911,7 @@ module Orb
|
|
911
911
|
# this is true, and in-arrears if this is false.
|
912
912
|
#
|
913
913
|
# @return [Boolean, nil]
|
914
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
914
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
915
915
|
|
916
916
|
# @!attribute billing_cycle_configuration
|
917
917
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1186,7 +1186,7 @@ module Orb
|
|
1186
1186
|
# this is true, and in-arrears if this is false.
|
1187
1187
|
#
|
1188
1188
|
# @return [Boolean, nil]
|
1189
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
1189
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
1190
1190
|
|
1191
1191
|
# @!attribute billing_cycle_configuration
|
1192
1192
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1469,7 +1469,7 @@ module Orb
|
|
1469
1469
|
# this is true, and in-arrears if this is false.
|
1470
1470
|
#
|
1471
1471
|
# @return [Boolean, nil]
|
1472
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
1472
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
1473
1473
|
|
1474
1474
|
# @!attribute billing_cycle_configuration
|
1475
1475
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1787,7 +1787,7 @@ module Orb
|
|
1787
1787
|
# this is true, and in-arrears if this is false.
|
1788
1788
|
#
|
1789
1789
|
# @return [Boolean, nil]
|
1790
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
1790
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
1791
1791
|
|
1792
1792
|
# @!attribute billing_cycle_configuration
|
1793
1793
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2096,7 +2096,7 @@ module Orb
|
|
2096
2096
|
# this is true, and in-arrears if this is false.
|
2097
2097
|
#
|
2098
2098
|
# @return [Boolean, nil]
|
2099
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
2099
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
2100
2100
|
|
2101
2101
|
# @!attribute billing_cycle_configuration
|
2102
2102
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2413,7 +2413,7 @@ module Orb
|
|
2413
2413
|
# this is true, and in-arrears if this is false.
|
2414
2414
|
#
|
2415
2415
|
# @return [Boolean, nil]
|
2416
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
2416
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
2417
2417
|
|
2418
2418
|
# @!attribute billing_cycle_configuration
|
2419
2419
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2695,7 +2695,7 @@ module Orb
|
|
2695
2695
|
# this is true, and in-arrears if this is false.
|
2696
2696
|
#
|
2697
2697
|
# @return [Boolean, nil]
|
2698
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
2698
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
2699
2699
|
|
2700
2700
|
# @!attribute billing_cycle_configuration
|
2701
2701
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3005,7 +3005,7 @@ module Orb
|
|
3005
3005
|
# this is true, and in-arrears if this is false.
|
3006
3006
|
#
|
3007
3007
|
# @return [Boolean, nil]
|
3008
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
3008
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3009
3009
|
|
3010
3010
|
# @!attribute billing_cycle_configuration
|
3011
3011
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3306,7 +3306,7 @@ module Orb
|
|
3306
3306
|
# this is true, and in-arrears if this is false.
|
3307
3307
|
#
|
3308
3308
|
# @return [Boolean, nil]
|
3309
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
3309
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3310
3310
|
|
3311
3311
|
# @!attribute billing_cycle_configuration
|
3312
3312
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3564,7 +3564,7 @@ module Orb
|
|
3564
3564
|
# this is true, and in-arrears if this is false.
|
3565
3565
|
#
|
3566
3566
|
# @return [Boolean, nil]
|
3567
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
3567
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3568
3568
|
|
3569
3569
|
# @!attribute billing_cycle_configuration
|
3570
3570
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3822,7 +3822,7 @@ module Orb
|
|
3822
3822
|
# this is true, and in-arrears if this is false.
|
3823
3823
|
#
|
3824
3824
|
# @return [Boolean, nil]
|
3825
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
3825
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3826
3826
|
|
3827
3827
|
# @!attribute billing_cycle_configuration
|
3828
3828
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4080,7 +4080,7 @@ module Orb
|
|
4080
4080
|
# this is true, and in-arrears if this is false.
|
4081
4081
|
#
|
4082
4082
|
# @return [Boolean, nil]
|
4083
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
4083
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4084
4084
|
|
4085
4085
|
# @!attribute billing_cycle_configuration
|
4086
4086
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4339,7 +4339,7 @@ module Orb
|
|
4339
4339
|
# this is true, and in-arrears if this is false.
|
4340
4340
|
#
|
4341
4341
|
# @return [Boolean, nil]
|
4342
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
4342
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4343
4343
|
|
4344
4344
|
# @!attribute billing_cycle_configuration
|
4345
4345
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4597,7 +4597,7 @@ module Orb
|
|
4597
4597
|
# this is true, and in-arrears if this is false.
|
4598
4598
|
#
|
4599
4599
|
# @return [Boolean, nil]
|
4600
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
4600
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4601
4601
|
|
4602
4602
|
# @!attribute billing_cycle_configuration
|
4603
4603
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4855,7 +4855,7 @@ module Orb
|
|
4855
4855
|
# this is true, and in-arrears if this is false.
|
4856
4856
|
#
|
4857
4857
|
# @return [Boolean, nil]
|
4858
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
4858
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4859
4859
|
|
4860
4860
|
# @!attribute billing_cycle_configuration
|
4861
4861
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5113,7 +5113,7 @@ module Orb
|
|
5113
5113
|
# this is true, and in-arrears if this is false.
|
5114
5114
|
#
|
5115
5115
|
# @return [Boolean, nil]
|
5116
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
5116
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5117
5117
|
|
5118
5118
|
# @!attribute billing_cycle_configuration
|
5119
5119
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5372,7 +5372,7 @@ module Orb
|
|
5372
5372
|
# this is true, and in-arrears if this is false.
|
5373
5373
|
#
|
5374
5374
|
# @return [Boolean, nil]
|
5375
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
5375
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5376
5376
|
|
5377
5377
|
# @!attribute billing_cycle_configuration
|
5378
5378
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5630,7 +5630,7 @@ module Orb
|
|
5630
5630
|
# this is true, and in-arrears if this is false.
|
5631
5631
|
#
|
5632
5632
|
# @return [Boolean, nil]
|
5633
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
5633
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5634
5634
|
|
5635
5635
|
# @!attribute billing_cycle_configuration
|
5636
5636
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5889,7 +5889,7 @@ module Orb
|
|
5889
5889
|
# this is true, and in-arrears if this is false.
|
5890
5890
|
#
|
5891
5891
|
# @return [Boolean, nil]
|
5892
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
5892
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5893
5893
|
|
5894
5894
|
# @!attribute billing_cycle_configuration
|
5895
5895
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6148,7 +6148,7 @@ module Orb
|
|
6148
6148
|
# this is true, and in-arrears if this is false.
|
6149
6149
|
#
|
6150
6150
|
# @return [Boolean, nil]
|
6151
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
6151
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6152
6152
|
|
6153
6153
|
# @!attribute billing_cycle_configuration
|
6154
6154
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6407,7 +6407,7 @@ module Orb
|
|
6407
6407
|
# this is true, and in-arrears if this is false.
|
6408
6408
|
#
|
6409
6409
|
# @return [Boolean, nil]
|
6410
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
6410
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6411
6411
|
|
6412
6412
|
# @!attribute billing_cycle_configuration
|
6413
6413
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6666,7 +6666,7 @@ module Orb
|
|
6666
6666
|
# this is true, and in-arrears if this is false.
|
6667
6667
|
#
|
6668
6668
|
# @return [Boolean, nil]
|
6669
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
6669
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6670
6670
|
|
6671
6671
|
# @!attribute billing_cycle_configuration
|
6672
6672
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6925,7 +6925,7 @@ module Orb
|
|
6925
6925
|
# this is true, and in-arrears if this is false.
|
6926
6926
|
#
|
6927
6927
|
# @return [Boolean, nil]
|
6928
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
6928
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6929
6929
|
|
6930
6930
|
# @!attribute billing_cycle_configuration
|
6931
6931
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -7184,7 +7184,7 @@ module Orb
|
|
7184
7184
|
# this is true, and in-arrears if this is false.
|
7185
7185
|
#
|
7186
7186
|
# @return [Boolean, nil]
|
7187
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
7187
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
7188
7188
|
|
7189
7189
|
# @!attribute billing_cycle_configuration
|
7190
7190
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -7442,7 +7442,7 @@ module Orb
|
|
7442
7442
|
# this is true, and in-arrears if this is false.
|
7443
7443
|
#
|
7444
7444
|
# @return [Boolean, nil]
|
7445
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
7445
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
7446
7446
|
|
7447
7447
|
# @!attribute billing_cycle_configuration
|
7448
7448
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -7820,7 +7820,7 @@ module Orb
|
|
7820
7820
|
# will be applied at the invoice level, possibly to multiple prices.
|
7821
7821
|
#
|
7822
7822
|
# @return [Boolean, nil]
|
7823
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
7823
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7824
7824
|
|
7825
7825
|
# @!parse
|
7826
7826
|
# # @return [Boolean]
|
@@ -7867,7 +7867,7 @@ module Orb
|
|
7867
7867
|
# will be applied at the invoice level, possibly to multiple prices.
|
7868
7868
|
#
|
7869
7869
|
# @return [Boolean, nil]
|
7870
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
7870
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7871
7871
|
|
7872
7872
|
# @!parse
|
7873
7873
|
# # @return [Boolean]
|
@@ -7906,7 +7906,7 @@ module Orb
|
|
7906
7906
|
# will be applied at the invoice level, possibly to multiple prices.
|
7907
7907
|
#
|
7908
7908
|
# @return [Boolean, nil]
|
7909
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
7909
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7910
7910
|
|
7911
7911
|
# @!parse
|
7912
7912
|
# # @return [Boolean]
|
@@ -7951,7 +7951,7 @@ module Orb
|
|
7951
7951
|
# will be applied at the invoice level, possibly to multiple prices.
|
7952
7952
|
#
|
7953
7953
|
# @return [Boolean, nil]
|
7954
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
7954
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7955
7955
|
|
7956
7956
|
# @!parse
|
7957
7957
|
# # @return [Boolean]
|
@@ -7991,7 +7991,7 @@ module Orb
|
|
7991
7991
|
# will be applied at the invoice level, possibly to multiple prices.
|
7992
7992
|
#
|
7993
7993
|
# @return [Boolean, nil]
|
7994
|
-
optional :is_invoice_level, Orb::Internal::Type::
|
7994
|
+
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7995
7995
|
|
7996
7996
|
# @!parse
|
7997
7997
|
# # @return [Boolean]
|
@@ -8133,7 +8133,7 @@ module Orb
|
|
8133
8133
|
# over to the next period.
|
8134
8134
|
#
|
8135
8135
|
# @return [Boolean]
|
8136
|
-
required :expires_at_end_of_cadence, Orb::Internal::Type::
|
8136
|
+
required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
|
8137
8137
|
|
8138
8138
|
# @!parse
|
8139
8139
|
# # The definition of a new allocation price to create and add to the subscription.
|
@@ -8347,7 +8347,7 @@ module Orb
|
|
8347
8347
|
# this is true, and in-arrears if this is false.
|
8348
8348
|
#
|
8349
8349
|
# @return [Boolean, nil]
|
8350
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
8350
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
8351
8351
|
|
8352
8352
|
# @!attribute billing_cycle_configuration
|
8353
8353
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -8622,7 +8622,7 @@ module Orb
|
|
8622
8622
|
# this is true, and in-arrears if this is false.
|
8623
8623
|
#
|
8624
8624
|
# @return [Boolean, nil]
|
8625
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
8625
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
8626
8626
|
|
8627
8627
|
# @!attribute billing_cycle_configuration
|
8628
8628
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -8905,7 +8905,7 @@ module Orb
|
|
8905
8905
|
# this is true, and in-arrears if this is false.
|
8906
8906
|
#
|
8907
8907
|
# @return [Boolean, nil]
|
8908
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
8908
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
8909
8909
|
|
8910
8910
|
# @!attribute billing_cycle_configuration
|
8911
8911
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -9223,7 +9223,7 @@ module Orb
|
|
9223
9223
|
# this is true, and in-arrears if this is false.
|
9224
9224
|
#
|
9225
9225
|
# @return [Boolean, nil]
|
9226
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
9226
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
9227
9227
|
|
9228
9228
|
# @!attribute billing_cycle_configuration
|
9229
9229
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -9532,7 +9532,7 @@ module Orb
|
|
9532
9532
|
# this is true, and in-arrears if this is false.
|
9533
9533
|
#
|
9534
9534
|
# @return [Boolean, nil]
|
9535
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
9535
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
9536
9536
|
|
9537
9537
|
# @!attribute billing_cycle_configuration
|
9538
9538
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -9849,7 +9849,7 @@ module Orb
|
|
9849
9849
|
# this is true, and in-arrears if this is false.
|
9850
9850
|
#
|
9851
9851
|
# @return [Boolean, nil]
|
9852
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
9852
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
9853
9853
|
|
9854
9854
|
# @!attribute billing_cycle_configuration
|
9855
9855
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -10131,7 +10131,7 @@ module Orb
|
|
10131
10131
|
# this is true, and in-arrears if this is false.
|
10132
10132
|
#
|
10133
10133
|
# @return [Boolean, nil]
|
10134
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
10134
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
10135
10135
|
|
10136
10136
|
# @!attribute billing_cycle_configuration
|
10137
10137
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -10441,7 +10441,7 @@ module Orb
|
|
10441
10441
|
# this is true, and in-arrears if this is false.
|
10442
10442
|
#
|
10443
10443
|
# @return [Boolean, nil]
|
10444
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
10444
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
10445
10445
|
|
10446
10446
|
# @!attribute billing_cycle_configuration
|
10447
10447
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -10742,7 +10742,7 @@ module Orb
|
|
10742
10742
|
# this is true, and in-arrears if this is false.
|
10743
10743
|
#
|
10744
10744
|
# @return [Boolean, nil]
|
10745
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
10745
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
10746
10746
|
|
10747
10747
|
# @!attribute billing_cycle_configuration
|
10748
10748
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -11000,7 +11000,7 @@ module Orb
|
|
11000
11000
|
# this is true, and in-arrears if this is false.
|
11001
11001
|
#
|
11002
11002
|
# @return [Boolean, nil]
|
11003
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
11003
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
11004
11004
|
|
11005
11005
|
# @!attribute billing_cycle_configuration
|
11006
11006
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -11258,7 +11258,7 @@ module Orb
|
|
11258
11258
|
# this is true, and in-arrears if this is false.
|
11259
11259
|
#
|
11260
11260
|
# @return [Boolean, nil]
|
11261
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
11261
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
11262
11262
|
|
11263
11263
|
# @!attribute billing_cycle_configuration
|
11264
11264
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -11516,7 +11516,7 @@ module Orb
|
|
11516
11516
|
# this is true, and in-arrears if this is false.
|
11517
11517
|
#
|
11518
11518
|
# @return [Boolean, nil]
|
11519
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
11519
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
11520
11520
|
|
11521
11521
|
# @!attribute billing_cycle_configuration
|
11522
11522
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -11775,7 +11775,7 @@ module Orb
|
|
11775
11775
|
# this is true, and in-arrears if this is false.
|
11776
11776
|
#
|
11777
11777
|
# @return [Boolean, nil]
|
11778
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
11778
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
11779
11779
|
|
11780
11780
|
# @!attribute billing_cycle_configuration
|
11781
11781
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -12033,7 +12033,7 @@ module Orb
|
|
12033
12033
|
# this is true, and in-arrears if this is false.
|
12034
12034
|
#
|
12035
12035
|
# @return [Boolean, nil]
|
12036
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
12036
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
12037
12037
|
|
12038
12038
|
# @!attribute billing_cycle_configuration
|
12039
12039
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -12291,7 +12291,7 @@ module Orb
|
|
12291
12291
|
# this is true, and in-arrears if this is false.
|
12292
12292
|
#
|
12293
12293
|
# @return [Boolean, nil]
|
12294
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
12294
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
12295
12295
|
|
12296
12296
|
# @!attribute billing_cycle_configuration
|
12297
12297
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -12549,7 +12549,7 @@ module Orb
|
|
12549
12549
|
# this is true, and in-arrears if this is false.
|
12550
12550
|
#
|
12551
12551
|
# @return [Boolean, nil]
|
12552
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
12552
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
12553
12553
|
|
12554
12554
|
# @!attribute billing_cycle_configuration
|
12555
12555
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -12808,7 +12808,7 @@ module Orb
|
|
12808
12808
|
# this is true, and in-arrears if this is false.
|
12809
12809
|
#
|
12810
12810
|
# @return [Boolean, nil]
|
12811
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
12811
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
12812
12812
|
|
12813
12813
|
# @!attribute billing_cycle_configuration
|
12814
12814
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -13066,7 +13066,7 @@ module Orb
|
|
13066
13066
|
# this is true, and in-arrears if this is false.
|
13067
13067
|
#
|
13068
13068
|
# @return [Boolean, nil]
|
13069
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
13069
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
13070
13070
|
|
13071
13071
|
# @!attribute billing_cycle_configuration
|
13072
13072
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -13325,7 +13325,7 @@ module Orb
|
|
13325
13325
|
# this is true, and in-arrears if this is false.
|
13326
13326
|
#
|
13327
13327
|
# @return [Boolean, nil]
|
13328
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
13328
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
13329
13329
|
|
13330
13330
|
# @!attribute billing_cycle_configuration
|
13331
13331
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -13584,7 +13584,7 @@ module Orb
|
|
13584
13584
|
# this is true, and in-arrears if this is false.
|
13585
13585
|
#
|
13586
13586
|
# @return [Boolean, nil]
|
13587
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
13587
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
13588
13588
|
|
13589
13589
|
# @!attribute billing_cycle_configuration
|
13590
13590
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -13843,7 +13843,7 @@ module Orb
|
|
13843
13843
|
# this is true, and in-arrears if this is false.
|
13844
13844
|
#
|
13845
13845
|
# @return [Boolean, nil]
|
13846
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
13846
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
13847
13847
|
|
13848
13848
|
# @!attribute billing_cycle_configuration
|
13849
13849
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -14102,7 +14102,7 @@ module Orb
|
|
14102
14102
|
# this is true, and in-arrears if this is false.
|
14103
14103
|
#
|
14104
14104
|
# @return [Boolean, nil]
|
14105
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
14105
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
14106
14106
|
|
14107
14107
|
# @!attribute billing_cycle_configuration
|
14108
14108
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -14361,7 +14361,7 @@ module Orb
|
|
14361
14361
|
# this is true, and in-arrears if this is false.
|
14362
14362
|
#
|
14363
14363
|
# @return [Boolean, nil]
|
14364
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
14364
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
14365
14365
|
|
14366
14366
|
# @!attribute billing_cycle_configuration
|
14367
14367
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -14620,7 +14620,7 @@ module Orb
|
|
14620
14620
|
# this is true, and in-arrears if this is false.
|
14621
14621
|
#
|
14622
14622
|
# @return [Boolean, nil]
|
14623
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
14623
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
14624
14624
|
|
14625
14625
|
# @!attribute billing_cycle_configuration
|
14626
14626
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -14878,7 +14878,7 @@ module Orb
|
|
14878
14878
|
# this is true, and in-arrears if this is false.
|
14879
14879
|
#
|
14880
14880
|
# @return [Boolean, nil]
|
14881
|
-
optional :billed_in_advance, Orb::Internal::Type::
|
14881
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
14882
14882
|
|
14883
14883
|
# @!attribute billing_cycle_configuration
|
14884
14884
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -30,7 +30,7 @@ module Orb
|
|
30
30
|
# the plan's behavior. If null, defaults to the customer's setting.
|
31
31
|
#
|
32
32
|
# @return [Boolean, nil]
|
33
|
-
required :auto_collection, Orb::Internal::Type::
|
33
|
+
required :auto_collection, Orb::Internal::Type::Boolean, nil?: true
|
34
34
|
|
35
35
|
# @!attribute billing_cycle_anchor_configuration
|
36
36
|
#
|
@@ -337,7 +337,7 @@ module Orb
|
|
337
337
|
# that apply to only one price.
|
338
338
|
#
|
339
339
|
# @return [Boolean]
|
340
|
-
required :is_invoice_level, Orb::Internal::Type::
|
340
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
341
341
|
|
342
342
|
# @!attribute plan_phase_order
|
343
343
|
# The plan phase in which this adjustment is active.
|
@@ -412,7 +412,7 @@ module Orb
|
|
412
412
|
# that apply to only one price.
|
413
413
|
#
|
414
414
|
# @return [Boolean]
|
415
|
-
required :is_invoice_level, Orb::Internal::Type::
|
415
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
416
416
|
|
417
417
|
# @!attribute plan_phase_order
|
418
418
|
# The plan phase in which this adjustment is active.
|
@@ -473,7 +473,7 @@ module Orb
|
|
473
473
|
# that apply to only one price.
|
474
474
|
#
|
475
475
|
# @return [Boolean]
|
476
|
-
required :is_invoice_level, Orb::Internal::Type::
|
476
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
477
477
|
|
478
478
|
# @!attribute percentage_discount
|
479
479
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
@@ -541,7 +541,7 @@ module Orb
|
|
541
541
|
# that apply to only one price.
|
542
542
|
#
|
543
543
|
# @return [Boolean]
|
544
|
-
required :is_invoice_level, Orb::Internal::Type::
|
544
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
545
545
|
|
546
546
|
# @!attribute item_id
|
547
547
|
# The item ID that revenue from this minimum will be attributed to.
|
@@ -617,7 +617,7 @@ module Orb
|
|
617
617
|
# that apply to only one price.
|
618
618
|
#
|
619
619
|
# @return [Boolean]
|
620
|
-
required :is_invoice_level, Orb::Internal::Type::
|
620
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
621
621
|
|
622
622
|
# @!attribute maximum_amount
|
623
623
|
# The maximum amount to charge in a given billing period for the prices this
|
@@ -14,7 +14,7 @@ module Orb
|
|
14
14
|
# existing invoices to be changed.
|
15
15
|
#
|
16
16
|
# @return [Boolean, nil]
|
17
|
-
optional :allow_invoice_credit_or_void, Orb::Internal::Type::
|
17
|
+
optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true
|
18
18
|
|
19
19
|
# @!attribute effective_date
|
20
20
|
# The date on which the phase change should take effect. If not provided, defaults
|
@@ -30,7 +30,7 @@ module Orb
|
|
30
30
|
# the plan's behavior. If null, defaults to the customer's setting.
|
31
31
|
#
|
32
32
|
# @return [Boolean, nil]
|
33
|
-
required :auto_collection, Orb::Internal::Type::
|
33
|
+
required :auto_collection, Orb::Internal::Type::Boolean, nil?: true
|
34
34
|
|
35
35
|
# @!attribute billing_cycle_anchor_configuration
|
36
36
|
#
|
@@ -337,7 +337,7 @@ module Orb
|
|
337
337
|
# that apply to only one price.
|
338
338
|
#
|
339
339
|
# @return [Boolean]
|
340
|
-
required :is_invoice_level, Orb::Internal::Type::
|
340
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
341
341
|
|
342
342
|
# @!attribute plan_phase_order
|
343
343
|
# The plan phase in which this adjustment is active.
|
@@ -412,7 +412,7 @@ module Orb
|
|
412
412
|
# that apply to only one price.
|
413
413
|
#
|
414
414
|
# @return [Boolean]
|
415
|
-
required :is_invoice_level, Orb::Internal::Type::
|
415
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
416
416
|
|
417
417
|
# @!attribute plan_phase_order
|
418
418
|
# The plan phase in which this adjustment is active.
|
@@ -473,7 +473,7 @@ module Orb
|
|
473
473
|
# that apply to only one price.
|
474
474
|
#
|
475
475
|
# @return [Boolean]
|
476
|
-
required :is_invoice_level, Orb::Internal::Type::
|
476
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
477
477
|
|
478
478
|
# @!attribute percentage_discount
|
479
479
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
@@ -541,7 +541,7 @@ module Orb
|
|
541
541
|
# that apply to only one price.
|
542
542
|
#
|
543
543
|
# @return [Boolean]
|
544
|
-
required :is_invoice_level, Orb::Internal::Type::
|
544
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
545
545
|
|
546
546
|
# @!attribute item_id
|
547
547
|
# The item ID that revenue from this minimum will be attributed to.
|
@@ -617,7 +617,7 @@ module Orb
|
|
617
617
|
# that apply to only one price.
|
618
618
|
#
|
619
619
|
# @return [Boolean]
|
620
|
-
required :is_invoice_level, Orb::Internal::Type::
|
620
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
621
621
|
|
622
622
|
# @!attribute maximum_amount
|
623
623
|
# The maximum amount to charge in a given billing period for the prices this
|