orb-billing 6.25.0 → 6.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/package.json +1 -1
  3. package/resources/beta/beta.d.mts +24 -24
  4. package/resources/beta/beta.d.mts.map +1 -1
  5. package/resources/beta/beta.d.ts +24 -24
  6. package/resources/beta/beta.d.ts.map +1 -1
  7. package/resources/beta/external-plan-id.d.mts +24 -24
  8. package/resources/beta/external-plan-id.d.mts.map +1 -1
  9. package/resources/beta/external-plan-id.d.ts +24 -24
  10. package/resources/beta/external-plan-id.d.ts.map +1 -1
  11. package/resources/events/backfills.d.mts +3 -1
  12. package/resources/events/backfills.d.mts.map +1 -1
  13. package/resources/events/backfills.d.ts +3 -1
  14. package/resources/events/backfills.d.ts.map +1 -1
  15. package/resources/events/backfills.js +3 -1
  16. package/resources/events/backfills.js.map +1 -1
  17. package/resources/events/backfills.mjs +3 -1
  18. package/resources/events/backfills.mjs.map +1 -1
  19. package/resources/invoices.d.mts +3 -5
  20. package/resources/invoices.d.mts.map +1 -1
  21. package/resources/invoices.d.ts +3 -5
  22. package/resources/invoices.d.ts.map +1 -1
  23. package/resources/invoices.js +2 -4
  24. package/resources/invoices.js.map +1 -1
  25. package/resources/invoices.mjs +2 -4
  26. package/resources/invoices.mjs.map +1 -1
  27. package/resources/plans/plans.d.mts +12 -12
  28. package/resources/plans/plans.d.mts.map +1 -1
  29. package/resources/plans/plans.d.ts +12 -12
  30. package/resources/plans/plans.d.ts.map +1 -1
  31. package/resources/prices/prices.d.mts +57 -57
  32. package/resources/prices/prices.d.mts.map +1 -1
  33. package/resources/prices/prices.d.ts +57 -57
  34. package/resources/prices/prices.d.ts.map +1 -1
  35. package/resources/prices/prices.js +1 -1
  36. package/resources/prices/prices.mjs +1 -1
  37. package/resources/shared.d.mts +51 -51
  38. package/resources/shared.d.mts.map +1 -1
  39. package/resources/shared.d.ts +51 -51
  40. package/resources/shared.d.ts.map +1 -1
  41. package/resources/subscriptions.d.mts +82 -82
  42. package/resources/subscriptions.d.mts.map +1 -1
  43. package/resources/subscriptions.d.ts +82 -82
  44. package/resources/subscriptions.d.ts.map +1 -1
  45. package/resources/subscriptions.js +3 -3
  46. package/resources/subscriptions.mjs +3 -3
  47. package/src/resources/beta/beta.ts +24 -24
  48. package/src/resources/beta/external-plan-id.ts +24 -24
  49. package/src/resources/events/backfills.ts +3 -1
  50. package/src/resources/invoices.ts +7 -5
  51. package/src/resources/plans/plans.ts +12 -12
  52. package/src/resources/prices/prices.ts +57 -57
  53. package/src/resources/shared.ts +51 -51
  54. package/src/resources/subscriptions.ts +82 -82
  55. package/src/version.ts +1 -1
  56. package/version.d.mts +1 -1
  57. package/version.d.ts +1 -1
  58. package/version.js +1 -1
  59. package/version.mjs +1 -1
@@ -510,9 +510,9 @@ class Subscriptions extends resource_1.APIResource {
510
510
  * but do not have the key set). Currently, it is only possible to view usage
511
511
  * grouped by a single attribute at a time.
512
512
  *
513
- * When viewing grouped usage, Orb uses pagination to limit the response size to
514
- * 1000 groups by default. If there are more groups for a given subscription,
515
- * pagination metadata in the response can be used to fetch all of the data.
513
+ * When viewing grouped usage, all groups are returned in a single response. For
514
+ * metrics with a large number of groups, Orb recommends using a shorter timeframe
515
+ * to keep response size and latency manageable.
516
516
  *
517
517
  * The following example shows usage for an "API Requests" billable metric grouped
518
518
  * by `region`. Note the extra `metric_group` dictionary in the response, which
@@ -507,9 +507,9 @@ export class Subscriptions extends APIResource {
507
507
  * but do not have the key set). Currently, it is only possible to view usage
508
508
  * grouped by a single attribute at a time.
509
509
  *
510
- * When viewing grouped usage, Orb uses pagination to limit the response size to
511
- * 1000 groups by default. If there are more groups for a given subscription,
512
- * pagination metadata in the response can be used to fetch all of the data.
510
+ * When viewing grouped usage, all groups are returned in a single response. For
511
+ * metrics with a large number of groups, Orb recommends using a shorter timeframe
512
+ * to keep response size and latency manageable.
513
513
  *
514
514
  * The following example shows usage for an "API Requests" billable metric grouped
515
515
  * by `region`. Note the extra `metric_group` dictionary in the response, which
@@ -409,7 +409,7 @@ export namespace BetaCreatePlanVersionParams {
409
409
  /**
410
410
  * The cadence to bill for this price on.
411
411
  */
412
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
412
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
413
413
 
414
414
  /**
415
415
  * The id of the item the price will be associated with.
@@ -551,7 +551,7 @@ export namespace BetaCreatePlanVersionParams {
551
551
  /**
552
552
  * The cadence to bill for this price on.
553
553
  */
554
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
554
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
555
555
 
556
556
  /**
557
557
  * The id of the item the price will be associated with.
@@ -705,7 +705,7 @@ export namespace BetaCreatePlanVersionParams {
705
705
  /**
706
706
  * The cadence to bill for this price on.
707
707
  */
708
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
708
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
709
709
 
710
710
  /**
711
711
  * Configuration for grouped_tiered_matrix pricing
@@ -857,7 +857,7 @@ export namespace BetaCreatePlanVersionParams {
857
857
  /**
858
858
  * The cadence to bill for this price on.
859
859
  */
860
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
860
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
861
861
 
862
862
  /**
863
863
  * The id of the item the price will be associated with.
@@ -1018,7 +1018,7 @@ export namespace BetaCreatePlanVersionParams {
1018
1018
  /**
1019
1019
  * The cadence to bill for this price on.
1020
1020
  */
1021
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1021
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1022
1022
 
1023
1023
  /**
1024
1024
  * The id of the item the price will be associated with.
@@ -1191,7 +1191,7 @@ export namespace BetaCreatePlanVersionParams {
1191
1191
  /**
1192
1192
  * The cadence to bill for this price on.
1193
1193
  */
1194
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1194
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1195
1195
 
1196
1196
  /**
1197
1197
  * The id of the item the price will be associated with.
@@ -1331,7 +1331,7 @@ export namespace BetaCreatePlanVersionParams {
1331
1331
  /**
1332
1332
  * The cadence to bill for this price on.
1333
1333
  */
1334
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1334
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1335
1335
 
1336
1336
  /**
1337
1337
  * Configuration for grouped_with_min_max_thresholds pricing
@@ -1468,7 +1468,7 @@ export namespace BetaCreatePlanVersionParams {
1468
1468
  /**
1469
1469
  * The cadence to bill for this price on.
1470
1470
  */
1471
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1471
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1472
1472
 
1473
1473
  /**
1474
1474
  * Configuration for cumulative_grouped_allocation pricing
@@ -1605,7 +1605,7 @@ export namespace BetaCreatePlanVersionParams {
1605
1605
  /**
1606
1606
  * The cadence to bill for this price on.
1607
1607
  */
1608
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1608
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1609
1609
 
1610
1610
  /**
1611
1611
  * Configuration for daily_credit_allowance pricing
@@ -1768,7 +1768,7 @@ export namespace BetaCreatePlanVersionParams {
1768
1768
  /**
1769
1769
  * The cadence to bill for this price on.
1770
1770
  */
1771
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1771
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1772
1772
 
1773
1773
  /**
1774
1774
  * The id of the item the price will be associated with.
@@ -1920,7 +1920,7 @@ export namespace BetaCreatePlanVersionParams {
1920
1920
  /**
1921
1921
  * The cadence to bill for this price on.
1922
1922
  */
1923
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1923
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1924
1924
 
1925
1925
  /**
1926
1926
  * The id of the item the price will be associated with.
@@ -2059,7 +2059,7 @@ export namespace BetaCreatePlanVersionParams {
2059
2059
  /**
2060
2060
  * The cadence to bill for this price on.
2061
2061
  */
2062
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2062
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2063
2063
 
2064
2064
  /**
2065
2065
  * Configuration for event_output pricing
@@ -2390,7 +2390,7 @@ export namespace BetaCreatePlanVersionParams {
2390
2390
  /**
2391
2391
  * The cadence to bill for this price on.
2392
2392
  */
2393
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2393
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2394
2394
 
2395
2395
  /**
2396
2396
  * The id of the item the price will be associated with.
@@ -2532,7 +2532,7 @@ export namespace BetaCreatePlanVersionParams {
2532
2532
  /**
2533
2533
  * The cadence to bill for this price on.
2534
2534
  */
2535
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2535
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2536
2536
 
2537
2537
  /**
2538
2538
  * The id of the item the price will be associated with.
@@ -2686,7 +2686,7 @@ export namespace BetaCreatePlanVersionParams {
2686
2686
  /**
2687
2687
  * The cadence to bill for this price on.
2688
2688
  */
2689
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2689
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2690
2690
 
2691
2691
  /**
2692
2692
  * Configuration for grouped_tiered_matrix pricing
@@ -2838,7 +2838,7 @@ export namespace BetaCreatePlanVersionParams {
2838
2838
  /**
2839
2839
  * The cadence to bill for this price on.
2840
2840
  */
2841
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2841
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2842
2842
 
2843
2843
  /**
2844
2844
  * The id of the item the price will be associated with.
@@ -2999,7 +2999,7 @@ export namespace BetaCreatePlanVersionParams {
2999
2999
  /**
3000
3000
  * The cadence to bill for this price on.
3001
3001
  */
3002
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3002
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3003
3003
 
3004
3004
  /**
3005
3005
  * The id of the item the price will be associated with.
@@ -3172,7 +3172,7 @@ export namespace BetaCreatePlanVersionParams {
3172
3172
  /**
3173
3173
  * The cadence to bill for this price on.
3174
3174
  */
3175
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3175
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3176
3176
 
3177
3177
  /**
3178
3178
  * The id of the item the price will be associated with.
@@ -3312,7 +3312,7 @@ export namespace BetaCreatePlanVersionParams {
3312
3312
  /**
3313
3313
  * The cadence to bill for this price on.
3314
3314
  */
3315
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3315
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3316
3316
 
3317
3317
  /**
3318
3318
  * Configuration for grouped_with_min_max_thresholds pricing
@@ -3449,7 +3449,7 @@ export namespace BetaCreatePlanVersionParams {
3449
3449
  /**
3450
3450
  * The cadence to bill for this price on.
3451
3451
  */
3452
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3452
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3453
3453
 
3454
3454
  /**
3455
3455
  * Configuration for cumulative_grouped_allocation pricing
@@ -3586,7 +3586,7 @@ export namespace BetaCreatePlanVersionParams {
3586
3586
  /**
3587
3587
  * The cadence to bill for this price on.
3588
3588
  */
3589
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3589
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3590
3590
 
3591
3591
  /**
3592
3592
  * Configuration for daily_credit_allowance pricing
@@ -3749,7 +3749,7 @@ export namespace BetaCreatePlanVersionParams {
3749
3749
  /**
3750
3750
  * The cadence to bill for this price on.
3751
3751
  */
3752
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3752
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3753
3753
 
3754
3754
  /**
3755
3755
  * The id of the item the price will be associated with.
@@ -3901,7 +3901,7 @@ export namespace BetaCreatePlanVersionParams {
3901
3901
  /**
3902
3902
  * The cadence to bill for this price on.
3903
3903
  */
3904
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3904
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3905
3905
 
3906
3906
  /**
3907
3907
  * The id of the item the price will be associated with.
@@ -4040,7 +4040,7 @@ export namespace BetaCreatePlanVersionParams {
4040
4040
  /**
4041
4041
  * The cadence to bill for this price on.
4042
4042
  */
4043
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
4043
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
4044
4044
 
4045
4045
  /**
4046
4046
  * Configuration for event_output pricing
@@ -261,7 +261,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
261
261
  /**
262
262
  * The cadence to bill for this price on.
263
263
  */
264
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
264
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
265
265
 
266
266
  /**
267
267
  * The id of the item the price will be associated with.
@@ -403,7 +403,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
403
403
  /**
404
404
  * The cadence to bill for this price on.
405
405
  */
406
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
406
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
407
407
 
408
408
  /**
409
409
  * The id of the item the price will be associated with.
@@ -557,7 +557,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
557
557
  /**
558
558
  * The cadence to bill for this price on.
559
559
  */
560
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
560
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
561
561
 
562
562
  /**
563
563
  * Configuration for grouped_tiered_matrix pricing
@@ -709,7 +709,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
709
709
  /**
710
710
  * The cadence to bill for this price on.
711
711
  */
712
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
712
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
713
713
 
714
714
  /**
715
715
  * The id of the item the price will be associated with.
@@ -870,7 +870,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
870
870
  /**
871
871
  * The cadence to bill for this price on.
872
872
  */
873
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
873
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
874
874
 
875
875
  /**
876
876
  * The id of the item the price will be associated with.
@@ -1043,7 +1043,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1043
1043
  /**
1044
1044
  * The cadence to bill for this price on.
1045
1045
  */
1046
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1046
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1047
1047
 
1048
1048
  /**
1049
1049
  * The id of the item the price will be associated with.
@@ -1183,7 +1183,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1183
1183
  /**
1184
1184
  * The cadence to bill for this price on.
1185
1185
  */
1186
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1186
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1187
1187
 
1188
1188
  /**
1189
1189
  * Configuration for grouped_with_min_max_thresholds pricing
@@ -1320,7 +1320,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1320
1320
  /**
1321
1321
  * The cadence to bill for this price on.
1322
1322
  */
1323
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1323
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1324
1324
 
1325
1325
  /**
1326
1326
  * Configuration for cumulative_grouped_allocation pricing
@@ -1457,7 +1457,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1457
1457
  /**
1458
1458
  * The cadence to bill for this price on.
1459
1459
  */
1460
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1460
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1461
1461
 
1462
1462
  /**
1463
1463
  * Configuration for daily_credit_allowance pricing
@@ -1620,7 +1620,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1620
1620
  /**
1621
1621
  * The cadence to bill for this price on.
1622
1622
  */
1623
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1623
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1624
1624
 
1625
1625
  /**
1626
1626
  * The id of the item the price will be associated with.
@@ -1772,7 +1772,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1772
1772
  /**
1773
1773
  * The cadence to bill for this price on.
1774
1774
  */
1775
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1775
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1776
1776
 
1777
1777
  /**
1778
1778
  * The id of the item the price will be associated with.
@@ -1911,7 +1911,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1911
1911
  /**
1912
1912
  * The cadence to bill for this price on.
1913
1913
  */
1914
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1914
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1915
1915
 
1916
1916
  /**
1917
1917
  * Configuration for event_output pricing
@@ -2242,7 +2242,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2242
2242
  /**
2243
2243
  * The cadence to bill for this price on.
2244
2244
  */
2245
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2245
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2246
2246
 
2247
2247
  /**
2248
2248
  * The id of the item the price will be associated with.
@@ -2384,7 +2384,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2384
2384
  /**
2385
2385
  * The cadence to bill for this price on.
2386
2386
  */
2387
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2387
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2388
2388
 
2389
2389
  /**
2390
2390
  * The id of the item the price will be associated with.
@@ -2538,7 +2538,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2538
2538
  /**
2539
2539
  * The cadence to bill for this price on.
2540
2540
  */
2541
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2541
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2542
2542
 
2543
2543
  /**
2544
2544
  * Configuration for grouped_tiered_matrix pricing
@@ -2690,7 +2690,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2690
2690
  /**
2691
2691
  * The cadence to bill for this price on.
2692
2692
  */
2693
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2693
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2694
2694
 
2695
2695
  /**
2696
2696
  * The id of the item the price will be associated with.
@@ -2851,7 +2851,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2851
2851
  /**
2852
2852
  * The cadence to bill for this price on.
2853
2853
  */
2854
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2854
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2855
2855
 
2856
2856
  /**
2857
2857
  * The id of the item the price will be associated with.
@@ -3024,7 +3024,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3024
3024
  /**
3025
3025
  * The cadence to bill for this price on.
3026
3026
  */
3027
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3027
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3028
3028
 
3029
3029
  /**
3030
3030
  * The id of the item the price will be associated with.
@@ -3164,7 +3164,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3164
3164
  /**
3165
3165
  * The cadence to bill for this price on.
3166
3166
  */
3167
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3167
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3168
3168
 
3169
3169
  /**
3170
3170
  * Configuration for grouped_with_min_max_thresholds pricing
@@ -3301,7 +3301,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3301
3301
  /**
3302
3302
  * The cadence to bill for this price on.
3303
3303
  */
3304
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3304
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3305
3305
 
3306
3306
  /**
3307
3307
  * Configuration for cumulative_grouped_allocation pricing
@@ -3438,7 +3438,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3438
3438
  /**
3439
3439
  * The cadence to bill for this price on.
3440
3440
  */
3441
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3441
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3442
3442
 
3443
3443
  /**
3444
3444
  * Configuration for daily_credit_allowance pricing
@@ -3601,7 +3601,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3601
3601
  /**
3602
3602
  * The cadence to bill for this price on.
3603
3603
  */
3604
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3604
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3605
3605
 
3606
3606
  /**
3607
3607
  * The id of the item the price will be associated with.
@@ -3753,7 +3753,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3753
3753
  /**
3754
3754
  * The cadence to bill for this price on.
3755
3755
  */
3756
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3756
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3757
3757
 
3758
3758
  /**
3759
3759
  * The id of the item the price will be associated with.
@@ -3892,7 +3892,7 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3892
3892
  /**
3893
3893
  * The cadence to bill for this price on.
3894
3894
  */
3895
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
3895
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
3896
3896
 
3897
3897
  /**
3898
3898
  * Configuration for event_output pricing
@@ -54,7 +54,9 @@ export class Backfills extends APIResource {
54
54
  * the event reporting grace boundary. Matching events that arrive later with
55
55
  * timestamps inside the timeframe will also be deprecated.
56
56
  *
57
- * You may not have multiple backfills in a pending or pending_revert state with
57
+ * A backfill may not overlap in timeframe with another backfill in a pending or
58
+ * pending_revert state for the same customer, or with any account-wide backfill in
59
+ * one of those states. Backfills scoped to different customers may have
58
60
  * overlapping timeframes.
59
61
  *
60
62
  * @example
@@ -268,12 +268,14 @@ export class Invoices extends APIResource {
268
268
  *
269
269
  * @example
270
270
  * ```ts
271
- * const invoice = await client.invoices.pay('invoice_id', {
272
- * shared_payment_token_id: 'shared_payment_token_id',
273
- * });
271
+ * const invoice = await client.invoices.pay('invoice_id');
274
272
  * ```
275
273
  */
276
- pay(invoiceID: string, body: InvoicePayParams, options?: RequestOptions): APIPromise<Shared.Invoice> {
274
+ pay(
275
+ invoiceID: string,
276
+ body: InvoicePayParams | null | undefined = {},
277
+ options?: RequestOptions,
278
+ ): APIPromise<Shared.Invoice> {
277
279
  return this._client.post(path`/invoices/${invoiceID}/pay`, { body, ...options });
278
280
  }
279
281
 
@@ -2316,7 +2318,7 @@ export interface InvoicePayParams {
2316
2318
  /**
2317
2319
  * The ID of a shared payment token granted by an agent to use for this payment.
2318
2320
  */
2319
- shared_payment_token_id: string;
2321
+ shared_payment_token_id?: string | null;
2320
2322
  }
2321
2323
 
2322
2324
  export declare namespace Invoices {
@@ -491,7 +491,7 @@ export namespace PlanCreateParams {
491
491
  /**
492
492
  * The cadence to bill for this price on.
493
493
  */
494
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
494
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
495
495
 
496
496
  /**
497
497
  * The id of the item the price will be associated with.
@@ -633,7 +633,7 @@ export namespace PlanCreateParams {
633
633
  /**
634
634
  * The cadence to bill for this price on.
635
635
  */
636
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
636
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
637
637
 
638
638
  /**
639
639
  * The id of the item the price will be associated with.
@@ -787,7 +787,7 @@ export namespace PlanCreateParams {
787
787
  /**
788
788
  * The cadence to bill for this price on.
789
789
  */
790
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
790
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
791
791
 
792
792
  /**
793
793
  * Configuration for grouped_tiered_matrix pricing
@@ -939,7 +939,7 @@ export namespace PlanCreateParams {
939
939
  /**
940
940
  * The cadence to bill for this price on.
941
941
  */
942
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
942
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
943
943
 
944
944
  /**
945
945
  * The id of the item the price will be associated with.
@@ -1100,7 +1100,7 @@ export namespace PlanCreateParams {
1100
1100
  /**
1101
1101
  * The cadence to bill for this price on.
1102
1102
  */
1103
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1103
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1104
1104
 
1105
1105
  /**
1106
1106
  * The id of the item the price will be associated with.
@@ -1273,7 +1273,7 @@ export namespace PlanCreateParams {
1273
1273
  /**
1274
1274
  * The cadence to bill for this price on.
1275
1275
  */
1276
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1276
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1277
1277
 
1278
1278
  /**
1279
1279
  * The id of the item the price will be associated with.
@@ -1413,7 +1413,7 @@ export namespace PlanCreateParams {
1413
1413
  /**
1414
1414
  * The cadence to bill for this price on.
1415
1415
  */
1416
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1416
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1417
1417
 
1418
1418
  /**
1419
1419
  * Configuration for grouped_with_min_max_thresholds pricing
@@ -1550,7 +1550,7 @@ export namespace PlanCreateParams {
1550
1550
  /**
1551
1551
  * The cadence to bill for this price on.
1552
1552
  */
1553
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1553
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1554
1554
 
1555
1555
  /**
1556
1556
  * Configuration for cumulative_grouped_allocation pricing
@@ -1687,7 +1687,7 @@ export namespace PlanCreateParams {
1687
1687
  /**
1688
1688
  * The cadence to bill for this price on.
1689
1689
  */
1690
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1690
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1691
1691
 
1692
1692
  /**
1693
1693
  * Configuration for daily_credit_allowance pricing
@@ -1850,7 +1850,7 @@ export namespace PlanCreateParams {
1850
1850
  /**
1851
1851
  * The cadence to bill for this price on.
1852
1852
  */
1853
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1853
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
1854
1854
 
1855
1855
  /**
1856
1856
  * The id of the item the price will be associated with.
@@ -2002,7 +2002,7 @@ export namespace PlanCreateParams {
2002
2002
  /**
2003
2003
  * The cadence to bill for this price on.
2004
2004
  */
2005
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2005
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2006
2006
 
2007
2007
  /**
2008
2008
  * The id of the item the price will be associated with.
@@ -2141,7 +2141,7 @@ export namespace PlanCreateParams {
2141
2141
  /**
2142
2142
  * The cadence to bill for this price on.
2143
2143
  */
2144
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2144
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
2145
2145
 
2146
2146
  /**
2147
2147
  * Configuration for event_output pricing