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
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice }
@@ -53,7 +54,7 @@ module Orb
53
54
  #
54
55
  # @param created_at [Time] The time at which this event was created, to the second.
55
56
  #
56
- # @param invoice [Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
57
+ # @param invoice [Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
57
58
  #
58
59
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
59
60
  #
@@ -443,7 +444,8 @@ module Orb
443
444
  # {Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice} for
444
445
  # more details.
445
446
  #
446
- # #InvoiceApiResourceWithoutLineItems
447
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
448
+ # Fetch the invoice for those.
447
449
  #
448
450
  # @param id [String]
449
451
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice }
@@ -52,7 +53,7 @@ module Orb
52
53
  #
53
54
  # @param created_at [Time] The time at which this event was created, to the second.
54
55
  #
55
- # @param invoice [Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
56
+ # @param invoice [Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
56
57
  #
57
58
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
58
59
  #
@@ -443,7 +444,8 @@ module Orb
443
444
  # {Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice}
444
445
  # for more details.
445
446
  #
446
- # #InvoiceApiResourceWithoutLineItems
447
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
448
+ # Fetch the invoice for those.
447
449
  #
448
450
  # @param id [String]
449
451
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice }
@@ -52,7 +53,7 @@ module Orb
52
53
  #
53
54
  # @param created_at [Time] The time at which this event was created, to the second.
54
55
  #
55
- # @param invoice [Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
56
+ # @param invoice [Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
56
57
  #
57
58
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
58
59
  #
@@ -443,7 +444,8 @@ module Orb
443
444
  # {Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice}
444
445
  # for more details.
445
446
  #
446
- # #InvoiceApiResourceWithoutLineItems
447
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
448
+ # Fetch the invoice for those.
447
449
  #
448
450
  # @param id [String]
449
451
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice }
@@ -53,7 +54,7 @@ module Orb
53
54
  #
54
55
  # @param created_at [Time] The time at which this event was created, to the second.
55
56
  #
56
- # @param invoice [Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
57
+ # @param invoice [Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
57
58
  #
58
59
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
59
60
  #
@@ -443,7 +444,8 @@ module Orb
443
444
  # {Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice} for
444
445
  # more details.
445
446
  #
446
- # #InvoiceApiResourceWithoutLineItems
447
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
448
+ # Fetch the invoice for those.
447
449
  #
448
450
  # @param id [String]
449
451
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice }
@@ -52,7 +53,7 @@ module Orb
52
53
  #
53
54
  # @param created_at [Time] The time at which this event was created, to the second.
54
55
  #
55
- # @param invoice [Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
56
+ # @param invoice [Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
56
57
  #
57
58
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
58
59
  #
@@ -443,7 +444,8 @@ module Orb
443
444
  # {Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice}
444
445
  # for more details.
445
446
  #
446
- # #InvoiceApiResourceWithoutLineItems
447
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
448
+ # Fetch the invoice for those.
447
449
  #
448
450
  # @param id [String]
449
451
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice }
@@ -54,7 +55,7 @@ module Orb
54
55
  #
55
56
  # @param created_at [Time] The time at which this event was created, to the second.
56
57
  #
57
- # @param invoice [Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
58
+ # @param invoice [Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
58
59
  #
59
60
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
60
61
  #
@@ -444,7 +445,8 @@ module Orb
444
445
  # {Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice}
445
446
  # for more details.
446
447
  #
447
- # #InvoiceApiResourceWithoutLineItems
448
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
449
+ # Fetch the invoice for those.
448
450
  #
449
451
  # @param id [String]
450
452
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice }
@@ -50,7 +51,7 @@ module Orb
50
51
  #
51
52
  # @param created_at [Time] The time at which this event was created, to the second.
52
53
  #
53
- # @param invoice [Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
54
+ # @param invoice [Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
54
55
  #
55
56
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
56
57
  #
@@ -440,7 +441,8 @@ module Orb
440
441
  # {Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice} for more
441
442
  # details.
442
443
  #
443
- # #InvoiceApiResourceWithoutLineItems
444
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
445
+ # Fetch the invoice for those.
444
446
  #
445
447
  # @param id [String]
446
448
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice }
@@ -52,7 +53,7 @@ module Orb
52
53
  #
53
54
  # @param created_at [Time] The time at which this event was created, to the second.
54
55
  #
55
- # @param invoice [Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
56
+ # @param invoice [Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
56
57
  #
57
58
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
58
59
  #
@@ -442,7 +443,8 @@ module Orb
442
443
  # {Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice} for
443
444
  # more details.
444
445
  #
445
- # #InvoiceApiResourceWithoutLineItems
446
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
447
+ # Fetch the invoice for those.
446
448
  #
447
449
  # @param id [String]
448
450
  #
@@ -17,7 +17,8 @@ module Orb
17
17
  required :created_at, Time
18
18
 
19
19
  # @!attribute invoice
20
- # #InvoiceApiResourceWithoutLineItems
20
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
21
+ # Fetch the invoice for those.
21
22
  #
22
23
  # @return [Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice]
23
24
  required :invoice, -> { Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice }
@@ -52,7 +53,7 @@ module Orb
52
53
  #
53
54
  # @param created_at [Time] The time at which this event was created, to the second.
54
55
  #
55
- # @param invoice [Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
56
+ # @param invoice [Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
56
57
  #
57
58
  # @param payload_style [Symbol, Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
58
59
  #
@@ -442,7 +443,8 @@ module Orb
442
443
  # {Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice} for
443
444
  # more details.
444
445
  #
445
- # #InvoiceApiResourceWithoutLineItems
446
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
447
+ # Fetch the invoice for those.
446
448
  #
447
449
  # @param id [String]
448
450
  #
@@ -23,7 +23,8 @@ module Orb
23
23
  required :created_at, Time
24
24
 
25
25
  # @!attribute invoice
26
- # #InvoiceApiResourceWithoutLineItems
26
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
27
+ # Fetch the invoice for those.
27
28
  #
28
29
  # @return [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice]
29
30
  required :invoice, -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice }
@@ -60,7 +61,7 @@ module Orb
60
61
  #
61
62
  # @param created_at [Time] The time at which this event was created, to the second.
62
63
  #
63
- # @param invoice [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
64
+ # @param invoice [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
64
65
  #
65
66
  # @param payload_style [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
66
67
  #
@@ -522,7 +523,8 @@ module Orb
522
523
  # {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice}
523
524
  # for more details.
524
525
  #
525
- # #InvoiceApiResourceWithoutLineItems
526
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
527
+ # Fetch the invoice for those.
526
528
  #
527
529
  # @param id [String]
528
530
  #
@@ -23,7 +23,8 @@ module Orb
23
23
  required :created_at, Time
24
24
 
25
25
  # @!attribute invoice
26
- # #InvoiceApiResourceWithoutLineItems
26
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
27
+ # Fetch the invoice for those.
27
28
  #
28
29
  # @return [Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice]
29
30
  required :invoice, -> { Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice }
@@ -61,7 +62,7 @@ module Orb
61
62
  #
62
63
  # @param created_at [Time] The time at which this event was created, to the second.
63
64
  #
64
- # @param invoice [Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
65
+ # @param invoice [Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
65
66
  #
66
67
  # @param payload_style [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
67
68
  #
@@ -523,7 +524,8 @@ module Orb
523
524
  # {Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice}
524
525
  # for more details.
525
526
  #
526
- # #InvoiceApiResourceWithoutLineItems
527
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
528
+ # Fetch the invoice for those.
527
529
  #
528
530
  # @param id [String]
529
531
  #
@@ -37,9 +37,10 @@ module Orb
37
37
  -> { Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Properties }
38
38
 
39
39
  # @!attribute subscription
40
- # The subscription in a standard webhook payload: the fields readable without
41
- # to_subscription_params(), which every interval, billing period and plan phase
42
- # depends on.
40
+ # A subscription's own fields, with its plan and customer as references, as listed
41
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
42
+ # the subscription for its price intervals, billing periods, plan phases and other
43
+ # derived fields.
43
44
  #
44
45
  # @return [Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Subscription]
45
46
  required :subscription,
@@ -68,7 +69,7 @@ module Orb
68
69
  #
69
70
  # @param properties [Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Properties]
70
71
  #
71
- # @param subscription [Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
72
+ # @param subscription [Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
72
73
  #
73
74
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Type] The event this payload describes.
74
75
 
@@ -238,9 +239,10 @@ module Orb
238
239
  # {Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Subscription}
239
240
  # for more details.
240
241
  #
241
- # The subscription in a standard webhook payload: the fields readable without
242
- # to_subscription_params(), which every interval, billing period and plan phase
243
- # depends on.
242
+ # A subscription's own fields, with its plan and customer as references, as listed
243
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
244
+ # the subscription for its price intervals, billing periods, plan phases and other
245
+ # derived fields.
244
246
  #
245
247
  # @param id [String]
246
248
  #
@@ -37,9 +37,10 @@ module Orb
37
37
  -> { Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Properties }
38
38
 
39
39
  # @!attribute subscription
40
- # The subscription in a standard webhook payload: the fields readable without
41
- # to_subscription_params(), which every interval, billing period and plan phase
42
- # depends on.
40
+ # A subscription's own fields, with its plan and customer as references, as listed
41
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
42
+ # the subscription for its price intervals, billing periods, plan phases and other
43
+ # derived fields.
43
44
  #
44
45
  # @return [Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Subscription]
45
46
  required :subscription,
@@ -68,7 +69,7 @@ module Orb
68
69
  #
69
70
  # @param properties [Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Properties]
70
71
  #
71
- # @param subscription [Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
72
+ # @param subscription [Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
72
73
  #
73
74
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Type] The event this payload describes.
74
75
 
@@ -232,9 +233,10 @@ module Orb
232
233
  # {Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Subscription}
233
234
  # for more details.
234
235
  #
235
- # The subscription in a standard webhook payload: the fields readable without
236
- # to_subscription_params(), which every interval, billing period and plan phase
237
- # depends on.
236
+ # A subscription's own fields, with its plan and customer as references, as listed
237
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
238
+ # the subscription for its price intervals, billing periods, plan phases and other
239
+ # derived fields.
238
240
  #
239
241
  # @param id [String]
240
242
  #
@@ -32,10 +32,8 @@ module Orb
32
32
  required :properties, -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties }
33
33
 
34
34
  # @!attribute subscription
35
- # A lightweight subscription representation for webhook payloads.
36
- #
37
- # This avoids the expensive to_subscription_params() call required for full
38
- # serialization.
35
+ # The subscription in a license or grouped cost webhook payload: its status,
36
+ # dates, plan and customer.
39
37
  #
40
38
  # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription]
41
39
  required :subscription, -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription }
@@ -61,7 +59,7 @@ module Orb
61
59
  #
62
60
  # @param properties [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties] Sent when the system disables an alert on its own, currently for cardinality-lim
63
61
  #
64
- # @param subscription [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription] A lightweight subscription representation for webhook payloads.
62
+ # @param subscription [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
65
63
  #
66
64
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Type] The event this payload describes.
67
65
 
@@ -593,10 +591,8 @@ module Orb
593
591
  enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Status }
594
592
 
595
593
  # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
596
- # A lightweight subscription representation for webhook payloads.
597
- #
598
- # This avoids the expensive to_subscription_params() call required for full
599
- # serialization.
594
+ # The subscription in a license or grouped cost webhook payload: its status,
595
+ # dates, plan and customer.
600
596
  #
601
597
  # @param id [String]
602
598
  # @param customer [Orb::Models::CustomerMinified]
@@ -31,9 +31,10 @@ module Orb
31
31
  -> { Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Properties }
32
32
 
33
33
  # @!attribute subscription
34
- # The subscription in a standard webhook payload: the fields readable without
35
- # to_subscription_params(), which every interval, billing period and plan phase
36
- # depends on.
34
+ # A subscription's own fields, with its plan and customer as references, as listed
35
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
36
+ # the subscription for its price intervals, billing periods, plan phases and other
37
+ # derived fields.
37
38
  #
38
39
  # @return [Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Subscription]
39
40
  required :subscription,
@@ -60,7 +61,7 @@ module Orb
60
61
  #
61
62
  # @param properties [Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Properties]
62
63
  #
63
- # @param subscription [Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
64
+ # @param subscription [Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
64
65
  #
65
66
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Type] The event this payload describes.
66
67
 
@@ -153,9 +154,10 @@ module Orb
153
154
  # {Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Subscription}
154
155
  # for more details.
155
156
  #
156
- # The subscription in a standard webhook payload: the fields readable without
157
- # to_subscription_params(), which every interval, billing period and plan phase
158
- # depends on.
157
+ # A subscription's own fields, with its plan and customer as references, as listed
158
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
159
+ # the subscription for its price intervals, billing periods, plan phases and other
160
+ # derived fields.
159
161
  #
160
162
  # @param id [String]
161
163
  #
@@ -31,9 +31,10 @@ module Orb
31
31
  -> { Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Properties }
32
32
 
33
33
  # @!attribute subscription
34
- # The subscription in a standard webhook payload: the fields readable without
35
- # to_subscription_params(), which every interval, billing period and plan phase
36
- # depends on.
34
+ # A subscription's own fields, with its plan and customer as references, as listed
35
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
36
+ # the subscription for its price intervals, billing periods, plan phases and other
37
+ # derived fields.
37
38
  #
38
39
  # @return [Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Subscription]
39
40
  required :subscription,
@@ -60,7 +61,7 @@ module Orb
60
61
  #
61
62
  # @param properties [Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Properties]
62
63
  #
63
- # @param subscription [Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
64
+ # @param subscription [Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
64
65
  #
65
66
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Type] The event this payload describes.
66
67
 
@@ -153,9 +154,10 @@ module Orb
153
154
  # {Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Subscription}
154
155
  # for more details.
155
156
  #
156
- # The subscription in a standard webhook payload: the fields readable without
157
- # to_subscription_params(), which every interval, billing period and plan phase
158
- # depends on.
157
+ # A subscription's own fields, with its plan and customer as references, as listed
158
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
159
+ # the subscription for its price intervals, billing periods, plan phases and other
160
+ # derived fields.
159
161
  #
160
162
  # @param id [String]
161
163
  #
@@ -30,9 +30,10 @@ module Orb
30
30
  required :properties, -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties }
31
31
 
32
32
  # @!attribute subscription
33
- # The subscription in a standard webhook payload: the fields readable without
34
- # to_subscription_params(), which every interval, billing period and plan phase
35
- # depends on.
33
+ # A subscription's own fields, with its plan and customer as references, as listed
34
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
35
+ # the subscription for its price intervals, billing periods, plan phases and other
36
+ # derived fields.
36
37
  #
37
38
  # @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription]
38
39
  required :subscription, -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription }
@@ -58,7 +59,7 @@ module Orb
58
59
  #
59
60
  # @param properties [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties]
60
61
  #
61
- # @param subscription [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
62
+ # @param subscription [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
62
63
  #
63
64
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Type] The event this payload describes.
64
65
 
@@ -608,9 +609,10 @@ module Orb
608
609
  # {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription}
609
610
  # for more details.
610
611
  #
611
- # The subscription in a standard webhook payload: the fields readable without
612
- # to_subscription_params(), which every interval, billing period and plan phase
613
- # depends on.
612
+ # A subscription's own fields, with its plan and customer as references, as listed
613
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
614
+ # the subscription for its price intervals, billing periods, plan phases and other
615
+ # derived fields.
614
616
  #
615
617
  # @param id [String]
616
618
  #
@@ -29,9 +29,10 @@ module Orb
29
29
  required :properties, Orb::Internal::Type::Unknown
30
30
 
31
31
  # @!attribute subscription
32
- # The subscription in a standard webhook payload: the fields readable without
33
- # to_subscription_params(), which every interval, billing period and plan phase
34
- # depends on.
32
+ # A subscription's own fields, with its plan and customer as references, as listed
33
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
34
+ # the subscription for its price intervals, billing periods, plan phases and other
35
+ # derived fields.
35
36
  #
36
37
  # @return [Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription]
37
38
  required :subscription, -> { Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription }
@@ -57,7 +58,7 @@ module Orb
57
58
  #
58
59
  # @param properties [Object]
59
60
  #
60
- # @param subscription [Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
61
+ # @param subscription [Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
61
62
  #
62
63
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Type] The event this payload describes.
63
64
 
@@ -137,9 +138,10 @@ module Orb
137
138
  # {Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription}
138
139
  # for more details.
139
140
  #
140
- # The subscription in a standard webhook payload: the fields readable without
141
- # to_subscription_params(), which every interval, billing period and plan phase
142
- # depends on.
141
+ # A subscription's own fields, with its plan and customer as references, as listed
142
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
143
+ # the subscription for its price intervals, billing periods, plan phases and other
144
+ # derived fields.
143
145
  #
144
146
  # @param id [String]
145
147
  #
@@ -29,9 +29,10 @@ module Orb
29
29
  required :properties, -> { Orb::Webhooks::SubscriptionEditedStandardWebhookEvent::Properties }
30
30
 
31
31
  # @!attribute subscription
32
- # The subscription in a standard webhook payload: the fields readable without
33
- # to_subscription_params(), which every interval, billing period and plan phase
34
- # depends on.
32
+ # A subscription's own fields, with its plan and customer as references, as listed
33
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
34
+ # the subscription for its price intervals, billing periods, plan phases and other
35
+ # derived fields.
35
36
  #
36
37
  # @return [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription]
37
38
  required :subscription, -> { Orb::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription }
@@ -57,7 +58,7 @@ module Orb
57
58
  #
58
59
  # @param properties [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Properties]
59
60
  #
60
- # @param subscription [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
61
+ # @param subscription [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
61
62
  #
62
63
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Type] The event this payload describes.
63
64
 
@@ -189,9 +190,10 @@ module Orb
189
190
  # {Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription}
190
191
  # for more details.
191
192
  #
192
- # The subscription in a standard webhook payload: the fields readable without
193
- # to_subscription_params(), which every interval, billing period and plan phase
194
- # depends on.
193
+ # A subscription's own fields, with its plan and customer as references, as listed
194
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
195
+ # the subscription for its price intervals, billing periods, plan phases and other
196
+ # derived fields.
195
197
  #
196
198
  # @param id [String]
197
199
  #