@wix/subscription 1.0.31 → 1.0.32
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/subscription",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.32",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"type-bundles"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@wix/subscription_subscriptions": "1.0.
|
|
24
|
+
"@wix/subscription_subscriptions": "1.0.31"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
27
|
"glob": "^10.4.1",
|
|
@@ -46,5 +46,5 @@
|
|
|
46
46
|
"fqdn": ""
|
|
47
47
|
}
|
|
48
48
|
},
|
|
49
|
-
"falconPackageHash": "
|
|
49
|
+
"falconPackageHash": "178b4aa21f3c5fb868c9de0ebde3eafd18b1166bad951560d012eb8e"
|
|
50
50
|
}
|
|
@@ -2559,6 +2559,19 @@ interface Charge {
|
|
|
2559
2559
|
interface PreviewSubscriptionsChargesRequest {
|
|
2560
2560
|
/** Information required to calculate the preview charges for the subscriptions, including an identifier. */
|
|
2561
2561
|
subscriptionsBillingDetails?: SubscriptionBillingDetails[];
|
|
2562
|
+
/**
|
|
2563
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
2564
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
2565
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
2566
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
2567
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
2568
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
2569
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
2570
|
+
* in this case, charges for cycle 1 through 3.
|
|
2571
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
2572
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
2573
|
+
*/
|
|
2574
|
+
numberOfNextRecurringCharges?: number | null;
|
|
2562
2575
|
}
|
|
2563
2576
|
interface SubscriptionBillingDetails {
|
|
2564
2577
|
/** External identifier of the subscription */
|
|
@@ -4021,44 +4034,44 @@ interface SubscriptionUpdatedEnvelope {
|
|
|
4021
4034
|
entity: Subscription;
|
|
4022
4035
|
metadata: EventMetadata;
|
|
4023
4036
|
}
|
|
4024
|
-
interface
|
|
4025
|
-
data:
|
|
4037
|
+
interface SubscriptionAutoRenewalTurnedOffEnvelope {
|
|
4038
|
+
data: SubscriptionAutoRenewalTurnedOff;
|
|
4026
4039
|
metadata: EventMetadata;
|
|
4027
4040
|
}
|
|
4028
|
-
interface
|
|
4029
|
-
data:
|
|
4041
|
+
interface SubscriptionAutoRenewalTurnedOnEnvelope {
|
|
4042
|
+
data: SubscriptionAutoRenewalTurnedOn;
|
|
4030
4043
|
metadata: EventMetadata;
|
|
4031
4044
|
}
|
|
4032
|
-
interface
|
|
4033
|
-
data:
|
|
4045
|
+
interface SubscriptionBillingDateUpdatedEnvelope {
|
|
4046
|
+
data: SubscriptionBillingDateUpdated;
|
|
4047
|
+
metadata: EventMetadata;
|
|
4048
|
+
}
|
|
4049
|
+
interface SubscriptionLatestInvoiceMarkedAsPaidEnvelope {
|
|
4050
|
+
data: LatestInvoiceMarkedAsPaid;
|
|
4034
4051
|
metadata: EventMetadata;
|
|
4035
4052
|
}
|
|
4036
4053
|
interface SubscriptionPauseScheduleCanceledEnvelope {
|
|
4037
4054
|
data: ScheduledPauseCanceled;
|
|
4038
4055
|
metadata: EventMetadata;
|
|
4039
4056
|
}
|
|
4040
|
-
interface
|
|
4041
|
-
data:
|
|
4057
|
+
interface SubscriptionPauseScheduledEnvelope {
|
|
4058
|
+
data: PauseSubscriptionRequested;
|
|
4042
4059
|
metadata: EventMetadata;
|
|
4043
4060
|
}
|
|
4044
|
-
interface
|
|
4045
|
-
data:
|
|
4061
|
+
interface SubscriptionPausedEnvelope {
|
|
4062
|
+
data: SubscriptionPaused;
|
|
4046
4063
|
metadata: EventMetadata;
|
|
4047
4064
|
}
|
|
4048
4065
|
interface SubscriptionResumeScheduleCanceledEnvelope {
|
|
4049
4066
|
data: ScheduledResumeCanceled;
|
|
4050
4067
|
metadata: EventMetadata;
|
|
4051
4068
|
}
|
|
4052
|
-
interface
|
|
4053
|
-
data:
|
|
4054
|
-
metadata: EventMetadata;
|
|
4055
|
-
}
|
|
4056
|
-
interface SubscriptionAutoRenewalTurnedOffEnvelope {
|
|
4057
|
-
data: SubscriptionAutoRenewalTurnedOff;
|
|
4069
|
+
interface SubscriptionResumeScheduledEnvelope {
|
|
4070
|
+
data: ResumeSubscriptionRequested;
|
|
4058
4071
|
metadata: EventMetadata;
|
|
4059
4072
|
}
|
|
4060
|
-
interface
|
|
4061
|
-
data:
|
|
4073
|
+
interface SubscriptionResumedEnvelope {
|
|
4074
|
+
data: SubscriptionResumed;
|
|
4062
4075
|
metadata: EventMetadata;
|
|
4063
4076
|
}
|
|
4064
4077
|
interface ListSubscriptionHistoryOptions {
|
|
@@ -4159,6 +4172,19 @@ interface PreviewSubscriptionChargesOptions extends PreviewSubscriptionChargesRe
|
|
|
4159
4172
|
interface PreviewSubscriptionsChargesOptions {
|
|
4160
4173
|
/** Information required to calculate the preview charges for the subscriptions, including an identifier. */
|
|
4161
4174
|
subscriptionsBillingDetails?: SubscriptionBillingDetails[];
|
|
4175
|
+
/**
|
|
4176
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
4177
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
4178
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
4179
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
4180
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
4181
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
4182
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
4183
|
+
* in this case, charges for cycle 1 through 3.
|
|
4184
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
4185
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
4186
|
+
*/
|
|
4187
|
+
numberOfNextRecurringCharges?: number | null;
|
|
4162
4188
|
}
|
|
4163
4189
|
interface InitiatePaymentMethodSetupOptions {
|
|
4164
4190
|
paymentMode?: PaymentMode;
|
|
@@ -4425,16 +4451,16 @@ interface PayCycleSignature {
|
|
|
4425
4451
|
declare const onSubscriptionCanceled$1: EventDefinition<SubscriptionCanceledEnvelope, "wix.billing.v1.subscription_canceled">;
|
|
4426
4452
|
declare const onSubscriptionExtended$1: EventDefinition<SubscriptionExtendedEnvelope, "wix.billing.v1.subscription_extended">;
|
|
4427
4453
|
declare const onSubscriptionUpdated$1: EventDefinition<SubscriptionUpdatedEnvelope, "wix.billing.v1.subscription_updated">;
|
|
4454
|
+
declare const onSubscriptionAutoRenewalTurnedOff$1: EventDefinition<SubscriptionAutoRenewalTurnedOffEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_off">;
|
|
4455
|
+
declare const onSubscriptionAutoRenewalTurnedOn$1: EventDefinition<SubscriptionAutoRenewalTurnedOnEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_on">;
|
|
4428
4456
|
declare const onSubscriptionBillingDateUpdated$1: EventDefinition<SubscriptionBillingDateUpdatedEnvelope, "wix.billing.v1.subscription_billing_date_updated">;
|
|
4429
|
-
declare const
|
|
4430
|
-
declare const onSubscriptionPauseScheduled$1: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
|
|
4457
|
+
declare const onSubscriptionLatestInvoiceMarkedAsPaid$1: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
|
|
4431
4458
|
declare const onSubscriptionPauseScheduleCanceled$1: EventDefinition<SubscriptionPauseScheduleCanceledEnvelope, "wix.billing.v1.subscription_pause_schedule_canceled">;
|
|
4432
|
-
declare const
|
|
4433
|
-
declare const
|
|
4459
|
+
declare const onSubscriptionPauseScheduled$1: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
|
|
4460
|
+
declare const onSubscriptionPaused$1: EventDefinition<SubscriptionPausedEnvelope, "wix.billing.v1.subscription_paused">;
|
|
4434
4461
|
declare const onSubscriptionResumeScheduleCanceled$1: EventDefinition<SubscriptionResumeScheduleCanceledEnvelope, "wix.billing.v1.subscription_resume_schedule_canceled">;
|
|
4435
|
-
declare const
|
|
4436
|
-
declare const
|
|
4437
|
-
declare const onSubscriptionLatestInvoiceMarkedAsPaid$1: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
|
|
4462
|
+
declare const onSubscriptionResumeScheduled$1: EventDefinition<SubscriptionResumeScheduledEnvelope, "wix.billing.v1.subscription_resume_scheduled">;
|
|
4463
|
+
declare const onSubscriptionResumed$1: EventDefinition<SubscriptionResumedEnvelope, "wix.billing.v1.subscription_resumed">;
|
|
4438
4464
|
|
|
4439
4465
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
4440
4466
|
|
|
@@ -4488,23 +4514,27 @@ type _publicOnSubscriptionUpdatedType = typeof onSubscriptionUpdated$1;
|
|
|
4488
4514
|
*/
|
|
4489
4515
|
declare const onSubscriptionUpdated: ReturnType<typeof createEventModule<_publicOnSubscriptionUpdatedType>>;
|
|
4490
4516
|
|
|
4491
|
-
type
|
|
4517
|
+
type _publicOnSubscriptionAutoRenewalTurnedOffType = typeof onSubscriptionAutoRenewalTurnedOff$1;
|
|
4492
4518
|
/**
|
|
4493
|
-
* Triggered when subscription
|
|
4519
|
+
* Triggered when a subscription cycleAutoRenew was turned off.
|
|
4494
4520
|
*/
|
|
4495
|
-
declare const
|
|
4521
|
+
declare const onSubscriptionAutoRenewalTurnedOff: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOffType>>;
|
|
4496
4522
|
|
|
4497
|
-
type
|
|
4523
|
+
type _publicOnSubscriptionAutoRenewalTurnedOnType = typeof onSubscriptionAutoRenewalTurnedOn$1;
|
|
4498
4524
|
/**
|
|
4499
|
-
* Triggered when a subscription
|
|
4525
|
+
* Triggered when a subscription cycleAutoRenew was turned on.
|
|
4500
4526
|
*/
|
|
4501
|
-
declare const
|
|
4527
|
+
declare const onSubscriptionAutoRenewalTurnedOn: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOnType>>;
|
|
4502
4528
|
|
|
4503
|
-
type
|
|
4529
|
+
type _publicOnSubscriptionBillingDateUpdatedType = typeof onSubscriptionBillingDateUpdated$1;
|
|
4504
4530
|
/**
|
|
4505
|
-
* Triggered when
|
|
4531
|
+
* Triggered when subscription has been extended
|
|
4506
4532
|
*/
|
|
4507
|
-
declare const
|
|
4533
|
+
declare const onSubscriptionBillingDateUpdated: ReturnType<typeof createEventModule<_publicOnSubscriptionBillingDateUpdatedType>>;
|
|
4534
|
+
|
|
4535
|
+
type _publicOnSubscriptionLatestInvoiceMarkedAsPaidType = typeof onSubscriptionLatestInvoiceMarkedAsPaid$1;
|
|
4536
|
+
/** */
|
|
4537
|
+
declare const onSubscriptionLatestInvoiceMarkedAsPaid: ReturnType<typeof createEventModule<_publicOnSubscriptionLatestInvoiceMarkedAsPaidType>>;
|
|
4508
4538
|
|
|
4509
4539
|
type _publicOnSubscriptionPauseScheduleCanceledType = typeof onSubscriptionPauseScheduleCanceled$1;
|
|
4510
4540
|
/**
|
|
@@ -4512,17 +4542,17 @@ type _publicOnSubscriptionPauseScheduleCanceledType = typeof onSubscriptionPause
|
|
|
4512
4542
|
*/
|
|
4513
4543
|
declare const onSubscriptionPauseScheduleCanceled: ReturnType<typeof createEventModule<_publicOnSubscriptionPauseScheduleCanceledType>>;
|
|
4514
4544
|
|
|
4515
|
-
type
|
|
4545
|
+
type _publicOnSubscriptionPauseScheduledType = typeof onSubscriptionPauseScheduled$1;
|
|
4516
4546
|
/**
|
|
4517
|
-
* Triggered when
|
|
4547
|
+
* Triggered when pause subscription requested
|
|
4518
4548
|
*/
|
|
4519
|
-
declare const
|
|
4549
|
+
declare const onSubscriptionPauseScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionPauseScheduledType>>;
|
|
4520
4550
|
|
|
4521
|
-
type
|
|
4551
|
+
type _publicOnSubscriptionPausedType = typeof onSubscriptionPaused$1;
|
|
4522
4552
|
/**
|
|
4523
|
-
* Triggered when
|
|
4553
|
+
* Triggered when a subscription is paused.
|
|
4524
4554
|
*/
|
|
4525
|
-
declare const
|
|
4555
|
+
declare const onSubscriptionPaused: ReturnType<typeof createEventModule<_publicOnSubscriptionPausedType>>;
|
|
4526
4556
|
|
|
4527
4557
|
type _publicOnSubscriptionResumeScheduleCanceledType = typeof onSubscriptionResumeScheduleCanceled$1;
|
|
4528
4558
|
/**
|
|
@@ -4530,21 +4560,17 @@ type _publicOnSubscriptionResumeScheduleCanceledType = typeof onSubscriptionResu
|
|
|
4530
4560
|
*/
|
|
4531
4561
|
declare const onSubscriptionResumeScheduleCanceled: ReturnType<typeof createEventModule<_publicOnSubscriptionResumeScheduleCanceledType>>;
|
|
4532
4562
|
|
|
4533
|
-
type
|
|
4563
|
+
type _publicOnSubscriptionResumeScheduledType = typeof onSubscriptionResumeScheduled$1;
|
|
4534
4564
|
/**
|
|
4535
|
-
* Triggered when
|
|
4565
|
+
* Triggered when resume subscription requested
|
|
4536
4566
|
*/
|
|
4537
|
-
declare const
|
|
4567
|
+
declare const onSubscriptionResumeScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionResumeScheduledType>>;
|
|
4538
4568
|
|
|
4539
|
-
type
|
|
4569
|
+
type _publicOnSubscriptionResumedType = typeof onSubscriptionResumed$1;
|
|
4540
4570
|
/**
|
|
4541
|
-
* Triggered when a subscription
|
|
4571
|
+
* Triggered when a subscription is resumed.
|
|
4542
4572
|
*/
|
|
4543
|
-
declare const
|
|
4544
|
-
|
|
4545
|
-
type _publicOnSubscriptionLatestInvoiceMarkedAsPaidType = typeof onSubscriptionLatestInvoiceMarkedAsPaid$1;
|
|
4546
|
-
/** */
|
|
4547
|
-
declare const onSubscriptionLatestInvoiceMarkedAsPaid: ReturnType<typeof createEventModule<_publicOnSubscriptionLatestInvoiceMarkedAsPaidType>>;
|
|
4573
|
+
declare const onSubscriptionResumed: ReturnType<typeof createEventModule<_publicOnSubscriptionResumedType>>;
|
|
4548
4574
|
|
|
4549
4575
|
type context_Action = Action;
|
|
4550
4576
|
type context_ActionContext = ActionContext;
|
|
@@ -2559,6 +2559,19 @@ interface Charge {
|
|
|
2559
2559
|
interface PreviewSubscriptionsChargesRequest {
|
|
2560
2560
|
/** Information required to calculate the preview charges for the subscriptions, including an identifier. */
|
|
2561
2561
|
subscriptionsBillingDetails?: SubscriptionBillingDetails[];
|
|
2562
|
+
/**
|
|
2563
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
2564
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
2565
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
2566
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
2567
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
2568
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
2569
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
2570
|
+
* in this case, charges for cycle 1 through 3.
|
|
2571
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
2572
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
2573
|
+
*/
|
|
2574
|
+
numberOfNextRecurringCharges?: number | null;
|
|
2562
2575
|
}
|
|
2563
2576
|
interface SubscriptionBillingDetails {
|
|
2564
2577
|
/** External identifier of the subscription */
|
|
@@ -4021,44 +4034,44 @@ interface SubscriptionUpdatedEnvelope {
|
|
|
4021
4034
|
entity: Subscription;
|
|
4022
4035
|
metadata: EventMetadata;
|
|
4023
4036
|
}
|
|
4024
|
-
interface
|
|
4025
|
-
data:
|
|
4037
|
+
interface SubscriptionAutoRenewalTurnedOffEnvelope {
|
|
4038
|
+
data: SubscriptionAutoRenewalTurnedOff;
|
|
4026
4039
|
metadata: EventMetadata;
|
|
4027
4040
|
}
|
|
4028
|
-
interface
|
|
4029
|
-
data:
|
|
4041
|
+
interface SubscriptionAutoRenewalTurnedOnEnvelope {
|
|
4042
|
+
data: SubscriptionAutoRenewalTurnedOn;
|
|
4030
4043
|
metadata: EventMetadata;
|
|
4031
4044
|
}
|
|
4032
|
-
interface
|
|
4033
|
-
data:
|
|
4045
|
+
interface SubscriptionBillingDateUpdatedEnvelope {
|
|
4046
|
+
data: SubscriptionBillingDateUpdated;
|
|
4047
|
+
metadata: EventMetadata;
|
|
4048
|
+
}
|
|
4049
|
+
interface SubscriptionLatestInvoiceMarkedAsPaidEnvelope {
|
|
4050
|
+
data: LatestInvoiceMarkedAsPaid;
|
|
4034
4051
|
metadata: EventMetadata;
|
|
4035
4052
|
}
|
|
4036
4053
|
interface SubscriptionPauseScheduleCanceledEnvelope {
|
|
4037
4054
|
data: ScheduledPauseCanceled;
|
|
4038
4055
|
metadata: EventMetadata;
|
|
4039
4056
|
}
|
|
4040
|
-
interface
|
|
4041
|
-
data:
|
|
4057
|
+
interface SubscriptionPauseScheduledEnvelope {
|
|
4058
|
+
data: PauseSubscriptionRequested;
|
|
4042
4059
|
metadata: EventMetadata;
|
|
4043
4060
|
}
|
|
4044
|
-
interface
|
|
4045
|
-
data:
|
|
4061
|
+
interface SubscriptionPausedEnvelope {
|
|
4062
|
+
data: SubscriptionPaused;
|
|
4046
4063
|
metadata: EventMetadata;
|
|
4047
4064
|
}
|
|
4048
4065
|
interface SubscriptionResumeScheduleCanceledEnvelope {
|
|
4049
4066
|
data: ScheduledResumeCanceled;
|
|
4050
4067
|
metadata: EventMetadata;
|
|
4051
4068
|
}
|
|
4052
|
-
interface
|
|
4053
|
-
data:
|
|
4054
|
-
metadata: EventMetadata;
|
|
4055
|
-
}
|
|
4056
|
-
interface SubscriptionAutoRenewalTurnedOffEnvelope {
|
|
4057
|
-
data: SubscriptionAutoRenewalTurnedOff;
|
|
4069
|
+
interface SubscriptionResumeScheduledEnvelope {
|
|
4070
|
+
data: ResumeSubscriptionRequested;
|
|
4058
4071
|
metadata: EventMetadata;
|
|
4059
4072
|
}
|
|
4060
|
-
interface
|
|
4061
|
-
data:
|
|
4073
|
+
interface SubscriptionResumedEnvelope {
|
|
4074
|
+
data: SubscriptionResumed;
|
|
4062
4075
|
metadata: EventMetadata;
|
|
4063
4076
|
}
|
|
4064
4077
|
interface ListSubscriptionHistoryOptions {
|
|
@@ -4159,6 +4172,19 @@ interface PreviewSubscriptionChargesOptions extends PreviewSubscriptionChargesRe
|
|
|
4159
4172
|
interface PreviewSubscriptionsChargesOptions {
|
|
4160
4173
|
/** Information required to calculate the preview charges for the subscriptions, including an identifier. */
|
|
4161
4174
|
subscriptionsBillingDetails?: SubscriptionBillingDetails[];
|
|
4175
|
+
/**
|
|
4176
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
4177
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
4178
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
4179
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
4180
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
4181
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
4182
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
4183
|
+
* in this case, charges for cycle 1 through 3.
|
|
4184
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
4185
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
4186
|
+
*/
|
|
4187
|
+
numberOfNextRecurringCharges?: number | null;
|
|
4162
4188
|
}
|
|
4163
4189
|
interface InitiatePaymentMethodSetupOptions {
|
|
4164
4190
|
paymentMode?: PaymentMode;
|
|
@@ -4425,16 +4451,16 @@ interface PayCycleSignature {
|
|
|
4425
4451
|
declare const onSubscriptionCanceled$1: EventDefinition<SubscriptionCanceledEnvelope, "wix.billing.v1.subscription_canceled">;
|
|
4426
4452
|
declare const onSubscriptionExtended$1: EventDefinition<SubscriptionExtendedEnvelope, "wix.billing.v1.subscription_extended">;
|
|
4427
4453
|
declare const onSubscriptionUpdated$1: EventDefinition<SubscriptionUpdatedEnvelope, "wix.billing.v1.subscription_updated">;
|
|
4454
|
+
declare const onSubscriptionAutoRenewalTurnedOff$1: EventDefinition<SubscriptionAutoRenewalTurnedOffEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_off">;
|
|
4455
|
+
declare const onSubscriptionAutoRenewalTurnedOn$1: EventDefinition<SubscriptionAutoRenewalTurnedOnEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_on">;
|
|
4428
4456
|
declare const onSubscriptionBillingDateUpdated$1: EventDefinition<SubscriptionBillingDateUpdatedEnvelope, "wix.billing.v1.subscription_billing_date_updated">;
|
|
4429
|
-
declare const
|
|
4430
|
-
declare const onSubscriptionPauseScheduled$1: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
|
|
4457
|
+
declare const onSubscriptionLatestInvoiceMarkedAsPaid$1: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
|
|
4431
4458
|
declare const onSubscriptionPauseScheduleCanceled$1: EventDefinition<SubscriptionPauseScheduleCanceledEnvelope, "wix.billing.v1.subscription_pause_schedule_canceled">;
|
|
4432
|
-
declare const
|
|
4433
|
-
declare const
|
|
4459
|
+
declare const onSubscriptionPauseScheduled$1: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
|
|
4460
|
+
declare const onSubscriptionPaused$1: EventDefinition<SubscriptionPausedEnvelope, "wix.billing.v1.subscription_paused">;
|
|
4434
4461
|
declare const onSubscriptionResumeScheduleCanceled$1: EventDefinition<SubscriptionResumeScheduleCanceledEnvelope, "wix.billing.v1.subscription_resume_schedule_canceled">;
|
|
4435
|
-
declare const
|
|
4436
|
-
declare const
|
|
4437
|
-
declare const onSubscriptionLatestInvoiceMarkedAsPaid$1: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
|
|
4462
|
+
declare const onSubscriptionResumeScheduled$1: EventDefinition<SubscriptionResumeScheduledEnvelope, "wix.billing.v1.subscription_resume_scheduled">;
|
|
4463
|
+
declare const onSubscriptionResumed$1: EventDefinition<SubscriptionResumedEnvelope, "wix.billing.v1.subscription_resumed">;
|
|
4438
4464
|
|
|
4439
4465
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
4440
4466
|
|
|
@@ -4488,23 +4514,27 @@ type _publicOnSubscriptionUpdatedType = typeof onSubscriptionUpdated$1;
|
|
|
4488
4514
|
*/
|
|
4489
4515
|
declare const onSubscriptionUpdated: ReturnType<typeof createEventModule<_publicOnSubscriptionUpdatedType>>;
|
|
4490
4516
|
|
|
4491
|
-
type
|
|
4517
|
+
type _publicOnSubscriptionAutoRenewalTurnedOffType = typeof onSubscriptionAutoRenewalTurnedOff$1;
|
|
4492
4518
|
/**
|
|
4493
|
-
* Triggered when subscription
|
|
4519
|
+
* Triggered when a subscription cycleAutoRenew was turned off.
|
|
4494
4520
|
*/
|
|
4495
|
-
declare const
|
|
4521
|
+
declare const onSubscriptionAutoRenewalTurnedOff: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOffType>>;
|
|
4496
4522
|
|
|
4497
|
-
type
|
|
4523
|
+
type _publicOnSubscriptionAutoRenewalTurnedOnType = typeof onSubscriptionAutoRenewalTurnedOn$1;
|
|
4498
4524
|
/**
|
|
4499
|
-
* Triggered when a subscription
|
|
4525
|
+
* Triggered when a subscription cycleAutoRenew was turned on.
|
|
4500
4526
|
*/
|
|
4501
|
-
declare const
|
|
4527
|
+
declare const onSubscriptionAutoRenewalTurnedOn: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOnType>>;
|
|
4502
4528
|
|
|
4503
|
-
type
|
|
4529
|
+
type _publicOnSubscriptionBillingDateUpdatedType = typeof onSubscriptionBillingDateUpdated$1;
|
|
4504
4530
|
/**
|
|
4505
|
-
* Triggered when
|
|
4531
|
+
* Triggered when subscription has been extended
|
|
4506
4532
|
*/
|
|
4507
|
-
declare const
|
|
4533
|
+
declare const onSubscriptionBillingDateUpdated: ReturnType<typeof createEventModule<_publicOnSubscriptionBillingDateUpdatedType>>;
|
|
4534
|
+
|
|
4535
|
+
type _publicOnSubscriptionLatestInvoiceMarkedAsPaidType = typeof onSubscriptionLatestInvoiceMarkedAsPaid$1;
|
|
4536
|
+
/** */
|
|
4537
|
+
declare const onSubscriptionLatestInvoiceMarkedAsPaid: ReturnType<typeof createEventModule<_publicOnSubscriptionLatestInvoiceMarkedAsPaidType>>;
|
|
4508
4538
|
|
|
4509
4539
|
type _publicOnSubscriptionPauseScheduleCanceledType = typeof onSubscriptionPauseScheduleCanceled$1;
|
|
4510
4540
|
/**
|
|
@@ -4512,17 +4542,17 @@ type _publicOnSubscriptionPauseScheduleCanceledType = typeof onSubscriptionPause
|
|
|
4512
4542
|
*/
|
|
4513
4543
|
declare const onSubscriptionPauseScheduleCanceled: ReturnType<typeof createEventModule<_publicOnSubscriptionPauseScheduleCanceledType>>;
|
|
4514
4544
|
|
|
4515
|
-
type
|
|
4545
|
+
type _publicOnSubscriptionPauseScheduledType = typeof onSubscriptionPauseScheduled$1;
|
|
4516
4546
|
/**
|
|
4517
|
-
* Triggered when
|
|
4547
|
+
* Triggered when pause subscription requested
|
|
4518
4548
|
*/
|
|
4519
|
-
declare const
|
|
4549
|
+
declare const onSubscriptionPauseScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionPauseScheduledType>>;
|
|
4520
4550
|
|
|
4521
|
-
type
|
|
4551
|
+
type _publicOnSubscriptionPausedType = typeof onSubscriptionPaused$1;
|
|
4522
4552
|
/**
|
|
4523
|
-
* Triggered when
|
|
4553
|
+
* Triggered when a subscription is paused.
|
|
4524
4554
|
*/
|
|
4525
|
-
declare const
|
|
4555
|
+
declare const onSubscriptionPaused: ReturnType<typeof createEventModule<_publicOnSubscriptionPausedType>>;
|
|
4526
4556
|
|
|
4527
4557
|
type _publicOnSubscriptionResumeScheduleCanceledType = typeof onSubscriptionResumeScheduleCanceled$1;
|
|
4528
4558
|
/**
|
|
@@ -4530,21 +4560,17 @@ type _publicOnSubscriptionResumeScheduleCanceledType = typeof onSubscriptionResu
|
|
|
4530
4560
|
*/
|
|
4531
4561
|
declare const onSubscriptionResumeScheduleCanceled: ReturnType<typeof createEventModule<_publicOnSubscriptionResumeScheduleCanceledType>>;
|
|
4532
4562
|
|
|
4533
|
-
type
|
|
4563
|
+
type _publicOnSubscriptionResumeScheduledType = typeof onSubscriptionResumeScheduled$1;
|
|
4534
4564
|
/**
|
|
4535
|
-
* Triggered when
|
|
4565
|
+
* Triggered when resume subscription requested
|
|
4536
4566
|
*/
|
|
4537
|
-
declare const
|
|
4567
|
+
declare const onSubscriptionResumeScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionResumeScheduledType>>;
|
|
4538
4568
|
|
|
4539
|
-
type
|
|
4569
|
+
type _publicOnSubscriptionResumedType = typeof onSubscriptionResumed$1;
|
|
4540
4570
|
/**
|
|
4541
|
-
* Triggered when a subscription
|
|
4571
|
+
* Triggered when a subscription is resumed.
|
|
4542
4572
|
*/
|
|
4543
|
-
declare const
|
|
4544
|
-
|
|
4545
|
-
type _publicOnSubscriptionLatestInvoiceMarkedAsPaidType = typeof onSubscriptionLatestInvoiceMarkedAsPaid$1;
|
|
4546
|
-
/** */
|
|
4547
|
-
declare const onSubscriptionLatestInvoiceMarkedAsPaid: ReturnType<typeof createEventModule<_publicOnSubscriptionLatestInvoiceMarkedAsPaidType>>;
|
|
4573
|
+
declare const onSubscriptionResumed: ReturnType<typeof createEventModule<_publicOnSubscriptionResumedType>>;
|
|
4548
4574
|
|
|
4549
4575
|
type index_d_Action = Action;
|
|
4550
4576
|
type index_d_ActionContext = ActionContext;
|
|
@@ -1793,6 +1793,19 @@ interface Charge$1 {
|
|
|
1793
1793
|
interface PreviewSubscriptionsChargesRequest$1 {
|
|
1794
1794
|
/** Information required to calculate the preview charges for the subscriptions, including an identifier. */
|
|
1795
1795
|
subscriptionsBillingDetails?: SubscriptionBillingDetails$1[];
|
|
1796
|
+
/**
|
|
1797
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
1798
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
1799
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
1800
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
1801
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
1802
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
1803
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
1804
|
+
* in this case, charges for cycle 1 through 3.
|
|
1805
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
1806
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
1807
|
+
*/
|
|
1808
|
+
numberOfNextRecurringCharges?: number | null;
|
|
1796
1809
|
}
|
|
1797
1810
|
interface SubscriptionBillingDetails$1 {
|
|
1798
1811
|
/** External identifier of the subscription */
|
|
@@ -4123,6 +4136,19 @@ interface Charge {
|
|
|
4123
4136
|
interface PreviewSubscriptionsChargesRequest {
|
|
4124
4137
|
/** Information required to calculate the preview charges for the subscriptions, including an identifier. */
|
|
4125
4138
|
subscriptionsBillingDetails?: SubscriptionBillingDetails[];
|
|
4139
|
+
/**
|
|
4140
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
4141
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
4142
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
4143
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
4144
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
4145
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
4146
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
4147
|
+
* in this case, charges for cycle 1 through 3.
|
|
4148
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
4149
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
4150
|
+
*/
|
|
4151
|
+
numberOfNextRecurringCharges?: number | null;
|
|
4126
4152
|
}
|
|
4127
4153
|
interface SubscriptionBillingDetails {
|
|
4128
4154
|
/** External identifier of the subscription */
|