orb-billing 1.47.0 → 1.49.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 (72) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  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/metric_archive_params.rb +20 -0
  7. data/lib/orb/models/metric_unarchive_params.rb +20 -0
  8. data/lib/orb/models/subscription_list_summary_params.rb +108 -0
  9. data/lib/orb/models/subscription_list_summary_response.rb +130 -0
  10. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +9 -7
  11. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +9 -7
  12. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +9 -7
  13. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +9 -7
  14. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +9 -7
  15. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +9 -7
  16. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +9 -7
  17. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +9 -7
  18. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +9 -7
  19. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +9 -7
  20. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +9 -7
  21. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +9 -7
  22. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +9 -7
  23. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +9 -7
  24. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +9 -7
  25. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +9 -7
  26. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +9 -7
  27. data/lib/orb/models.rb +8 -0
  28. data/lib/orb/resources/alerts.rb +7 -4
  29. data/lib/orb/resources/credit_blocks.rb +35 -0
  30. data/lib/orb/resources/metrics.rb +46 -0
  31. data/lib/orb/resources/subscriptions.rb +60 -0
  32. data/lib/orb/version.rb +1 -1
  33. data/lib/orb.rb +6 -0
  34. data/rbi/orb/models/credit_block_update_params.rbi +53 -0
  35. data/rbi/orb/models/credit_block_update_response.rbi +693 -0
  36. data/rbi/orb/models/metric_archive_params.rbi +33 -0
  37. data/rbi/orb/models/metric_unarchive_params.rbi +35 -0
  38. data/rbi/orb/models/subscription_list_summary_params.rbi +148 -0
  39. data/rbi/orb/models/subscription_list_summary_response.rbi +214 -0
  40. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +12 -9
  41. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +12 -9
  42. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +12 -9
  43. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +12 -9
  44. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +12 -9
  45. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +12 -9
  46. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +12 -9
  47. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +12 -9
  48. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +12 -9
  49. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +12 -9
  50. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +12 -9
  51. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +12 -9
  52. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +12 -9
  53. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +12 -9
  54. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +12 -9
  55. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +12 -9
  56. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +12 -9
  57. data/rbi/orb/models.rbi +8 -0
  58. data/rbi/orb/resources/alerts.rbi +7 -4
  59. data/rbi/orb/resources/credit_blocks.rbi +26 -0
  60. data/rbi/orb/resources/metrics.rbi +28 -0
  61. data/rbi/orb/resources/subscriptions.rbi +47 -0
  62. data/sig/orb/models/credit_block_update_params.rbs +28 -0
  63. data/sig/orb/models/credit_block_update_response.rbs +263 -0
  64. data/sig/orb/models/metric_archive_params.rbs +23 -0
  65. data/sig/orb/models/metric_unarchive_params.rbs +23 -0
  66. data/sig/orb/models/subscription_list_summary_params.rbs +90 -0
  67. data/sig/orb/models/subscription_list_summary_response.rbs +94 -0
  68. data/sig/orb/models.rbs +8 -0
  69. data/sig/orb/resources/credit_blocks.rbs +6 -0
  70. data/sig/orb/resources/metrics.rbs +10 -0
  71. data/sig/orb/resources/subscriptions.rbs +15 -0
  72. metadata +19 -1
@@ -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: its own fields, with its plan
36
- # and customer as references. Fetch the subscription for its price intervals,
37
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
85
- # and customer as references. Fetch the subscription for its price intervals,
86
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
214
- # and customer as references. Fetch the subscription for its price intervals,
215
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
98
- # and customer as references. Fetch the subscription for its price intervals,
99
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
336
- # and customer as references. Fetch the subscription for its price intervals,
337
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
36
- # and customer as references. Fetch the subscription for its price intervals,
37
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
85
- # and customer as references. Fetch the subscription for its price intervals,
86
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
214
- # and customer as references. Fetch the subscription for its price intervals,
215
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
98
- # and customer as references. Fetch the subscription for its price intervals,
99
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
274
- # and customer as references. Fetch the subscription for its price intervals,
275
- # billing periods, plan phases and other derived fields.
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,
@@ -44,9 +44,10 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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::SubscriptionPlanChangeScheduledStandardWebhookEvent::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: its own fields, with its plan
98
- # and customer as references. Fetch the subscription for its price intervals,
99
- # billing periods, plan phases and other derived fields.
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:
@@ -265,9 +267,10 @@ module Orb
265
267
  end
266
268
  attr_accessor :status
267
269
 
268
- # The subscription in a standard webhook payload: its own fields, with its plan
269
- # and customer as references. Fetch the subscription for its price intervals,
270
- # billing periods, plan phases and other derived fields.
270
+ # A subscription's own fields, with its plan and customer as references, as listed
271
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
272
+ # the subscription for its price intervals, billing periods, plan phases and other
273
+ # derived fields.
271
274
  sig do
272
275
  params(
273
276
  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: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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::SubscriptionPlanChangedStandardWebhookEvent::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: its own fields, with its plan
98
- # and customer as references. Fetch the subscription for its price intervals,
99
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
249
- # and customer as references. Fetch the subscription for its price intervals,
250
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::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: its own fields, with its plan
98
- # and customer as references. Fetch the subscription for its price intervals,
99
- # billing periods, plan phases and other derived fields.
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:
@@ -269,9 +271,10 @@ module Orb
269
271
  end
270
272
  attr_accessor :status
271
273
 
272
- # The subscription in a standard webhook payload: its own fields, with its plan
273
- # and customer as references. Fetch the subscription for its price intervals,
274
- # billing periods, plan phases and other derived fields.
274
+ # A subscription's own fields, with its plan and customer as references, as listed
275
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
276
+ # the subscription for its price intervals, billing periods, plan phases and other
277
+ # derived fields.
275
278
  sig do
276
279
  params(
277
280
  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: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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::SubscriptionPlanVersionChangedStandardWebhookEvent::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: its own fields, with its plan
98
- # and customer as references. Fetch the subscription for its price intervals,
99
- # billing periods, plan phases and other derived fields.
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:
@@ -269,9 +271,10 @@ module Orb
269
271
  end
270
272
  attr_accessor :status
271
273
 
272
- # The subscription in a standard webhook payload: its own fields, with its plan
273
- # and customer as references. Fetch the subscription for its price intervals,
274
- # billing periods, plan phases and other derived fields.
274
+ # A subscription's own fields, with its plan and customer as references, as listed
275
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
276
+ # the subscription for its price intervals, billing periods, plan phases and other
277
+ # derived fields.
275
278
  sig do
276
279
  params(
277
280
  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: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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::SubscriptionSpendExceededStandardWebhookEvent::Subscription
@@ -95,9 +96,10 @@ module Orb
95
96
  # endpoint.
96
97
  payload_style:,
97
98
  properties:,
98
- # The subscription in a standard webhook payload: its own fields, with its plan
99
- # and customer as references. Fetch the subscription for its price intervals,
100
- # billing periods, plan phases and other derived fields.
99
+ # A subscription's own fields, with its plan and customer as references, as listed
100
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
101
+ # the subscription for its price intervals, billing periods, plan phases and other
102
+ # derived fields.
101
103
  subscription:,
102
104
  # The event this payload describes.
103
105
  type:
@@ -1111,9 +1113,10 @@ module Orb
1111
1113
  end
1112
1114
  attr_accessor :status
1113
1115
 
1114
- # The subscription in a standard webhook payload: its own fields, with its plan
1115
- # and customer as references. Fetch the subscription for its price intervals,
1116
- # billing periods, plan phases and other derived fields.
1116
+ # A subscription's own fields, with its plan and customer as references, as listed
1117
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
1118
+ # the subscription for its price intervals, billing periods, plan phases and other
1119
+ # derived fields.
1117
1120
  sig do
1118
1121
  params(
1119
1122
  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: its own fields, with its plan
36
- # and customer as references. Fetch the subscription for its price intervals,
37
- # billing periods, plan phases and other derived fields.
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::SubscriptionStartedStandardWebhookEvent::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: its own fields, with its plan
85
- # and customer as references. Fetch the subscription for its price intervals,
86
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
214
- # and customer as references. Fetch the subscription for its price intervals,
215
- # billing periods, plan phases and other derived fields.
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,
@@ -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: its own fields, with its plan
36
- # and customer as references. Fetch the subscription for its price intervals,
37
- # billing periods, plan phases and other derived fields.
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::SubscriptionTrialEndedStandardWebhookEvent::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: its own fields, with its plan
85
- # and customer as references. Fetch the subscription for its price intervals,
86
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
214
- # and customer as references. Fetch the subscription for its price intervals,
215
- # billing periods, plan phases and other derived fields.
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: its own fields, with its plan
48
- # and customer as references. Fetch the subscription for its price intervals,
49
- # billing periods, plan phases and other derived fields.
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::SubscriptionUsageExceededStandardWebhookEvent::Subscription
@@ -95,9 +96,10 @@ module Orb
95
96
  # endpoint.
96
97
  payload_style:,
97
98
  properties:,
98
- # The subscription in a standard webhook payload: its own fields, with its plan
99
- # and customer as references. Fetch the subscription for its price intervals,
100
- # billing periods, plan phases and other derived fields.
99
+ # A subscription's own fields, with its plan and customer as references, as listed
100
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
101
+ # the subscription for its price intervals, billing periods, plan phases and other
102
+ # derived fields.
101
103
  subscription:,
102
104
  # The event this payload describes.
103
105
  type:
@@ -1117,9 +1119,10 @@ module Orb
1117
1119
  end
1118
1120
  attr_accessor :status
1119
1121
 
1120
- # The subscription in a standard webhook payload: its own fields, with its plan
1121
- # and customer as references. Fetch the subscription for its price intervals,
1122
- # billing periods, plan phases and other derived fields.
1122
+ # A subscription's own fields, with its plan and customer as references, as listed
1123
+ # by List subscription summaries and carried in standard webhook payloads. Fetch
1124
+ # the subscription for its price intervals, billing periods, plan phases and other
1125
+ # derived fields.
1123
1126
  sig do
1124
1127
  params(
1125
1128
  id: String,
data/rbi/orb/models.rbi CHANGED
@@ -106,6 +106,8 @@ module Orb
106
106
 
107
107
  CreditBlockRetrieveParams = Orb::Models::CreditBlockRetrieveParams
108
108
 
109
+ CreditBlockUpdateParams = Orb::Models::CreditBlockUpdateParams
110
+
109
111
  CreditNote = Orb::Models::CreditNote
110
112
 
111
113
  CreditNoteAccountingSyncFailedWebhookEvent =
@@ -392,6 +394,8 @@ module Orb
392
394
 
393
395
  MaximumInterval = Orb::Models::MaximumInterval
394
396
 
397
+ MetricArchiveParams = Orb::Models::MetricArchiveParams
398
+
395
399
  MetricCreateParams = Orb::Models::MetricCreateParams
396
400
 
397
401
  MetricEventsDroppedByWatermarkWebhookEvent =
@@ -401,6 +405,8 @@ module Orb
401
405
 
402
406
  MetricListParams = Orb::Models::MetricListParams
403
407
 
408
+ MetricUnarchiveParams = Orb::Models::MetricUnarchiveParams
409
+
404
410
  MetricUpdateParams = Orb::Models::MetricUpdateParams
405
411
 
406
412
  Minimum = Orb::Models::Minimum
@@ -807,6 +813,8 @@ module Orb
807
813
 
808
814
  SubscriptionListParams = Orb::Models::SubscriptionListParams
809
815
 
816
+ SubscriptionListSummaryParams = Orb::Models::SubscriptionListSummaryParams
817
+
810
818
  SubscriptionMinified = Orb::Models::SubscriptionMinified
811
819
 
812
820
  SubscriptionPlanChangedWebhookEvent =
@@ -187,8 +187,9 @@ module Orb
187
187
  # before invoice-level adjustments and credits) denominated in the alert's
188
188
  # currency exceeds predefined thresholds during the current billing cycle;
189
189
  # `price_filters` can scope which prices contribute. Each plan can have one
190
- # `cost_exceeded` alert and one `usage_exceeded` alert per metric that is a part
191
- # of the plan.
190
+ # `cost_exceeded` alert, one `usage_exceeded` alert per metric that is a part of
191
+ # the plan, and up to 50 `spend_exceeded` alerts, one per combination of currency
192
+ # and `price_filters`, so separate products can each have their own spend alert.
192
193
  sig do
193
194
  params(
194
195
  plan_id: String,
@@ -243,8 +244,10 @@ module Orb
243
244
  # spend (the pricing subtotal, before invoice-level adjustments and credits)
244
245
  # denominated in the alert's currency exceeds predefined thresholds during the
245
246
  # current billing cycle; `price_filters` can scope which prices contribute. Each
246
- # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
247
- # per metric that is a part of the subscription.
247
+ # subscription can have one `cost_exceeded` alert, one `usage_exceeded` alert per
248
+ # metric that is a part of the subscription, and up to 50 `spend_exceeded` alerts,
249
+ # one per combination of currency and `price_filters`, so separate products can
250
+ # each have their own spend alert.
248
251
  sig do
249
252
  params(
250
253
  subscription_id: String,
@@ -15,6 +15,32 @@ module Orb
15
15
  def retrieve(block_id, request_options: {})
16
16
  end
17
17
 
18
+ # This endpoint updates the `metadata` of a credit block. Keys you pass are added
19
+ # to the block's existing metadata or overwrite the value already stored for that
20
+ # key, and setting a key to `null` removes it. Passing `null` for `metadata`
21
+ # clears all of the block's metadata. The block's `increment` entry in the
22
+ # [credits ledger](fetch-customer-credits-ledger) reports the block's metadata, so
23
+ # it shows the update too.
24
+ #
25
+ # Other fields on a credit block cannot be changed through this endpoint. Deleted
26
+ # credit blocks return a 404.
27
+ sig do
28
+ params(
29
+ block_id: String,
30
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
31
+ request_options: Orb::RequestOptions::OrHash
32
+ ).returns(Orb::Models::CreditBlockUpdateResponse)
33
+ end
34
+ def update(
35
+ block_id,
36
+ # User-specified key/value pairs for the resource. Individual keys can be removed
37
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
38
+ # by setting `metadata` to `null`.
39
+ metadata: nil,
40
+ request_options: {}
41
+ )
42
+ end
43
+
18
44
  # This endpoint deletes a credit block by its ID.
19
45
  #
20
46
  # When a credit block is deleted: