rebilly-js-sdk 62.181.0 → 62.182.1
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.
- package/CHANGELOG.md +3 -3
- package/dist/rebilly-js-sdk.d.cts +33 -96
- package/dist/rebilly-js-sdk.d.mts +33 -96
- package/dist/rebilly-js-sdk.d.ts +33 -96
- package/dist/rebilly-js-sdk.es.mjs +1 -1
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
## 62.
|
|
1
|
+
## 62.182.1 (2026-09-29)
|
|
2
2
|
|
|
3
|
-
###
|
|
3
|
+
### 🧱 Updated Dependencies
|
|
4
4
|
|
|
5
|
-
-
|
|
5
|
+
- Updated eslint-config to 4.30.3
|
|
@@ -12233,7 +12233,7 @@ export interface coreComponents {
|
|
|
12233
12233
|
*
|
|
12234
12234
|
* This is used in conjunction with the service period anchor to calculate
|
|
12235
12235
|
* the time at which the invoice is issued. For more information, see
|
|
12236
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
12236
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
12237
12237
|
*/
|
|
12238
12238
|
issueTimeShift?: {
|
|
12239
12239
|
/** Sequential order of the billing time relative to the start of the service period. */
|
|
@@ -12248,9 +12248,9 @@ export interface coreComponents {
|
|
|
12248
12248
|
/**
|
|
12249
12249
|
* Calculation instruction of the invoice due time.
|
|
12250
12250
|
*
|
|
12251
|
-
* This is used in conjunction with the
|
|
12251
|
+
* This is used in conjunction with the service period anchor to calculate when
|
|
12252
12252
|
* an invoice is due for payment. For more information, see
|
|
12253
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
12253
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
12254
12254
|
*
|
|
12255
12255
|
* The sequential order of due time shift is always after the due date.
|
|
12256
12256
|
*/
|
|
@@ -12495,7 +12495,7 @@ export interface coreComponents {
|
|
|
12495
12495
|
* Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
|
|
12496
12496
|
* For example, rent must be paid in advance,
|
|
12497
12497
|
* so the invoice must be in advance of the billing date.
|
|
12498
|
-
* For more information, see [Service period anchor,
|
|
12498
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
12499
12499
|
*/
|
|
12500
12500
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
12501
12501
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -13626,16 +13626,6 @@ export interface coreComponents {
|
|
|
13626
13626
|
* this property enables the customer to subscribe to different plans.
|
|
13627
13627
|
*/
|
|
13628
13628
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
13629
|
-
/**
|
|
13630
|
-
* Recurring interval to override plan settings.
|
|
13631
|
-
* To use plan settings, set this value to `null`.
|
|
13632
|
-
*
|
|
13633
|
-
* To use multiple plans in one subscription,
|
|
13634
|
-
* all plans must have the same recurring period length.
|
|
13635
|
-
*/
|
|
13636
|
-
recurringInterval?: {
|
|
13637
|
-
periodAnchorInstruction?: coreComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
13638
|
-
} | null;
|
|
13639
13629
|
/**
|
|
13640
13630
|
* Specifies if payment attempts are made automatically.
|
|
13641
13631
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -14628,15 +14618,15 @@ export interface coreComponents {
|
|
|
14628
14618
|
* Amount of time between the pause end time and the renewal time in ISO-8601 durations format.
|
|
14629
14619
|
* By default, this value is computed as the time between the pause and the renewal.
|
|
14630
14620
|
*
|
|
14631
|
-
* Example: A $30 per month
|
|
14621
|
+
* Example: A $30 per month order on a 30-day month is paused on day 20.
|
|
14632
14622
|
* There are 10 unused days on the order.
|
|
14633
14623
|
* Therefore, the order renews in 10 days after it is resumed.
|
|
14634
14624
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
14635
|
-
* If the order uses a
|
|
14625
|
+
* If a subscription item in the order uses a service period anchor,
|
|
14636
14626
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
14637
|
-
* and the
|
|
14627
|
+
* and the service period anchor is ignored for that period.
|
|
14638
14628
|
*
|
|
14639
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
14629
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
14640
14630
|
*/
|
|
14641
14631
|
timeRemaining?: string | null;
|
|
14642
14632
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -14928,11 +14918,11 @@ export interface coreComponents {
|
|
|
14928
14918
|
* There are 10 unused days on the subscription.
|
|
14929
14919
|
* Therefore, the subscription renews in 10 days after it is resumed.
|
|
14930
14920
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
14931
|
-
* If the subscription uses a
|
|
14921
|
+
* If the subscription uses a service period anchor,
|
|
14932
14922
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
14933
|
-
* and the
|
|
14923
|
+
* and the service period anchor is ignored for that period.
|
|
14934
14924
|
*
|
|
14935
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
14925
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
14936
14926
|
*/
|
|
14937
14927
|
timeRemaining?: string | null;
|
|
14938
14928
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -26497,17 +26487,6 @@ export interface coreComponents {
|
|
|
26497
26487
|
* this property enables the customer to subscribe to different plans.
|
|
26498
26488
|
*/
|
|
26499
26489
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
26500
|
-
/**
|
|
26501
|
-
* Recurring interval to override plan settings.
|
|
26502
|
-
* To use plan settings, set this value to `null`.
|
|
26503
|
-
*
|
|
26504
|
-
* To use multiple plans in one subscription,
|
|
26505
|
-
* all plans must have the same same recurring period length,
|
|
26506
|
-
* this property enables the customer to subscribe to different plans.
|
|
26507
|
-
*/
|
|
26508
|
-
recurringInterval?: {
|
|
26509
|
-
periodAnchorInstruction?: coreComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
26510
|
-
} | null;
|
|
26511
26490
|
/**
|
|
26512
26491
|
* Specifies if payment attempts are made automatically.
|
|
26513
26492
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -51752,7 +51731,7 @@ export interface storefrontComponents {
|
|
|
51752
51731
|
*
|
|
51753
51732
|
* This is used in conjunction with the service period anchor to calculate
|
|
51754
51733
|
* the time at which the invoice is issued. For more information, see
|
|
51755
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
51734
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
51756
51735
|
*/
|
|
51757
51736
|
issueTimeShift?: {
|
|
51758
51737
|
/** Sequential order of the billing time relative to the start of the service period. */
|
|
@@ -51767,9 +51746,9 @@ export interface storefrontComponents {
|
|
|
51767
51746
|
/**
|
|
51768
51747
|
* Calculation instruction of the invoice due time.
|
|
51769
51748
|
*
|
|
51770
|
-
* This is used in conjunction with the
|
|
51749
|
+
* This is used in conjunction with the service period anchor to calculate when
|
|
51771
51750
|
* an invoice is due for payment. For more information, see
|
|
51772
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
51751
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
51773
51752
|
*
|
|
51774
51753
|
* The sequential order of due time shift is always after the due date.
|
|
51775
51754
|
*/
|
|
@@ -52014,7 +51993,7 @@ export interface storefrontComponents {
|
|
|
52014
51993
|
* Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
|
|
52015
51994
|
* For example, rent must be paid in advance,
|
|
52016
51995
|
* so the invoice must be in advance of the billing date.
|
|
52017
|
-
* For more information, see [Service period anchor,
|
|
51996
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
52018
51997
|
*/
|
|
52019
51998
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
52020
51999
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -53145,16 +53124,6 @@ export interface storefrontComponents {
|
|
|
53145
53124
|
* this property enables the customer to subscribe to different plans.
|
|
53146
53125
|
*/
|
|
53147
53126
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
53148
|
-
/**
|
|
53149
|
-
* Recurring interval to override plan settings.
|
|
53150
|
-
* To use plan settings, set this value to `null`.
|
|
53151
|
-
*
|
|
53152
|
-
* To use multiple plans in one subscription,
|
|
53153
|
-
* all plans must have the same recurring period length.
|
|
53154
|
-
*/
|
|
53155
|
-
recurringInterval?: {
|
|
53156
|
-
periodAnchorInstruction?: storefrontComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
53157
|
-
} | null;
|
|
53158
53127
|
/**
|
|
53159
53128
|
* Specifies if payment attempts are made automatically.
|
|
53160
53129
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -54147,15 +54116,15 @@ export interface storefrontComponents {
|
|
|
54147
54116
|
* Amount of time between the pause end time and the renewal time in ISO-8601 durations format.
|
|
54148
54117
|
* By default, this value is computed as the time between the pause and the renewal.
|
|
54149
54118
|
*
|
|
54150
|
-
* Example: A $30 per month
|
|
54119
|
+
* Example: A $30 per month order on a 30-day month is paused on day 20.
|
|
54151
54120
|
* There are 10 unused days on the order.
|
|
54152
54121
|
* Therefore, the order renews in 10 days after it is resumed.
|
|
54153
54122
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
54154
|
-
* If the order uses a
|
|
54123
|
+
* If a subscription item in the order uses a service period anchor,
|
|
54155
54124
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
54156
|
-
* and the
|
|
54125
|
+
* and the service period anchor is ignored for that period.
|
|
54157
54126
|
*
|
|
54158
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
54127
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
54159
54128
|
*/
|
|
54160
54129
|
timeRemaining?: string | null;
|
|
54161
54130
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -54447,11 +54416,11 @@ export interface storefrontComponents {
|
|
|
54447
54416
|
* There are 10 unused days on the subscription.
|
|
54448
54417
|
* Therefore, the subscription renews in 10 days after it is resumed.
|
|
54449
54418
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
54450
|
-
* If the subscription uses a
|
|
54419
|
+
* If the subscription uses a service period anchor,
|
|
54451
54420
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
54452
|
-
* and the
|
|
54421
|
+
* and the service period anchor is ignored for that period.
|
|
54453
54422
|
*
|
|
54454
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
54423
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
54455
54424
|
*/
|
|
54456
54425
|
timeRemaining?: string | null;
|
|
54457
54426
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -66016,17 +65985,6 @@ export interface storefrontComponents {
|
|
|
66016
65985
|
* this property enables the customer to subscribe to different plans.
|
|
66017
65986
|
*/
|
|
66018
65987
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
66019
|
-
/**
|
|
66020
|
-
* Recurring interval to override plan settings.
|
|
66021
|
-
* To use plan settings, set this value to `null`.
|
|
66022
|
-
*
|
|
66023
|
-
* To use multiple plans in one subscription,
|
|
66024
|
-
* all plans must have the same same recurring period length,
|
|
66025
|
-
* this property enables the customer to subscribe to different plans.
|
|
66026
|
-
*/
|
|
66027
|
-
recurringInterval?: {
|
|
66028
|
-
periodAnchorInstruction?: storefrontComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
66029
|
-
} | null;
|
|
66030
65988
|
/**
|
|
66031
65989
|
* Specifies if payment attempts are made automatically.
|
|
66032
65990
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -78404,7 +78362,7 @@ export interface reportsComponents {
|
|
|
78404
78362
|
*
|
|
78405
78363
|
* This is used in conjunction with the service period anchor to calculate
|
|
78406
78364
|
* the time at which the invoice is issued. For more information, see
|
|
78407
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
78365
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
78408
78366
|
*/
|
|
78409
78367
|
issueTimeShift?: {
|
|
78410
78368
|
/** Sequential order of the billing time relative to the start of the service period. */
|
|
@@ -78419,9 +78377,9 @@ export interface reportsComponents {
|
|
|
78419
78377
|
/**
|
|
78420
78378
|
* Calculation instruction of the invoice due time.
|
|
78421
78379
|
*
|
|
78422
|
-
* This is used in conjunction with the
|
|
78380
|
+
* This is used in conjunction with the service period anchor to calculate when
|
|
78423
78381
|
* an invoice is due for payment. For more information, see
|
|
78424
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
78382
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
78425
78383
|
*
|
|
78426
78384
|
* The sequential order of due time shift is always after the due date.
|
|
78427
78385
|
*/
|
|
@@ -78666,7 +78624,7 @@ export interface reportsComponents {
|
|
|
78666
78624
|
* Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
|
|
78667
78625
|
* For example, rent must be paid in advance,
|
|
78668
78626
|
* so the invoice must be in advance of the billing date.
|
|
78669
|
-
* For more information, see [Service period anchor,
|
|
78627
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
78670
78628
|
*/
|
|
78671
78629
|
invoiceTimeShift?: reportsComponents["schemas"]["InvoiceTimeShift"];
|
|
78672
78630
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
@@ -79797,16 +79755,6 @@ export interface reportsComponents {
|
|
|
79797
79755
|
* this property enables the customer to subscribe to different plans.
|
|
79798
79756
|
*/
|
|
79799
79757
|
invoiceTimeShift?: reportsComponents["schemas"]["InvoiceTimeShift"];
|
|
79800
|
-
/**
|
|
79801
|
-
* Recurring interval to override plan settings.
|
|
79802
|
-
* To use plan settings, set this value to `null`.
|
|
79803
|
-
*
|
|
79804
|
-
* To use multiple plans in one subscription,
|
|
79805
|
-
* all plans must have the same recurring period length.
|
|
79806
|
-
*/
|
|
79807
|
-
recurringInterval?: {
|
|
79808
|
-
periodAnchorInstruction?: reportsComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
79809
|
-
} | null;
|
|
79810
79758
|
/**
|
|
79811
79759
|
* Specifies if payment attempts are made automatically.
|
|
79812
79760
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -80799,15 +80747,15 @@ export interface reportsComponents {
|
|
|
80799
80747
|
* Amount of time between the pause end time and the renewal time in ISO-8601 durations format.
|
|
80800
80748
|
* By default, this value is computed as the time between the pause and the renewal.
|
|
80801
80749
|
*
|
|
80802
|
-
* Example: A $30 per month
|
|
80750
|
+
* Example: A $30 per month order on a 30-day month is paused on day 20.
|
|
80803
80751
|
* There are 10 unused days on the order.
|
|
80804
80752
|
* Therefore, the order renews in 10 days after it is resumed.
|
|
80805
80753
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
80806
|
-
* If the order uses a
|
|
80754
|
+
* If a subscription item in the order uses a service period anchor,
|
|
80807
80755
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
80808
|
-
* and the
|
|
80756
|
+
* and the service period anchor is ignored for that period.
|
|
80809
80757
|
*
|
|
80810
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
80758
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
80811
80759
|
*/
|
|
80812
80760
|
timeRemaining?: string | null;
|
|
80813
80761
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
@@ -81099,11 +81047,11 @@ export interface reportsComponents {
|
|
|
81099
81047
|
* There are 10 unused days on the subscription.
|
|
81100
81048
|
* Therefore, the subscription renews in 10 days after it is resumed.
|
|
81101
81049
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
81102
|
-
* If the subscription uses a
|
|
81050
|
+
* If the subscription uses a service period anchor,
|
|
81103
81051
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
81104
|
-
* and the
|
|
81052
|
+
* and the service period anchor is ignored for that period.
|
|
81105
81053
|
*
|
|
81106
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
81054
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
81107
81055
|
*/
|
|
81108
81056
|
timeRemaining?: string | null;
|
|
81109
81057
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
@@ -92668,17 +92616,6 @@ export interface reportsComponents {
|
|
|
92668
92616
|
* this property enables the customer to subscribe to different plans.
|
|
92669
92617
|
*/
|
|
92670
92618
|
invoiceTimeShift?: reportsComponents["schemas"]["InvoiceTimeShift"];
|
|
92671
|
-
/**
|
|
92672
|
-
* Recurring interval to override plan settings.
|
|
92673
|
-
* To use plan settings, set this value to `null`.
|
|
92674
|
-
*
|
|
92675
|
-
* To use multiple plans in one subscription,
|
|
92676
|
-
* all plans must have the same same recurring period length,
|
|
92677
|
-
* this property enables the customer to subscribe to different plans.
|
|
92678
|
-
*/
|
|
92679
|
-
recurringInterval?: {
|
|
92680
|
-
periodAnchorInstruction?: reportsComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
92681
|
-
} | null;
|
|
92682
92619
|
/**
|
|
92683
92620
|
* Specifies if payment attempts are made automatically.
|
|
92684
92621
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -12233,7 +12233,7 @@ export interface coreComponents {
|
|
|
12233
12233
|
*
|
|
12234
12234
|
* This is used in conjunction with the service period anchor to calculate
|
|
12235
12235
|
* the time at which the invoice is issued. For more information, see
|
|
12236
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
12236
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
12237
12237
|
*/
|
|
12238
12238
|
issueTimeShift?: {
|
|
12239
12239
|
/** Sequential order of the billing time relative to the start of the service period. */
|
|
@@ -12248,9 +12248,9 @@ export interface coreComponents {
|
|
|
12248
12248
|
/**
|
|
12249
12249
|
* Calculation instruction of the invoice due time.
|
|
12250
12250
|
*
|
|
12251
|
-
* This is used in conjunction with the
|
|
12251
|
+
* This is used in conjunction with the service period anchor to calculate when
|
|
12252
12252
|
* an invoice is due for payment. For more information, see
|
|
12253
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
12253
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
12254
12254
|
*
|
|
12255
12255
|
* The sequential order of due time shift is always after the due date.
|
|
12256
12256
|
*/
|
|
@@ -12495,7 +12495,7 @@ export interface coreComponents {
|
|
|
12495
12495
|
* Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
|
|
12496
12496
|
* For example, rent must be paid in advance,
|
|
12497
12497
|
* so the invoice must be in advance of the billing date.
|
|
12498
|
-
* For more information, see [Service period anchor,
|
|
12498
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
12499
12499
|
*/
|
|
12500
12500
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
12501
12501
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -13626,16 +13626,6 @@ export interface coreComponents {
|
|
|
13626
13626
|
* this property enables the customer to subscribe to different plans.
|
|
13627
13627
|
*/
|
|
13628
13628
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
13629
|
-
/**
|
|
13630
|
-
* Recurring interval to override plan settings.
|
|
13631
|
-
* To use plan settings, set this value to `null`.
|
|
13632
|
-
*
|
|
13633
|
-
* To use multiple plans in one subscription,
|
|
13634
|
-
* all plans must have the same recurring period length.
|
|
13635
|
-
*/
|
|
13636
|
-
recurringInterval?: {
|
|
13637
|
-
periodAnchorInstruction?: coreComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
13638
|
-
} | null;
|
|
13639
13629
|
/**
|
|
13640
13630
|
* Specifies if payment attempts are made automatically.
|
|
13641
13631
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -14628,15 +14618,15 @@ export interface coreComponents {
|
|
|
14628
14618
|
* Amount of time between the pause end time and the renewal time in ISO-8601 durations format.
|
|
14629
14619
|
* By default, this value is computed as the time between the pause and the renewal.
|
|
14630
14620
|
*
|
|
14631
|
-
* Example: A $30 per month
|
|
14621
|
+
* Example: A $30 per month order on a 30-day month is paused on day 20.
|
|
14632
14622
|
* There are 10 unused days on the order.
|
|
14633
14623
|
* Therefore, the order renews in 10 days after it is resumed.
|
|
14634
14624
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
14635
|
-
* If the order uses a
|
|
14625
|
+
* If a subscription item in the order uses a service period anchor,
|
|
14636
14626
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
14637
|
-
* and the
|
|
14627
|
+
* and the service period anchor is ignored for that period.
|
|
14638
14628
|
*
|
|
14639
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
14629
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
14640
14630
|
*/
|
|
14641
14631
|
timeRemaining?: string | null;
|
|
14642
14632
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -14928,11 +14918,11 @@ export interface coreComponents {
|
|
|
14928
14918
|
* There are 10 unused days on the subscription.
|
|
14929
14919
|
* Therefore, the subscription renews in 10 days after it is resumed.
|
|
14930
14920
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
14931
|
-
* If the subscription uses a
|
|
14921
|
+
* If the subscription uses a service period anchor,
|
|
14932
14922
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
14933
|
-
* and the
|
|
14923
|
+
* and the service period anchor is ignored for that period.
|
|
14934
14924
|
*
|
|
14935
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
14925
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
14936
14926
|
*/
|
|
14937
14927
|
timeRemaining?: string | null;
|
|
14938
14928
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -26497,17 +26487,6 @@ export interface coreComponents {
|
|
|
26497
26487
|
* this property enables the customer to subscribe to different plans.
|
|
26498
26488
|
*/
|
|
26499
26489
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
26500
|
-
/**
|
|
26501
|
-
* Recurring interval to override plan settings.
|
|
26502
|
-
* To use plan settings, set this value to `null`.
|
|
26503
|
-
*
|
|
26504
|
-
* To use multiple plans in one subscription,
|
|
26505
|
-
* all plans must have the same same recurring period length,
|
|
26506
|
-
* this property enables the customer to subscribe to different plans.
|
|
26507
|
-
*/
|
|
26508
|
-
recurringInterval?: {
|
|
26509
|
-
periodAnchorInstruction?: coreComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
26510
|
-
} | null;
|
|
26511
26490
|
/**
|
|
26512
26491
|
* Specifies if payment attempts are made automatically.
|
|
26513
26492
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -51752,7 +51731,7 @@ export interface storefrontComponents {
|
|
|
51752
51731
|
*
|
|
51753
51732
|
* This is used in conjunction with the service period anchor to calculate
|
|
51754
51733
|
* the time at which the invoice is issued. For more information, see
|
|
51755
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
51734
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
51756
51735
|
*/
|
|
51757
51736
|
issueTimeShift?: {
|
|
51758
51737
|
/** Sequential order of the billing time relative to the start of the service period. */
|
|
@@ -51767,9 +51746,9 @@ export interface storefrontComponents {
|
|
|
51767
51746
|
/**
|
|
51768
51747
|
* Calculation instruction of the invoice due time.
|
|
51769
51748
|
*
|
|
51770
|
-
* This is used in conjunction with the
|
|
51749
|
+
* This is used in conjunction with the service period anchor to calculate when
|
|
51771
51750
|
* an invoice is due for payment. For more information, see
|
|
51772
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
51751
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
51773
51752
|
*
|
|
51774
51753
|
* The sequential order of due time shift is always after the due date.
|
|
51775
51754
|
*/
|
|
@@ -52014,7 +51993,7 @@ export interface storefrontComponents {
|
|
|
52014
51993
|
* Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
|
|
52015
51994
|
* For example, rent must be paid in advance,
|
|
52016
51995
|
* so the invoice must be in advance of the billing date.
|
|
52017
|
-
* For more information, see [Service period anchor,
|
|
51996
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
52018
51997
|
*/
|
|
52019
51998
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
52020
51999
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -53145,16 +53124,6 @@ export interface storefrontComponents {
|
|
|
53145
53124
|
* this property enables the customer to subscribe to different plans.
|
|
53146
53125
|
*/
|
|
53147
53126
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
53148
|
-
/**
|
|
53149
|
-
* Recurring interval to override plan settings.
|
|
53150
|
-
* To use plan settings, set this value to `null`.
|
|
53151
|
-
*
|
|
53152
|
-
* To use multiple plans in one subscription,
|
|
53153
|
-
* all plans must have the same recurring period length.
|
|
53154
|
-
*/
|
|
53155
|
-
recurringInterval?: {
|
|
53156
|
-
periodAnchorInstruction?: storefrontComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
53157
|
-
} | null;
|
|
53158
53127
|
/**
|
|
53159
53128
|
* Specifies if payment attempts are made automatically.
|
|
53160
53129
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -54147,15 +54116,15 @@ export interface storefrontComponents {
|
|
|
54147
54116
|
* Amount of time between the pause end time and the renewal time in ISO-8601 durations format.
|
|
54148
54117
|
* By default, this value is computed as the time between the pause and the renewal.
|
|
54149
54118
|
*
|
|
54150
|
-
* Example: A $30 per month
|
|
54119
|
+
* Example: A $30 per month order on a 30-day month is paused on day 20.
|
|
54151
54120
|
* There are 10 unused days on the order.
|
|
54152
54121
|
* Therefore, the order renews in 10 days after it is resumed.
|
|
54153
54122
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
54154
|
-
* If the order uses a
|
|
54123
|
+
* If a subscription item in the order uses a service period anchor,
|
|
54155
54124
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
54156
|
-
* and the
|
|
54125
|
+
* and the service period anchor is ignored for that period.
|
|
54157
54126
|
*
|
|
54158
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
54127
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
54159
54128
|
*/
|
|
54160
54129
|
timeRemaining?: string | null;
|
|
54161
54130
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -54447,11 +54416,11 @@ export interface storefrontComponents {
|
|
|
54447
54416
|
* There are 10 unused days on the subscription.
|
|
54448
54417
|
* Therefore, the subscription renews in 10 days after it is resumed.
|
|
54449
54418
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
54450
|
-
* If the subscription uses a
|
|
54419
|
+
* If the subscription uses a service period anchor,
|
|
54451
54420
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
54452
|
-
* and the
|
|
54421
|
+
* and the service period anchor is ignored for that period.
|
|
54453
54422
|
*
|
|
54454
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
54423
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
54455
54424
|
*/
|
|
54456
54425
|
timeRemaining?: string | null;
|
|
54457
54426
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -66016,17 +65985,6 @@ export interface storefrontComponents {
|
|
|
66016
65985
|
* this property enables the customer to subscribe to different plans.
|
|
66017
65986
|
*/
|
|
66018
65987
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
66019
|
-
/**
|
|
66020
|
-
* Recurring interval to override plan settings.
|
|
66021
|
-
* To use plan settings, set this value to `null`.
|
|
66022
|
-
*
|
|
66023
|
-
* To use multiple plans in one subscription,
|
|
66024
|
-
* all plans must have the same same recurring period length,
|
|
66025
|
-
* this property enables the customer to subscribe to different plans.
|
|
66026
|
-
*/
|
|
66027
|
-
recurringInterval?: {
|
|
66028
|
-
periodAnchorInstruction?: storefrontComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
66029
|
-
} | null;
|
|
66030
65988
|
/**
|
|
66031
65989
|
* Specifies if payment attempts are made automatically.
|
|
66032
65990
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -78404,7 +78362,7 @@ export interface reportsComponents {
|
|
|
78404
78362
|
*
|
|
78405
78363
|
* This is used in conjunction with the service period anchor to calculate
|
|
78406
78364
|
* the time at which the invoice is issued. For more information, see
|
|
78407
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
78365
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
78408
78366
|
*/
|
|
78409
78367
|
issueTimeShift?: {
|
|
78410
78368
|
/** Sequential order of the billing time relative to the start of the service period. */
|
|
@@ -78419,9 +78377,9 @@ export interface reportsComponents {
|
|
|
78419
78377
|
/**
|
|
78420
78378
|
* Calculation instruction of the invoice due time.
|
|
78421
78379
|
*
|
|
78422
|
-
* This is used in conjunction with the
|
|
78380
|
+
* This is used in conjunction with the service period anchor to calculate when
|
|
78423
78381
|
* an invoice is due for payment. For more information, see
|
|
78424
|
-
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
78382
|
+
* [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
78425
78383
|
*
|
|
78426
78384
|
* The sequential order of due time shift is always after the due date.
|
|
78427
78385
|
*/
|
|
@@ -78666,7 +78624,7 @@ export interface reportsComponents {
|
|
|
78666
78624
|
* Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
|
|
78667
78625
|
* For example, rent must be paid in advance,
|
|
78668
78626
|
* so the invoice must be in advance of the billing date.
|
|
78669
|
-
* For more information, see [Service period anchor,
|
|
78627
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
78670
78628
|
*/
|
|
78671
78629
|
invoiceTimeShift?: reportsComponents["schemas"]["InvoiceTimeShift"];
|
|
78672
78630
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
@@ -79797,16 +79755,6 @@ export interface reportsComponents {
|
|
|
79797
79755
|
* this property enables the customer to subscribe to different plans.
|
|
79798
79756
|
*/
|
|
79799
79757
|
invoiceTimeShift?: reportsComponents["schemas"]["InvoiceTimeShift"];
|
|
79800
|
-
/**
|
|
79801
|
-
* Recurring interval to override plan settings.
|
|
79802
|
-
* To use plan settings, set this value to `null`.
|
|
79803
|
-
*
|
|
79804
|
-
* To use multiple plans in one subscription,
|
|
79805
|
-
* all plans must have the same recurring period length.
|
|
79806
|
-
*/
|
|
79807
|
-
recurringInterval?: {
|
|
79808
|
-
periodAnchorInstruction?: reportsComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
79809
|
-
} | null;
|
|
79810
79758
|
/**
|
|
79811
79759
|
* Specifies if payment attempts are made automatically.
|
|
79812
79760
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|
|
@@ -80799,15 +80747,15 @@ export interface reportsComponents {
|
|
|
80799
80747
|
* Amount of time between the pause end time and the renewal time in ISO-8601 durations format.
|
|
80800
80748
|
* By default, this value is computed as the time between the pause and the renewal.
|
|
80801
80749
|
*
|
|
80802
|
-
* Example: A $30 per month
|
|
80750
|
+
* Example: A $30 per month order on a 30-day month is paused on day 20.
|
|
80803
80751
|
* There are 10 unused days on the order.
|
|
80804
80752
|
* Therefore, the order renews in 10 days after it is resumed.
|
|
80805
80753
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
80806
|
-
* If the order uses a
|
|
80754
|
+
* If a subscription item in the order uses a service period anchor,
|
|
80807
80755
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
80808
|
-
* and the
|
|
80756
|
+
* and the service period anchor is ignored for that period.
|
|
80809
80757
|
*
|
|
80810
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
80758
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
80811
80759
|
*/
|
|
80812
80760
|
timeRemaining?: string | null;
|
|
80813
80761
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
@@ -81099,11 +81047,11 @@ export interface reportsComponents {
|
|
|
81099
81047
|
* There are 10 unused days on the subscription.
|
|
81100
81048
|
* Therefore, the subscription renews in 10 days after it is resumed.
|
|
81101
81049
|
* The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
|
|
81102
|
-
* If the subscription uses a
|
|
81050
|
+
* If the subscription uses a service period anchor,
|
|
81103
81051
|
* the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
|
|
81104
|
-
* and the
|
|
81052
|
+
* and the service period anchor is ignored for that period.
|
|
81105
81053
|
*
|
|
81106
|
-
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/
|
|
81054
|
+
* For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift).
|
|
81107
81055
|
*/
|
|
81108
81056
|
timeRemaining?: string | null;
|
|
81109
81057
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
@@ -92668,17 +92616,6 @@ export interface reportsComponents {
|
|
|
92668
92616
|
* this property enables the customer to subscribe to different plans.
|
|
92669
92617
|
*/
|
|
92670
92618
|
invoiceTimeShift?: reportsComponents["schemas"]["InvoiceTimeShift"];
|
|
92671
|
-
/**
|
|
92672
|
-
* Recurring interval to override plan settings.
|
|
92673
|
-
* To use plan settings, set this value to `null`.
|
|
92674
|
-
*
|
|
92675
|
-
* To use multiple plans in one subscription,
|
|
92676
|
-
* all plans must have the same same recurring period length,
|
|
92677
|
-
* this property enables the customer to subscribe to different plans.
|
|
92678
|
-
*/
|
|
92679
|
-
recurringInterval?: {
|
|
92680
|
-
periodAnchorInstruction?: reportsComponents["schemas"]["ServicePeriodAnchorInstruction"];
|
|
92681
|
-
} | null;
|
|
92682
92619
|
/**
|
|
92683
92620
|
* Specifies if payment attempts are made automatically.
|
|
92684
92621
|
* If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
|