orb-billing 1.54.0 → 1.55.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.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +496 -6
  5. data/lib/orb/models/beta_create_plan_version_params.rb +496 -6
  6. data/lib/orb/models/changed_subscription_resources.rb +2 -2
  7. data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb +4 -4
  8. data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb +4 -4
  9. data/lib/orb/models/credit_block_list_invoices_response.rb +4 -4
  10. data/lib/orb/models/credit_block_retrieve_response.rb +4 -4
  11. data/lib/orb/models/credit_block_update_response.rb +4 -4
  12. data/lib/orb/models/customer_credit_ledger_incremented_webhook_event.rb +4 -4
  13. data/lib/orb/models/dimensional_price_groups/price_create_response.rb +2 -2
  14. data/lib/orb/models/invoice.rb +2 -2
  15. data/lib/orb/models/invoice_edited_webhook_event.rb +2 -2
  16. data/lib/orb/models/invoice_fetch_upcoming_response.rb +2 -2
  17. data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
  18. data/lib/orb/models/per_price_cost.rb +2 -2
  19. data/lib/orb/models/plan.rb +2 -2
  20. data/lib/orb/models/plan_create_params.rb +246 -3
  21. data/lib/orb/models/plan_version.rb +2 -2
  22. data/lib/orb/models/price.rb +416 -1
  23. data/lib/orb/models/price_create_params.rb +231 -3
  24. data/lib/orb/models/price_edited_webhook_event.rb +2 -2
  25. data/lib/orb/models/price_evaluate_multiple_params.rb +238 -3
  26. data/lib/orb/models/price_evaluate_preview_events_params.rb +238 -3
  27. data/lib/orb/models/price_interval.rb +2 -2
  28. data/lib/orb/models/subscription_create_params.rb +495 -6
  29. data/lib/orb/models/subscription_price_intervals_params.rb +238 -3
  30. data/lib/orb/models/subscription_schedule_plan_change_params.rb +496 -6
  31. data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +4 -4
  32. data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +4 -4
  33. data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +4 -4
  34. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +2 -2
  35. data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +2 -2
  36. data/lib/orb/resources/credit_blocks.rb +1 -1
  37. data/lib/orb/resources/dimensional_price_groups/prices.rb +1 -1
  38. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  39. data/lib/orb/resources/prices.rb +5 -5
  40. data/lib/orb/version.rb +1 -1
  41. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +2939 -2129
  42. data/rbi/orb/models/beta_create_plan_version_params.rbi +2937 -2127
  43. data/rbi/orb/models/changed_subscription_resources.rbi +2 -1
  44. data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi +5 -5
  45. data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi +5 -5
  46. data/rbi/orb/models/credit_block_list_invoices_response.rbi +5 -5
  47. data/rbi/orb/models/credit_block_retrieve_response.rbi +5 -5
  48. data/rbi/orb/models/credit_block_update_response.rbi +5 -5
  49. data/rbi/orb/models/customer_credit_ledger_incremented_webhook_event.rbi +5 -5
  50. data/rbi/orb/models/dimensional_price_groups/price_create_response.rbi +2 -1
  51. data/rbi/orb/models/invoice.rbi +2 -1
  52. data/rbi/orb/models/invoice_edited_webhook_event.rbi +2 -1
  53. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2 -1
  54. data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -1
  55. data/rbi/orb/models/per_price_cost.rbi +2 -1
  56. data/rbi/orb/models/plan.rbi +2 -1
  57. data/rbi/orb/models/plan_create_params.rbi +409 -4
  58. data/rbi/orb/models/plan_version.rbi +2 -1
  59. data/rbi/orb/models/price.rbi +716 -1
  60. data/rbi/orb/models/price_create_params.rbi +397 -4
  61. data/rbi/orb/models/price_edited_webhook_event.rbi +2 -1
  62. data/rbi/orb/models/price_evaluate_multiple_params.rbi +397 -4
  63. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +397 -4
  64. data/rbi/orb/models/price_interval.rbi +2 -1
  65. data/rbi/orb/models/subscription_create_params.rbi +2676 -1866
  66. data/rbi/orb/models/subscription_price_intervals_params.rbi +397 -4
  67. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +2686 -1876
  68. data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +5 -5
  69. data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +5 -5
  70. data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +5 -5
  71. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2 -1
  72. data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +2 -1
  73. data/rbi/orb/resources/credit_blocks.rbi +1 -1
  74. data/rbi/orb/resources/prices.rbi +2 -1
  75. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +322 -0
  76. data/sig/orb/models/beta_create_plan_version_params.rbs +322 -0
  77. data/sig/orb/models/credit_block_accounting_sync_failed_webhook_event.rbs +2 -2
  78. data/sig/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbs +2 -2
  79. data/sig/orb/models/credit_block_list_invoices_response.rbs +2 -2
  80. data/sig/orb/models/credit_block_retrieve_response.rbs +2 -2
  81. data/sig/orb/models/credit_block_update_response.rbs +2 -2
  82. data/sig/orb/models/customer_credit_ledger_incremented_webhook_event.rbs +2 -2
  83. data/sig/orb/models/plan_create_params.rbs +161 -0
  84. data/sig/orb/models/price.rbs +305 -0
  85. data/sig/orb/models/price_create_params.rbs +151 -0
  86. data/sig/orb/models/price_evaluate_multiple_params.rbs +156 -0
  87. data/sig/orb/models/price_evaluate_preview_events_params.rbs +156 -0
  88. data/sig/orb/models/subscription_create_params.rbs +322 -0
  89. data/sig/orb/models/subscription_price_intervals_params.rbs +156 -0
  90. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +322 -0
  91. data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +2 -2
  92. data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +2 -2
  93. data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +2 -2
  94. metadata +1 -1
@@ -1492,7 +1492,8 @@ module Orb
1492
1492
  Orb::Price::MeteredAllowance::OrHash,
1493
1493
  Orb::Price::MinimumComposite::OrHash,
1494
1494
  Orb::Price::Percent::OrHash,
1495
- Orb::Price::EventOutput::OrHash
1495
+ Orb::Price::EventOutput::OrHash,
1496
+ Orb::Price::UnitWithMultiplier::OrHash
1496
1497
  ),
1497
1498
  quantity: Float,
1498
1499
  start_date: Time,
@@ -334,7 +334,7 @@ module Orb
334
334
  sig { returns(T.nilable(String)) }
335
335
  attr_accessor :per_unit_cost_basis
336
336
 
337
- # `void` means the credit block was deleted. A voided block's `balance` is
337
+ # A deleted credit block keeps its historical fields, and its `balance` is
338
338
  # always 0.
339
339
  sig do
340
340
  returns(
@@ -432,7 +432,7 @@ module Orb
432
432
  # `null`.
433
433
  metadata:,
434
434
  per_unit_cost_basis:,
435
- # `void` means the credit block was deleted. A voided block's `balance` is
435
+ # A deleted credit block keeps its historical fields, and its `balance` is
436
436
  # always 0.
437
437
  status:,
438
438
  # The credit allocation that funded a block. Extends the allocation resource
@@ -673,7 +673,7 @@ module Orb
673
673
  end
674
674
  end
675
675
 
676
- # `void` means the credit block was deleted. A voided block's `balance` is
676
+ # A deleted credit block keeps its historical fields, and its `balance` is
677
677
  # always 0.
678
678
  module Status
679
679
  extend Orb::Internal::Type::Enum
@@ -697,9 +697,9 @@ module Orb
697
697
  :pending_payment,
698
698
  Orb::CreditBlockAccountingSyncFailedWebhookEvent::Block::Status::TaggedSymbol
699
699
  )
700
- VOID =
700
+ DELETED =
701
701
  T.let(
702
- :void,
702
+ :deleted,
703
703
  Orb::CreditBlockAccountingSyncFailedWebhookEvent::Block::Status::TaggedSymbol
704
704
  )
705
705
 
@@ -338,7 +338,7 @@ module Orb
338
338
  sig { returns(T.nilable(String)) }
339
339
  attr_accessor :per_unit_cost_basis
340
340
 
341
- # `void` means the credit block was deleted. A voided block's `balance` is
341
+ # A deleted credit block keeps its historical fields, and its `balance` is
342
342
  # always 0.
343
343
  sig do
344
344
  returns(
@@ -436,7 +436,7 @@ module Orb
436
436
  # `null`.
437
437
  metadata:,
438
438
  per_unit_cost_basis:,
439
- # `void` means the credit block was deleted. A voided block's `balance` is
439
+ # A deleted credit block keeps its historical fields, and its `balance` is
440
440
  # always 0.
441
441
  status:,
442
442
  # The credit allocation that funded a block. Extends the allocation resource
@@ -677,7 +677,7 @@ module Orb
677
677
  end
678
678
  end
679
679
 
680
- # `void` means the credit block was deleted. A voided block's `balance` is
680
+ # A deleted credit block keeps its historical fields, and its `balance` is
681
681
  # always 0.
682
682
  module Status
683
683
  extend Orb::Internal::Type::Enum
@@ -701,9 +701,9 @@ module Orb
701
701
  :pending_payment,
702
702
  Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Status::TaggedSymbol
703
703
  )
704
- VOID =
704
+ DELETED =
705
705
  T.let(
706
- :void,
706
+ :deleted,
707
707
  Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Status::TaggedSymbol
708
708
  )
709
709
 
@@ -110,7 +110,7 @@ module Orb
110
110
  sig { returns(T.nilable(String)) }
111
111
  attr_accessor :per_unit_cost_basis
112
112
 
113
- # `void` means the credit block was deleted. A voided block's `balance` is
113
+ # A deleted credit block keeps its historical fields, and its `balance` is
114
114
  # always 0.
115
115
  sig do
116
116
  returns(
@@ -208,7 +208,7 @@ module Orb
208
208
  # `null`.
209
209
  metadata:,
210
210
  per_unit_cost_basis:,
211
- # `void` means the credit block was deleted. A voided block's `balance` is
211
+ # A deleted credit block keeps its historical fields, and its `balance` is
212
212
  # always 0.
213
213
  status:,
214
214
  # The credit allocation that funded a block. Extends the allocation resource
@@ -449,7 +449,7 @@ module Orb
449
449
  end
450
450
  end
451
451
 
452
- # `void` means the credit block was deleted. A voided block's `balance` is
452
+ # A deleted credit block keeps its historical fields, and its `balance` is
453
453
  # always 0.
454
454
  module Status
455
455
  extend Orb::Internal::Type::Enum
@@ -473,9 +473,9 @@ module Orb
473
473
  :pending_payment,
474
474
  Orb::Models::CreditBlockListInvoicesResponse::Block::Status::TaggedSymbol
475
475
  )
476
- VOID =
476
+ DELETED =
477
477
  T.let(
478
- :void,
478
+ :deleted,
479
479
  Orb::Models::CreditBlockListInvoicesResponse::Block::Status::TaggedSymbol
480
480
  )
481
481
 
@@ -53,7 +53,7 @@ module Orb
53
53
  sig { returns(T.nilable(String)) }
54
54
  attr_accessor :per_unit_cost_basis
55
55
 
56
- # `void` means the credit block was deleted. A voided block's `balance` is
56
+ # A deleted credit block keeps its historical fields, and its `balance` is
57
57
  # always 0.
58
58
  sig do
59
59
  returns(Orb::Models::CreditBlockRetrieveResponse::Status::TaggedSymbol)
@@ -142,7 +142,7 @@ module Orb
142
142
  # `null`.
143
143
  metadata:,
144
144
  per_unit_cost_basis:,
145
- # `void` means the credit block was deleted. A voided block's `balance` is
145
+ # A deleted credit block keeps its historical fields, and its `balance` is
146
146
  # always 0.
147
147
  status:,
148
148
  # The credit allocation that funded a block. Extends the allocation resource
@@ -380,7 +380,7 @@ module Orb
380
380
  end
381
381
  end
382
382
 
383
- # `void` means the credit block was deleted. A voided block's `balance` is
383
+ # A deleted credit block keeps its historical fields, and its `balance` is
384
384
  # always 0.
385
385
  module Status
386
386
  extend Orb::Internal::Type::Enum
@@ -401,9 +401,9 @@ module Orb
401
401
  :pending_payment,
402
402
  Orb::Models::CreditBlockRetrieveResponse::Status::TaggedSymbol
403
403
  )
404
- VOID =
404
+ DELETED =
405
405
  T.let(
406
- :void,
406
+ :deleted,
407
407
  Orb::Models::CreditBlockRetrieveResponse::Status::TaggedSymbol
408
408
  )
409
409
 
@@ -48,7 +48,7 @@ module Orb
48
48
  sig { returns(T.nilable(String)) }
49
49
  attr_accessor :per_unit_cost_basis
50
50
 
51
- # `void` means the credit block was deleted. A voided block's `balance` is
51
+ # A deleted credit block keeps its historical fields, and its `balance` is
52
52
  # always 0.
53
53
  sig do
54
54
  returns(Orb::Models::CreditBlockUpdateResponse::Status::TaggedSymbol)
@@ -137,7 +137,7 @@ module Orb
137
137
  # `null`.
138
138
  metadata:,
139
139
  per_unit_cost_basis:,
140
- # `void` means the credit block was deleted. A voided block's `balance` is
140
+ # A deleted credit block keeps its historical fields, and its `balance` is
141
141
  # always 0.
142
142
  status:,
143
143
  # The credit allocation that funded a block. Extends the allocation resource
@@ -375,7 +375,7 @@ module Orb
375
375
  end
376
376
  end
377
377
 
378
- # `void` means the credit block was deleted. A voided block's `balance` is
378
+ # A deleted credit block keeps its historical fields, and its `balance` is
379
379
  # always 0.
380
380
  module Status
381
381
  extend Orb::Internal::Type::Enum
@@ -396,9 +396,9 @@ module Orb
396
396
  :pending_payment,
397
397
  Orb::Models::CreditBlockUpdateResponse::Status::TaggedSymbol
398
398
  )
399
- VOID =
399
+ DELETED =
400
400
  T.let(
401
- :void,
401
+ :deleted,
402
402
  Orb::Models::CreditBlockUpdateResponse::Status::TaggedSymbol
403
403
  )
404
404
 
@@ -298,7 +298,7 @@ module Orb
298
298
  sig { returns(T.nilable(String)) }
299
299
  attr_accessor :per_unit_cost_basis
300
300
 
301
- # `void` means the credit block was deleted. A voided block's `balance` is
301
+ # A deleted credit block keeps its historical fields, and its `balance` is
302
302
  # always 0.
303
303
  sig do
304
304
  returns(
@@ -396,7 +396,7 @@ module Orb
396
396
  # `null`.
397
397
  metadata:,
398
398
  per_unit_cost_basis:,
399
- # `void` means the credit block was deleted. A voided block's `balance` is
399
+ # A deleted credit block keeps its historical fields, and its `balance` is
400
400
  # always 0.
401
401
  status:,
402
402
  # The credit allocation that funded a block. Extends the allocation resource
@@ -637,7 +637,7 @@ module Orb
637
637
  end
638
638
  end
639
639
 
640
- # `void` means the credit block was deleted. A voided block's `balance` is
640
+ # A deleted credit block keeps its historical fields, and its `balance` is
641
641
  # always 0.
642
642
  module Status
643
643
  extend Orb::Internal::Type::Enum
@@ -661,9 +661,9 @@ module Orb
661
661
  :pending_payment,
662
662
  Orb::CustomerCreditLedgerIncrementedWebhookEvent::Properties::Block::Status::TaggedSymbol
663
663
  )
664
- VOID =
664
+ DELETED =
665
665
  T.let(
666
- :void,
666
+ :deleted,
667
667
  Orb::CustomerCreditLedgerIncrementedWebhookEvent::Properties::Block::Status::TaggedSymbol
668
668
  )
669
669
 
@@ -56,7 +56,8 @@ module Orb
56
56
  Orb::Price::MeteredAllowance::OrHash,
57
57
  Orb::Price::MinimumComposite::OrHash,
58
58
  Orb::Price::Percent::OrHash,
59
- Orb::Price::EventOutput::OrHash
59
+ Orb::Price::EventOutput::OrHash,
60
+ Orb::Price::UnitWithMultiplier::OrHash
60
61
  )
61
62
  ]
62
63
  ).returns(T.attached_class)
@@ -1297,7 +1297,8 @@ module Orb
1297
1297
  Orb::Price::MeteredAllowance::OrHash,
1298
1298
  Orb::Price::MinimumComposite::OrHash,
1299
1299
  Orb::Price::Percent::OrHash,
1300
- Orb::Price::EventOutput::OrHash
1300
+ Orb::Price::EventOutput::OrHash,
1301
+ Orb::Price::UnitWithMultiplier::OrHash
1301
1302
  ),
1302
1303
  quantity: Float,
1303
1304
  start_date: Time,
@@ -469,7 +469,8 @@ module Orb
469
469
  Orb::Price::MeteredAllowance::OrHash,
470
470
  Orb::Price::MinimumComposite::OrHash,
471
471
  Orb::Price::Percent::OrHash,
472
- Orb::Price::EventOutput::OrHash
472
+ Orb::Price::EventOutput::OrHash,
473
+ Orb::Price::UnitWithMultiplier::OrHash
473
474
  ),
474
475
  quantity: Float,
475
476
  start_date: Time,
@@ -1400,7 +1400,8 @@ module Orb
1400
1400
  Orb::Price::MeteredAllowance::OrHash,
1401
1401
  Orb::Price::MinimumComposite::OrHash,
1402
1402
  Orb::Price::Percent::OrHash,
1403
- Orb::Price::EventOutput::OrHash
1403
+ Orb::Price::EventOutput::OrHash,
1404
+ Orb::Price::UnitWithMultiplier::OrHash
1404
1405
  ),
1405
1406
  quantity: Float,
1406
1407
  start_date: Time,
@@ -167,7 +167,8 @@ module Orb
167
167
  Orb::Price::MeteredAllowance::OrHash,
168
168
  Orb::Price::MinimumComposite::OrHash,
169
169
  Orb::Price::Percent::OrHash,
170
- Orb::Price::EventOutput::OrHash
170
+ Orb::Price::EventOutput::OrHash,
171
+ Orb::Price::UnitWithMultiplier::OrHash
171
172
  ),
172
173
  quantity: Float,
173
174
  start_date: Time,
@@ -64,7 +64,8 @@ module Orb
64
64
  Orb::Price::MeteredAllowance::OrHash,
65
65
  Orb::Price::MinimumComposite::OrHash,
66
66
  Orb::Price::Percent::OrHash,
67
- Orb::Price::EventOutput::OrHash
67
+ Orb::Price::EventOutput::OrHash,
68
+ Orb::Price::UnitWithMultiplier::OrHash
68
69
  ),
69
70
  price_id: String,
70
71
  subtotal: String,
@@ -200,7 +200,8 @@ module Orb
200
200
  Orb::Price::MeteredAllowance::OrHash,
201
201
  Orb::Price::MinimumComposite::OrHash,
202
202
  Orb::Price::Percent::OrHash,
203
- Orb::Price::EventOutput::OrHash
203
+ Orb::Price::EventOutput::OrHash,
204
+ Orb::Price::UnitWithMultiplier::OrHash
204
205
  )
205
206
  ],
206
207
  product: Orb::Plan::Product::OrHash,