orb-billing 4.71.6 → 4.72.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 +8 -0
  2. package/index.d.mts +3 -0
  3. package/index.d.ts +3 -0
  4. package/index.d.ts.map +1 -1
  5. package/index.js +3 -0
  6. package/index.js.map +1 -1
  7. package/index.mjs +3 -0
  8. package/index.mjs.map +1 -1
  9. package/package.json +1 -1
  10. package/resources/index.d.ts +1 -0
  11. package/resources/index.d.ts.map +1 -1
  12. package/resources/index.js +3 -1
  13. package/resources/index.js.map +1 -1
  14. package/resources/index.mjs +1 -0
  15. package/resources/index.mjs.map +1 -1
  16. package/resources/invoices.d.ts +3 -2
  17. package/resources/invoices.d.ts.map +1 -1
  18. package/resources/invoices.js.map +1 -1
  19. package/resources/invoices.mjs.map +1 -1
  20. package/resources/plans/plans.d.ts +4 -4
  21. package/resources/prices/prices.d.ts +8 -8
  22. package/resources/subscription-changes.d.ts +1707 -0
  23. package/resources/subscription-changes.d.ts.map +1 -0
  24. package/resources/subscription-changes.js +38 -0
  25. package/resources/subscription-changes.js.map +1 -0
  26. package/resources/subscription-changes.mjs +34 -0
  27. package/resources/subscription-changes.mjs.map +1 -0
  28. package/resources/subscriptions.d.ts +422 -20
  29. package/resources/subscriptions.d.ts.map +1 -1
  30. package/resources/subscriptions.js.map +1 -1
  31. package/resources/subscriptions.mjs.map +1 -1
  32. package/src/index.ts +17 -0
  33. package/src/resources/index.ts +7 -0
  34. package/src/resources/invoices.ts +3 -2
  35. package/src/resources/plans/plans.ts +4 -4
  36. package/src/resources/prices/prices.ts +8 -8
  37. package/src/resources/subscription-changes.ts +2167 -0
  38. package/src/resources/subscriptions.ts +494 -20
  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
@@ -3,6 +3,8 @@
3
3
  import { APIResource } from '../resource';
4
4
  import { isRequestOptions } from '../core';
5
5
  import * as Core from '../core';
6
+ import * as CreditNotesAPI from './credit-notes';
7
+ import * as InvoicesAPI from './invoices';
6
8
  import * as Shared from './shared';
7
9
  import * as CustomersAPI from './customers/customers';
8
10
  import * as PlansAPI from './plans/plans';
@@ -1200,6 +1202,11 @@ export interface Subscription {
1200
1202
  */
1201
1203
  net_terms: number;
1202
1204
 
1205
+ /**
1206
+ * A pending subscription change if one exists on this subscription.
1207
+ */
1208
+ pending_subscription_change: Subscription.PendingSubscriptionChange | null;
1209
+
1203
1210
  /**
1204
1211
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
1205
1212
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -1602,6 +1609,13 @@ export namespace Subscription {
1602
1609
  start_date: string;
1603
1610
  }
1604
1611
 
1612
+ /**
1613
+ * A pending subscription change if one exists on this subscription.
1614
+ */
1615
+ export interface PendingSubscriptionChange {
1616
+ id: string;
1617
+ }
1618
+
1605
1619
  /**
1606
1620
  * The Price Interval resource represents a period of time for which a price will
1607
1621
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -1898,6 +1912,11 @@ export interface SubscriptionCreateResponse {
1898
1912
  */
1899
1913
  net_terms: number;
1900
1914
 
1915
+ /**
1916
+ * A pending subscription change if one exists on this subscription.
1917
+ */
1918
+ pending_subscription_change: SubscriptionCreateResponse.PendingSubscriptionChange | null;
1919
+
1901
1920
  /**
1902
1921
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
1903
1922
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -1921,6 +1940,13 @@ export interface SubscriptionCreateResponse {
1921
1940
  status: 'active' | 'ended' | 'upcoming';
1922
1941
 
1923
1942
  trial_info: SubscriptionCreateResponse.TrialInfo;
1943
+
1944
+ /**
1945
+ * The resources that were changed as part of this operation. Only present when
1946
+ * fetched through the subscription changes API or if the
1947
+ * `include_changed_resources` parameter was passed in the request.
1948
+ */
1949
+ changed_resources?: SubscriptionCreateResponse.ChangedResources | null;
1924
1950
  }
1925
1951
 
1926
1952
  export namespace SubscriptionCreateResponse {
@@ -2300,6 +2326,13 @@ export namespace SubscriptionCreateResponse {
2300
2326
  start_date: string;
2301
2327
  }
2302
2328
 
2329
+ /**
2330
+ * A pending subscription change if one exists on this subscription.
2331
+ */
2332
+ export interface PendingSubscriptionChange {
2333
+ id: string;
2334
+ }
2335
+
2303
2336
  /**
2304
2337
  * The Price Interval resource represents a period of time for which a price will
2305
2338
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -2392,6 +2425,33 @@ export namespace SubscriptionCreateResponse {
2392
2425
  export interface TrialInfo {
2393
2426
  end_date: string | null;
2394
2427
  }
2428
+
2429
+ /**
2430
+ * The resources that were changed as part of this operation. Only present when
2431
+ * fetched through the subscription changes API or if the
2432
+ * `include_changed_resources` parameter was passed in the request.
2433
+ */
2434
+ export interface ChangedResources {
2435
+ /**
2436
+ * The credit notes that were created as part of this operation.
2437
+ */
2438
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
2439
+
2440
+ /**
2441
+ * The invoices that were created as part of this operation.
2442
+ */
2443
+ created_invoices: Array<InvoicesAPI.Invoice>;
2444
+
2445
+ /**
2446
+ * The credit notes that were voided as part of this operation.
2447
+ */
2448
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
2449
+
2450
+ /**
2451
+ * The invoices that were voided as part of this operation.
2452
+ */
2453
+ voided_invoices: Array<InvoicesAPI.Invoice>;
2454
+ }
2395
2455
  }
2396
2456
 
2397
2457
  export interface SubscriptionCancelResponse {
@@ -2514,6 +2574,11 @@ export interface SubscriptionCancelResponse {
2514
2574
  */
2515
2575
  net_terms: number;
2516
2576
 
2577
+ /**
2578
+ * A pending subscription change if one exists on this subscription.
2579
+ */
2580
+ pending_subscription_change: SubscriptionCancelResponse.PendingSubscriptionChange | null;
2581
+
2517
2582
  /**
2518
2583
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
2519
2584
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -2537,6 +2602,13 @@ export interface SubscriptionCancelResponse {
2537
2602
  status: 'active' | 'ended' | 'upcoming';
2538
2603
 
2539
2604
  trial_info: SubscriptionCancelResponse.TrialInfo;
2605
+
2606
+ /**
2607
+ * The resources that were changed as part of this operation. Only present when
2608
+ * fetched through the subscription changes API or if the
2609
+ * `include_changed_resources` parameter was passed in the request.
2610
+ */
2611
+ changed_resources?: SubscriptionCancelResponse.ChangedResources | null;
2540
2612
  }
2541
2613
 
2542
2614
  export namespace SubscriptionCancelResponse {
@@ -2916,6 +2988,13 @@ export namespace SubscriptionCancelResponse {
2916
2988
  start_date: string;
2917
2989
  }
2918
2990
 
2991
+ /**
2992
+ * A pending subscription change if one exists on this subscription.
2993
+ */
2994
+ export interface PendingSubscriptionChange {
2995
+ id: string;
2996
+ }
2997
+
2919
2998
  /**
2920
2999
  * The Price Interval resource represents a period of time for which a price will
2921
3000
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -3008,6 +3087,33 @@ export namespace SubscriptionCancelResponse {
3008
3087
  export interface TrialInfo {
3009
3088
  end_date: string | null;
3010
3089
  }
3090
+
3091
+ /**
3092
+ * The resources that were changed as part of this operation. Only present when
3093
+ * fetched through the subscription changes API or if the
3094
+ * `include_changed_resources` parameter was passed in the request.
3095
+ */
3096
+ export interface ChangedResources {
3097
+ /**
3098
+ * The credit notes that were created as part of this operation.
3099
+ */
3100
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
3101
+
3102
+ /**
3103
+ * The invoices that were created as part of this operation.
3104
+ */
3105
+ created_invoices: Array<InvoicesAPI.Invoice>;
3106
+
3107
+ /**
3108
+ * The credit notes that were voided as part of this operation.
3109
+ */
3110
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
3111
+
3112
+ /**
3113
+ * The invoices that were voided as part of this operation.
3114
+ */
3115
+ voided_invoices: Array<InvoicesAPI.Invoice>;
3116
+ }
3011
3117
  }
3012
3118
 
3013
3119
  export interface SubscriptionFetchCostsResponse {
@@ -3208,6 +3314,11 @@ export interface SubscriptionPriceIntervalsResponse {
3208
3314
  */
3209
3315
  net_terms: number;
3210
3316
 
3317
+ /**
3318
+ * A pending subscription change if one exists on this subscription.
3319
+ */
3320
+ pending_subscription_change: SubscriptionPriceIntervalsResponse.PendingSubscriptionChange | null;
3321
+
3211
3322
  /**
3212
3323
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
3213
3324
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -3231,6 +3342,13 @@ export interface SubscriptionPriceIntervalsResponse {
3231
3342
  status: 'active' | 'ended' | 'upcoming';
3232
3343
 
3233
3344
  trial_info: SubscriptionPriceIntervalsResponse.TrialInfo;
3345
+
3346
+ /**
3347
+ * The resources that were changed as part of this operation. Only present when
3348
+ * fetched through the subscription changes API or if the
3349
+ * `include_changed_resources` parameter was passed in the request.
3350
+ */
3351
+ changed_resources?: SubscriptionPriceIntervalsResponse.ChangedResources | null;
3234
3352
  }
3235
3353
 
3236
3354
  export namespace SubscriptionPriceIntervalsResponse {
@@ -3610,6 +3728,13 @@ export namespace SubscriptionPriceIntervalsResponse {
3610
3728
  start_date: string;
3611
3729
  }
3612
3730
 
3731
+ /**
3732
+ * A pending subscription change if one exists on this subscription.
3733
+ */
3734
+ export interface PendingSubscriptionChange {
3735
+ id: string;
3736
+ }
3737
+
3613
3738
  /**
3614
3739
  * The Price Interval resource represents a period of time for which a price will
3615
3740
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -3702,6 +3827,33 @@ export namespace SubscriptionPriceIntervalsResponse {
3702
3827
  export interface TrialInfo {
3703
3828
  end_date: string | null;
3704
3829
  }
3830
+
3831
+ /**
3832
+ * The resources that were changed as part of this operation. Only present when
3833
+ * fetched through the subscription changes API or if the
3834
+ * `include_changed_resources` parameter was passed in the request.
3835
+ */
3836
+ export interface ChangedResources {
3837
+ /**
3838
+ * The credit notes that were created as part of this operation.
3839
+ */
3840
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
3841
+
3842
+ /**
3843
+ * The invoices that were created as part of this operation.
3844
+ */
3845
+ created_invoices: Array<InvoicesAPI.Invoice>;
3846
+
3847
+ /**
3848
+ * The credit notes that were voided as part of this operation.
3849
+ */
3850
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
3851
+
3852
+ /**
3853
+ * The invoices that were voided as part of this operation.
3854
+ */
3855
+ voided_invoices: Array<InvoicesAPI.Invoice>;
3856
+ }
3705
3857
  }
3706
3858
 
3707
3859
  export interface SubscriptionSchedulePlanChangeResponse {
@@ -3824,6 +3976,11 @@ export interface SubscriptionSchedulePlanChangeResponse {
3824
3976
  */
3825
3977
  net_terms: number;
3826
3978
 
3979
+ /**
3980
+ * A pending subscription change if one exists on this subscription.
3981
+ */
3982
+ pending_subscription_change: SubscriptionSchedulePlanChangeResponse.PendingSubscriptionChange | null;
3983
+
3827
3984
  /**
3828
3985
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
3829
3986
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -3847,6 +4004,13 @@ export interface SubscriptionSchedulePlanChangeResponse {
3847
4004
  status: 'active' | 'ended' | 'upcoming';
3848
4005
 
3849
4006
  trial_info: SubscriptionSchedulePlanChangeResponse.TrialInfo;
4007
+
4008
+ /**
4009
+ * The resources that were changed as part of this operation. Only present when
4010
+ * fetched through the subscription changes API or if the
4011
+ * `include_changed_resources` parameter was passed in the request.
4012
+ */
4013
+ changed_resources?: SubscriptionSchedulePlanChangeResponse.ChangedResources | null;
3850
4014
  }
3851
4015
 
3852
4016
  export namespace SubscriptionSchedulePlanChangeResponse {
@@ -4226,6 +4390,13 @@ export namespace SubscriptionSchedulePlanChangeResponse {
4226
4390
  start_date: string;
4227
4391
  }
4228
4392
 
4393
+ /**
4394
+ * A pending subscription change if one exists on this subscription.
4395
+ */
4396
+ export interface PendingSubscriptionChange {
4397
+ id: string;
4398
+ }
4399
+
4229
4400
  /**
4230
4401
  * The Price Interval resource represents a period of time for which a price will
4231
4402
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -4318,6 +4489,33 @@ export namespace SubscriptionSchedulePlanChangeResponse {
4318
4489
  export interface TrialInfo {
4319
4490
  end_date: string | null;
4320
4491
  }
4492
+
4493
+ /**
4494
+ * The resources that were changed as part of this operation. Only present when
4495
+ * fetched through the subscription changes API or if the
4496
+ * `include_changed_resources` parameter was passed in the request.
4497
+ */
4498
+ export interface ChangedResources {
4499
+ /**
4500
+ * The credit notes that were created as part of this operation.
4501
+ */
4502
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
4503
+
4504
+ /**
4505
+ * The invoices that were created as part of this operation.
4506
+ */
4507
+ created_invoices: Array<InvoicesAPI.Invoice>;
4508
+
4509
+ /**
4510
+ * The credit notes that were voided as part of this operation.
4511
+ */
4512
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
4513
+
4514
+ /**
4515
+ * The invoices that were voided as part of this operation.
4516
+ */
4517
+ voided_invoices: Array<InvoicesAPI.Invoice>;
4518
+ }
4321
4519
  }
4322
4520
 
4323
4521
  export interface SubscriptionTriggerPhaseResponse {
@@ -4440,6 +4638,11 @@ export interface SubscriptionTriggerPhaseResponse {
4440
4638
  */
4441
4639
  net_terms: number;
4442
4640
 
4641
+ /**
4642
+ * A pending subscription change if one exists on this subscription.
4643
+ */
4644
+ pending_subscription_change: SubscriptionTriggerPhaseResponse.PendingSubscriptionChange | null;
4645
+
4443
4646
  /**
4444
4647
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
4445
4648
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -4463,6 +4666,13 @@ export interface SubscriptionTriggerPhaseResponse {
4463
4666
  status: 'active' | 'ended' | 'upcoming';
4464
4667
 
4465
4668
  trial_info: SubscriptionTriggerPhaseResponse.TrialInfo;
4669
+
4670
+ /**
4671
+ * The resources that were changed as part of this operation. Only present when
4672
+ * fetched through the subscription changes API or if the
4673
+ * `include_changed_resources` parameter was passed in the request.
4674
+ */
4675
+ changed_resources?: SubscriptionTriggerPhaseResponse.ChangedResources | null;
4466
4676
  }
4467
4677
 
4468
4678
  export namespace SubscriptionTriggerPhaseResponse {
@@ -4842,6 +5052,13 @@ export namespace SubscriptionTriggerPhaseResponse {
4842
5052
  start_date: string;
4843
5053
  }
4844
5054
 
5055
+ /**
5056
+ * A pending subscription change if one exists on this subscription.
5057
+ */
5058
+ export interface PendingSubscriptionChange {
5059
+ id: string;
5060
+ }
5061
+
4845
5062
  /**
4846
5063
  * The Price Interval resource represents a period of time for which a price will
4847
5064
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -4934,6 +5151,33 @@ export namespace SubscriptionTriggerPhaseResponse {
4934
5151
  export interface TrialInfo {
4935
5152
  end_date: string | null;
4936
5153
  }
5154
+
5155
+ /**
5156
+ * The resources that were changed as part of this operation. Only present when
5157
+ * fetched through the subscription changes API or if the
5158
+ * `include_changed_resources` parameter was passed in the request.
5159
+ */
5160
+ export interface ChangedResources {
5161
+ /**
5162
+ * The credit notes that were created as part of this operation.
5163
+ */
5164
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
5165
+
5166
+ /**
5167
+ * The invoices that were created as part of this operation.
5168
+ */
5169
+ created_invoices: Array<InvoicesAPI.Invoice>;
5170
+
5171
+ /**
5172
+ * The credit notes that were voided as part of this operation.
5173
+ */
5174
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
5175
+
5176
+ /**
5177
+ * The invoices that were voided as part of this operation.
5178
+ */
5179
+ voided_invoices: Array<InvoicesAPI.Invoice>;
5180
+ }
4937
5181
  }
4938
5182
 
4939
5183
  export interface SubscriptionUnscheduleCancellationResponse {
@@ -5056,6 +5300,11 @@ export interface SubscriptionUnscheduleCancellationResponse {
5056
5300
  */
5057
5301
  net_terms: number;
5058
5302
 
5303
+ /**
5304
+ * A pending subscription change if one exists on this subscription.
5305
+ */
5306
+ pending_subscription_change: SubscriptionUnscheduleCancellationResponse.PendingSubscriptionChange | null;
5307
+
5059
5308
  /**
5060
5309
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
5061
5310
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -5079,6 +5328,13 @@ export interface SubscriptionUnscheduleCancellationResponse {
5079
5328
  status: 'active' | 'ended' | 'upcoming';
5080
5329
 
5081
5330
  trial_info: SubscriptionUnscheduleCancellationResponse.TrialInfo;
5331
+
5332
+ /**
5333
+ * The resources that were changed as part of this operation. Only present when
5334
+ * fetched through the subscription changes API or if the
5335
+ * `include_changed_resources` parameter was passed in the request.
5336
+ */
5337
+ changed_resources?: SubscriptionUnscheduleCancellationResponse.ChangedResources | null;
5082
5338
  }
5083
5339
 
5084
5340
  export namespace SubscriptionUnscheduleCancellationResponse {
@@ -5458,6 +5714,13 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5458
5714
  start_date: string;
5459
5715
  }
5460
5716
 
5717
+ /**
5718
+ * A pending subscription change if one exists on this subscription.
5719
+ */
5720
+ export interface PendingSubscriptionChange {
5721
+ id: string;
5722
+ }
5723
+
5461
5724
  /**
5462
5725
  * The Price Interval resource represents a period of time for which a price will
5463
5726
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -5550,6 +5813,33 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5550
5813
  export interface TrialInfo {
5551
5814
  end_date: string | null;
5552
5815
  }
5816
+
5817
+ /**
5818
+ * The resources that were changed as part of this operation. Only present when
5819
+ * fetched through the subscription changes API or if the
5820
+ * `include_changed_resources` parameter was passed in the request.
5821
+ */
5822
+ export interface ChangedResources {
5823
+ /**
5824
+ * The credit notes that were created as part of this operation.
5825
+ */
5826
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
5827
+
5828
+ /**
5829
+ * The invoices that were created as part of this operation.
5830
+ */
5831
+ created_invoices: Array<InvoicesAPI.Invoice>;
5832
+
5833
+ /**
5834
+ * The credit notes that were voided as part of this operation.
5835
+ */
5836
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
5837
+
5838
+ /**
5839
+ * The invoices that were voided as part of this operation.
5840
+ */
5841
+ voided_invoices: Array<InvoicesAPI.Invoice>;
5842
+ }
5553
5843
  }
5554
5844
 
5555
5845
  export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
@@ -5672,6 +5962,11 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5672
5962
  */
5673
5963
  net_terms: number;
5674
5964
 
5965
+ /**
5966
+ * A pending subscription change if one exists on this subscription.
5967
+ */
5968
+ pending_subscription_change: SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse.PendingSubscriptionChange | null;
5969
+
5675
5970
  /**
5676
5971
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
5677
5972
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -5695,6 +5990,13 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5695
5990
  status: 'active' | 'ended' | 'upcoming';
5696
5991
 
5697
5992
  trial_info: SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse.TrialInfo;
5993
+
5994
+ /**
5995
+ * The resources that were changed as part of this operation. Only present when
5996
+ * fetched through the subscription changes API or if the
5997
+ * `include_changed_resources` parameter was passed in the request.
5998
+ */
5999
+ changed_resources?: SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse.ChangedResources | null;
5698
6000
  }
5699
6001
 
5700
6002
  export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
@@ -6074,6 +6376,13 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
6074
6376
  start_date: string;
6075
6377
  }
6076
6378
 
6379
+ /**
6380
+ * A pending subscription change if one exists on this subscription.
6381
+ */
6382
+ export interface PendingSubscriptionChange {
6383
+ id: string;
6384
+ }
6385
+
6077
6386
  /**
6078
6387
  * The Price Interval resource represents a period of time for which a price will
6079
6388
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -6166,6 +6475,33 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
6166
6475
  export interface TrialInfo {
6167
6476
  end_date: string | null;
6168
6477
  }
6478
+
6479
+ /**
6480
+ * The resources that were changed as part of this operation. Only present when
6481
+ * fetched through the subscription changes API or if the
6482
+ * `include_changed_resources` parameter was passed in the request.
6483
+ */
6484
+ export interface ChangedResources {
6485
+ /**
6486
+ * The credit notes that were created as part of this operation.
6487
+ */
6488
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
6489
+
6490
+ /**
6491
+ * The invoices that were created as part of this operation.
6492
+ */
6493
+ created_invoices: Array<InvoicesAPI.Invoice>;
6494
+
6495
+ /**
6496
+ * The credit notes that were voided as part of this operation.
6497
+ */
6498
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
6499
+
6500
+ /**
6501
+ * The invoices that were voided as part of this operation.
6502
+ */
6503
+ voided_invoices: Array<InvoicesAPI.Invoice>;
6504
+ }
6169
6505
  }
6170
6506
 
6171
6507
  export interface SubscriptionUnschedulePendingPlanChangesResponse {
@@ -6288,6 +6624,11 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
6288
6624
  */
6289
6625
  net_terms: number;
6290
6626
 
6627
+ /**
6628
+ * A pending subscription change if one exists on this subscription.
6629
+ */
6630
+ pending_subscription_change: SubscriptionUnschedulePendingPlanChangesResponse.PendingSubscriptionChange | null;
6631
+
6291
6632
  /**
6292
6633
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
6293
6634
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -6311,6 +6652,13 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
6311
6652
  status: 'active' | 'ended' | 'upcoming';
6312
6653
 
6313
6654
  trial_info: SubscriptionUnschedulePendingPlanChangesResponse.TrialInfo;
6655
+
6656
+ /**
6657
+ * The resources that were changed as part of this operation. Only present when
6658
+ * fetched through the subscription changes API or if the
6659
+ * `include_changed_resources` parameter was passed in the request.
6660
+ */
6661
+ changed_resources?: SubscriptionUnschedulePendingPlanChangesResponse.ChangedResources | null;
6314
6662
  }
6315
6663
 
6316
6664
  export namespace SubscriptionUnschedulePendingPlanChangesResponse {
@@ -6690,6 +7038,13 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6690
7038
  start_date: string;
6691
7039
  }
6692
7040
 
7041
+ /**
7042
+ * A pending subscription change if one exists on this subscription.
7043
+ */
7044
+ export interface PendingSubscriptionChange {
7045
+ id: string;
7046
+ }
7047
+
6693
7048
  /**
6694
7049
  * The Price Interval resource represents a period of time for which a price will
6695
7050
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -6782,6 +7137,33 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6782
7137
  export interface TrialInfo {
6783
7138
  end_date: string | null;
6784
7139
  }
7140
+
7141
+ /**
7142
+ * The resources that were changed as part of this operation. Only present when
7143
+ * fetched through the subscription changes API or if the
7144
+ * `include_changed_resources` parameter was passed in the request.
7145
+ */
7146
+ export interface ChangedResources {
7147
+ /**
7148
+ * The credit notes that were created as part of this operation.
7149
+ */
7150
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
7151
+
7152
+ /**
7153
+ * The invoices that were created as part of this operation.
7154
+ */
7155
+ created_invoices: Array<InvoicesAPI.Invoice>;
7156
+
7157
+ /**
7158
+ * The credit notes that were voided as part of this operation.
7159
+ */
7160
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
7161
+
7162
+ /**
7163
+ * The invoices that were voided as part of this operation.
7164
+ */
7165
+ voided_invoices: Array<InvoicesAPI.Invoice>;
7166
+ }
6785
7167
  }
6786
7168
 
6787
7169
  export interface SubscriptionUpdateFixedFeeQuantityResponse {
@@ -6904,6 +7286,11 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
6904
7286
  */
6905
7287
  net_terms: number;
6906
7288
 
7289
+ /**
7290
+ * A pending subscription change if one exists on this subscription.
7291
+ */
7292
+ pending_subscription_change: SubscriptionUpdateFixedFeeQuantityResponse.PendingSubscriptionChange | null;
7293
+
6907
7294
  /**
6908
7295
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
6909
7296
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -6927,6 +7314,13 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
6927
7314
  status: 'active' | 'ended' | 'upcoming';
6928
7315
 
6929
7316
  trial_info: SubscriptionUpdateFixedFeeQuantityResponse.TrialInfo;
7317
+
7318
+ /**
7319
+ * The resources that were changed as part of this operation. Only present when
7320
+ * fetched through the subscription changes API or if the
7321
+ * `include_changed_resources` parameter was passed in the request.
7322
+ */
7323
+ changed_resources?: SubscriptionUpdateFixedFeeQuantityResponse.ChangedResources | null;
6930
7324
  }
6931
7325
 
6932
7326
  export namespace SubscriptionUpdateFixedFeeQuantityResponse {
@@ -7306,6 +7700,13 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
7306
7700
  start_date: string;
7307
7701
  }
7308
7702
 
7703
+ /**
7704
+ * A pending subscription change if one exists on this subscription.
7705
+ */
7706
+ export interface PendingSubscriptionChange {
7707
+ id: string;
7708
+ }
7709
+
7309
7710
  /**
7310
7711
  * The Price Interval resource represents a period of time for which a price will
7311
7712
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -7398,6 +7799,33 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
7398
7799
  export interface TrialInfo {
7399
7800
  end_date: string | null;
7400
7801
  }
7802
+
7803
+ /**
7804
+ * The resources that were changed as part of this operation. Only present when
7805
+ * fetched through the subscription changes API or if the
7806
+ * `include_changed_resources` parameter was passed in the request.
7807
+ */
7808
+ export interface ChangedResources {
7809
+ /**
7810
+ * The credit notes that were created as part of this operation.
7811
+ */
7812
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
7813
+
7814
+ /**
7815
+ * The invoices that were created as part of this operation.
7816
+ */
7817
+ created_invoices: Array<InvoicesAPI.Invoice>;
7818
+
7819
+ /**
7820
+ * The credit notes that were voided as part of this operation.
7821
+ */
7822
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
7823
+
7824
+ /**
7825
+ * The invoices that were voided as part of this operation.
7826
+ */
7827
+ voided_invoices: Array<InvoicesAPI.Invoice>;
7828
+ }
7401
7829
  }
7402
7830
 
7403
7831
  export interface SubscriptionUpdateTrialResponse {
@@ -7520,6 +7948,11 @@ export interface SubscriptionUpdateTrialResponse {
7520
7948
  */
7521
7949
  net_terms: number;
7522
7950
 
7951
+ /**
7952
+ * A pending subscription change if one exists on this subscription.
7953
+ */
7954
+ pending_subscription_change: SubscriptionUpdateTrialResponse.PendingSubscriptionChange | null;
7955
+
7523
7956
  /**
7524
7957
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
7525
7958
  * subscribed to by a customer. Plans define the billing behavior of the
@@ -7543,6 +7976,13 @@ export interface SubscriptionUpdateTrialResponse {
7543
7976
  status: 'active' | 'ended' | 'upcoming';
7544
7977
 
7545
7978
  trial_info: SubscriptionUpdateTrialResponse.TrialInfo;
7979
+
7980
+ /**
7981
+ * The resources that were changed as part of this operation. Only present when
7982
+ * fetched through the subscription changes API or if the
7983
+ * `include_changed_resources` parameter was passed in the request.
7984
+ */
7985
+ changed_resources?: SubscriptionUpdateTrialResponse.ChangedResources | null;
7546
7986
  }
7547
7987
 
7548
7988
  export namespace SubscriptionUpdateTrialResponse {
@@ -7922,6 +8362,13 @@ export namespace SubscriptionUpdateTrialResponse {
7922
8362
  start_date: string;
7923
8363
  }
7924
8364
 
8365
+ /**
8366
+ * A pending subscription change if one exists on this subscription.
8367
+ */
8368
+ export interface PendingSubscriptionChange {
8369
+ id: string;
8370
+ }
8371
+
7925
8372
  /**
7926
8373
  * The Price Interval resource represents a period of time for which a price will
7927
8374
  * bill on a subscription. A subscription’s price intervals define its billing
@@ -8014,6 +8461,33 @@ export namespace SubscriptionUpdateTrialResponse {
8014
8461
  export interface TrialInfo {
8015
8462
  end_date: string | null;
8016
8463
  }
8464
+
8465
+ /**
8466
+ * The resources that were changed as part of this operation. Only present when
8467
+ * fetched through the subscription changes API or if the
8468
+ * `include_changed_resources` parameter was passed in the request.
8469
+ */
8470
+ export interface ChangedResources {
8471
+ /**
8472
+ * The credit notes that were created as part of this operation.
8473
+ */
8474
+ created_credit_notes: Array<CreditNotesAPI.CreditNote>;
8475
+
8476
+ /**
8477
+ * The invoices that were created as part of this operation.
8478
+ */
8479
+ created_invoices: Array<InvoicesAPI.Invoice>;
8480
+
8481
+ /**
8482
+ * The credit notes that were voided as part of this operation.
8483
+ */
8484
+ voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
8485
+
8486
+ /**
8487
+ * The invoices that were voided as part of this operation.
8488
+ */
8489
+ voided_invoices: Array<InvoicesAPI.Invoice>;
8490
+ }
8017
8491
  }
8018
8492
 
8019
8493
  export interface SubscriptionCreateParams {
@@ -8934,7 +9408,7 @@ export namespace SubscriptionCreateParams {
8934
9408
  export namespace TieredConfig {
8935
9409
  export interface Tier {
8936
9410
  /**
8937
- * Inclusive tier starting value
9411
+ * Exclusive tier starting value
8938
9412
  */
8939
9413
  first_unit: number;
8940
9414
 
@@ -8944,7 +9418,7 @@ export namespace SubscriptionCreateParams {
8944
9418
  unit_amount: string;
8945
9419
 
8946
9420
  /**
8947
- * Exclusive tier ending value. If null, this is treated as the last tier
9421
+ * Inclusive tier ending value. If null, this is treated as the last tier
8948
9422
  */
8949
9423
  last_unit?: number | null;
8950
9424
  }
@@ -9085,12 +9559,12 @@ export namespace SubscriptionCreateParams {
9085
9559
  bps: number;
9086
9560
 
9087
9561
  /**
9088
- * Inclusive tier starting value
9562
+ * Exclusive tier starting value
9089
9563
  */
9090
9564
  minimum_amount: string;
9091
9565
 
9092
9566
  /**
9093
- * Exclusive tier ending value
9567
+ * Inclusive tier ending value
9094
9568
  */
9095
9569
  maximum_amount?: string | null;
9096
9570
 
@@ -12357,7 +12831,7 @@ export namespace SubscriptionCreateParams {
12357
12831
  export namespace TieredConfig {
12358
12832
  export interface Tier {
12359
12833
  /**
12360
- * Inclusive tier starting value
12834
+ * Exclusive tier starting value
12361
12835
  */
12362
12836
  first_unit: number;
12363
12837
 
@@ -12367,7 +12841,7 @@ export namespace SubscriptionCreateParams {
12367
12841
  unit_amount: string;
12368
12842
 
12369
12843
  /**
12370
- * Exclusive tier ending value. If null, this is treated as the last tier
12844
+ * Inclusive tier ending value. If null, this is treated as the last tier
12371
12845
  */
12372
12846
  last_unit?: number | null;
12373
12847
  }
@@ -12508,12 +12982,12 @@ export namespace SubscriptionCreateParams {
12508
12982
  bps: number;
12509
12983
 
12510
12984
  /**
12511
- * Inclusive tier starting value
12985
+ * Exclusive tier starting value
12512
12986
  */
12513
12987
  minimum_amount: string;
12514
12988
 
12515
12989
  /**
12516
- * Exclusive tier ending value
12990
+ * Inclusive tier ending value
12517
12991
  */
12518
12992
  maximum_amount?: string | null;
12519
12993
 
@@ -15986,7 +16460,7 @@ export namespace SubscriptionPriceIntervalsParams {
15986
16460
  export namespace TieredConfig {
15987
16461
  export interface Tier {
15988
16462
  /**
15989
- * Inclusive tier starting value
16463
+ * Exclusive tier starting value
15990
16464
  */
15991
16465
  first_unit: number;
15992
16466
 
@@ -15996,7 +16470,7 @@ export namespace SubscriptionPriceIntervalsParams {
15996
16470
  unit_amount: string;
15997
16471
 
15998
16472
  /**
15999
- * Exclusive tier ending value. If null, this is treated as the last tier
16473
+ * Inclusive tier ending value. If null, this is treated as the last tier
16000
16474
  */
16001
16475
  last_unit?: number | null;
16002
16476
  }
@@ -16130,12 +16604,12 @@ export namespace SubscriptionPriceIntervalsParams {
16130
16604
  bps: number;
16131
16605
 
16132
16606
  /**
16133
- * Inclusive tier starting value
16607
+ * Exclusive tier starting value
16134
16608
  */
16135
16609
  minimum_amount: string;
16136
16610
 
16137
16611
  /**
16138
- * Exclusive tier ending value
16612
+ * Inclusive tier ending value
16139
16613
  */
16140
16614
  maximum_amount?: string | null;
16141
16615
 
@@ -19826,7 +20300,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
19826
20300
  export namespace TieredConfig {
19827
20301
  export interface Tier {
19828
20302
  /**
19829
- * Inclusive tier starting value
20303
+ * Exclusive tier starting value
19830
20304
  */
19831
20305
  first_unit: number;
19832
20306
 
@@ -19836,7 +20310,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
19836
20310
  unit_amount: string;
19837
20311
 
19838
20312
  /**
19839
- * Exclusive tier ending value. If null, this is treated as the last tier
20313
+ * Inclusive tier ending value. If null, this is treated as the last tier
19840
20314
  */
19841
20315
  last_unit?: number | null;
19842
20316
  }
@@ -19977,12 +20451,12 @@ export namespace SubscriptionSchedulePlanChangeParams {
19977
20451
  bps: number;
19978
20452
 
19979
20453
  /**
19980
- * Inclusive tier starting value
20454
+ * Exclusive tier starting value
19981
20455
  */
19982
20456
  minimum_amount: string;
19983
20457
 
19984
20458
  /**
19985
- * Exclusive tier ending value
20459
+ * Inclusive tier ending value
19986
20460
  */
19987
20461
  maximum_amount?: string | null;
19988
20462
 
@@ -23249,7 +23723,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
23249
23723
  export namespace TieredConfig {
23250
23724
  export interface Tier {
23251
23725
  /**
23252
- * Inclusive tier starting value
23726
+ * Exclusive tier starting value
23253
23727
  */
23254
23728
  first_unit: number;
23255
23729
 
@@ -23259,7 +23733,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
23259
23733
  unit_amount: string;
23260
23734
 
23261
23735
  /**
23262
- * Exclusive tier ending value. If null, this is treated as the last tier
23736
+ * Inclusive tier ending value. If null, this is treated as the last tier
23263
23737
  */
23264
23738
  last_unit?: number | null;
23265
23739
  }
@@ -23400,12 +23874,12 @@ export namespace SubscriptionSchedulePlanChangeParams {
23400
23874
  bps: number;
23401
23875
 
23402
23876
  /**
23403
- * Inclusive tier starting value
23877
+ * Exclusive tier starting value
23404
23878
  */
23405
23879
  minimum_amount: string;
23406
23880
 
23407
23881
  /**
23408
- * Exclusive tier ending value
23882
+ * Inclusive tier ending value
23409
23883
  */
23410
23884
  maximum_amount?: string | null;
23411
23885