-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathprice.go
More file actions
7271 lines (6333 loc) · 440 KB
/
price.go
File metadata and controls
7271 lines (6333 loc) · 440 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package orb
import (
"context"
"errors"
"fmt"
"net/http"
"net/url"
"reflect"
"slices"
"time"
"github.com/orbcorp/orb-go/internal/apijson"
"github.com/orbcorp/orb-go/internal/apiquery"
"github.com/orbcorp/orb-go/internal/param"
"github.com/orbcorp/orb-go/internal/requestconfig"
"github.com/orbcorp/orb-go/option"
"github.com/orbcorp/orb-go/packages/pagination"
"github.com/orbcorp/orb-go/shared"
"github.com/tidwall/gjson"
)
// The Price resource represents a price that can be billed on a subscription,
// resulting in a charge on an invoice in the form of an invoice line item. Prices
// take a quantity and determine an amount to bill.
//
// Orb supports a few different pricing models out of the box. Each of these models
// is serialized differently in a given Price object. The model_type field
// determines the key for the configuration object that is present.
//
// For more on the types of prices, see
// [the core concepts documentation](/core-concepts#plan-and-price)
//
// PriceService contains methods and other services that help with interacting with
// the orb API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewPriceService] method instead.
type PriceService struct {
Options []option.RequestOption
// The Price resource represents a price that can be billed on a subscription,
// resulting in a charge on an invoice in the form of an invoice line item. Prices
// take a quantity and determine an amount to bill.
//
// Orb supports a few different pricing models out of the box. Each of these models
// is serialized differently in a given Price object. The model_type field
// determines the key for the configuration object that is present.
//
// For more on the types of prices, see
// [the core concepts documentation](/core-concepts#plan-and-price)
ExternalPriceID *PriceExternalPriceIDService
}
// NewPriceService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
func NewPriceService(opts ...option.RequestOption) (r *PriceService) {
r = &PriceService{}
r.Options = opts
r.ExternalPriceID = NewPriceExternalPriceIDService(opts...)
return
}
// This endpoint is used to create a [price](/product-catalog/price-configuration).
// A price created using this endpoint is always an add-on, meaning that it's not
// associated with a specific plan and can instead be individually added to
// subscriptions, including subscriptions on different plans.
//
// An `external_price_id` can be optionally specified as an alias to allow
// ergonomic interaction with prices in the Orb API.
//
// See the [Price resource](/product-catalog/price-configuration) for the
// specification of different price model configurations possible in this endpoint.
func (r *PriceService) New(ctx context.Context, body PriceNewParams, opts ...option.RequestOption) (res *shared.Price, err error) {
opts = slices.Concat(r.Options, opts)
path := "prices"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// This endpoint allows you to update the `metadata` property on a price. If you
// pass null for the metadata value, it will clear any existing metadata for that
// price.
func (r *PriceService) Update(ctx context.Context, priceID string, body PriceUpdateParams, opts ...option.RequestOption) (res *shared.Price, err error) {
opts = slices.Concat(r.Options, opts)
if priceID == "" {
err = errors.New("missing required price_id parameter")
return nil, err
}
path := fmt.Sprintf("prices/%s", priceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPut, path, body, &res, opts...)
return res, err
}
// This endpoint is used to list all add-on prices created using the
// [price creation endpoint](/api-reference/price/create-price).
func (r *PriceService) List(ctx context.Context, query PriceListParams, opts ...option.RequestOption) (res *pagination.Page[shared.Price], err error) {
var raw *http.Response
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "prices"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, query, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// This endpoint is used to list all add-on prices created using the
// [price creation endpoint](/api-reference/price/create-price).
func (r *PriceService) ListAutoPaging(ctx context.Context, query PriceListParams, opts ...option.RequestOption) *pagination.PageAutoPager[shared.Price] {
return pagination.NewPageAutoPager(r.List(ctx, query, opts...))
}
// [NOTE] It is recommended to use the `/v1/prices/evaluate` which offers further
// functionality, such as multiple prices, inline price definitions, and querying
// over preview events.
//
// This endpoint is used to evaluate the output of a price for a given customer and
// time range. It enables filtering and grouping the output using
// [computed properties](/extensibility/advanced-metrics#computed-properties),
// supporting the following workflows:
//
// 1. Showing detailed usage and costs to the end customer.
// 2. Auditing subtotals on invoice line items.
//
// For these workflows, the expressiveness of computed properties in both the
// filters and grouping is critical. For example, if you'd like to show your
// customer their usage grouped by hour and another property, you can do so with
// the following `grouping_keys`:
// `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd
// like to examine a customer's usage for a specific property value, you can do so
// with the following `filter`:
// `my_property = 'foo' AND my_other_property = 'bar'`.
//
// By default, the start of the time range must be no more than 100 days ago and
// the length of the results must be no greater than 1000. Note that this is a POST
// endpoint rather than a GET endpoint because it employs a JSON body rather than
// query parameters.
func (r *PriceService) Evaluate(ctx context.Context, priceID string, body PriceEvaluateParams, opts ...option.RequestOption) (res *PriceEvaluateResponse, err error) {
opts = slices.Concat(r.Options, opts)
if priceID == "" {
err = errors.New("missing required price_id parameter")
return nil, err
}
path := fmt.Sprintf("prices/%s/evaluate", priceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// This endpoint is used to evaluate the output of price(s) for a given customer
// and time range over ingested events. It enables filtering and grouping the
// output using
// [computed properties](/extensibility/advanced-metrics#computed-properties),
// supporting the following workflows:
//
// 1. Showing detailed usage and costs to the end customer.
// 2. Auditing subtotals on invoice line items.
//
// For these workflows, the expressiveness of computed properties in both the
// filters and grouping is critical. For example, if you'd like to show your
// customer their usage grouped by hour and another property, you can do so with
// the following `grouping_keys`:
// `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd
// like to examine a customer's usage for a specific property value, you can do so
// with the following `filter`:
// `my_property = 'foo' AND my_other_property = 'bar'`.
//
// Prices may either reference existing prices in your Orb account or be defined
// inline in the request body. Up to 100 prices can be evaluated in a single
// request.
//
// Prices are evaluated on ingested events and the start of the time range must be
// no more than 100 days ago. To evaluate based off a set of provided events, the
// [evaluate preview events](/api-reference/price/evaluate-preview-events) endpoint
// can be used instead.
//
// Note that this is a POST endpoint rather than a GET endpoint because it employs
// a JSON body rather than query parameters.
func (r *PriceService) EvaluateMultiple(ctx context.Context, body PriceEvaluateMultipleParams, opts ...option.RequestOption) (res *PriceEvaluateMultipleResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "prices/evaluate"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// This endpoint evaluates prices on preview events instead of actual usage, making
// it ideal for building price calculators and cost estimation tools. You can
// filter and group results using
// [computed properties](/extensibility/advanced-metrics#computed-properties) to
// analyze pricing across different dimensions.
//
// Prices may either reference existing prices in your Orb account or be defined
// inline in the request body. The endpoint has the following limitations:
//
// 1. Up to 100 prices can be evaluated in a single request.
// 2. Up to 500 preview events can be provided in a single request.
//
// A top-level customer_id is required to evaluate the preview events.
// Additionally, all events without a customer_id will have the top-level
// customer_id added.
//
// Note that this is a POST endpoint rather than a GET endpoint because it employs
// a JSON body rather than query parameters.
func (r *PriceService) EvaluatePreviewEvents(ctx context.Context, body PriceEvaluatePreviewEventsParams, opts ...option.RequestOption) (res *PriceEvaluatePreviewEventsResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "prices/evaluate_preview_events"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// This endpoint returns a price given an identifier.
func (r *PriceService) Fetch(ctx context.Context, priceID string, opts ...option.RequestOption) (res *shared.Price, err error) {
opts = slices.Concat(r.Options, opts)
if priceID == "" {
err = errors.New("missing required price_id parameter")
return nil, err
}
path := fmt.Sprintf("prices/%s", priceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
return res, err
}
type EvaluatePriceGroup struct {
// The price's output for the group
Amount string `json:"amount" api:"required"`
// The values for the group in the order specified by `grouping_keys`
GroupingValues []EvaluatePriceGroupGroupingValuesUnion `json:"grouping_values" api:"required"`
// The price's usage quantity for the group
Quantity float64 `json:"quantity" api:"required"`
JSON evaluatePriceGroupJSON `json:"-"`
}
// evaluatePriceGroupJSON contains the JSON metadata for the struct
// [EvaluatePriceGroup]
type evaluatePriceGroupJSON struct {
Amount apijson.Field
GroupingValues apijson.Field
Quantity apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EvaluatePriceGroup) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r evaluatePriceGroupJSON) RawJSON() string {
return r.raw
}
// Union satisfied by [shared.UnionString], [shared.UnionFloat] or
// [shared.UnionBool].
type EvaluatePriceGroupGroupingValuesUnion interface {
ImplementsEvaluatePriceGroupGroupingValuesUnion()
}
func init() {
apijson.RegisterUnion(
reflect.TypeOf((*EvaluatePriceGroupGroupingValuesUnion)(nil)).Elem(),
"",
apijson.UnionVariant{
TypeFilter: gjson.String,
Type: reflect.TypeOf(shared.UnionString("")),
},
apijson.UnionVariant{
TypeFilter: gjson.Number,
Type: reflect.TypeOf(shared.UnionFloat(0)),
},
apijson.UnionVariant{
TypeFilter: gjson.True,
Type: reflect.TypeOf(shared.UnionBool(false)),
},
apijson.UnionVariant{
TypeFilter: gjson.False,
Type: reflect.TypeOf(shared.UnionBool(false)),
},
)
}
type PriceEvaluateResponse struct {
Data []EvaluatePriceGroup `json:"data" api:"required"`
JSON priceEvaluateResponseJSON `json:"-"`
}
// priceEvaluateResponseJSON contains the JSON metadata for the struct
// [PriceEvaluateResponse]
type priceEvaluateResponseJSON struct {
Data apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *PriceEvaluateResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r priceEvaluateResponseJSON) RawJSON() string {
return r.raw
}
type PriceEvaluateMultipleResponse struct {
Data []PriceEvaluateMultipleResponseData `json:"data" api:"required"`
JSON priceEvaluateMultipleResponseJSON `json:"-"`
}
// priceEvaluateMultipleResponseJSON contains the JSON metadata for the struct
// [PriceEvaluateMultipleResponse]
type priceEvaluateMultipleResponseJSON struct {
Data apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *PriceEvaluateMultipleResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r priceEvaluateMultipleResponseJSON) RawJSON() string {
return r.raw
}
type PriceEvaluateMultipleResponseData struct {
// The currency of the price
Currency string `json:"currency" api:"required"`
// The computed price groups associated with input price.
PriceGroups []EvaluatePriceGroup `json:"price_groups" api:"required"`
// The external ID of the price
ExternalPriceID string `json:"external_price_id" api:"nullable"`
// The index of the inline price
InlinePriceIndex int64 `json:"inline_price_index" api:"nullable"`
// The ID of the price
PriceID string `json:"price_id" api:"nullable"`
JSON priceEvaluateMultipleResponseDataJSON `json:"-"`
}
// priceEvaluateMultipleResponseDataJSON contains the JSON metadata for the struct
// [PriceEvaluateMultipleResponseData]
type priceEvaluateMultipleResponseDataJSON struct {
Currency apijson.Field
PriceGroups apijson.Field
ExternalPriceID apijson.Field
InlinePriceIndex apijson.Field
PriceID apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *PriceEvaluateMultipleResponseData) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r priceEvaluateMultipleResponseDataJSON) RawJSON() string {
return r.raw
}
type PriceEvaluatePreviewEventsResponse struct {
Data []PriceEvaluatePreviewEventsResponseData `json:"data" api:"required"`
JSON priceEvaluatePreviewEventsResponseJSON `json:"-"`
}
// priceEvaluatePreviewEventsResponseJSON contains the JSON metadata for the struct
// [PriceEvaluatePreviewEventsResponse]
type priceEvaluatePreviewEventsResponseJSON struct {
Data apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *PriceEvaluatePreviewEventsResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r priceEvaluatePreviewEventsResponseJSON) RawJSON() string {
return r.raw
}
type PriceEvaluatePreviewEventsResponseData struct {
// The currency of the price
Currency string `json:"currency" api:"required"`
// The computed price groups associated with input price.
PriceGroups []EvaluatePriceGroup `json:"price_groups" api:"required"`
// The external ID of the price
ExternalPriceID string `json:"external_price_id" api:"nullable"`
// The index of the inline price
InlinePriceIndex int64 `json:"inline_price_index" api:"nullable"`
// The ID of the price
PriceID string `json:"price_id" api:"nullable"`
JSON priceEvaluatePreviewEventsResponseDataJSON `json:"-"`
}
// priceEvaluatePreviewEventsResponseDataJSON contains the JSON metadata for the
// struct [PriceEvaluatePreviewEventsResponseData]
type priceEvaluatePreviewEventsResponseDataJSON struct {
Currency apijson.Field
PriceGroups apijson.Field
ExternalPriceID apijson.Field
InlinePriceIndex apijson.Field
PriceID apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *PriceEvaluatePreviewEventsResponseData) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r priceEvaluatePreviewEventsResponseDataJSON) RawJSON() string {
return r.raw
}
// This interface is a union satisfied by one of the following:
// [PriceNewParamsNewFloatingUnitPrice], [PriceNewParamsNewFloatingTieredPrice],
// [PriceNewParamsNewFloatingBulkPrice],
// [PriceNewParamsNewFloatingBulkWithFiltersPrice],
// [PriceNewParamsNewFloatingPackagePrice], [PriceNewParamsNewFloatingMatrixPrice],
// [PriceNewParamsNewFloatingThresholdTotalAmountPrice],
// [PriceNewParamsNewFloatingTieredPackagePrice],
// [PriceNewParamsNewFloatingTieredWithMinimumPrice],
// [PriceNewParamsNewFloatingGroupedTieredPrice],
// [PriceNewParamsNewFloatingTieredPackageWithMinimumPrice],
// [PriceNewParamsNewFloatingPackageWithAllocationPrice],
// [PriceNewParamsNewFloatingUnitWithPercentPrice],
// [PriceNewParamsNewFloatingMatrixWithAllocationPrice],
// [PriceNewParamsNewFloatingTieredWithProrationPrice],
// [PriceNewParamsNewFloatingUnitWithProrationPrice],
// [PriceNewParamsNewFloatingGroupedAllocationPrice],
// [PriceNewParamsNewFloatingBulkWithProrationPrice],
// [PriceNewParamsNewFloatingGroupedWithProratedMinimumPrice],
// [PriceNewParamsNewFloatingGroupedWithMeteredMinimumPrice],
// [PriceNewParamsNewFloatingGroupedWithMinMaxThresholdsPrice],
// [PriceNewParamsNewFloatingMatrixWithDisplayNamePrice],
// [PriceNewParamsNewFloatingGroupedTieredPackagePrice],
// [PriceNewParamsNewFloatingMaxGroupTieredPackagePrice],
// [PriceNewParamsNewFloatingScalableMatrixWithUnitPricingPrice],
// [PriceNewParamsNewFloatingScalableMatrixWithTieredPricingPrice],
// [PriceNewParamsNewFloatingCumulativeGroupedBulkPrice],
// [PriceNewParamsNewFloatingCumulativeGroupedAllocationPrice],
// [PriceNewParamsNewFloatingDailyCreditAllowancePrice],
// [PriceNewParamsNewFloatingMinimumCompositePrice],
// [PriceNewParamsNewFloatingPercentCompositePrice],
// [PriceNewParamsNewFloatingEventOutputPrice].
type PriceNewParams interface {
ImplementsPriceNewParams()
}
type PriceNewParamsNewFloatingUnitPrice struct {
// The cadence to bill for this price on.
Cadence param.Field[PriceNewParamsNewFloatingUnitPriceCadence] `json:"cadence" api:"required"`
// An ISO 4217 currency string for which this price is billed in.
Currency param.Field[string] `json:"currency" api:"required"`
// The id of the item the price will be associated with.
ItemID param.Field[string] `json:"item_id" api:"required"`
// The pricing model type
ModelType param.Field[PriceNewParamsNewFloatingUnitPriceModelType] `json:"model_type" api:"required"`
// The name of the price.
Name param.Field[string] `json:"name" api:"required"`
// Configuration for unit pricing
UnitConfig param.Field[shared.UnitConfigParam] `json:"unit_config" api:"required"`
// The id of the billable metric for the price. Only needed if the price is
// usage-based.
BillableMetricID param.Field[string] `json:"billable_metric_id"`
// If the Price represents a fixed cost, the price will be billed in-advance if
// this is true, and in-arrears if this is false.
BilledInAdvance param.Field[bool] `json:"billed_in_advance"`
// For custom cadence: specifies the duration of the billing period in days or
// months.
BillingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"billing_cycle_configuration"`
// The per unit conversion rate of the price currency to the invoicing currency.
ConversionRate param.Field[float64] `json:"conversion_rate"`
// The configuration for the rate of the price currency to the invoicing currency.
ConversionRateConfig param.Field[PriceNewParamsNewFloatingUnitPriceConversionRateConfigUnion] `json:"conversion_rate_config"`
// For dimensional price: specifies a price group and dimension values
DimensionalPriceConfiguration param.Field[shared.NewDimensionalPriceConfigurationParam] `json:"dimensional_price_configuration"`
// An alias for the price.
ExternalPriceID param.Field[string] `json:"external_price_id"`
// If the Price represents a fixed cost, this represents the quantity of units
// applied.
FixedPriceQuantity param.Field[float64] `json:"fixed_price_quantity"`
// The property used to group this price on an invoice
InvoiceGroupingKey param.Field[string] `json:"invoice_grouping_key"`
// Within each billing cycle, specifies the cadence at which invoices are produced.
// If unspecified, a single invoice is produced per billing cycle.
InvoicingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"invoicing_cycle_configuration"`
// The ID of the license type to associate with this price.
LicenseTypeID param.Field[string] `json:"license_type_id"`
// User-specified key/value pairs for the resource. Individual keys can be removed
// by setting the value to `null`, and the entire metadata mapping can be cleared
// by setting `metadata` to `null`.
Metadata param.Field[map[string]string] `json:"metadata"`
}
func (r PriceNewParamsNewFloatingUnitPrice) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (PriceNewParamsNewFloatingUnitPrice) ImplementsPriceNewParams() {
}
// The cadence to bill for this price on.
type PriceNewParamsNewFloatingUnitPriceCadence string
const (
PriceNewParamsNewFloatingUnitPriceCadenceAnnual PriceNewParamsNewFloatingUnitPriceCadence = "annual"
PriceNewParamsNewFloatingUnitPriceCadenceSemiAnnual PriceNewParamsNewFloatingUnitPriceCadence = "semi_annual"
PriceNewParamsNewFloatingUnitPriceCadenceMonthly PriceNewParamsNewFloatingUnitPriceCadence = "monthly"
PriceNewParamsNewFloatingUnitPriceCadenceQuarterly PriceNewParamsNewFloatingUnitPriceCadence = "quarterly"
PriceNewParamsNewFloatingUnitPriceCadenceOneTime PriceNewParamsNewFloatingUnitPriceCadence = "one_time"
PriceNewParamsNewFloatingUnitPriceCadenceCustom PriceNewParamsNewFloatingUnitPriceCadence = "custom"
)
func (r PriceNewParamsNewFloatingUnitPriceCadence) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingUnitPriceCadenceAnnual, PriceNewParamsNewFloatingUnitPriceCadenceSemiAnnual, PriceNewParamsNewFloatingUnitPriceCadenceMonthly, PriceNewParamsNewFloatingUnitPriceCadenceQuarterly, PriceNewParamsNewFloatingUnitPriceCadenceOneTime, PriceNewParamsNewFloatingUnitPriceCadenceCustom:
return true
}
return false
}
// The pricing model type
type PriceNewParamsNewFloatingUnitPriceModelType string
const (
PriceNewParamsNewFloatingUnitPriceModelTypeUnit PriceNewParamsNewFloatingUnitPriceModelType = "unit"
)
func (r PriceNewParamsNewFloatingUnitPriceModelType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingUnitPriceModelTypeUnit:
return true
}
return false
}
type PriceNewParamsNewFloatingUnitPriceConversionRateConfig struct {
ConversionRateType param.Field[PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateType] `json:"conversion_rate_type" api:"required"`
TieredConfig param.Field[shared.ConversionRateTieredConfigParam] `json:"tiered_config"`
UnitConfig param.Field[shared.ConversionRateUnitConfigParam] `json:"unit_config"`
}
func (r PriceNewParamsNewFloatingUnitPriceConversionRateConfig) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (r PriceNewParamsNewFloatingUnitPriceConversionRateConfig) ImplementsPriceNewParamsNewFloatingUnitPriceConversionRateConfigUnion() {
}
// Satisfied by [shared.UnitConversionRateConfigParam],
// [shared.TieredConversionRateConfigParam],
// [PriceNewParamsNewFloatingUnitPriceConversionRateConfig].
type PriceNewParamsNewFloatingUnitPriceConversionRateConfigUnion interface {
ImplementsPriceNewParamsNewFloatingUnitPriceConversionRateConfigUnion()
}
type PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateType string
const (
PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateTypeUnit PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateType = "unit"
PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateTypeTiered PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateType = "tiered"
)
func (r PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateTypeUnit, PriceNewParamsNewFloatingUnitPriceConversionRateConfigConversionRateTypeTiered:
return true
}
return false
}
type PriceNewParamsNewFloatingTieredPrice struct {
// The cadence to bill for this price on.
Cadence param.Field[PriceNewParamsNewFloatingTieredPriceCadence] `json:"cadence" api:"required"`
// An ISO 4217 currency string for which this price is billed in.
Currency param.Field[string] `json:"currency" api:"required"`
// The id of the item the price will be associated with.
ItemID param.Field[string] `json:"item_id" api:"required"`
// The pricing model type
ModelType param.Field[PriceNewParamsNewFloatingTieredPriceModelType] `json:"model_type" api:"required"`
// The name of the price.
Name param.Field[string] `json:"name" api:"required"`
// Configuration for tiered pricing
TieredConfig param.Field[shared.TieredConfigParam] `json:"tiered_config" api:"required"`
// The id of the billable metric for the price. Only needed if the price is
// usage-based.
BillableMetricID param.Field[string] `json:"billable_metric_id"`
// If the Price represents a fixed cost, the price will be billed in-advance if
// this is true, and in-arrears if this is false.
BilledInAdvance param.Field[bool] `json:"billed_in_advance"`
// For custom cadence: specifies the duration of the billing period in days or
// months.
BillingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"billing_cycle_configuration"`
// The per unit conversion rate of the price currency to the invoicing currency.
ConversionRate param.Field[float64] `json:"conversion_rate"`
// The configuration for the rate of the price currency to the invoicing currency.
ConversionRateConfig param.Field[PriceNewParamsNewFloatingTieredPriceConversionRateConfigUnion] `json:"conversion_rate_config"`
// For dimensional price: specifies a price group and dimension values
DimensionalPriceConfiguration param.Field[shared.NewDimensionalPriceConfigurationParam] `json:"dimensional_price_configuration"`
// An alias for the price.
ExternalPriceID param.Field[string] `json:"external_price_id"`
// If the Price represents a fixed cost, this represents the quantity of units
// applied.
FixedPriceQuantity param.Field[float64] `json:"fixed_price_quantity"`
// The property used to group this price on an invoice
InvoiceGroupingKey param.Field[string] `json:"invoice_grouping_key"`
// Within each billing cycle, specifies the cadence at which invoices are produced.
// If unspecified, a single invoice is produced per billing cycle.
InvoicingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"invoicing_cycle_configuration"`
// The ID of the license type to associate with this price.
LicenseTypeID param.Field[string] `json:"license_type_id"`
// User-specified key/value pairs for the resource. Individual keys can be removed
// by setting the value to `null`, and the entire metadata mapping can be cleared
// by setting `metadata` to `null`.
Metadata param.Field[map[string]string] `json:"metadata"`
}
func (r PriceNewParamsNewFloatingTieredPrice) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (PriceNewParamsNewFloatingTieredPrice) ImplementsPriceNewParams() {
}
// The cadence to bill for this price on.
type PriceNewParamsNewFloatingTieredPriceCadence string
const (
PriceNewParamsNewFloatingTieredPriceCadenceAnnual PriceNewParamsNewFloatingTieredPriceCadence = "annual"
PriceNewParamsNewFloatingTieredPriceCadenceSemiAnnual PriceNewParamsNewFloatingTieredPriceCadence = "semi_annual"
PriceNewParamsNewFloatingTieredPriceCadenceMonthly PriceNewParamsNewFloatingTieredPriceCadence = "monthly"
PriceNewParamsNewFloatingTieredPriceCadenceQuarterly PriceNewParamsNewFloatingTieredPriceCadence = "quarterly"
PriceNewParamsNewFloatingTieredPriceCadenceOneTime PriceNewParamsNewFloatingTieredPriceCadence = "one_time"
PriceNewParamsNewFloatingTieredPriceCadenceCustom PriceNewParamsNewFloatingTieredPriceCadence = "custom"
)
func (r PriceNewParamsNewFloatingTieredPriceCadence) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingTieredPriceCadenceAnnual, PriceNewParamsNewFloatingTieredPriceCadenceSemiAnnual, PriceNewParamsNewFloatingTieredPriceCadenceMonthly, PriceNewParamsNewFloatingTieredPriceCadenceQuarterly, PriceNewParamsNewFloatingTieredPriceCadenceOneTime, PriceNewParamsNewFloatingTieredPriceCadenceCustom:
return true
}
return false
}
// The pricing model type
type PriceNewParamsNewFloatingTieredPriceModelType string
const (
PriceNewParamsNewFloatingTieredPriceModelTypeTiered PriceNewParamsNewFloatingTieredPriceModelType = "tiered"
)
func (r PriceNewParamsNewFloatingTieredPriceModelType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingTieredPriceModelTypeTiered:
return true
}
return false
}
type PriceNewParamsNewFloatingTieredPriceConversionRateConfig struct {
ConversionRateType param.Field[PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateType] `json:"conversion_rate_type" api:"required"`
TieredConfig param.Field[shared.ConversionRateTieredConfigParam] `json:"tiered_config"`
UnitConfig param.Field[shared.ConversionRateUnitConfigParam] `json:"unit_config"`
}
func (r PriceNewParamsNewFloatingTieredPriceConversionRateConfig) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (r PriceNewParamsNewFloatingTieredPriceConversionRateConfig) ImplementsPriceNewParamsNewFloatingTieredPriceConversionRateConfigUnion() {
}
// Satisfied by [shared.UnitConversionRateConfigParam],
// [shared.TieredConversionRateConfigParam],
// [PriceNewParamsNewFloatingTieredPriceConversionRateConfig].
type PriceNewParamsNewFloatingTieredPriceConversionRateConfigUnion interface {
ImplementsPriceNewParamsNewFloatingTieredPriceConversionRateConfigUnion()
}
type PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateType string
const (
PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateTypeUnit PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateType = "unit"
PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateTypeTiered PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateType = "tiered"
)
func (r PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateTypeUnit, PriceNewParamsNewFloatingTieredPriceConversionRateConfigConversionRateTypeTiered:
return true
}
return false
}
type PriceNewParamsNewFloatingBulkPrice struct {
// Configuration for bulk pricing
BulkConfig param.Field[shared.BulkConfigParam] `json:"bulk_config" api:"required"`
// The cadence to bill for this price on.
Cadence param.Field[PriceNewParamsNewFloatingBulkPriceCadence] `json:"cadence" api:"required"`
// An ISO 4217 currency string for which this price is billed in.
Currency param.Field[string] `json:"currency" api:"required"`
// The id of the item the price will be associated with.
ItemID param.Field[string] `json:"item_id" api:"required"`
// The pricing model type
ModelType param.Field[PriceNewParamsNewFloatingBulkPriceModelType] `json:"model_type" api:"required"`
// The name of the price.
Name param.Field[string] `json:"name" api:"required"`
// The id of the billable metric for the price. Only needed if the price is
// usage-based.
BillableMetricID param.Field[string] `json:"billable_metric_id"`
// If the Price represents a fixed cost, the price will be billed in-advance if
// this is true, and in-arrears if this is false.
BilledInAdvance param.Field[bool] `json:"billed_in_advance"`
// For custom cadence: specifies the duration of the billing period in days or
// months.
BillingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"billing_cycle_configuration"`
// The per unit conversion rate of the price currency to the invoicing currency.
ConversionRate param.Field[float64] `json:"conversion_rate"`
// The configuration for the rate of the price currency to the invoicing currency.
ConversionRateConfig param.Field[PriceNewParamsNewFloatingBulkPriceConversionRateConfigUnion] `json:"conversion_rate_config"`
// For dimensional price: specifies a price group and dimension values
DimensionalPriceConfiguration param.Field[shared.NewDimensionalPriceConfigurationParam] `json:"dimensional_price_configuration"`
// An alias for the price.
ExternalPriceID param.Field[string] `json:"external_price_id"`
// If the Price represents a fixed cost, this represents the quantity of units
// applied.
FixedPriceQuantity param.Field[float64] `json:"fixed_price_quantity"`
// The property used to group this price on an invoice
InvoiceGroupingKey param.Field[string] `json:"invoice_grouping_key"`
// Within each billing cycle, specifies the cadence at which invoices are produced.
// If unspecified, a single invoice is produced per billing cycle.
InvoicingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"invoicing_cycle_configuration"`
// The ID of the license type to associate with this price.
LicenseTypeID param.Field[string] `json:"license_type_id"`
// User-specified key/value pairs for the resource. Individual keys can be removed
// by setting the value to `null`, and the entire metadata mapping can be cleared
// by setting `metadata` to `null`.
Metadata param.Field[map[string]string] `json:"metadata"`
}
func (r PriceNewParamsNewFloatingBulkPrice) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (PriceNewParamsNewFloatingBulkPrice) ImplementsPriceNewParams() {
}
// The cadence to bill for this price on.
type PriceNewParamsNewFloatingBulkPriceCadence string
const (
PriceNewParamsNewFloatingBulkPriceCadenceAnnual PriceNewParamsNewFloatingBulkPriceCadence = "annual"
PriceNewParamsNewFloatingBulkPriceCadenceSemiAnnual PriceNewParamsNewFloatingBulkPriceCadence = "semi_annual"
PriceNewParamsNewFloatingBulkPriceCadenceMonthly PriceNewParamsNewFloatingBulkPriceCadence = "monthly"
PriceNewParamsNewFloatingBulkPriceCadenceQuarterly PriceNewParamsNewFloatingBulkPriceCadence = "quarterly"
PriceNewParamsNewFloatingBulkPriceCadenceOneTime PriceNewParamsNewFloatingBulkPriceCadence = "one_time"
PriceNewParamsNewFloatingBulkPriceCadenceCustom PriceNewParamsNewFloatingBulkPriceCadence = "custom"
)
func (r PriceNewParamsNewFloatingBulkPriceCadence) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingBulkPriceCadenceAnnual, PriceNewParamsNewFloatingBulkPriceCadenceSemiAnnual, PriceNewParamsNewFloatingBulkPriceCadenceMonthly, PriceNewParamsNewFloatingBulkPriceCadenceQuarterly, PriceNewParamsNewFloatingBulkPriceCadenceOneTime, PriceNewParamsNewFloatingBulkPriceCadenceCustom:
return true
}
return false
}
// The pricing model type
type PriceNewParamsNewFloatingBulkPriceModelType string
const (
PriceNewParamsNewFloatingBulkPriceModelTypeBulk PriceNewParamsNewFloatingBulkPriceModelType = "bulk"
)
func (r PriceNewParamsNewFloatingBulkPriceModelType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingBulkPriceModelTypeBulk:
return true
}
return false
}
type PriceNewParamsNewFloatingBulkPriceConversionRateConfig struct {
ConversionRateType param.Field[PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateType] `json:"conversion_rate_type" api:"required"`
TieredConfig param.Field[shared.ConversionRateTieredConfigParam] `json:"tiered_config"`
UnitConfig param.Field[shared.ConversionRateUnitConfigParam] `json:"unit_config"`
}
func (r PriceNewParamsNewFloatingBulkPriceConversionRateConfig) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (r PriceNewParamsNewFloatingBulkPriceConversionRateConfig) ImplementsPriceNewParamsNewFloatingBulkPriceConversionRateConfigUnion() {
}
// Satisfied by [shared.UnitConversionRateConfigParam],
// [shared.TieredConversionRateConfigParam],
// [PriceNewParamsNewFloatingBulkPriceConversionRateConfig].
type PriceNewParamsNewFloatingBulkPriceConversionRateConfigUnion interface {
ImplementsPriceNewParamsNewFloatingBulkPriceConversionRateConfigUnion()
}
type PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateType string
const (
PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateTypeUnit PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateType = "unit"
PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateTypeTiered PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateType = "tiered"
)
func (r PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateTypeUnit, PriceNewParamsNewFloatingBulkPriceConversionRateConfigConversionRateTypeTiered:
return true
}
return false
}
type PriceNewParamsNewFloatingBulkWithFiltersPrice struct {
// Configuration for bulk_with_filters pricing
BulkWithFiltersConfig param.Field[PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfig] `json:"bulk_with_filters_config" api:"required"`
// The cadence to bill for this price on.
Cadence param.Field[PriceNewParamsNewFloatingBulkWithFiltersPriceCadence] `json:"cadence" api:"required"`
// An ISO 4217 currency string for which this price is billed in.
Currency param.Field[string] `json:"currency" api:"required"`
// The id of the item the price will be associated with.
ItemID param.Field[string] `json:"item_id" api:"required"`
// The pricing model type
ModelType param.Field[PriceNewParamsNewFloatingBulkWithFiltersPriceModelType] `json:"model_type" api:"required"`
// The name of the price.
Name param.Field[string] `json:"name" api:"required"`
// The id of the billable metric for the price. Only needed if the price is
// usage-based.
BillableMetricID param.Field[string] `json:"billable_metric_id"`
// If the Price represents a fixed cost, the price will be billed in-advance if
// this is true, and in-arrears if this is false.
BilledInAdvance param.Field[bool] `json:"billed_in_advance"`
// For custom cadence: specifies the duration of the billing period in days or
// months.
BillingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"billing_cycle_configuration"`
// The per unit conversion rate of the price currency to the invoicing currency.
ConversionRate param.Field[float64] `json:"conversion_rate"`
// The configuration for the rate of the price currency to the invoicing currency.
ConversionRateConfig param.Field[PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigUnion] `json:"conversion_rate_config"`
// For dimensional price: specifies a price group and dimension values
DimensionalPriceConfiguration param.Field[shared.NewDimensionalPriceConfigurationParam] `json:"dimensional_price_configuration"`
// An alias for the price.
ExternalPriceID param.Field[string] `json:"external_price_id"`
// If the Price represents a fixed cost, this represents the quantity of units
// applied.
FixedPriceQuantity param.Field[float64] `json:"fixed_price_quantity"`
// The property used to group this price on an invoice
InvoiceGroupingKey param.Field[string] `json:"invoice_grouping_key"`
// Within each billing cycle, specifies the cadence at which invoices are produced.
// If unspecified, a single invoice is produced per billing cycle.
InvoicingCycleConfiguration param.Field[shared.NewBillingCycleConfigurationParam] `json:"invoicing_cycle_configuration"`
// The ID of the license type to associate with this price.
LicenseTypeID param.Field[string] `json:"license_type_id"`
// User-specified key/value pairs for the resource. Individual keys can be removed
// by setting the value to `null`, and the entire metadata mapping can be cleared
// by setting `metadata` to `null`.
Metadata param.Field[map[string]string] `json:"metadata"`
}
func (r PriceNewParamsNewFloatingBulkWithFiltersPrice) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (PriceNewParamsNewFloatingBulkWithFiltersPrice) ImplementsPriceNewParams() {
}
// Configuration for bulk_with_filters pricing
type PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfig struct {
// Property filters to apply (all must match)
Filters param.Field[[]PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfigFilter] `json:"filters" api:"required"`
// Bulk tiers for rating based on total usage volume
Tiers param.Field[[]PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfigTier] `json:"tiers" api:"required"`
}
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfig) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Configuration for a single property filter
type PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfigFilter struct {
// Event property key to filter on
PropertyKey param.Field[string] `json:"property_key" api:"required"`
// Event property value to match
PropertyValue param.Field[string] `json:"property_value" api:"required"`
}
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfigFilter) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Configuration for a single bulk pricing tier
type PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfigTier struct {
// Amount per unit
UnitAmount param.Field[string] `json:"unit_amount" api:"required"`
// The lower bound for this tier
TierLowerBound param.Field[string] `json:"tier_lower_bound"`
}
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceBulkWithFiltersConfigTier) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// The cadence to bill for this price on.
type PriceNewParamsNewFloatingBulkWithFiltersPriceCadence string
const (
PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceAnnual PriceNewParamsNewFloatingBulkWithFiltersPriceCadence = "annual"
PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceSemiAnnual PriceNewParamsNewFloatingBulkWithFiltersPriceCadence = "semi_annual"
PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceMonthly PriceNewParamsNewFloatingBulkWithFiltersPriceCadence = "monthly"
PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceQuarterly PriceNewParamsNewFloatingBulkWithFiltersPriceCadence = "quarterly"
PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceOneTime PriceNewParamsNewFloatingBulkWithFiltersPriceCadence = "one_time"
PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceCustom PriceNewParamsNewFloatingBulkWithFiltersPriceCadence = "custom"
)
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceCadence) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceAnnual, PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceSemiAnnual, PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceMonthly, PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceQuarterly, PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceOneTime, PriceNewParamsNewFloatingBulkWithFiltersPriceCadenceCustom:
return true
}
return false
}
// The pricing model type
type PriceNewParamsNewFloatingBulkWithFiltersPriceModelType string
const (
PriceNewParamsNewFloatingBulkWithFiltersPriceModelTypeBulkWithFilters PriceNewParamsNewFloatingBulkWithFiltersPriceModelType = "bulk_with_filters"
)
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceModelType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingBulkWithFiltersPriceModelTypeBulkWithFilters:
return true
}
return false
}
type PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfig struct {
ConversionRateType param.Field[PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateType] `json:"conversion_rate_type" api:"required"`
TieredConfig param.Field[shared.ConversionRateTieredConfigParam] `json:"tiered_config"`
UnitConfig param.Field[shared.ConversionRateUnitConfigParam] `json:"unit_config"`
}
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfig) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfig) ImplementsPriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigUnion() {
}
// Satisfied by [shared.UnitConversionRateConfigParam],
// [shared.TieredConversionRateConfigParam],
// [PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfig].
type PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigUnion interface {
ImplementsPriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigUnion()
}
type PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateType string
const (
PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateTypeUnit PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateType = "unit"
PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateTypeTiered PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateType = "tiered"
)
func (r PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateType) IsKnown() bool {
switch r {
case PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateTypeUnit, PriceNewParamsNewFloatingBulkWithFiltersPriceConversionRateConfigConversionRateTypeTiered:
return true
}
return false
}
type PriceNewParamsNewFloatingPackagePrice struct {
// The cadence to bill for this price on.
Cadence param.Field[PriceNewParamsNewFloatingPackagePriceCadence] `json:"cadence" api:"required"`
// An ISO 4217 currency string for which this price is billed in.
Currency param.Field[string] `json:"currency" api:"required"`
// The id of the item the price will be associated with.
ItemID param.Field[string] `json:"item_id" api:"required"`
// The pricing model type
ModelType param.Field[PriceNewParamsNewFloatingPackagePriceModelType] `json:"model_type" api:"required"`
// The name of the price.
Name param.Field[string] `json:"name" api:"required"`
// Configuration for package pricing
PackageConfig param.Field[shared.PackageConfigParam] `json:"package_config" api:"required"`
// The id of the billable metric for the price. Only needed if the price is