orb-billing 5.30.0 → 5.32.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 (42) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +1 -1
  3. package/resources/beta/beta.d.ts +218 -2
  4. package/resources/beta/beta.d.ts.map +1 -1
  5. package/resources/beta/beta.js.map +1 -1
  6. package/resources/beta/beta.mjs.map +1 -1
  7. package/resources/beta/external-plan-id.d.ts +218 -2
  8. package/resources/beta/external-plan-id.d.ts.map +1 -1
  9. package/resources/invoice-line-items.d.ts +0 -20
  10. package/resources/invoice-line-items.d.ts.map +1 -1
  11. package/resources/invoices.d.ts +0 -20
  12. package/resources/invoices.d.ts.map +1 -1
  13. package/resources/invoices.js.map +1 -1
  14. package/resources/invoices.mjs.map +1 -1
  15. package/resources/plans/plans.d.ts +125 -17
  16. package/resources/plans/plans.d.ts.map +1 -1
  17. package/resources/plans/plans.js.map +1 -1
  18. package/resources/plans/plans.mjs.map +1 -1
  19. package/resources/prices/prices.d.ts +309 -3
  20. package/resources/prices/prices.d.ts.map +1 -1
  21. package/resources/prices/prices.js.map +1 -1
  22. package/resources/prices/prices.mjs.map +1 -1
  23. package/resources/shared.d.ts +105 -41
  24. package/resources/shared.d.ts.map +1 -1
  25. package/resources/shared.js.map +1 -1
  26. package/resources/shared.mjs.map +1 -1
  27. package/resources/subscriptions.d.ts +539 -5
  28. package/resources/subscriptions.d.ts.map +1 -1
  29. package/resources/subscriptions.js.map +1 -1
  30. package/resources/subscriptions.mjs.map +1 -1
  31. package/src/resources/beta/beta.ts +258 -0
  32. package/src/resources/beta/external-plan-id.ts +258 -0
  33. package/src/resources/invoice-line-items.ts +0 -25
  34. package/src/resources/invoices.ts +0 -25
  35. package/src/resources/plans/plans.ts +150 -21
  36. package/src/resources/prices/prices.ts +366 -0
  37. package/src/resources/shared.ts +138 -50
  38. package/src/resources/subscriptions.ts +655 -17
  39. package/src/version.ts +1 -1
  40. package/version.d.ts +1 -1
  41. package/version.js +1 -1
  42. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"prices.js","sourceRoot":"","sources":["../../src/resources/prices/prices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,yCAAuC;AAykK9B,2FAzkKA,mBAAU,OAykKA;AAxkKnB,2EAA0D;AAC1D,8DAAmF;AAGnF,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,oBAAe,GAAuC,IAAI,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyJ7G,CAAC;IAvJC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAQD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,mBAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,OAAe,EACf,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CACnB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AA1JD,wBA0JC;AAo5JD,MAAM,CAAC,eAAe,GAAG,mCAAe,CAAC"}
1
+ {"version":3,"file":"prices.js","sourceRoot":"","sources":["../../src/resources/prices/prices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,yCAAuC;AAu7K9B,2FAv7KA,mBAAU,OAu7KA;AAt7KnB,2EAA0D;AAC1D,8DAAmF;AAGnF,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,oBAAe,GAAuC,IAAI,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyJ7G,CAAC;IAvJC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAQD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,mBAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,OAAe,EACf,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CACnB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AA1JD,wBA0JC;AAkwKD,MAAM,CAAC,eAAe,GAAG,mCAAe,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"prices.mjs","sourceRoot":"","sources":["../../src/resources/prices/prices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,UAAU,EAAE;OACd,KAAK,kBAAkB;OACvB,EAAE,eAAe,EAA+B;AAGvD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,oBAAe,GAAuC,IAAI,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyJ7G,CAAC;IAvJC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAQD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,OAAe,EACf,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CACnB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAo5JD,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC;AAsBzC,OAAO,EAAE,UAAU,EAAE,CAAC"}
1
+ {"version":3,"file":"prices.mjs","sourceRoot":"","sources":["../../src/resources/prices/prices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,UAAU,EAAE;OACd,KAAK,kBAAkB;OACvB,EAAE,eAAe,EAA+B;AAGvD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,oBAAe,GAAuC,IAAI,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyJ7G,CAAC;IAvJC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAQD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,OAAe,EACf,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CACnB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAkwKD,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC;AAsBzC,OAAO,EAAE,UAAU,EAAE,CAAC"}
@@ -595,10 +595,6 @@ export declare namespace ChangedSubscriptionResources {
595
595
  * The number of prepaid credits applied.
596
596
  */
597
597
  credits_applied: string;
598
- /**
599
- * @deprecated This field is deprecated in favor of `adjustments`
600
- */
601
- discount: Shared.Discount | null;
602
598
  /**
603
599
  * The end date of the range of time applied for this line item's price.
604
600
  */
@@ -613,22 +609,6 @@ export declare namespace ChangedSubscriptionResources {
613
609
  * values for this particular grouping.
614
610
  */
615
611
  grouping: string | null;
616
- /**
617
- * @deprecated This field is deprecated in favor of `adjustments`.
618
- */
619
- maximum: Shared.Maximum | null;
620
- /**
621
- * @deprecated This field is deprecated in favor of `adjustments`.
622
- */
623
- maximum_amount: string | null;
624
- /**
625
- * @deprecated This field is deprecated in favor of `adjustments`.
626
- */
627
- minimum: Shared.Minimum | null;
628
- /**
629
- * @deprecated This field is deprecated in favor of `adjustments`.
630
- */
631
- minimum_amount: string | null;
632
612
  /**
633
613
  * The name of the price associated with this line item.
634
614
  */
@@ -1465,10 +1445,6 @@ export declare namespace Invoice {
1465
1445
  * The number of prepaid credits applied.
1466
1446
  */
1467
1447
  credits_applied: string;
1468
- /**
1469
- * @deprecated This field is deprecated in favor of `adjustments`
1470
- */
1471
- discount: Shared.Discount | null;
1472
1448
  /**
1473
1449
  * The end date of the range of time applied for this line item's price.
1474
1450
  */
@@ -1483,22 +1459,6 @@ export declare namespace Invoice {
1483
1459
  * values for this particular grouping.
1484
1460
  */
1485
1461
  grouping: string | null;
1486
- /**
1487
- * @deprecated This field is deprecated in favor of `adjustments`.
1488
- */
1489
- maximum: Shared.Maximum | null;
1490
- /**
1491
- * @deprecated This field is deprecated in favor of `adjustments`.
1492
- */
1493
- maximum_amount: string | null;
1494
- /**
1495
- * @deprecated This field is deprecated in favor of `adjustments`.
1496
- */
1497
- minimum: Shared.Minimum | null;
1498
- /**
1499
- * @deprecated This field is deprecated in favor of `adjustments`.
1500
- */
1501
- minimum_amount: string | null;
1502
1462
  /**
1503
1463
  * The name of the price associated with this line item.
1504
1464
  */
@@ -8188,7 +8148,7 @@ export declare namespace PlanPhaseUsageDiscountAdjustment {
8188
8148
  * For more on the types of prices, see
8189
8149
  * [the core concepts documentation](/core-concepts#plan-and-price)
8190
8150
  */
8191
- export type Price = Price.UnitPrice | Price.TieredPrice | Price.BulkPrice | Price.BulkWithFiltersPrice | Price.PackagePrice | Price.MatrixPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.TieredWithMinimumPrice | Price.GroupedTieredPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.BulkWithProrationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.GroupedWithMinMaxThresholdsPrice | Price.MatrixWithDisplayNamePrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice | Price.CumulativeGroupedBulkPrice | Price.MinimumCompositePrice | Price.PercentCompositePrice | Price.EventOutputPrice;
8151
+ export type Price = Price.UnitPrice | Price.TieredPrice | Price.BulkPrice | Price.BulkWithFiltersPrice | Price.PackagePrice | Price.MatrixPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.TieredWithMinimumPrice | Price.GroupedTieredPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.BulkWithProrationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.GroupedWithMinMaxThresholdsPrice | Price.MatrixWithDisplayNamePrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice | Price.CumulativeGroupedBulkPrice | Price.CumulativeGroupedAllocationPrice | Price.MinimumCompositePrice | Price.PercentCompositePrice | Price.EventOutputPrice;
8192
8152
  export declare namespace Price {
8193
8153
  interface UnitPrice {
8194
8154
  id: string;
@@ -11059,6 +11019,110 @@ export declare namespace Price {
11059
11019
  }
11060
11020
  }
11061
11021
  }
11022
+ interface CumulativeGroupedAllocationPrice {
11023
+ id: string;
11024
+ billable_metric: Shared.BillableMetricTiny | null;
11025
+ billing_cycle_configuration: Shared.BillingCycleConfiguration;
11026
+ billing_mode: 'in_advance' | 'in_arrear';
11027
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11028
+ composite_price_filters: Array<CumulativeGroupedAllocationPrice.CompositePriceFilter> | null;
11029
+ conversion_rate: number | null;
11030
+ conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
11031
+ created_at: string;
11032
+ credit_allocation: Shared.Allocation | null;
11033
+ /**
11034
+ * Configuration for cumulative_grouped_allocation pricing
11035
+ */
11036
+ cumulative_grouped_allocation_config: CumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
11037
+ currency: string;
11038
+ /**
11039
+ * @deprecated
11040
+ */
11041
+ discount: Shared.Discount | null;
11042
+ external_price_id: string | null;
11043
+ fixed_price_quantity: number | null;
11044
+ invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
11045
+ /**
11046
+ * A minimal representation of an Item containing only the essential identifying
11047
+ * information.
11048
+ */
11049
+ item: Shared.ItemSlim;
11050
+ /**
11051
+ * @deprecated
11052
+ */
11053
+ maximum: Shared.Maximum | null;
11054
+ /**
11055
+ * @deprecated
11056
+ */
11057
+ maximum_amount: string | null;
11058
+ /**
11059
+ * User specified key-value pairs for the resource. If not present, this defaults
11060
+ * to an empty dictionary. Individual keys can be removed by setting the value to
11061
+ * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
11062
+ * `null`.
11063
+ */
11064
+ metadata: {
11065
+ [key: string]: string;
11066
+ };
11067
+ /**
11068
+ * @deprecated
11069
+ */
11070
+ minimum: Shared.Minimum | null;
11071
+ /**
11072
+ * @deprecated
11073
+ */
11074
+ minimum_amount: string | null;
11075
+ /**
11076
+ * The pricing model type
11077
+ */
11078
+ model_type: 'cumulative_grouped_allocation';
11079
+ name: string;
11080
+ plan_phase_order: number | null;
11081
+ price_type: 'usage_price' | 'fixed_price' | 'composite_price';
11082
+ /**
11083
+ * The price id this price replaces. This price will take the place of the replaced
11084
+ * price in plan version migrations.
11085
+ */
11086
+ replaces_price_id: string | null;
11087
+ dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11088
+ }
11089
+ namespace CumulativeGroupedAllocationPrice {
11090
+ interface CompositePriceFilter {
11091
+ /**
11092
+ * The property of the price to filter on.
11093
+ */
11094
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11095
+ /**
11096
+ * Should prices that match the filter be included or excluded.
11097
+ */
11098
+ operator: 'includes' | 'excludes';
11099
+ /**
11100
+ * The IDs or values that match this filter.
11101
+ */
11102
+ values: Array<string>;
11103
+ }
11104
+ /**
11105
+ * Configuration for cumulative_grouped_allocation pricing
11106
+ */
11107
+ interface CumulativeGroupedAllocationConfig {
11108
+ /**
11109
+ * The overall allocation across all groups
11110
+ */
11111
+ cumulative_allocation: string;
11112
+ /**
11113
+ * The allocation per individual group
11114
+ */
11115
+ group_allocation: string;
11116
+ /**
11117
+ * The event property used to group usage before applying allocations
11118
+ */
11119
+ grouping_key: string;
11120
+ /**
11121
+ * The amount to charge for each unit outside of the allocation
11122
+ */
11123
+ unit_amount: string;
11124
+ }
11125
+ }
11062
11126
  interface MinimumCompositePrice {
11063
11127
  id: string;
11064
11128
  billable_metric: Shared.BillableMetricTiny | null;