Class: Orb::Models::SubscriptionPriceIntervalsParams::Add

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/subscription_price_intervals_params.rb

Defined Under Namespace

Modules: Discount, EndDate, Price, StartDate Classes: FixedFeeQuantityTransition

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(effective_date: , quantity: ) ⇒ Object

Parameters:

  • effective_date (Time) (defaults to: ) —

    The date that the fixed fee quantity transition should take effect.

  • quantity (Integer) (defaults to: ) —

    The quantity of the fixed fee quantity transition.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 60

class Add < Orb::Internal::Type::BaseModel
  # @!attribute start_date
  #   The start date of the price interval. This is the date that the price will start
  #   billing on the subscription.
  #
  #   @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate]
  required :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::StartDate }

  # @!attribute allocation_price
  #   The definition of a new allocation price to create and add to the subscription.
  #
  #   @return [Orb::Models::NewAllocationPrice, nil]
  optional :allocation_price, -> { Orb::NewAllocationPrice }, nil?: true

  # @!attribute discounts
  #   A list of discounts to initialize on the price interval.
  #
  #   @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil]
  optional :discounts,
           -> {
             Orb::Internal::Type::ArrayOf[union: Orb::SubscriptionPriceIntervalsParams::Add::Discount]
           },
           nil?: true

  # @!attribute end_date
  #   The end date of the price interval. This is the date that the price will stop
  #   billing on the subscription.
  #
  #   @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
  optional :end_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::EndDate }, nil?: true

  # @!attribute external_price_id
  #   The external price id of the price to add to the subscription.
  #
  #   @return [String, nil]
  optional :external_price_id, String, nil?: true

  # @!attribute filter
  #   An additional filter to apply to usage queries. This filter must be expressed as
  #   a boolean
  #   [computed property](/extensibility/advanced-metrics#computed-properties). If
  #   null, usage queries will not include any additional filter.
  #
  #   @return [String, nil]
  optional :filter, String, nil?: true

  # @!attribute fixed_fee_quantity_transitions
  #   A list of fixed fee quantity transitions to initialize on the price interval.
  #
  #   @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil]
  optional :fixed_fee_quantity_transitions,
           -> {
             Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition]
           },
           nil?: true

  # @!attribute maximum_amount
  #   The maximum amount that will be billed for this price interval for a given
  #   billing period.
  #
  #   @return [Float, nil]
  optional :maximum_amount, Float, nil?: true

  # @!attribute minimum_amount
  #   The minimum amount that will be billed for this price interval for a given
  #   billing period.
  #
  #   @return [Float, nil]
  optional :minimum_amount, Float, nil?: true

  # @!attribute price
  #   The definition of a new price to create and add to the subscription.
  #
  #   @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingTieredBPSPrice, Orb::Models::NewFloatingBPSPrice, Orb::Models::NewFloatingBulkBPSPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, nil]
  optional :price, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price }, nil?: true

  # @!attribute price_id
  #   The id of the price to add to the subscription.
  #
  #   @return [String, nil]
  optional :price_id, String, nil?: true

  # @!attribute usage_customer_ids
  #   A list of customer IDs whose usage events will be aggregated and billed under
  #   this subscription. By default, a subscription only considers usage events
  #   associated with its attached customer's customer_id. When usage_customer_ids is
  #   provided, the subscription includes usage events from the specified customers
  #   only. Provided usage_customer_ids must be either the customer for this
  #   subscription itself, or any of that customer's children.
  #
  #   @return [Array<String>, nil]
  optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true

  # @!method initialize(start_date:, allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, filter: nil, fixed_fee_quantity_transitions: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil, usage_customer_ids: nil)
  #   Some parameter documentations has been truncated, see
  #   {Orb::Models::SubscriptionPriceIntervalsParams::Add} for more details.
  #
  #   @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The start date of the price interval. This is the date that the price will start
  #
  #   @param allocation_price [Orb::Models::NewAllocationPrice, nil] The definition of a new allocation price to create and add to the subscription.
  #
  #   @param discounts [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil] A list of discounts to initialize on the price interval.
  #
  #   @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The end date of the price interval. This is the date that the price will stop bi
  #
  #   @param external_price_id [String, nil] The external price id of the price to add to the subscription.
  #
  #   @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as
  #
  #   @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to initialize on the price interval.
  #
  #   @param maximum_amount [Float, nil] The maximum amount that will be billed for this price interval for a given billi
  #
  #   @param minimum_amount [Float, nil] The minimum amount that will be billed for this price interval for a given billi
  #
  #   @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingTieredBPSPrice, Orb::Models::NewFloatingBPSPrice, Orb::Models::NewFloatingBulkBPSPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, nil] The definition of a new price to create and add to the subscription.
  #
  #   @param price_id [String, nil] The id of the price to add to the subscription.
  #
  #   @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th

  # The start date of the price interval. This is the date that the price will start
  # billing on the subscription.
  #
  # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#start_date
  module StartDate
    extend Orb::Internal::Type::Union

    variant Time

    variant enum: -> { Orb::BillingCycleRelativeDate }

    # @!method self.variants
    #   @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
  end

  module Discount
    extend Orb::Internal::Type::Union

    discriminator :discount_type

    variant :amount, -> { Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount }

    variant :percentage, -> { Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage }

    variant :usage, -> { Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage }

    class Amount < Orb::Internal::Type::BaseModel
      # @!attribute amount_discount
      #   Only available if discount_type is `amount`.
      #
      #   @return [Float]
      required :amount_discount, Float

      # @!attribute discount_type
      #
      #   @return [Symbol, :amount]
      required :discount_type, const: :amount

      # @!method initialize(amount_discount:, discount_type: :amount)
      #   @param amount_discount [Float] Only available if discount_type is `amount`.
      #
      #   @param discount_type [Symbol, :amount]
    end

    class Percentage < Orb::Internal::Type::BaseModel
      # @!attribute discount_type
      #
      #   @return [Symbol, :percentage]
      required :discount_type, const: :percentage

      # @!attribute percentage_discount
      #   Only available if discount_type is `percentage`. This is a number between 0
      #   and 1.
      #
      #   @return [Float]
      required :percentage_discount, Float

      # @!method initialize(percentage_discount:, discount_type: :percentage)
      #   Some parameter documentations has been truncated, see
      #   {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage} for
      #   more details.
      #
      #   @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and
      #
      #   @param discount_type [Symbol, :percentage]
    end

    class Usage < Orb::Internal::Type::BaseModel
      # @!attribute discount_type
      #
      #   @return [Symbol, :usage]
      required :discount_type, const: :usage

      # @!attribute usage_discount
      #   Only available if discount_type is `usage`. Number of usage units that this
      #   discount is for.
      #
      #   @return [Float]
      required :usage_discount, Float

      # @!method initialize(usage_discount:, discount_type: :usage)
      #   Some parameter documentations has been truncated, see
      #   {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage} for more
      #   details.
      #
      #   @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
      #
      #   @param discount_type [Symbol, :usage]
    end

    # @!method self.variants
    #   @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage)]
  end

  # The end date of the price interval. This is the date that the price will stop
  # billing on the subscription.
  #
  # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#end_date
  module EndDate
    extend Orb::Internal::Type::Union

    variant Time

    variant enum: -> { Orb::BillingCycleRelativeDate }

    # @!method self.variants
    #   @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
  end

  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
    # @!attribute effective_date
    #   The date that the fixed fee quantity transition should take effect.
    #
    #   @return [Time]
    required :effective_date, Time

    # @!attribute quantity
    #   The quantity of the fixed fee quantity transition.
    #
    #   @return [Integer]
    required :quantity, Integer

    # @!method initialize(effective_date:, quantity:)
    #   @param effective_date [Time] The date that the fixed fee quantity transition should take effect.
    #
    #   @param quantity [Integer] The quantity of the fixed fee quantity transition.
  end

  # The definition of a new price to create and add to the subscription.
  #
  # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#price
  module Price
    extend Orb::Internal::Type::Union

    discriminator :model_type

    variant :unit, -> { Orb::NewFloatingUnitPrice }

    variant :package, -> { Orb::NewFloatingPackagePrice }

    variant :matrix, -> { Orb::NewFloatingMatrixPrice }

    variant :matrix_with_allocation, -> { Orb::NewFloatingMatrixWithAllocationPrice }

    variant :tiered, -> { Orb::NewFloatingTieredPrice }

    variant :tiered_bps, -> { Orb::NewFloatingTieredBPSPrice }

    variant :bps, -> { Orb::NewFloatingBPSPrice }

    variant :bulk_bps, -> { Orb::NewFloatingBulkBPSPrice }

    variant :bulk, -> { Orb::NewFloatingBulkPrice }

    variant :threshold_total_amount, -> { Orb::NewFloatingThresholdTotalAmountPrice }

    variant :tiered_package, -> { Orb::NewFloatingTieredPackagePrice }

    variant :grouped_tiered, -> { Orb::NewFloatingGroupedTieredPrice }

    variant :max_group_tiered_package, -> { Orb::NewFloatingMaxGroupTieredPackagePrice }

    variant :tiered_with_minimum, -> { Orb::NewFloatingTieredWithMinimumPrice }

    variant :package_with_allocation, -> { Orb::NewFloatingPackageWithAllocationPrice }

    variant :tiered_package_with_minimum, -> { Orb::NewFloatingTieredPackageWithMinimumPrice }

    variant :unit_with_percent, -> { Orb::NewFloatingUnitWithPercentPrice }

    variant :tiered_with_proration, -> { Orb::NewFloatingTieredWithProrationPrice }

    variant :unit_with_proration, -> { Orb::NewFloatingUnitWithProrationPrice }

    variant :grouped_allocation, -> { Orb::NewFloatingGroupedAllocationPrice }

    variant :grouped_with_prorated_minimum, -> { Orb::NewFloatingGroupedWithProratedMinimumPrice }

    variant :grouped_with_metered_minimum, -> { Orb::NewFloatingGroupedWithMeteredMinimumPrice }

    variant :matrix_with_display_name, -> { Orb::NewFloatingMatrixWithDisplayNamePrice }

    variant :bulk_with_proration, -> { Orb::NewFloatingBulkWithProrationPrice }

    variant :grouped_tiered_package, -> { Orb::NewFloatingGroupedTieredPackagePrice }

    variant :scalable_matrix_with_unit_pricing, -> { Orb::NewFloatingScalableMatrixWithUnitPricingPrice }

    variant :scalable_matrix_with_tiered_pricing, -> { Orb::NewFloatingScalableMatrixWithTieredPricingPrice }

    variant :cumulative_grouped_bulk, -> { Orb::NewFloatingCumulativeGroupedBulkPrice }

    # @!method self.variants
    #   @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingTieredBPSPrice, Orb::Models::NewFloatingBPSPrice, Orb::Models::NewFloatingBulkBPSPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice)]
  end
end

Instance Attribute Details

#allocation_price ⇒ Orb::Models::NewAllocationPrice?

The definition of a new allocation price to create and add to the subscription.

Returns:



72
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 72

optional :allocation_price, -> { Orb::NewAllocationPrice }, nil?: true

#discounts ⇒ Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage>?

A list of discounts to initialize on the price interval.

Returns:



78
79
80
81
82
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 78

optional :discounts,
-> {
  Orb::Internal::Type::ArrayOf[union: Orb::SubscriptionPriceIntervalsParams::Add::Discount]
},
nil?: true

#end_date ⇒ Time, ...

The end date of the price interval. This is the date that the price will stop billing on the subscription.

Returns:



89
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 89

optional :end_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::EndDate }, nil?: true

#external_price_id ⇒ String?

The external price id of the price to add to the subscription.

Returns:

  • (String, nil) 


95
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 95

optional :external_price_id, String, nil?: true

#filter ⇒ String?

An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.

Returns:

  • (String, nil) 


104
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 104

optional :filter, String, nil?: true

#fixed_fee_quantity_transitions ⇒ Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>?

A list of fixed fee quantity transitions to initialize on the price interval.

Returns:



110
111
112
113
114
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 110

optional :fixed_fee_quantity_transitions,
-> {
  Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition]
},
nil?: true

#maximum_amount ⇒ Float?

The maximum amount that will be billed for this price interval for a given billing period.

Returns:

  • (Float, nil) 


121
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 121

optional :maximum_amount, Float, nil?: true

#minimum_amount ⇒ Float?

The minimum amount that will be billed for this price interval for a given billing period.

Returns:

  • (Float, nil) 


128
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 128

optional :minimum_amount, Float, nil?: true

#price ⇒ Orb::Models::NewFloatingUnitPrice, ...

The definition of a new price to create and add to the subscription.

Returns:



134
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 134

optional :price, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price }, nil?: true

#price_id ⇒ String?

The id of the price to add to the subscription.

Returns:

  • (String, nil) 


140
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 140

optional :price_id, String, nil?: true

#start_date ⇒ Time, ...

The start date of the price interval. This is the date that the price will start billing on the subscription.

Returns:



66
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 66

required :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::StartDate }

#usage_customer_ids ⇒ Array<String>?

A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer’s customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer’s children.

Returns:

  • (Array<String>, nil) 


151
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 151

optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true

Class Method Details

.variants ⇒ Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)

Returns:




# File 'lib/orb/models/subscription_price_intervals_params.rb', line 192