orb-billing 1.46.0 → 1.48.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 (160) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -1
  3. data/README.md +1 -1
  4. data/lib/orb/models/credit_block_update_params.rb +34 -0
  5. data/lib/orb/models/credit_block_update_response.rb +332 -0
  6. data/lib/orb/models/invoice_issue_summary_response.rb +2 -1
  7. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +5 -3
  8. data/lib/orb/models/invoice_list_summary_response.rb +2 -1
  9. data/lib/orb/models/metric_archive_params.rb +20 -0
  10. data/lib/orb/models/metric_list_params.rb +21 -1
  11. data/lib/orb/models/metric_unarchive_params.rb +20 -0
  12. data/lib/orb/models/metric_update_params.rb +17 -1
  13. data/lib/orb/models/plan_update_params.rb +9 -1
  14. data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
  15. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +5 -9
  16. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +5 -9
  17. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +5 -9
  18. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +5 -9
  19. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +5 -9
  20. data/lib/orb/models/webhook_endpoint.rb +28 -1
  21. data/lib/orb/models/webhook_endpoint_create_params.rb +22 -1
  22. data/lib/orb/models/webhook_endpoint_update_params.rb +22 -1
  23. data/lib/orb/models/webhook_endpoint_with_secret.rb +28 -1
  24. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +5 -3
  25. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  26. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +5 -3
  27. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +5 -3
  28. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +5 -3
  29. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +5 -3
  30. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +5 -3
  31. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +5 -3
  32. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +5 -3
  33. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +5 -3
  34. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +5 -3
  35. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +5 -3
  36. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +5 -3
  37. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +5 -3
  38. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +5 -3
  39. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +5 -3
  40. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +5 -3
  41. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +5 -3
  42. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +5 -3
  43. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  44. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +9 -7
  45. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +9 -7
  46. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +5 -9
  47. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +9 -7
  48. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +9 -7
  49. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +9 -7
  50. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +9 -7
  51. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +9 -7
  52. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +9 -7
  53. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +9 -7
  54. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +5 -9
  55. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +5 -9
  56. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +5 -9
  57. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +5 -9
  58. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +9 -7
  59. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +9 -7
  60. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +9 -7
  61. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +9 -7
  62. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +9 -7
  63. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +9 -7
  64. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +9 -7
  65. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +9 -7
  66. data/lib/orb/models.rb +6 -0
  67. data/lib/orb/resources/credit_blocks.rb +35 -0
  68. data/lib/orb/resources/metrics.rb +61 -5
  69. data/lib/orb/resources/plans/external_plan_id.rb +6 -3
  70. data/lib/orb/resources/plans.rb +6 -3
  71. data/lib/orb/resources/webhook_endpoints.rb +6 -2
  72. data/lib/orb/version.rb +1 -1
  73. data/lib/orb.rb +4 -0
  74. data/rbi/orb/models/credit_block_update_params.rbi +53 -0
  75. data/rbi/orb/models/credit_block_update_response.rbi +693 -0
  76. data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
  77. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
  78. data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
  79. data/rbi/orb/models/metric_archive_params.rbi +33 -0
  80. data/rbi/orb/models/metric_list_params.rbi +29 -0
  81. data/rbi/orb/models/metric_unarchive_params.rbi +35 -0
  82. data/rbi/orb/models/metric_update_params.rbi +16 -0
  83. data/rbi/orb/models/plan_update_params.rbi +8 -0
  84. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
  85. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
  86. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
  87. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
  88. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
  89. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
  90. data/rbi/orb/models/webhook_endpoint.rbi +39 -0
  91. data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
  92. data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
  93. data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
  94. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  95. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  96. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +6 -3
  97. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +6 -3
  98. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +6 -3
  99. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +6 -3
  100. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +6 -3
  101. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +6 -3
  102. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +6 -3
  103. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +6 -3
  104. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +6 -3
  105. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +6 -3
  106. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +6 -3
  107. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +6 -3
  108. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +6 -3
  109. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +6 -3
  110. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +6 -3
  111. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +6 -3
  112. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  113. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  114. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +12 -9
  115. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +12 -9
  116. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +6 -12
  117. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +12 -9
  118. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +12 -9
  119. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +12 -9
  120. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +12 -9
  121. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +12 -9
  122. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +12 -9
  123. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +12 -9
  124. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +6 -12
  125. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +6 -12
  126. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +6 -12
  127. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +6 -12
  128. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +12 -9
  129. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +12 -9
  130. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +12 -9
  131. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +12 -9
  132. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +12 -9
  133. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +12 -9
  134. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +12 -9
  135. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +12 -9
  136. data/rbi/orb/models.rbi +6 -0
  137. data/rbi/orb/resources/credit_blocks.rbi +26 -0
  138. data/rbi/orb/resources/metrics.rbi +44 -3
  139. data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
  140. data/rbi/orb/resources/plans.rbi +6 -2
  141. data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
  142. data/sig/orb/models/credit_block_update_params.rbs +28 -0
  143. data/sig/orb/models/credit_block_update_response.rbs +263 -0
  144. data/sig/orb/models/metric_archive_params.rbs +23 -0
  145. data/sig/orb/models/metric_list_params.rbs +18 -1
  146. data/sig/orb/models/metric_unarchive_params.rbs +23 -0
  147. data/sig/orb/models/metric_update_params.rbs +14 -1
  148. data/sig/orb/models/plan_update_params.rbs +6 -1
  149. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
  150. data/sig/orb/models/webhook_endpoint.rbs +16 -0
  151. data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
  152. data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
  153. data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
  154. data/sig/orb/models.rbs +6 -0
  155. data/sig/orb/resources/credit_blocks.rbs +6 -0
  156. data/sig/orb/resources/metrics.rbs +13 -0
  157. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  158. data/sig/orb/resources/plans.rbs +1 -0
  159. data/sig/orb/resources/webhook_endpoints.rbs +2 -0
  160. metadata +13 -1
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
88
89
  id:,
89
90
  # The time at which this event was created, to the second.
90
91
  created_at:,
91
- # #InvoiceApiResourceWithoutLineItems
92
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
93
+ # Fetch the invoice for those.
92
94
  invoice:,
93
95
  # The serialization style this payload was rendered in, as configured on the
94
96
  # endpoint.
@@ -488,7 +490,8 @@ module Orb
488
490
  sig { returns(T::Boolean) }
489
491
  attr_accessor :will_auto_issue
490
492
 
491
- # #InvoiceApiResourceWithoutLineItems
493
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
494
+ # Fetch the invoice for those.
492
495
  sig do
493
496
  params(
494
497
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice
@@ -75,7 +76,8 @@ module Orb
75
76
  id:,
76
77
  # The time at which this event was created, to the second.
77
78
  created_at:,
78
- # #InvoiceApiResourceWithoutLineItems
79
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
80
+ # Fetch the invoice for those.
79
81
  invoice:,
80
82
  # The serialization style this payload was rendered in, as configured on the
81
83
  # endpoint.
@@ -474,7 +476,8 @@ module Orb
474
476
  sig { returns(T::Boolean) }
475
477
  attr_accessor :will_auto_issue
476
478
 
477
- # #InvoiceApiResourceWithoutLineItems
479
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
480
+ # Fetch the invoice for those.
478
481
  sig do
479
482
  params(
480
483
  id: String,
@@ -35,7 +35,8 @@ module Orb
35
35
  sig { returns(Time) }
36
36
  attr_accessor :created_at
37
37
 
38
- # #InvoiceApiResourceWithoutLineItems
38
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
39
+ # Fetch the invoice for those.
39
40
  sig do
40
41
  returns(
41
42
  Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice
@@ -106,7 +107,8 @@ module Orb
106
107
  accounting_sync_record:,
107
108
  # The time at which this event was created, to the second.
108
109
  created_at:,
109
- # #InvoiceApiResourceWithoutLineItems
110
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
111
+ # Fetch the invoice for those.
110
112
  invoice:,
111
113
  # The serialization style this payload was rendered in, as configured on the
112
114
  # endpoint.
@@ -653,7 +655,8 @@ module Orb
653
655
  sig { returns(T::Boolean) }
654
656
  attr_accessor :will_auto_issue
655
657
 
656
- # #InvoiceApiResourceWithoutLineItems
658
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
659
+ # Fetch the invoice for those.
657
660
  sig do
658
661
  params(
659
662
  id: String,
@@ -35,7 +35,8 @@ module Orb
35
35
  sig { returns(Time) }
36
36
  attr_accessor :created_at
37
37
 
38
- # #InvoiceApiResourceWithoutLineItems
38
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
39
+ # Fetch the invoice for those.
39
40
  sig do
40
41
  returns(
41
42
  Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice
@@ -106,7 +107,8 @@ module Orb
106
107
  accounting_sync_record:,
107
108
  # The time at which this event was created, to the second.
108
109
  created_at:,
109
- # #InvoiceApiResourceWithoutLineItems
110
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
111
+ # Fetch the invoice for those.
110
112
  invoice:,
111
113
  # The serialization style this payload was rendered in, as configured on the
112
114
  # endpoint.
@@ -653,7 +655,8 @@ module Orb
653
655
  sig { returns(T::Boolean) }
654
656
  attr_accessor :will_auto_issue
655
657
 
656
- # #InvoiceApiResourceWithoutLineItems
658
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
659
+ # Fetch the invoice for those.
657
660
  sig do
658
661
  params(
659
662
  id: String,
@@ -59,9 +59,10 @@ module Orb
59
59
  end
60
60
  attr_writer :properties
61
61
 
62
- # The subscription in a standard webhook payload: the fields readable without
63
- # to_subscription_params(), which every interval, billing period and plan phase
64
- # depends on.
62
+ # A subscription's own fields, with its plan and customer as references, as listed
63
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
64
+ # the subscription for its price intervals, billing periods, plan phases and other
65
+ # derived fields.
65
66
  sig do
66
67
  returns(
67
68
  Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Subscription
@@ -112,9 +113,10 @@ module Orb
112
113
  # endpoint.
113
114
  payload_style:,
114
115
  properties:,
115
- # The subscription in a standard webhook payload: the fields readable without
116
- # to_subscription_params(), which every interval, billing period and plan phase
117
- # depends on.
116
+ # A subscription's own fields, with its plan and customer as references, as listed
117
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
118
+ # the subscription for its price intervals, billing periods, plan phases and other
119
+ # derived fields.
118
120
  subscription:,
119
121
  # The event this payload describes.
120
122
  type:
@@ -421,9 +423,10 @@ module Orb
421
423
  end
422
424
  attr_accessor :status
423
425
 
424
- # The subscription in a standard webhook payload: the fields readable without
425
- # to_subscription_params(), which every interval, billing period and plan phase
426
- # depends on.
426
+ # A subscription's own fields, with its plan and customer as references, as listed
427
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
428
+ # the subscription for its price intervals, billing periods, plan phases and other
429
+ # derived fields.
427
430
  sig do
428
431
  params(
429
432
  id: String,
@@ -59,9 +59,10 @@ module Orb
59
59
  end
60
60
  attr_writer :properties
61
61
 
62
- # The subscription in a standard webhook payload: the fields readable without
63
- # to_subscription_params(), which every interval, billing period and plan phase
64
- # depends on.
62
+ # A subscription's own fields, with its plan and customer as references, as listed
63
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
64
+ # the subscription for its price intervals, billing periods, plan phases and other
65
+ # derived fields.
65
66
  sig do
66
67
  returns(
67
68
  Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Subscription
@@ -112,9 +113,10 @@ module Orb
112
113
  # endpoint.
113
114
  payload_style:,
114
115
  properties:,
115
- # The subscription in a standard webhook payload: the fields readable without
116
- # to_subscription_params(), which every interval, billing period and plan phase
117
- # depends on.
116
+ # A subscription's own fields, with its plan and customer as references, as listed
117
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
118
+ # the subscription for its price intervals, billing periods, plan phases and other
119
+ # derived fields.
118
120
  subscription:,
119
121
  # The event this payload describes.
120
122
  type:
@@ -410,9 +412,10 @@ module Orb
410
412
  end
411
413
  attr_accessor :status
412
414
 
413
- # The subscription in a standard webhook payload: the fields readable without
414
- # to_subscription_params(), which every interval, billing period and plan phase
415
- # depends on.
415
+ # A subscription's own fields, with its plan and customer as references, as listed
416
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
417
+ # the subscription for its price intervals, billing periods, plan phases and other
418
+ # derived fields.
416
419
  sig do
417
420
  params(
418
421
  id: String,
@@ -46,10 +46,8 @@ module Orb
46
46
  end
47
47
  attr_writer :properties
48
48
 
49
- # A lightweight subscription representation for webhook payloads.
50
- #
51
- # This avoids the expensive to_subscription_params() call required for full
52
- # serialization.
49
+ # The subscription in a license or grouped cost webhook payload: its status,
50
+ # dates, plan and customer.
53
51
  sig do
54
52
  returns(
55
53
  Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription
@@ -99,10 +97,8 @@ module Orb
99
97
  # Sent when the system disables an alert on its own, currently for
100
98
  # cardinality-limit enforcement on grouped cost alerts.
101
99
  properties:,
102
- # A lightweight subscription representation for webhook payloads.
103
- #
104
- # This avoids the expensive to_subscription_params() call required for full
105
- # serialization.
100
+ # The subscription in a license or grouped cost webhook payload: its status,
101
+ # dates, plan and customer.
106
102
  subscription:,
107
103
  # The event this payload describes.
108
104
  type:
@@ -1136,10 +1132,8 @@ module Orb
1136
1132
  end
1137
1133
  attr_accessor :status
1138
1134
 
1139
- # A lightweight subscription representation for webhook payloads.
1140
- #
1141
- # This avoids the expensive to_subscription_params() call required for full
1142
- # serialization.
1135
+ # The subscription in a license or grouped cost webhook payload: its status,
1136
+ # dates, plan and customer.
1143
1137
  sig do
1144
1138
  params(
1145
1139
  id: String,
@@ -44,9 +44,10 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # A subscription's own fields, with its plan and customer as references, as listed
48
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
49
+ # the subscription for its price intervals, billing periods, plan phases and other
50
+ # derived fields.
50
51
  sig do
51
52
  returns(
52
53
  Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ module Orb
94
95
  # endpoint.
95
96
  payload_style:,
96
97
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
98
+ # A subscription's own fields, with its plan and customer as references, as listed
99
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
100
+ # the subscription for its price intervals, billing periods, plan phases and other
101
+ # derived fields.
100
102
  subscription:,
101
103
  # The event this payload describes.
102
104
  type:
@@ -245,9 +247,10 @@ module Orb
245
247
  end
246
248
  attr_accessor :status
247
249
 
248
- # The subscription in a standard webhook payload: the fields readable without
249
- # to_subscription_params(), which every interval, billing period and plan phase
250
- # depends on.
250
+ # A subscription's own fields, with its plan and customer as references, as listed
251
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
252
+ # the subscription for its price intervals, billing periods, plan phases and other
253
+ # derived fields.
251
254
  sig do
252
255
  params(
253
256
  id: String,
@@ -44,9 +44,10 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # A subscription's own fields, with its plan and customer as references, as listed
48
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
49
+ # the subscription for its price intervals, billing periods, plan phases and other
50
+ # derived fields.
50
51
  sig do
51
52
  returns(
52
53
  Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ module Orb
94
95
  # endpoint.
95
96
  payload_style:,
96
97
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
98
+ # A subscription's own fields, with its plan and customer as references, as listed
99
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
100
+ # the subscription for its price intervals, billing periods, plan phases and other
101
+ # derived fields.
100
102
  subscription:,
101
103
  # The event this payload describes.
102
104
  type:
@@ -247,9 +249,10 @@ module Orb
247
249
  end
248
250
  attr_accessor :status
249
251
 
250
- # The subscription in a standard webhook payload: the fields readable without
251
- # to_subscription_params(), which every interval, billing period and plan phase
252
- # depends on.
252
+ # A subscription's own fields, with its plan and customer as references, as listed
253
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
254
+ # the subscription for its price intervals, billing periods, plan phases and other
255
+ # derived fields.
253
256
  sig do
254
257
  params(
255
258
  id: String,
@@ -44,9 +44,10 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # A subscription's own fields, with its plan and customer as references, as listed
48
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
49
+ # the subscription for its price intervals, billing periods, plan phases and other
50
+ # derived fields.
50
51
  sig do
51
52
  returns(
52
53
  Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ module Orb
94
95
  # endpoint.
95
96
  payload_style:,
96
97
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
98
+ # A subscription's own fields, with its plan and customer as references, as listed
99
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
100
+ # the subscription for its price intervals, billing periods, plan phases and other
101
+ # derived fields.
100
102
  subscription:,
101
103
  # The event this payload describes.
102
104
  type:
@@ -1110,9 +1112,10 @@ module Orb
1110
1112
  end
1111
1113
  attr_accessor :status
1112
1114
 
1113
- # The subscription in a standard webhook payload: the fields readable without
1114
- # to_subscription_params(), which every interval, billing period and plan phase
1115
- # depends on.
1115
+ # A subscription's own fields, with its plan and customer as references, as listed
1116
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
1117
+ # the subscription for its price intervals, billing periods, plan phases and other
1118
+ # derived fields.
1116
1119
  sig do
1117
1120
  params(
1118
1121
  id: String,
@@ -32,9 +32,10 @@ module Orb
32
32
  sig { returns(T.anything) }
33
33
  attr_accessor :properties
34
34
 
35
- # The subscription in a standard webhook payload: the fields readable without
36
- # to_subscription_params(), which every interval, billing period and plan phase
37
- # depends on.
35
+ # A subscription's own fields, with its plan and customer as references, as listed
36
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
37
+ # the subscription for its price intervals, billing periods, plan phases and other
38
+ # derived fields.
38
39
  sig do
39
40
  returns(
40
41
  Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription
@@ -81,9 +82,10 @@ module Orb
81
82
  # endpoint.
82
83
  payload_style:,
83
84
  properties:,
84
- # The subscription in a standard webhook payload: the fields readable without
85
- # to_subscription_params(), which every interval, billing period and plan phase
86
- # depends on.
85
+ # A subscription's own fields, with its plan and customer as references, as listed
86
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
87
+ # the subscription for its price intervals, billing periods, plan phases and other
88
+ # derived fields.
87
89
  subscription:,
88
90
  # The event this payload describes.
89
91
  type:
@@ -210,9 +212,10 @@ module Orb
210
212
  end
211
213
  attr_accessor :status
212
214
 
213
- # The subscription in a standard webhook payload: the fields readable without
214
- # to_subscription_params(), which every interval, billing period and plan phase
215
- # depends on.
215
+ # A subscription's own fields, with its plan and customer as references, as listed
216
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
217
+ # the subscription for its price intervals, billing periods, plan phases and other
218
+ # derived fields.
216
219
  sig do
217
220
  params(
218
221
  id: String,
@@ -44,9 +44,10 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # A subscription's own fields, with its plan and customer as references, as listed
48
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
49
+ # the subscription for its price intervals, billing periods, plan phases and other
50
+ # derived fields.
50
51
  sig do
51
52
  returns(
52
53
  Orb::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ module Orb
94
95
  # endpoint.
95
96
  payload_style:,
96
97
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
98
+ # A subscription's own fields, with its plan and customer as references, as listed
99
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
100
+ # the subscription for its price intervals, billing periods, plan phases and other
101
+ # derived fields.
100
102
  subscription:,
101
103
  # The event this payload describes.
102
104
  type:
@@ -332,9 +334,10 @@ module Orb
332
334
  end
333
335
  attr_accessor :status
334
336
 
335
- # The subscription in a standard webhook payload: the fields readable without
336
- # to_subscription_params(), which every interval, billing period and plan phase
337
- # depends on.
337
+ # A subscription's own fields, with its plan and customer as references, as listed
338
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
339
+ # the subscription for its price intervals, billing periods, plan phases and other
340
+ # derived fields.
338
341
  sig do
339
342
  params(
340
343
  id: String,
@@ -32,9 +32,10 @@ module Orb
32
32
  sig { returns(T.anything) }
33
33
  attr_accessor :properties
34
34
 
35
- # The subscription in a standard webhook payload: the fields readable without
36
- # to_subscription_params(), which every interval, billing period and plan phase
37
- # depends on.
35
+ # A subscription's own fields, with its plan and customer as references, as listed
36
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
37
+ # the subscription for its price intervals, billing periods, plan phases and other
38
+ # derived fields.
38
39
  sig do
39
40
  returns(
40
41
  Orb::Webhooks::SubscriptionEndedStandardWebhookEvent::Subscription
@@ -81,9 +82,10 @@ module Orb
81
82
  # endpoint.
82
83
  payload_style:,
83
84
  properties:,
84
- # The subscription in a standard webhook payload: the fields readable without
85
- # to_subscription_params(), which every interval, billing period and plan phase
86
- # depends on.
85
+ # A subscription's own fields, with its plan and customer as references, as listed
86
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
87
+ # the subscription for its price intervals, billing periods, plan phases and other
88
+ # derived fields.
87
89
  subscription:,
88
90
  # The event this payload describes.
89
91
  type:
@@ -210,9 +212,10 @@ module Orb
210
212
  end
211
213
  attr_accessor :status
212
214
 
213
- # The subscription in a standard webhook payload: the fields readable without
214
- # to_subscription_params(), which every interval, billing period and plan phase
215
- # depends on.
215
+ # A subscription's own fields, with its plan and customer as references, as listed
216
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
217
+ # the subscription for its price intervals, billing periods, plan phases and other
218
+ # derived fields.
216
219
  sig do
217
220
  params(
218
221
  id: String,
@@ -44,9 +44,10 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # A subscription's own fields, with its plan and customer as references, as listed
48
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
49
+ # the subscription for its price intervals, billing periods, plan phases and other
50
+ # derived fields.
50
51
  sig do
51
52
  returns(
52
53
  Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ module Orb
94
95
  # endpoint.
95
96
  payload_style:,
96
97
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
98
+ # A subscription's own fields, with its plan and customer as references, as listed
99
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
100
+ # the subscription for its price intervals, billing periods, plan phases and other
101
+ # derived fields.
100
102
  subscription:,
101
103
  # The event this payload describes.
102
104
  type:
@@ -270,9 +272,10 @@ module Orb
270
272
  end
271
273
  attr_accessor :status
272
274
 
273
- # The subscription in a standard webhook payload: the fields readable without
274
- # to_subscription_params(), which every interval, billing period and plan phase
275
- # depends on.
275
+ # A subscription's own fields, with its plan and customer as references, as listed
276
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
277
+ # the subscription for its price intervals, billing periods, plan phases and other
278
+ # derived fields.
276
279
  sig do
277
280
  params(
278
281
  id: String,
@@ -46,10 +46,8 @@ module Orb
46
46
  end
47
47
  attr_writer :properties
48
48
 
49
- # A lightweight subscription representation for webhook payloads.
50
- #
51
- # This avoids the expensive to_subscription_params() call required for full
52
- # serialization.
49
+ # The subscription in a license or grouped cost webhook payload: its status,
50
+ # dates, plan and customer.
53
51
  sig do
54
52
  returns(
55
53
  Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Subscription
@@ -99,10 +97,8 @@ module Orb
99
97
  # Every group that crossed a threshold for one alert, batched into a single
100
98
  # message.
101
99
  properties:,
102
- # A lightweight subscription representation for webhook payloads.
103
- #
104
- # This avoids the expensive to_subscription_params() call required for full
105
- # serialization.
100
+ # The subscription in a license or grouped cost webhook payload: its status,
101
+ # dates, plan and customer.
106
102
  subscription:,
107
103
  # The event this payload describes.
108
104
  type:
@@ -1155,10 +1151,8 @@ module Orb
1155
1151
  end
1156
1152
  attr_accessor :status
1157
1153
 
1158
- # A lightweight subscription representation for webhook payloads.
1159
- #
1160
- # This avoids the expensive to_subscription_params() call required for full
1161
- # serialization.
1154
+ # The subscription in a license or grouped cost webhook payload: its status,
1155
+ # dates, plan and customer.
1162
1156
  sig do
1163
1157
  params(
1164
1158
  id: String,
@@ -44,10 +44,8 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # A lightweight subscription representation for webhook payloads.
48
- #
49
- # This avoids the expensive to_subscription_params() call required for full
50
- # serialization.
47
+ # The subscription in a license or grouped cost webhook payload: its status,
48
+ # dates, plan and customer.
51
49
  sig do
52
50
  returns(
53
51
  Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription
@@ -96,10 +94,8 @@ module Orb
96
94
  # endpoint.
97
95
  payload_style:,
98
96
  properties:,
99
- # A lightweight subscription representation for webhook payloads.
100
- #
101
- # This avoids the expensive to_subscription_params() call required for full
102
- # serialization.
97
+ # The subscription in a license or grouped cost webhook payload: its status,
98
+ # dates, plan and customer.
103
99
  subscription:,
104
100
  # The event this payload describes.
105
101
  type:
@@ -262,10 +258,8 @@ module Orb
262
258
  end
263
259
  attr_accessor :status
264
260
 
265
- # A lightweight subscription representation for webhook payloads.
266
- #
267
- # This avoids the expensive to_subscription_params() call required for full
268
- # serialization.
261
+ # The subscription in a license or grouped cost webhook payload: its status,
262
+ # dates, plan and customer.
269
263
  sig do
270
264
  params(
271
265
  id: String,