Class: Stigg::Models::V1::ChargeList::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/charge_list.rb

Defined Under Namespace

Modules: BillingCadence, BillingModel, BillingPeriod, CreditGrantCadence, TiersMode Classes: CreditRate, Price, Tier

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(amount:, currency_id:, cost_formula: nil) ⇒ Object

Credit rate configuration for credit-based pricing

Parameters:

  • amount (Float) —

    Credit rate amount

  • currency_id (String) —

    Custom currency identifier

  • cost_formula (String, nil) (defaults to: nil) —

    Optional cost formula expression



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/stigg/models/v1/charge_list.rb', line 25

class Data < Stigg::Internal::Type::BaseModel
  # @!attribute id
  #   Unique identifier of the charge
  #
  #   @return [String]
  required :id, String

  # @!attribute billing_cadence
  #   The billing cadence (RECURRING or ONE_OFF)
  #
  #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::BillingCadence]
  required :billing_cadence,
           enum: -> { Stigg::V1::ChargeList::Data::BillingCadence },
           api_name: :billingCadence

  # @!attribute billing_model
  #   The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
  #
  #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::BillingModel]
  required :billing_model,
           enum: -> {
             Stigg::V1::ChargeList::Data::BillingModel
           },
           api_name: :billingModel

  # @!attribute billing_period
  #   The billing period (MONTHLY or ANNUALLY)
  #
  #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::BillingPeriod]
  required :billing_period,
           enum: -> { Stigg::V1::ChargeList::Data::BillingPeriod },
           api_name: :billingPeriod

  # @!attribute created_at
  #   Timestamp when the charge was created
  #
  #   @return [Time]
  required :created_at, Time, api_name: :createdAt

  # @!attribute billing_country_code
  #   ISO country code for localized pricing, if any
  #
  #   @return [String, nil]
  optional :billing_country_code, String, api_name: :billingCountryCode, nil?: true

  # @!attribute billing_id
  #   Identifier in the external billing integration (e.g. Stripe price id), if any
  #
  #   @return [String, nil]
  optional :billing_id, String, api_name: :billingId, nil?: true

  # @!attribute block_size
  #   Block size for usage-based pricing
  #
  #   @return [Float, nil]
  optional :block_size, Float, api_name: :blockSize, nil?: true

  # @!attribute credit_grant_cadence
  #   When credits are granted (for credit-based pricing)
  #
  #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::CreditGrantCadence, nil]
  optional :credit_grant_cadence,
           enum: -> { Stigg::V1::ChargeList::Data::CreditGrantCadence },
           api_name: :creditGrantCadence,
           nil?: true

  # @!attribute credit_rate
  #   Credit rate configuration for credit-based pricing
  #
  #   @return [Stigg::Models::V1::ChargeList::Data::CreditRate, nil]
  optional :credit_rate,
           -> {
             Stigg::V1::ChargeList::Data::CreditRate
           },
           api_name: :creditRate,
           nil?: true

  # @!attribute crm_id
  #   Identifier in the linked CRM, if any
  #
  #   @return [String, nil]
  optional :crm_id, String, api_name: :crmId, nil?: true

  # @!attribute crm_link_url
  #   Deep link to the charge in the linked CRM, if any
  #
  #   @return [String, nil]
  optional :crm_link_url, String, api_name: :crmLinkUrl, nil?: true

  # @!attribute feature_id
  #   The feature this charge meters, if metered
  #
  #   @return [String, nil]
  optional :feature_id, String, api_name: :featureId, nil?: true

  # @!attribute max_unit_quantity
  #   Maximum unit quantity that can be purchased
  #
  #   @return [Float, nil]
  optional :max_unit_quantity, Float, api_name: :maxUnitQuantity, nil?: true

  # @!attribute min_unit_quantity
  #   Minimum unit quantity that can be purchased
  #
  #   @return [Float, nil]
  optional :min_unit_quantity, Float, api_name: :minUnitQuantity, nil?: true

  # @!attribute price
  #   The flat price amount and currency, when applicable
  #
  #   @return [Stigg::Models::V1::ChargeList::Data::Price, nil]
  optional :price, -> { Stigg::V1::ChargeList::Data::Price }, nil?: true

  # @!attribute tiers
  #   Tiered pricing rows when the charge is tiered
  #
  #   @return [Array<Stigg::Models::V1::ChargeList::Data::Tier>, nil]
  optional :tiers,
           -> {
             Stigg::Internal::Type::ArrayOf[Stigg::V1::ChargeList::Data::Tier]
           },
           nil?: true

  # @!attribute tiers_mode
  #   Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
  #
  #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::TiersMode, nil]
  optional :tiers_mode,
           enum: -> { Stigg::V1::ChargeList::Data::TiersMode },
           api_name: :tiersMode,
           nil?: true

  # @!attribute top_up_custom_currency_id
  #   Custom currency identifier for top-up pricing, if any
  #
  #   @return [String, nil]
  optional :top_up_custom_currency_id, String, api_name: :topUpCustomCurrencyId, nil?: true

  # @!attribute used_in_subscriptions
  #   True if this charge is referenced by at least one subscription
  #
  #   @return [Boolean, nil]
  optional :used_in_subscriptions,
           Stigg::Internal::Type::Boolean,
           api_name: :usedInSubscriptions,
           nil?: true

  # @!method initialize(id:, billing_cadence:, billing_model:, billing_period:, created_at:, billing_country_code: nil, billing_id: nil, block_size: nil, credit_grant_cadence: nil, credit_rate: nil, crm_id: nil, crm_link_url: nil, feature_id: nil, max_unit_quantity: nil, min_unit_quantity: nil, price: nil, tiers: nil, tiers_mode: nil, top_up_custom_currency_id: nil, used_in_subscriptions: nil)
  #   Some parameter documentations has been truncated, see
  #   {Stigg::Models::V1::ChargeList::Data} for more details.
  #
  #   A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
  #   billingModel, billingCadence, billingCountryCode) combination. Plans and addons
  #   own many of these — one per currency / billing period / feature.
  #
  #   @param id [String] Unique identifier of the charge
  #
  #   @param billing_cadence [Symbol, Stigg::Models::V1::ChargeList::Data::BillingCadence] The billing cadence (RECURRING or ONE_OFF)
  #
  #   @param billing_model [Symbol, Stigg::Models::V1::ChargeList::Data::BillingModel] The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
  #
  #   @param billing_period [Symbol, Stigg::Models::V1::ChargeList::Data::BillingPeriod] The billing period (MONTHLY or ANNUALLY)
  #
  #   @param created_at [Time] Timestamp when the charge was created
  #
  #   @param billing_country_code [String, nil] ISO country code for localized pricing, if any
  #
  #   @param billing_id [String, nil] Identifier in the external billing integration (e.g. Stripe price id), if any
  #
  #   @param block_size [Float, nil] Block size for usage-based pricing
  #
  #   @param credit_grant_cadence [Symbol, Stigg::Models::V1::ChargeList::Data::CreditGrantCadence, nil] When credits are granted (for credit-based pricing)
  #
  #   @param credit_rate [Stigg::Models::V1::ChargeList::Data::CreditRate, nil] Credit rate configuration for credit-based pricing
  #
  #   @param crm_id [String, nil] Identifier in the linked CRM, if any
  #
  #   @param crm_link_url [String, nil] Deep link to the charge in the linked CRM, if any
  #
  #   @param feature_id [String, nil] The feature this charge meters, if metered
  #
  #   @param max_unit_quantity [Float, nil] Maximum unit quantity that can be purchased
  #
  #   @param min_unit_quantity [Float, nil] Minimum unit quantity that can be purchased
  #
  #   @param price [Stigg::Models::V1::ChargeList::Data::Price, nil] The flat price amount and currency, when applicable
  #
  #   @param tiers [Array<Stigg::Models::V1::ChargeList::Data::Tier>, nil] Tiered pricing rows when the charge is tiered
  #
  #   @param tiers_mode [Symbol, Stigg::Models::V1::ChargeList::Data::TiersMode, nil] Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
  #
  #   @param top_up_custom_currency_id [String, nil] Custom currency identifier for top-up pricing, if any
  #
  #   @param used_in_subscriptions [Boolean, nil] True if this charge is referenced by at least one subscription

  # The billing cadence (RECURRING or ONE_OFF)
  #
  # @see Stigg::Models::V1::ChargeList::Data#billing_cadence
  module BillingCadence
    extend Stigg::Internal::Type::Enum

    RECURRING = :RECURRING
    ONE_OFF = :ONE_OFF

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
  #
  # @see Stigg::Models::V1::ChargeList::Data#billing_model
  module BillingModel
    extend Stigg::Internal::Type::Enum

    FLAT_FEE = :FLAT_FEE
    MINIMUM_SPEND = :MINIMUM_SPEND
    PER_UNIT = :PER_UNIT
    USAGE_BASED = :USAGE_BASED
    CREDIT_BASED = :CREDIT_BASED

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # The billing period (MONTHLY or ANNUALLY)
  #
  # @see Stigg::Models::V1::ChargeList::Data#billing_period
  module BillingPeriod
    extend Stigg::Internal::Type::Enum

    MONTHLY = :MONTHLY
    ANNUALLY = :ANNUALLY

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # When credits are granted (for credit-based pricing)
  #
  # @see Stigg::Models::V1::ChargeList::Data#credit_grant_cadence
  module CreditGrantCadence
    extend Stigg::Internal::Type::Enum

    BEGINNING_OF_BILLING_PERIOD = :BEGINNING_OF_BILLING_PERIOD
    MONTHLY = :MONTHLY

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Stigg::Models::V1::ChargeList::Data#credit_rate
  class CreditRate < Stigg::Internal::Type::BaseModel
    # @!attribute amount
    #   Credit rate amount
    #
    #   @return [Float]
    required :amount, Float

    # @!attribute currency_id
    #   Custom currency identifier
    #
    #   @return [String]
    required :currency_id, String, api_name: :currencyId

    # @!attribute cost_formula
    #   Optional cost formula expression
    #
    #   @return [String, nil]
    optional :cost_formula, String, api_name: :costFormula, nil?: true

    # @!method initialize(amount:, currency_id:, cost_formula: nil)
    #   Credit rate configuration for credit-based pricing
    #
    #   @param amount [Float] Credit rate amount
    #
    #   @param currency_id [String] Custom currency identifier
    #
    #   @param cost_formula [String, nil] Optional cost formula expression
  end

  # @see Stigg::Models::V1::ChargeList::Data#price
  class Price < Stigg::Internal::Type::BaseModel
    # @!attribute amount
    #   The price amount
    #
    #   @return [Float]
    required :amount, Float

    # @!attribute currency
    #   ISO 4217 currency code
    #
    #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::Price::Currency]
    required :currency, enum: -> { Stigg::V1::ChargeList::Data::Price::Currency }

    # @!method initialize(amount:, currency:)
    #   The flat price amount and currency, when applicable
    #
    #   @param amount [Float] The price amount
    #
    #   @param currency [Symbol, Stigg::Models::V1::ChargeList::Data::Price::Currency] ISO 4217 currency code

    # ISO 4217 currency code
    #
    # @see Stigg::Models::V1::ChargeList::Data::Price#currency
    module Currency
      extend Stigg::Internal::Type::Enum

      USD = :usd
      AED = :aed
      ALL = :all
      AMD = :amd
      ANG = :ang
      AUD = :aud
      AWG = :awg
      AZN = :azn
      BAM = :bam
      BBD = :bbd
      BDT = :bdt
      BGN = :bgn
      BIF = :bif
      BMD = :bmd
      BND = :bnd
      BSD = :bsd
      BWP = :bwp
      BYN = :byn
      BZD = :bzd
      BRL = :brl
      CAD = :cad
      CDF = :cdf
      CHF = :chf
      CNY = :cny
      CZK = :czk
      DKK = :dkk
      DOP = :dop
      DZD = :dzd
      EGP = :egp
      ETB = :etb
      EUR = :eur
      FJD = :fjd
      GBP = :gbp
      GEL = :gel
      GIP = :gip
      GMD = :gmd
      GYD = :gyd
      HKD = :hkd
      HRK = :hrk
      HTG = :htg
      IDR = :idr
      ILS = :ils
      INR = :inr
      ISK = :isk
      JMD = :jmd
      JPY = :jpy
      KES = :kes
      KGS = :kgs
      KHR = :khr
      KMF = :kmf
      KRW = :krw
      KYD = :kyd
      KZT = :kzt
      LBP = :lbp
      LKR = :lkr
      LRD = :lrd
      LSL = :lsl
      MAD = :mad
      MDL = :mdl
      MGA = :mga
      MKD = :mkd
      MMK = :mmk
      MNT = :mnt
      MOP = :mop
      MRO = :mro
      MVR = :mvr
      MWK = :mwk
      MXN = :mxn
      MYR = :myr
      MZN = :mzn
      NAD = :nad
      NGN = :ngn
      NOK = :nok
      NPR = :npr
      NZD = :nzd
      PGK = :pgk
      PHP = :php
      PKR = :pkr
      PLN = :pln
      QAR = :qar
      RON = :ron
      RSD = :rsd
      RUB = :rub
      RWF = :rwf
      SAR = :sar
      SBD = :sbd
      SCR = :scr
      SEK = :sek
      SGD = :sgd
      SLE = :sle
      SLL = :sll
      SOS = :sos
      SZL = :szl
      THB = :thb
      TJS = :tjs
      TOP = :top
      TRY = :try
      TTD = :ttd
      TZS = :tzs
      UAH = :uah
      UZS = :uzs
      VND = :vnd
      VUV = :vuv
      WST = :wst
      XAF = :xaf
      XCD = :xcd
      YER = :yer
      ZAR = :zar
      ZMW = :zmw
      CLP = :clp
      DJF = :djf
      GNF = :gnf
      UGX = :ugx
      PYG = :pyg
      XOF = :xof
      XPF = :xpf

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  class Tier < Stigg::Internal::Type::BaseModel
    # @!attribute flat_price
    #   Flat price for this tier
    #
    #   @return [Stigg::Models::V1::ChargeList::Data::Tier::FlatPrice, nil]
    optional :flat_price,
             -> { Stigg::V1::ChargeList::Data::Tier::FlatPrice },
             api_name: :flatPrice,
             nil?: true

    # @!attribute unit_price
    #   Per-unit price in this tier
    #
    #   @return [Stigg::Models::V1::ChargeList::Data::Tier::UnitPrice, nil]
    optional :unit_price,
             -> { Stigg::V1::ChargeList::Data::Tier::UnitPrice },
             api_name: :unitPrice,
             nil?: true

    # @!attribute up_to
    #   Upper bound of this tier (null for unlimited)
    #
    #   @return [Float, nil]
    optional :up_to, Float, api_name: :upTo, nil?: true

    # @!method initialize(flat_price: nil, unit_price: nil, up_to: nil)
    #   A single tier within a tiered charge
    #
    #   @param flat_price [Stigg::Models::V1::ChargeList::Data::Tier::FlatPrice, nil] Flat price for this tier
    #
    #   @param unit_price [Stigg::Models::V1::ChargeList::Data::Tier::UnitPrice, nil] Per-unit price in this tier
    #
    #   @param up_to [Float, nil] Upper bound of this tier (null for unlimited)

    # @see Stigg::Models::V1::ChargeList::Data::Tier#flat_price
    class FlatPrice < Stigg::Internal::Type::BaseModel
      # @!attribute amount
      #   The price amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute currency
      #   ISO 4217 currency code
      #
      #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::Tier::FlatPrice::Currency]
      required :currency, enum: -> { Stigg::V1::ChargeList::Data::Tier::FlatPrice::Currency }

      # @!method initialize(amount:, currency:)
      #   Flat price for this tier
      #
      #   @param amount [Float] The price amount
      #
      #   @param currency [Symbol, Stigg::Models::V1::ChargeList::Data::Tier::FlatPrice::Currency] ISO 4217 currency code

      # ISO 4217 currency code
      #
      # @see Stigg::Models::V1::ChargeList::Data::Tier::FlatPrice#currency
      module Currency
        extend Stigg::Internal::Type::Enum

        USD = :usd
        AED = :aed
        ALL = :all
        AMD = :amd
        ANG = :ang
        AUD = :aud
        AWG = :awg
        AZN = :azn
        BAM = :bam
        BBD = :bbd
        BDT = :bdt
        BGN = :bgn
        BIF = :bif
        BMD = :bmd
        BND = :bnd
        BSD = :bsd
        BWP = :bwp
        BYN = :byn
        BZD = :bzd
        BRL = :brl
        CAD = :cad
        CDF = :cdf
        CHF = :chf
        CNY = :cny
        CZK = :czk
        DKK = :dkk
        DOP = :dop
        DZD = :dzd
        EGP = :egp
        ETB = :etb
        EUR = :eur
        FJD = :fjd
        GBP = :gbp
        GEL = :gel
        GIP = :gip
        GMD = :gmd
        GYD = :gyd
        HKD = :hkd
        HRK = :hrk
        HTG = :htg
        IDR = :idr
        ILS = :ils
        INR = :inr
        ISK = :isk
        JMD = :jmd
        JPY = :jpy
        KES = :kes
        KGS = :kgs
        KHR = :khr
        KMF = :kmf
        KRW = :krw
        KYD = :kyd
        KZT = :kzt
        LBP = :lbp
        LKR = :lkr
        LRD = :lrd
        LSL = :lsl
        MAD = :mad
        MDL = :mdl
        MGA = :mga
        MKD = :mkd
        MMK = :mmk
        MNT = :mnt
        MOP = :mop
        MRO = :mro
        MVR = :mvr
        MWK = :mwk
        MXN = :mxn
        MYR = :myr
        MZN = :mzn
        NAD = :nad
        NGN = :ngn
        NOK = :nok
        NPR = :npr
        NZD = :nzd
        PGK = :pgk
        PHP = :php
        PKR = :pkr
        PLN = :pln
        QAR = :qar
        RON = :ron
        RSD = :rsd
        RUB = :rub
        RWF = :rwf
        SAR = :sar
        SBD = :sbd
        SCR = :scr
        SEK = :sek
        SGD = :sgd
        SLE = :sle
        SLL = :sll
        SOS = :sos
        SZL = :szl
        THB = :thb
        TJS = :tjs
        TOP = :top
        TRY = :try
        TTD = :ttd
        TZS = :tzs
        UAH = :uah
        UZS = :uzs
        VND = :vnd
        VUV = :vuv
        WST = :wst
        XAF = :xaf
        XCD = :xcd
        YER = :yer
        ZAR = :zar
        ZMW = :zmw
        CLP = :clp
        DJF = :djf
        GNF = :gnf
        UGX = :ugx
        PYG = :pyg
        XOF = :xof
        XPF = :xpf

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    # @see Stigg::Models::V1::ChargeList::Data::Tier#unit_price
    class UnitPrice < Stigg::Internal::Type::BaseModel
      # @!attribute amount
      #   The price amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute currency
      #   ISO 4217 currency code
      #
      #   @return [Symbol, Stigg::Models::V1::ChargeList::Data::Tier::UnitPrice::Currency]
      required :currency, enum: -> { Stigg::V1::ChargeList::Data::Tier::UnitPrice::Currency }

      # @!method initialize(amount:, currency:)
      #   Per-unit price in this tier
      #
      #   @param amount [Float] The price amount
      #
      #   @param currency [Symbol, Stigg::Models::V1::ChargeList::Data::Tier::UnitPrice::Currency] ISO 4217 currency code

      # ISO 4217 currency code
      #
      # @see Stigg::Models::V1::ChargeList::Data::Tier::UnitPrice#currency
      module Currency
        extend Stigg::Internal::Type::Enum

        USD = :usd
        AED = :aed
        ALL = :all
        AMD = :amd
        ANG = :ang
        AUD = :aud
        AWG = :awg
        AZN = :azn
        BAM = :bam
        BBD = :bbd
        BDT = :bdt
        BGN = :bgn
        BIF = :bif
        BMD = :bmd
        BND = :bnd
        BSD = :bsd
        BWP = :bwp
        BYN = :byn
        BZD = :bzd
        BRL = :brl
        CAD = :cad
        CDF = :cdf
        CHF = :chf
        CNY = :cny
        CZK = :czk
        DKK = :dkk
        DOP = :dop
        DZD = :dzd
        EGP = :egp
        ETB = :etb
        EUR = :eur
        FJD = :fjd
        GBP = :gbp
        GEL = :gel
        GIP = :gip
        GMD = :gmd
        GYD = :gyd
        HKD = :hkd
        HRK = :hrk
        HTG = :htg
        IDR = :idr
        ILS = :ils
        INR = :inr
        ISK = :isk
        JMD = :jmd
        JPY = :jpy
        KES = :kes
        KGS = :kgs
        KHR = :khr
        KMF = :kmf
        KRW = :krw
        KYD = :kyd
        KZT = :kzt
        LBP = :lbp
        LKR = :lkr
        LRD = :lrd
        LSL = :lsl
        MAD = :mad
        MDL = :mdl
        MGA = :mga
        MKD = :mkd
        MMK = :mmk
        MNT = :mnt
        MOP = :mop
        MRO = :mro
        MVR = :mvr
        MWK = :mwk
        MXN = :mxn
        MYR = :myr
        MZN = :mzn
        NAD = :nad
        NGN = :ngn
        NOK = :nok
        NPR = :npr
        NZD = :nzd
        PGK = :pgk
        PHP = :php
        PKR = :pkr
        PLN = :pln
        QAR = :qar
        RON = :ron
        RSD = :rsd
        RUB = :rub
        RWF = :rwf
        SAR = :sar
        SBD = :sbd
        SCR = :scr
        SEK = :sek
        SGD = :sgd
        SLE = :sle
        SLL = :sll
        SOS = :sos
        SZL = :szl
        THB = :thb
        TJS = :tjs
        TOP = :top
        TRY = :try
        TTD = :ttd
        TZS = :tzs
        UAH = :uah
        UZS = :uzs
        VND = :vnd
        VUV = :vuv
        WST = :wst
        XAF = :xaf
        XCD = :xcd
        YER = :yer
        ZAR = :zar
        ZMW = :zmw
        CLP = :clp
        DJF = :djf
        GNF = :gnf
        UGX = :ugx
        PYG = :pyg
        XOF = :xof
        XPF = :xpf

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end
  end

  # Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
  #
  # @see Stigg::Models::V1::ChargeList::Data#tiers_mode
  module TiersMode
    extend Stigg::Internal::Type::Enum

    VOLUME = :VOLUME
    GRADUATED = :GRADUATED

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#billing_cadence ⇒ Symbol, Stigg::Models::V1::ChargeList::Data::BillingCadence

The billing cadence (RECURRING or ONE_OFF)

Returns:



36
37
38
 
# File 'lib/stigg/models/v1/charge_list.rb', line 36

required :billing_cadence,
enum: -> { Stigg::V1::ChargeList::Data::BillingCadence },
api_name: :billingCadence

#billing_country_code ⇒ String?

ISO country code for localized pricing, if any

Returns:

  • (String, nil) 


68
 
# File 'lib/stigg/models/v1/charge_list.rb', line 68

optional :billing_country_code, String, api_name: :billingCountryCode, nil?: true

#billing_id ⇒ String?

Identifier in the external billing integration (e.g. Stripe price id), if any

Returns:

  • (String, nil) 


74
 
# File 'lib/stigg/models/v1/charge_list.rb', line 74

optional :billing_id, String, api_name: :billingId, nil?: true

#billing_model ⇒ Symbol, Stigg::Models::V1::ChargeList::Data::BillingModel

The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)

Returns:



44
45
46
47
48
 
# File 'lib/stigg/models/v1/charge_list.rb', line 44

required :billing_model,
enum: -> {
  Stigg::V1::ChargeList::Data::BillingModel
},
api_name: :billingModel

#billing_period ⇒ Symbol, Stigg::Models::V1::ChargeList::Data::BillingPeriod

The billing period (MONTHLY or ANNUALLY)

Returns:



54
55
56
 
# File 'lib/stigg/models/v1/charge_list.rb', line 54

required :billing_period,
enum: -> { Stigg::V1::ChargeList::Data::BillingPeriod },
api_name: :billingPeriod

#block_size ⇒ Float?

Block size for usage-based pricing

Returns:

  • (Float, nil) 


80
 
# File 'lib/stigg/models/v1/charge_list.rb', line 80

optional :block_size, Float, api_name: :blockSize, nil?: true

#created_at ⇒ Time

Timestamp when the charge was created

Returns:

  • (Time) 


62
 
# File 'lib/stigg/models/v1/charge_list.rb', line 62

required :created_at, Time, api_name: :createdAt

#credit_grant_cadence ⇒ Symbol, ...

When credits are granted (for credit-based pricing)

Returns:



86
87
88
89
 
# File 'lib/stigg/models/v1/charge_list.rb', line 86

optional :credit_grant_cadence,
enum: -> { Stigg::V1::ChargeList::Data::CreditGrantCadence },
api_name: :creditGrantCadence,
nil?: true

#credit_rate ⇒ Stigg::Models::V1::ChargeList::Data::CreditRate?

Credit rate configuration for credit-based pricing

Returns:



95
96
97
98
99
100
 
# File 'lib/stigg/models/v1/charge_list.rb', line 95

optional :credit_rate,
-> {
  Stigg::V1::ChargeList::Data::CreditRate
},
api_name: :creditRate,
nil?: true

#crm_id ⇒ String?

Identifier in the linked CRM, if any

Returns:

  • (String, nil) 


106
 
# File 'lib/stigg/models/v1/charge_list.rb', line 106

optional :crm_id, String, api_name: :crmId, nil?: true

#crm_link_url ⇒ String?

Deep link to the charge in the linked CRM, if any

Returns:

  • (String, nil) 


112
 
# File 'lib/stigg/models/v1/charge_list.rb', line 112

optional :crm_link_url, String, api_name: :crmLinkUrl, nil?: true

#feature_id ⇒ String?

The feature this charge meters, if metered

Returns:

  • (String, nil) 


118
 
# File 'lib/stigg/models/v1/charge_list.rb', line 118

optional :feature_id, String, api_name: :featureId, nil?: true

#id ⇒ String

Unique identifier of the charge

Returns:

  • (String) 


30
 
# File 'lib/stigg/models/v1/charge_list.rb', line 30

required :id, String

#max_unit_quantity ⇒ Float?

Maximum unit quantity that can be purchased

Returns:

  • (Float, nil) 


124
 
# File 'lib/stigg/models/v1/charge_list.rb', line 124

optional :max_unit_quantity, Float, api_name: :maxUnitQuantity, nil?: true

#min_unit_quantity ⇒ Float?

Minimum unit quantity that can be purchased

Returns:

  • (Float, nil) 


130
 
# File 'lib/stigg/models/v1/charge_list.rb', line 130

optional :min_unit_quantity, Float, api_name: :minUnitQuantity, nil?: true

#price ⇒ Stigg::Models::V1::ChargeList::Data::Price?

The flat price amount and currency, when applicable

Returns:



136
 
# File 'lib/stigg/models/v1/charge_list.rb', line 136

optional :price, -> { Stigg::V1::ChargeList::Data::Price }, nil?: true

#tiers ⇒ Array<Stigg::Models::V1::ChargeList::Data::Tier>?

Tiered pricing rows when the charge is tiered

Returns:



142
143
144
145
146
 
# File 'lib/stigg/models/v1/charge_list.rb', line 142

optional :tiers,
-> {
  Stigg::Internal::Type::ArrayOf[Stigg::V1::ChargeList::Data::Tier]
},
nil?: true

#tiers_mode ⇒ Symbol, ...

Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered

Returns:



152
153
154
155
 
# File 'lib/stigg/models/v1/charge_list.rb', line 152

optional :tiers_mode,
enum: -> { Stigg::V1::ChargeList::Data::TiersMode },
api_name: :tiersMode,
nil?: true

#top_up_custom_currency_id ⇒ String?

Custom currency identifier for top-up pricing, if any

Returns:

  • (String, nil) 


161
 
# File 'lib/stigg/models/v1/charge_list.rb', line 161

optional :top_up_custom_currency_id, String, api_name: :topUpCustomCurrencyId, nil?: true

#used_in_subscriptions ⇒ Boolean?

True if this charge is referenced by at least one subscription

Returns:

  • (Boolean, nil) 


167
168
169
170
 
# File 'lib/stigg/models/v1/charge_list.rb', line 167

optional :used_in_subscriptions,
Stigg::Internal::Type::Boolean,
api_name: :usedInSubscriptions,
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/charge_list.rb', line 229