orb-billing 2.2.0 → 2.4.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 (123) hide show
  1. package/CHANGELOG.md +75 -0
  2. package/client.d.ts +222 -0
  3. package/client.d.ts.map +1 -0
  4. package/client.js +156 -0
  5. package/client.js.map +1 -0
  6. package/client.mjs +129 -0
  7. package/client.mjs.map +1 -0
  8. package/index.d.mts +5 -217
  9. package/index.d.ts +5 -217
  10. package/index.d.ts.map +1 -1
  11. package/index.js +10 -133
  12. package/index.js.map +1 -1
  13. package/index.mjs +5 -130
  14. package/index.mjs.map +1 -1
  15. package/package.json +4 -4
  16. package/resources/coupons/coupons.d.ts +3 -22
  17. package/resources/coupons/coupons.d.ts.map +1 -1
  18. package/resources/coupons/coupons.js.map +1 -1
  19. package/resources/coupons/coupons.mjs.map +1 -1
  20. package/resources/customers/costs.d.ts +4 -4
  21. package/resources/customers/costs.d.ts.map +1 -1
  22. package/resources/customers/costs.js.map +1 -1
  23. package/resources/customers/costs.mjs.map +1 -1
  24. package/resources/customers/credits/credits.d.ts +12 -4
  25. package/resources/customers/credits/credits.d.ts.map +1 -1
  26. package/resources/customers/credits/credits.js.map +1 -1
  27. package/resources/customers/credits/credits.mjs.map +1 -1
  28. package/resources/customers/credits/ledger.d.ts +16 -6
  29. package/resources/customers/credits/ledger.d.ts.map +1 -1
  30. package/resources/customers/credits/ledger.js.map +1 -1
  31. package/resources/customers/credits/ledger.mjs.map +1 -1
  32. package/resources/customers/credits/top-ups.d.ts +38 -8
  33. package/resources/customers/credits/top-ups.d.ts.map +1 -1
  34. package/resources/customers/credits/top-ups.js.map +1 -1
  35. package/resources/customers/credits/top-ups.mjs.map +1 -1
  36. package/resources/customers/usage.d.ts +2 -2
  37. package/resources/customers/usage.d.ts.map +1 -1
  38. package/resources/customers/usage.js.map +1 -1
  39. package/resources/customers/usage.mjs.map +1 -1
  40. package/resources/events/backfills.d.ts +20 -0
  41. package/resources/events/backfills.d.ts.map +1 -1
  42. package/resources/events/backfills.js.map +1 -1
  43. package/resources/events/backfills.mjs.map +1 -1
  44. package/resources/index.d.ts +2 -3
  45. package/resources/index.d.ts.map +1 -1
  46. package/resources/index.js +4 -6
  47. package/resources/index.js.map +1 -1
  48. package/resources/index.mjs +1 -2
  49. package/resources/index.mjs.map +1 -1
  50. package/resources/invoices.d.ts +1 -1
  51. package/resources/invoices.js +1 -1
  52. package/resources/invoices.mjs +1 -1
  53. package/resources/plans/plans.d.ts +118 -1
  54. package/resources/plans/plans.d.ts.map +1 -1
  55. package/resources/plans/plans.js.map +1 -1
  56. package/resources/plans/plans.mjs.map +1 -1
  57. package/resources/prices/index.d.ts +1 -1
  58. package/resources/prices/index.d.ts.map +1 -1
  59. package/resources/prices/index.js +3 -3
  60. package/resources/prices/index.js.map +1 -1
  61. package/resources/prices/index.mjs +1 -1
  62. package/resources/prices/index.mjs.map +1 -1
  63. package/resources/prices/prices.d.ts +236 -2
  64. package/resources/prices/prices.d.ts.map +1 -1
  65. package/resources/prices/prices.js +26 -0
  66. package/resources/prices/prices.js.map +1 -1
  67. package/resources/prices/prices.mjs +26 -0
  68. package/resources/prices/prices.mjs.map +1 -1
  69. package/resources/shared.d.ts +5 -0
  70. package/resources/shared.d.ts.map +1 -1
  71. package/resources/subscriptions.d.ts +353 -19
  72. package/resources/subscriptions.d.ts.map +1 -1
  73. package/resources/subscriptions.js +11 -0
  74. package/resources/subscriptions.js.map +1 -1
  75. package/resources/subscriptions.mjs +11 -0
  76. package/resources/subscriptions.mjs.map +1 -1
  77. package/resources/webhooks.d.ts.map +1 -1
  78. package/resources/webhooks.js +4 -2
  79. package/resources/webhooks.js.map +1 -1
  80. package/resources/webhooks.mjs +5 -3
  81. package/resources/webhooks.mjs.map +1 -1
  82. package/src/client.ts +301 -0
  83. package/src/index.ts +6 -297
  84. package/src/resources/coupons/coupons.ts +3 -26
  85. package/src/resources/customers/costs.ts +6 -6
  86. package/src/resources/customers/credits/credits.ts +16 -6
  87. package/src/resources/customers/credits/ledger.ts +20 -8
  88. package/src/resources/customers/credits/top-ups.ts +46 -10
  89. package/src/resources/customers/usage.ts +2 -2
  90. package/src/resources/events/backfills.ts +25 -0
  91. package/src/resources/index.ts +11 -2
  92. package/src/resources/invoices.ts +1 -1
  93. package/src/resources/plans/plans.ts +144 -1
  94. package/src/resources/prices/index.ts +10 -1
  95. package/src/resources/prices/prices.ts +333 -2
  96. package/src/resources/shared.ts +8 -0
  97. package/src/resources/subscriptions.ts +441 -23
  98. package/src/resources/webhooks.ts +5 -3
  99. package/src/version.ts +1 -1
  100. package/version.d.ts +1 -1
  101. package/version.js +1 -1
  102. package/version.mjs +1 -1
  103. package/resources/beta/beta.d.ts +0 -12
  104. package/resources/beta/beta.d.ts.map +0 -1
  105. package/resources/beta/beta.js +0 -40
  106. package/resources/beta/beta.js.map +0 -1
  107. package/resources/beta/beta.mjs +0 -13
  108. package/resources/beta/beta.mjs.map +0 -1
  109. package/resources/beta/index.d.ts +0 -3
  110. package/resources/beta/index.d.ts.map +0 -1
  111. package/resources/beta/index.js +0 -9
  112. package/resources/beta/index.js.map +0 -1
  113. package/resources/beta/index.mjs +0 -4
  114. package/resources/beta/index.mjs.map +0 -1
  115. package/resources/beta/price.d.ts +0 -82
  116. package/resources/beta/price.d.ts.map +0 -1
  117. package/resources/beta/price.js +0 -37
  118. package/resources/beta/price.js.map +0 -1
  119. package/resources/beta/price.mjs +0 -33
  120. package/resources/beta/price.mjs.map +0 -1
  121. package/src/resources/beta/beta.ts +0 -15
  122. package/src/resources/beta/index.ts +0 -4
  123. package/src/resources/beta/price.ts +0 -101
@@ -4,6 +4,7 @@ import * as Core from "../core";
4
4
  import { APIResource } from "../resource";
5
5
  import { isRequestOptions } from "../core";
6
6
  import * as SubscriptionsAPI from "./subscriptions";
7
+ import * as Shared from "./shared";
7
8
  import * as CustomersAPI from "./customers/customers";
8
9
  import * as PlansAPI from "./plans/plans";
9
10
  import * as PricesAPI from "./prices/prices";
@@ -414,6 +415,28 @@ export class Subscriptions extends APIResource {
414
415
  return this._client.post('/subscriptions', { body, ...options });
415
416
  }
416
417
 
418
+ /**
419
+ * This endpoint can be used to update the `metadata`, `net terms`,
420
+ * `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties
421
+ * on a subscription.
422
+ */
423
+ update(
424
+ subscriptionId: string,
425
+ body?: SubscriptionUpdateParams,
426
+ options?: Core.RequestOptions,
427
+ ): Core.APIPromise<Subscription>;
428
+ update(subscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<Subscription>;
429
+ update(
430
+ subscriptionId: string,
431
+ body: SubscriptionUpdateParams | Core.RequestOptions = {},
432
+ options?: Core.RequestOptions,
433
+ ): Core.APIPromise<Subscription> {
434
+ if (isRequestOptions(body)) {
435
+ return this.update(subscriptionId, {}, body);
436
+ }
437
+ return this._client.put(`/subscriptions/${subscriptionId}`, { body, ...options });
438
+ }
439
+
417
440
  /**
418
441
  * This endpoint returns a list of all subscriptions for an account as a
419
442
  * [paginated](../reference/pagination) list, ordered starting from the most
@@ -902,6 +925,11 @@ export class Subscriptions extends APIResource {
902
925
  * default for the plan. The request format for price overrides, maximums, and
903
926
  * minimums are the same as those in [subscription creation](create-subscription).
904
927
  *
928
+ * ## Scheduling multiple plan changes
929
+ *
930
+ * When scheduling multiple plan changes with the same date, the latest plan change
931
+ * on that day takes effect.
932
+ *
905
933
  * ## Prorations for in-advance fees
906
934
  *
907
935
  * By default, Orb calculates the prorated difference in any fixed fees when making
@@ -1670,7 +1698,7 @@ export namespace SubscriptionUsage {
1670
1698
  export interface GroupedSubscriptionUsage {
1671
1699
  data: Array<GroupedSubscriptionUsage.Data>;
1672
1700
 
1673
- pagination_metadata?: GroupedSubscriptionUsage.PaginationMetadata | null;
1701
+ pagination_metadata?: Shared.PaginationMetadata | null;
1674
1702
  }
1675
1703
 
1676
1704
  export namespace GroupedSubscriptionUsage {
@@ -1705,27 +1733,13 @@ export namespace SubscriptionUsage {
1705
1733
  timeframe_start: string;
1706
1734
  }
1707
1735
  }
1708
-
1709
- export interface PaginationMetadata {
1710
- has_more: boolean;
1711
-
1712
- next_cursor: string | null;
1713
- }
1714
1736
  }
1715
1737
  }
1716
1738
 
1717
1739
  export interface Subscriptions {
1718
1740
  data: Array<Subscription>;
1719
1741
 
1720
- pagination_metadata: Subscriptions.PaginationMetadata;
1721
- }
1722
-
1723
- export namespace Subscriptions {
1724
- export interface PaginationMetadata {
1725
- has_more: boolean;
1726
-
1727
- next_cursor: string | null;
1728
- }
1742
+ pagination_metadata: Shared.PaginationMetadata;
1729
1743
  }
1730
1744
 
1731
1745
  export interface SubscriptionFetchCostsResponse {
@@ -2111,6 +2125,17 @@ export namespace SubscriptionCreateParams {
2111
2125
 
2112
2126
  unit_config: OverrideUnitPrice.UnitConfig;
2113
2127
 
2128
+ /**
2129
+ * The per unit conversion rate of the price currency to the invoicing currency.
2130
+ */
2131
+ conversion_rate?: number | null;
2132
+
2133
+ /**
2134
+ * The currency of the price. If not provided, the currency of the plan will be
2135
+ * used.
2136
+ */
2137
+ currency?: string | null;
2138
+
2114
2139
  /**
2115
2140
  * The subscription's override discount for the plan.
2116
2141
  */
@@ -2183,6 +2208,17 @@ export namespace SubscriptionCreateParams {
2183
2208
 
2184
2209
  package_config: OverridePackagePrice.PackageConfig;
2185
2210
 
2211
+ /**
2212
+ * The per unit conversion rate of the price currency to the invoicing currency.
2213
+ */
2214
+ conversion_rate?: number | null;
2215
+
2216
+ /**
2217
+ * The currency of the price. If not provided, the currency of the plan will be
2218
+ * used.
2219
+ */
2220
+ currency?: string | null;
2221
+
2186
2222
  /**
2187
2223
  * The subscription's override discount for the plan.
2188
2224
  */
@@ -2215,7 +2251,7 @@ export namespace SubscriptionCreateParams {
2215
2251
  * An integer amount to represent package size. For example, 1000 here would divide
2216
2252
  * usage by 1000 before multiplying by package_amount in rating
2217
2253
  */
2218
- package_size?: number | null;
2254
+ package_size: number;
2219
2255
  }
2220
2256
 
2221
2257
  /**
@@ -2261,6 +2297,17 @@ export namespace SubscriptionCreateParams {
2261
2297
 
2262
2298
  model_type: 'matrix';
2263
2299
 
2300
+ /**
2301
+ * The per unit conversion rate of the price currency to the invoicing currency.
2302
+ */
2303
+ conversion_rate?: number | null;
2304
+
2305
+ /**
2306
+ * The currency of the price. If not provided, the currency of the plan will be
2307
+ * used.
2308
+ */
2309
+ currency?: string | null;
2310
+
2264
2311
  /**
2265
2312
  * The subscription's override discount for the plan.
2266
2313
  */
@@ -2359,6 +2406,17 @@ export namespace SubscriptionCreateParams {
2359
2406
 
2360
2407
  tiered_config: OverrideTieredPrice.TieredConfig;
2361
2408
 
2409
+ /**
2410
+ * The per unit conversion rate of the price currency to the invoicing currency.
2411
+ */
2412
+ conversion_rate?: number | null;
2413
+
2414
+ /**
2415
+ * The currency of the price. If not provided, the currency of the plan will be
2416
+ * used.
2417
+ */
2418
+ currency?: string | null;
2419
+
2362
2420
  /**
2363
2421
  * The subscription's override discount for the plan.
2364
2422
  */
@@ -2450,6 +2508,17 @@ export namespace SubscriptionCreateParams {
2450
2508
 
2451
2509
  tiered_bps_config: OverrideTieredBpsPrice.TieredBpsConfig;
2452
2510
 
2511
+ /**
2512
+ * The per unit conversion rate of the price currency to the invoicing currency.
2513
+ */
2514
+ conversion_rate?: number | null;
2515
+
2516
+ /**
2517
+ * The currency of the price. If not provided, the currency of the plan will be
2518
+ * used.
2519
+ */
2520
+ currency?: string | null;
2521
+
2453
2522
  /**
2454
2523
  * The subscription's override discount for the plan.
2455
2524
  */
@@ -2547,6 +2616,17 @@ export namespace SubscriptionCreateParams {
2547
2616
 
2548
2617
  model_type: 'bps';
2549
2618
 
2619
+ /**
2620
+ * The per unit conversion rate of the price currency to the invoicing currency.
2621
+ */
2622
+ conversion_rate?: number | null;
2623
+
2624
+ /**
2625
+ * The currency of the price. If not provided, the currency of the plan will be
2626
+ * used.
2627
+ */
2628
+ currency?: string | null;
2629
+
2550
2630
  /**
2551
2631
  * The subscription's override discount for the plan.
2552
2632
  */
@@ -2624,6 +2704,17 @@ export namespace SubscriptionCreateParams {
2624
2704
 
2625
2705
  model_type: 'bulk_bps';
2626
2706
 
2707
+ /**
2708
+ * The per unit conversion rate of the price currency to the invoicing currency.
2709
+ */
2710
+ conversion_rate?: number | null;
2711
+
2712
+ /**
2713
+ * The currency of the price. If not provided, the currency of the plan will be
2714
+ * used.
2715
+ */
2716
+ currency?: string | null;
2717
+
2627
2718
  /**
2628
2719
  * The subscription's override discount for the plan.
2629
2720
  */
@@ -2716,6 +2807,17 @@ export namespace SubscriptionCreateParams {
2716
2807
 
2717
2808
  model_type: 'bulk';
2718
2809
 
2810
+ /**
2811
+ * The per unit conversion rate of the price currency to the invoicing currency.
2812
+ */
2813
+ conversion_rate?: number | null;
2814
+
2815
+ /**
2816
+ * The currency of the price. If not provided, the currency of the plan will be
2817
+ * used.
2818
+ */
2819
+ currency?: string | null;
2820
+
2719
2821
  /**
2720
2822
  * The subscription's override discount for the plan.
2721
2823
  */
@@ -2802,6 +2904,17 @@ export namespace SubscriptionCreateParams {
2802
2904
 
2803
2905
  threshold_total_amount_config: Record<string, unknown>;
2804
2906
 
2907
+ /**
2908
+ * The per unit conversion rate of the price currency to the invoicing currency.
2909
+ */
2910
+ conversion_rate?: number | null;
2911
+
2912
+ /**
2913
+ * The currency of the price. If not provided, the currency of the plan will be
2914
+ * used.
2915
+ */
2916
+ currency?: string | null;
2917
+
2805
2918
  /**
2806
2919
  * The subscription's override discount for the plan.
2807
2920
  */
@@ -2867,6 +2980,17 @@ export namespace SubscriptionCreateParams {
2867
2980
 
2868
2981
  tiered_package_config: Record<string, unknown>;
2869
2982
 
2983
+ /**
2984
+ * The per unit conversion rate of the price currency to the invoicing currency.
2985
+ */
2986
+ conversion_rate?: number | null;
2987
+
2988
+ /**
2989
+ * The currency of the price. If not provided, the currency of the plan will be
2990
+ * used.
2991
+ */
2992
+ currency?: string | null;
2993
+
2870
2994
  /**
2871
2995
  * The subscription's override discount for the plan.
2872
2996
  */
@@ -2932,6 +3056,17 @@ export namespace SubscriptionCreateParams {
2932
3056
 
2933
3057
  tiered_with_minimum_config: Record<string, unknown>;
2934
3058
 
3059
+ /**
3060
+ * The per unit conversion rate of the price currency to the invoicing currency.
3061
+ */
3062
+ conversion_rate?: number | null;
3063
+
3064
+ /**
3065
+ * The currency of the price. If not provided, the currency of the plan will be
3066
+ * used.
3067
+ */
3068
+ currency?: string | null;
3069
+
2935
3070
  /**
2936
3071
  * The subscription's override discount for the plan.
2937
3072
  */
@@ -2997,6 +3132,17 @@ export namespace SubscriptionCreateParams {
2997
3132
 
2998
3133
  package_with_allocation_config: Record<string, unknown>;
2999
3134
 
3135
+ /**
3136
+ * The per unit conversion rate of the price currency to the invoicing currency.
3137
+ */
3138
+ conversion_rate?: number | null;
3139
+
3140
+ /**
3141
+ * The currency of the price. If not provided, the currency of the plan will be
3142
+ * used.
3143
+ */
3144
+ currency?: string | null;
3145
+
3000
3146
  /**
3001
3147
  * The subscription's override discount for the plan.
3002
3148
  */
@@ -3062,6 +3208,17 @@ export namespace SubscriptionCreateParams {
3062
3208
 
3063
3209
  unit_with_percent_config: Record<string, unknown>;
3064
3210
 
3211
+ /**
3212
+ * The per unit conversion rate of the price currency to the invoicing currency.
3213
+ */
3214
+ conversion_rate?: number | null;
3215
+
3216
+ /**
3217
+ * The currency of the price. If not provided, the currency of the plan will be
3218
+ * used.
3219
+ */
3220
+ currency?: string | null;
3221
+
3065
3222
  /**
3066
3223
  * The subscription's override discount for the plan.
3067
3224
  */
@@ -3121,6 +3278,43 @@ export namespace SubscriptionCreateParams {
3121
3278
  }
3122
3279
  }
3123
3280
 
3281
+ export interface SubscriptionUpdateParams {
3282
+ /**
3283
+ * Determines whether issued invoices for this subscription will automatically be
3284
+ * charged with the saved payment method on the due date. This property defaults to
3285
+ * the plan's behavior.
3286
+ */
3287
+ auto_collection?: boolean | null;
3288
+
3289
+ /**
3290
+ * Determines the default memo on this subscription's invoices. Note that if this
3291
+ * is not provided, it is determined by the plan configuration.
3292
+ */
3293
+ default_invoice_memo?: string | null;
3294
+
3295
+ /**
3296
+ * When this subscription's accrued usage reaches this threshold, an invoice will
3297
+ * be issued for the subscription. If not specified, invoices will only be issued
3298
+ * at the end of the billing period.
3299
+ */
3300
+ invoicing_threshold?: string | null;
3301
+
3302
+ /**
3303
+ * User-specified key/value pairs for the resource. Individual keys can be removed
3304
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
3305
+ * by setting `metadata` to `null`.
3306
+ */
3307
+ metadata?: Record<string, string | null> | null;
3308
+
3309
+ /**
3310
+ * Determines the difference between the invoice issue date for subscription
3311
+ * invoices as the date that they are due. A value of `0` here represents that the
3312
+ * invoice is due on issue, whereas a value of `30` represents that the customer
3313
+ * has a month to pay the invoice.
3314
+ */
3315
+ net_terms?: number | null;
3316
+ }
3317
+
3124
3318
  export interface SubscriptionListParams extends PageParams {
3125
3319
  'created_at[gt]'?: string | null;
3126
3320
 
@@ -3255,7 +3449,7 @@ export namespace SubscriptionPriceIntervalsParams {
3255
3449
  * The start date of the price interval. This is the date that the price will start
3256
3450
  * billing on the subscription.
3257
3451
  */
3258
- start_date: (string & {}) | 'start_of_term' | 'end_of_term';
3452
+ start_date: (string & {}) | Shared.BillingCycleRelativeDate;
3259
3453
 
3260
3454
  /**
3261
3455
  * A list of discounts to initialize on the price interval.
@@ -3270,7 +3464,7 @@ export namespace SubscriptionPriceIntervalsParams {
3270
3464
  * The end date of the price interval. This is the date that the price will stop
3271
3465
  * billing on the subscription.
3272
3466
  */
3273
- end_date?: (string & {}) | 'start_of_term' | 'end_of_term' | null;
3467
+ end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
3274
3468
 
3275
3469
  /**
3276
3470
  * The external price id of the price to add to the subscription.
@@ -3401,6 +3595,11 @@ export namespace SubscriptionPriceIntervalsParams {
3401
3595
  */
3402
3596
  billed_in_advance?: boolean | null;
3403
3597
 
3598
+ /**
3599
+ * The per unit conversion rate of the price currency to the invoicing currency.
3600
+ */
3601
+ conversion_rate?: number | null;
3602
+
3404
3603
  /**
3405
3604
  * An alias for the price.
3406
3605
  */
@@ -3464,6 +3663,11 @@ export namespace SubscriptionPriceIntervalsParams {
3464
3663
  */
3465
3664
  billed_in_advance?: boolean | null;
3466
3665
 
3666
+ /**
3667
+ * The per unit conversion rate of the price currency to the invoicing currency.
3668
+ */
3669
+ conversion_rate?: number | null;
3670
+
3467
3671
  /**
3468
3672
  * An alias for the price.
3469
3673
  */
@@ -3492,7 +3696,7 @@ export namespace SubscriptionPriceIntervalsParams {
3492
3696
  * An integer amount to represent package size. For example, 1000 here would divide
3493
3697
  * usage by 1000 before multiplying by package_amount in rating
3494
3698
  */
3495
- package_size?: number | null;
3699
+ package_size: number;
3496
3700
  }
3497
3701
  }
3498
3702
 
@@ -3533,6 +3737,11 @@ export namespace SubscriptionPriceIntervalsParams {
3533
3737
  */
3534
3738
  billed_in_advance?: boolean | null;
3535
3739
 
3740
+ /**
3741
+ * The per unit conversion rate of the price currency to the invoicing currency.
3742
+ */
3743
+ conversion_rate?: number | null;
3744
+
3536
3745
  /**
3537
3746
  * An alias for the price.
3538
3747
  */
@@ -3622,6 +3831,11 @@ export namespace SubscriptionPriceIntervalsParams {
3622
3831
  */
3623
3832
  billed_in_advance?: boolean | null;
3624
3833
 
3834
+ /**
3835
+ * The per unit conversion rate of the price currency to the invoicing currency.
3836
+ */
3837
+ conversion_rate?: number | null;
3838
+
3625
3839
  /**
3626
3840
  * An alias for the price.
3627
3841
  */
@@ -3716,6 +3930,11 @@ export namespace SubscriptionPriceIntervalsParams {
3716
3930
  */
3717
3931
  billed_in_advance?: boolean | null;
3718
3932
 
3933
+ /**
3934
+ * The per unit conversion rate of the price currency to the invoicing currency.
3935
+ */
3936
+ conversion_rate?: number | null;
3937
+
3719
3938
  /**
3720
3939
  * An alias for the price.
3721
3940
  */
@@ -3798,6 +4017,11 @@ export namespace SubscriptionPriceIntervalsParams {
3798
4017
  */
3799
4018
  billed_in_advance?: boolean | null;
3800
4019
 
4020
+ /**
4021
+ * The per unit conversion rate of the price currency to the invoicing currency.
4022
+ */
4023
+ conversion_rate?: number | null;
4024
+
3801
4025
  /**
3802
4026
  * An alias for the price.
3803
4027
  */
@@ -3886,6 +4110,11 @@ export namespace SubscriptionPriceIntervalsParams {
3886
4110
  */
3887
4111
  billed_in_advance?: boolean | null;
3888
4112
 
4113
+ /**
4114
+ * The per unit conversion rate of the price currency to the invoicing currency.
4115
+ */
4116
+ conversion_rate?: number | null;
4117
+
3889
4118
  /**
3890
4119
  * An alias for the price.
3891
4120
  */
@@ -3954,6 +4183,11 @@ export namespace SubscriptionPriceIntervalsParams {
3954
4183
  */
3955
4184
  billed_in_advance?: boolean | null;
3956
4185
 
4186
+ /**
4187
+ * The per unit conversion rate of the price currency to the invoicing currency.
4188
+ */
4189
+ conversion_rate?: number | null;
4190
+
3957
4191
  /**
3958
4192
  * An alias for the price.
3959
4193
  */
@@ -4037,6 +4271,11 @@ export namespace SubscriptionPriceIntervalsParams {
4037
4271
  */
4038
4272
  billed_in_advance?: boolean | null;
4039
4273
 
4274
+ /**
4275
+ * The per unit conversion rate of the price currency to the invoicing currency.
4276
+ */
4277
+ conversion_rate?: number | null;
4278
+
4040
4279
  /**
4041
4280
  * An alias for the price.
4042
4281
  */
@@ -4114,6 +4353,11 @@ export namespace SubscriptionPriceIntervalsParams {
4114
4353
  */
4115
4354
  billed_in_advance?: boolean | null;
4116
4355
 
4356
+ /**
4357
+ * The per unit conversion rate of the price currency to the invoicing currency.
4358
+ */
4359
+ conversion_rate?: number | null;
4360
+
4117
4361
  /**
4118
4362
  * An alias for the price.
4119
4363
  */
@@ -4168,6 +4412,11 @@ export namespace SubscriptionPriceIntervalsParams {
4168
4412
  */
4169
4413
  billed_in_advance?: boolean | null;
4170
4414
 
4415
+ /**
4416
+ * The per unit conversion rate of the price currency to the invoicing currency.
4417
+ */
4418
+ conversion_rate?: number | null;
4419
+
4171
4420
  /**
4172
4421
  * An alias for the price.
4173
4422
  */
@@ -4222,6 +4471,11 @@ export namespace SubscriptionPriceIntervalsParams {
4222
4471
  */
4223
4472
  billed_in_advance?: boolean | null;
4224
4473
 
4474
+ /**
4475
+ * The per unit conversion rate of the price currency to the invoicing currency.
4476
+ */
4477
+ conversion_rate?: number | null;
4478
+
4225
4479
  /**
4226
4480
  * An alias for the price.
4227
4481
  */
@@ -4276,6 +4530,11 @@ export namespace SubscriptionPriceIntervalsParams {
4276
4530
  */
4277
4531
  billed_in_advance?: boolean | null;
4278
4532
 
4533
+ /**
4534
+ * The per unit conversion rate of the price currency to the invoicing currency.
4535
+ */
4536
+ conversion_rate?: number | null;
4537
+
4279
4538
  /**
4280
4539
  * An alias for the price.
4281
4540
  */
@@ -4330,6 +4589,11 @@ export namespace SubscriptionPriceIntervalsParams {
4330
4589
  */
4331
4590
  billed_in_advance?: boolean | null;
4332
4591
 
4592
+ /**
4593
+ * The per unit conversion rate of the price currency to the invoicing currency.
4594
+ */
4595
+ conversion_rate?: number | null;
4596
+
4333
4597
  /**
4334
4598
  * An alias for the price.
4335
4599
  */
@@ -4384,6 +4648,11 @@ export namespace SubscriptionPriceIntervalsParams {
4384
4648
  */
4385
4649
  billed_in_advance?: boolean | null;
4386
4650
 
4651
+ /**
4652
+ * The per unit conversion rate of the price currency to the invoicing currency.
4653
+ */
4654
+ conversion_rate?: number | null;
4655
+
4387
4656
  /**
4388
4657
  * An alias for the price.
4389
4658
  */
@@ -4438,6 +4707,11 @@ export namespace SubscriptionPriceIntervalsParams {
4438
4707
  */
4439
4708
  billed_in_advance?: boolean | null;
4440
4709
 
4710
+ /**
4711
+ * The per unit conversion rate of the price currency to the invoicing currency.
4712
+ */
4713
+ conversion_rate?: number | null;
4714
+
4441
4715
  /**
4442
4716
  * An alias for the price.
4443
4717
  */
@@ -4473,7 +4747,7 @@ export namespace SubscriptionPriceIntervalsParams {
4473
4747
  * The updated end date of this price interval. If not specified, the start date
4474
4748
  * will not be updated.
4475
4749
  */
4476
- end_date?: (string & {}) | 'start_of_term' | 'end_of_term' | null;
4750
+ end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
4477
4751
 
4478
4752
  /**
4479
4753
  * A list of fixed fee quantity transitions to use for this price interval. Note
@@ -4486,7 +4760,7 @@ export namespace SubscriptionPriceIntervalsParams {
4486
4760
  * The updated start date of this price interval. If not specified, the start date
4487
4761
  * will not be updated.
4488
4762
  */
4489
- start_date?: (string & {}) | 'start_of_term' | 'end_of_term';
4763
+ start_date?: (string & {}) | Shared.BillingCycleRelativeDate;
4490
4764
  }
4491
4765
 
4492
4766
  export namespace Edit {
@@ -4589,6 +4863,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
4589
4863
 
4590
4864
  unit_config: OverrideUnitPrice.UnitConfig;
4591
4865
 
4866
+ /**
4867
+ * The per unit conversion rate of the price currency to the invoicing currency.
4868
+ */
4869
+ conversion_rate?: number | null;
4870
+
4871
+ /**
4872
+ * The currency of the price. If not provided, the currency of the plan will be
4873
+ * used.
4874
+ */
4875
+ currency?: string | null;
4876
+
4592
4877
  /**
4593
4878
  * The subscription's override discount for the plan.
4594
4879
  */
@@ -4661,6 +4946,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
4661
4946
 
4662
4947
  package_config: OverridePackagePrice.PackageConfig;
4663
4948
 
4949
+ /**
4950
+ * The per unit conversion rate of the price currency to the invoicing currency.
4951
+ */
4952
+ conversion_rate?: number | null;
4953
+
4954
+ /**
4955
+ * The currency of the price. If not provided, the currency of the plan will be
4956
+ * used.
4957
+ */
4958
+ currency?: string | null;
4959
+
4664
4960
  /**
4665
4961
  * The subscription's override discount for the plan.
4666
4962
  */
@@ -4693,7 +4989,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
4693
4989
  * An integer amount to represent package size. For example, 1000 here would divide
4694
4990
  * usage by 1000 before multiplying by package_amount in rating
4695
4991
  */
4696
- package_size?: number | null;
4992
+ package_size: number;
4697
4993
  }
4698
4994
 
4699
4995
  /**
@@ -4739,6 +5035,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
4739
5035
 
4740
5036
  model_type: 'matrix';
4741
5037
 
5038
+ /**
5039
+ * The per unit conversion rate of the price currency to the invoicing currency.
5040
+ */
5041
+ conversion_rate?: number | null;
5042
+
5043
+ /**
5044
+ * The currency of the price. If not provided, the currency of the plan will be
5045
+ * used.
5046
+ */
5047
+ currency?: string | null;
5048
+
4742
5049
  /**
4743
5050
  * The subscription's override discount for the plan.
4744
5051
  */
@@ -4837,6 +5144,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
4837
5144
 
4838
5145
  tiered_config: OverrideTieredPrice.TieredConfig;
4839
5146
 
5147
+ /**
5148
+ * The per unit conversion rate of the price currency to the invoicing currency.
5149
+ */
5150
+ conversion_rate?: number | null;
5151
+
5152
+ /**
5153
+ * The currency of the price. If not provided, the currency of the plan will be
5154
+ * used.
5155
+ */
5156
+ currency?: string | null;
5157
+
4840
5158
  /**
4841
5159
  * The subscription's override discount for the plan.
4842
5160
  */
@@ -4928,6 +5246,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
4928
5246
 
4929
5247
  tiered_bps_config: OverrideTieredBpsPrice.TieredBpsConfig;
4930
5248
 
5249
+ /**
5250
+ * The per unit conversion rate of the price currency to the invoicing currency.
5251
+ */
5252
+ conversion_rate?: number | null;
5253
+
5254
+ /**
5255
+ * The currency of the price. If not provided, the currency of the plan will be
5256
+ * used.
5257
+ */
5258
+ currency?: string | null;
5259
+
4931
5260
  /**
4932
5261
  * The subscription's override discount for the plan.
4933
5262
  */
@@ -5025,6 +5354,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5025
5354
 
5026
5355
  model_type: 'bps';
5027
5356
 
5357
+ /**
5358
+ * The per unit conversion rate of the price currency to the invoicing currency.
5359
+ */
5360
+ conversion_rate?: number | null;
5361
+
5362
+ /**
5363
+ * The currency of the price. If not provided, the currency of the plan will be
5364
+ * used.
5365
+ */
5366
+ currency?: string | null;
5367
+
5028
5368
  /**
5029
5369
  * The subscription's override discount for the plan.
5030
5370
  */
@@ -5102,6 +5442,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5102
5442
 
5103
5443
  model_type: 'bulk_bps';
5104
5444
 
5445
+ /**
5446
+ * The per unit conversion rate of the price currency to the invoicing currency.
5447
+ */
5448
+ conversion_rate?: number | null;
5449
+
5450
+ /**
5451
+ * The currency of the price. If not provided, the currency of the plan will be
5452
+ * used.
5453
+ */
5454
+ currency?: string | null;
5455
+
5105
5456
  /**
5106
5457
  * The subscription's override discount for the plan.
5107
5458
  */
@@ -5194,6 +5545,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5194
5545
 
5195
5546
  model_type: 'bulk';
5196
5547
 
5548
+ /**
5549
+ * The per unit conversion rate of the price currency to the invoicing currency.
5550
+ */
5551
+ conversion_rate?: number | null;
5552
+
5553
+ /**
5554
+ * The currency of the price. If not provided, the currency of the plan will be
5555
+ * used.
5556
+ */
5557
+ currency?: string | null;
5558
+
5197
5559
  /**
5198
5560
  * The subscription's override discount for the plan.
5199
5561
  */
@@ -5280,6 +5642,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5280
5642
 
5281
5643
  threshold_total_amount_config: Record<string, unknown>;
5282
5644
 
5645
+ /**
5646
+ * The per unit conversion rate of the price currency to the invoicing currency.
5647
+ */
5648
+ conversion_rate?: number | null;
5649
+
5650
+ /**
5651
+ * The currency of the price. If not provided, the currency of the plan will be
5652
+ * used.
5653
+ */
5654
+ currency?: string | null;
5655
+
5283
5656
  /**
5284
5657
  * The subscription's override discount for the plan.
5285
5658
  */
@@ -5345,6 +5718,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5345
5718
 
5346
5719
  tiered_package_config: Record<string, unknown>;
5347
5720
 
5721
+ /**
5722
+ * The per unit conversion rate of the price currency to the invoicing currency.
5723
+ */
5724
+ conversion_rate?: number | null;
5725
+
5726
+ /**
5727
+ * The currency of the price. If not provided, the currency of the plan will be
5728
+ * used.
5729
+ */
5730
+ currency?: string | null;
5731
+
5348
5732
  /**
5349
5733
  * The subscription's override discount for the plan.
5350
5734
  */
@@ -5410,6 +5794,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5410
5794
 
5411
5795
  tiered_with_minimum_config: Record<string, unknown>;
5412
5796
 
5797
+ /**
5798
+ * The per unit conversion rate of the price currency to the invoicing currency.
5799
+ */
5800
+ conversion_rate?: number | null;
5801
+
5802
+ /**
5803
+ * The currency of the price. If not provided, the currency of the plan will be
5804
+ * used.
5805
+ */
5806
+ currency?: string | null;
5807
+
5413
5808
  /**
5414
5809
  * The subscription's override discount for the plan.
5415
5810
  */
@@ -5475,6 +5870,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5475
5870
 
5476
5871
  package_with_allocation_config: Record<string, unknown>;
5477
5872
 
5873
+ /**
5874
+ * The per unit conversion rate of the price currency to the invoicing currency.
5875
+ */
5876
+ conversion_rate?: number | null;
5877
+
5878
+ /**
5879
+ * The currency of the price. If not provided, the currency of the plan will be
5880
+ * used.
5881
+ */
5882
+ currency?: string | null;
5883
+
5478
5884
  /**
5479
5885
  * The subscription's override discount for the plan.
5480
5886
  */
@@ -5540,6 +5946,17 @@ export namespace SubscriptionSchedulePlanChangeParams {
5540
5946
 
5541
5947
  unit_with_percent_config: Record<string, unknown>;
5542
5948
 
5949
+ /**
5950
+ * The per unit conversion rate of the price currency to the invoicing currency.
5951
+ */
5952
+ conversion_rate?: number | null;
5953
+
5954
+ /**
5955
+ * The currency of the price. If not provided, the currency of the plan will be
5956
+ * used.
5957
+ */
5958
+ currency?: string | null;
5959
+
5543
5960
  /**
5544
5961
  * The subscription's override discount for the plan.
5545
5962
  */
@@ -5646,6 +6063,7 @@ export namespace Subscriptions {
5646
6063
  export import SubscriptionsPage = SubscriptionsAPI.SubscriptionsPage;
5647
6064
  export import SubscriptionFetchScheduleResponsesPage = SubscriptionsAPI.SubscriptionFetchScheduleResponsesPage;
5648
6065
  export import SubscriptionCreateParams = SubscriptionsAPI.SubscriptionCreateParams;
6066
+ export import SubscriptionUpdateParams = SubscriptionsAPI.SubscriptionUpdateParams;
5649
6067
  export import SubscriptionListParams = SubscriptionsAPI.SubscriptionListParams;
5650
6068
  export import SubscriptionCancelParams = SubscriptionsAPI.SubscriptionCancelParams;
5651
6069
  export import SubscriptionFetchCostsParams = SubscriptionsAPI.SubscriptionFetchCostsParams;