orb-billing 5.19.0 → 5.20.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 (45) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/index.d.mts +0 -1
  3. package/index.d.ts +0 -1
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/resources/beta/beta.d.ts +12 -0
  9. package/resources/beta/beta.d.ts.map +1 -1
  10. package/resources/beta/beta.js.map +1 -1
  11. package/resources/beta/beta.mjs.map +1 -1
  12. package/resources/beta/external-plan-id.d.ts +12 -0
  13. package/resources/beta/external-plan-id.d.ts.map +1 -1
  14. package/resources/customers/credits/ledger.d.ts +17 -0
  15. package/resources/customers/credits/ledger.d.ts.map +1 -1
  16. package/resources/customers/credits/ledger.js.map +1 -1
  17. package/resources/customers/credits/ledger.mjs.map +1 -1
  18. package/resources/plans/plans.d.ts +6 -0
  19. package/resources/plans/plans.d.ts.map +1 -1
  20. package/resources/plans/plans.js.map +1 -1
  21. package/resources/plans/plans.mjs.map +1 -1
  22. package/resources/prices/prices.d.ts +18 -0
  23. package/resources/prices/prices.d.ts.map +1 -1
  24. package/resources/prices/prices.js.map +1 -1
  25. package/resources/prices/prices.mjs.map +1 -1
  26. package/resources/shared.d.ts +910 -70
  27. package/resources/shared.d.ts.map +1 -1
  28. package/resources/shared.js.map +1 -1
  29. package/resources/shared.mjs.map +1 -1
  30. package/resources/subscriptions.d.ts +30 -0
  31. package/resources/subscriptions.d.ts.map +1 -1
  32. package/resources/subscriptions.js.map +1 -1
  33. package/resources/subscriptions.mjs.map +1 -1
  34. package/src/index.ts +0 -1
  35. package/src/resources/beta/beta.ts +14 -0
  36. package/src/resources/beta/external-plan-id.ts +14 -0
  37. package/src/resources/customers/credits/ledger.ts +21 -0
  38. package/src/resources/plans/plans.ts +7 -0
  39. package/src/resources/prices/prices.ts +21 -0
  40. package/src/resources/shared.ts +1082 -76
  41. package/src/resources/subscriptions.ts +35 -0
  42. package/src/version.ts +1 -1
  43. package/version.d.ts +1 -1
  44. package/version.js +1 -1
  45. package/version.mjs +1 -1
@@ -793,6 +793,13 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
793
793
  */
794
794
  unit_rating_key: string;
795
795
 
796
+ /**
797
+ * If provided, this amount will be used as the unit rate when an event does not
798
+ * have a value for the `unit_rating_key`. If not provided, events missing a unit
799
+ * rate will be ignored.
800
+ */
801
+ default_unit_rate?: string | null;
802
+
796
803
  /**
797
804
  * An optional key in the event data to group by (e.g., event ID). All events will
798
805
  * also be grouped by their unit rate.
@@ -1535,6 +1542,13 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1535
1542
  */
1536
1543
  unit_rating_key: string;
1537
1544
 
1545
+ /**
1546
+ * If provided, this amount will be used as the unit rate when an event does not
1547
+ * have a value for the `unit_rating_key`. If not provided, events missing a unit
1548
+ * rate will be ignored.
1549
+ */
1550
+ default_unit_rate?: string | null;
1551
+
1538
1552
  /**
1539
1553
  * An optional key in the event data to group by (e.g., event ID). All events will
1540
1554
  * also be grouped by their unit rate.
@@ -471,11 +471,32 @@ export class LedgerListByExternalIDResponsesPage extends Page<LedgerListByExtern
471
471
  export interface AffectedBlock {
472
472
  id: string;
473
473
 
474
+ block_filters: Array<AffectedBlock.BlockFilter> | null;
475
+
474
476
  expiry_date: string | null;
475
477
 
476
478
  per_unit_cost_basis: string | null;
477
479
  }
478
480
 
481
+ export namespace AffectedBlock {
482
+ export interface BlockFilter {
483
+ /**
484
+ * The property of the price to filter on.
485
+ */
486
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
487
+
488
+ /**
489
+ * Should prices that match the filter be included or excluded.
490
+ */
491
+ operator: 'includes' | 'excludes';
492
+
493
+ /**
494
+ * The IDs or values that match this filter.
495
+ */
496
+ values: Array<string>;
497
+ }
498
+ }
499
+
479
500
  export interface AmendmentLedgerEntry {
480
501
  id: string;
481
502
 
@@ -990,6 +990,13 @@ export namespace PlanCreateParams {
990
990
  */
991
991
  unit_rating_key: string;
992
992
 
993
+ /**
994
+ * If provided, this amount will be used as the unit rate when an event does not
995
+ * have a value for the `unit_rating_key`. If not provided, events missing a unit
996
+ * rate will be ignored.
997
+ */
998
+ default_unit_rate?: string | null;
999
+
993
1000
  /**
994
1001
  * An optional key in the event data to group by (e.g., event ID). All events will
995
1002
  * also be grouped by their unit rate.
@@ -3913,6 +3913,13 @@ export declare namespace PriceCreateParams {
3913
3913
  */
3914
3914
  unit_rating_key: string;
3915
3915
 
3916
+ /**
3917
+ * If provided, this amount will be used as the unit rate when an event does not
3918
+ * have a value for the `unit_rating_key`. If not provided, events missing a unit
3919
+ * rate will be ignored.
3920
+ */
3921
+ default_unit_rate?: string | null;
3922
+
3916
3923
  /**
3917
3924
  * An optional key in the event data to group by (e.g., event ID). All events will
3918
3925
  * also be grouped by their unit rate.
@@ -4534,6 +4541,13 @@ export namespace PriceEvaluateMultipleParams {
4534
4541
  */
4535
4542
  unit_rating_key: string;
4536
4543
 
4544
+ /**
4545
+ * If provided, this amount will be used as the unit rate when an event does not
4546
+ * have a value for the `unit_rating_key`. If not provided, events missing a unit
4547
+ * rate will be ignored.
4548
+ */
4549
+ default_unit_rate?: string | null;
4550
+
4537
4551
  /**
4538
4552
  * An optional key in the event data to group by (e.g., event ID). All events will
4539
4553
  * also be grouped by their unit rate.
@@ -5145,6 +5159,13 @@ export namespace PriceEvaluatePreviewEventsParams {
5145
5159
  */
5146
5160
  unit_rating_key: string;
5147
5161
 
5162
+ /**
5163
+ * If provided, this amount will be used as the unit rate when an event does not
5164
+ * have a value for the `unit_rating_key`. If not provided, events missing a unit
5165
+ * rate will be ignored.
5166
+ */
5167
+ default_unit_rate?: string | null;
5168
+
5148
5169
  /**
5149
5170
  * An optional key in the event data to group by (e.g., event ID). All events will
5150
5171
  * also be grouped by their unit rate.