@wix/subscription 1.0.15 → 1.0.17
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.
|
@@ -786,6 +786,20 @@ interface SpecificDateSubscriptionUpdateData$1 {
|
|
|
786
786
|
updateData?: SubscriptionUpdateData$1;
|
|
787
787
|
executionDate?: Date;
|
|
788
788
|
}
|
|
789
|
+
interface ListSubscriptionHistoryRequest$1 {
|
|
790
|
+
subscriptionId: string;
|
|
791
|
+
/** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
|
|
792
|
+
mode?: HistoryViewMode$1;
|
|
793
|
+
/** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
|
|
794
|
+
cursor?: CursorPaging$1;
|
|
795
|
+
}
|
|
796
|
+
declare enum HistoryViewMode$1 {
|
|
797
|
+
UNKNOWN = "UNKNOWN",
|
|
798
|
+
/** Comprehensive view including all history events. */
|
|
799
|
+
BACKOFFICE = "BACKOFFICE",
|
|
800
|
+
/** User-centric view of the history. */
|
|
801
|
+
USER = "USER"
|
|
802
|
+
}
|
|
789
803
|
interface CursorPaging$1 {
|
|
790
804
|
/** Maximum number of items to return in the results. */
|
|
791
805
|
limit?: number | null;
|
|
@@ -797,6 +811,255 @@ interface CursorPaging$1 {
|
|
|
797
811
|
*/
|
|
798
812
|
cursor?: string | null;
|
|
799
813
|
}
|
|
814
|
+
interface ListSubscriptionHistoryResponse$1 {
|
|
815
|
+
/** List of history entries for the subscription. */
|
|
816
|
+
historyEntries?: SubscriptionHistoryEntry$1[];
|
|
817
|
+
/** Paging metadata. A `next` cursor is returned if there are more results. */
|
|
818
|
+
pagingMetadata?: PagingMetadataV2$1;
|
|
819
|
+
}
|
|
820
|
+
interface SubscriptionHistoryEntry$1 {
|
|
821
|
+
entryId?: string;
|
|
822
|
+
/** TODO: add max length? it is not defined in domainevents, so should we? */
|
|
823
|
+
slug?: string;
|
|
824
|
+
entryTime?: Date;
|
|
825
|
+
event?: SubscriptionEvent$1;
|
|
826
|
+
}
|
|
827
|
+
interface SubscriptionEvent$1 extends SubscriptionEventPayloadOneOf$1 {
|
|
828
|
+
created?: SubscriptionCreated$1;
|
|
829
|
+
updated?: SubscriptionUpdated$1;
|
|
830
|
+
deleted?: SubscriptionDeleted$1;
|
|
831
|
+
activated?: SubscriptionActivated$1;
|
|
832
|
+
ended?: SubscriptionEnded$1;
|
|
833
|
+
canceled?: SubscriptionCanceled$1;
|
|
834
|
+
paused?: SubscriptionPaused$1;
|
|
835
|
+
resumed?: SubscriptionResumed$1;
|
|
836
|
+
pauseRequested?: PauseSubscriptionRequested$1;
|
|
837
|
+
resumeRequested?: ResumeSubscriptionRequested$1;
|
|
838
|
+
scheduledPauseCanceled?: ScheduledPauseCanceled$1;
|
|
839
|
+
scheduledResumeCanceled?: ScheduledResumeCanceled$1;
|
|
840
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted$1;
|
|
841
|
+
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn$1;
|
|
842
|
+
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff$1;
|
|
843
|
+
cycleReadyToPay?: SubscriptionCycleReadyToPay$1;
|
|
844
|
+
extended?: SubscriptionExtended$1;
|
|
845
|
+
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted$1;
|
|
846
|
+
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid$1;
|
|
847
|
+
revived?: SubscriptionRevived$1;
|
|
848
|
+
billingDateUpdated?: SubscriptionBillingDateUpdated$1;
|
|
849
|
+
futureUpdatesRequested?: FutureUpdatesRequested$1;
|
|
850
|
+
updatesApplied?: UpdatesApplied$1;
|
|
851
|
+
resetPendingUpdates?: ResetPendingUpdates$1;
|
|
852
|
+
gracePeriodStarted?: GracePeriodStarted$1;
|
|
853
|
+
gracePeriodEnded?: GracePeriodEnded$1;
|
|
854
|
+
paymentMethodUpdated?: PaymentMethodUpdated$1;
|
|
855
|
+
collectionMethodUpdated?: SubscriptionCollectionMethodUpdated$1;
|
|
856
|
+
freeTrailStarted?: FreeTrailStarted$1;
|
|
857
|
+
freeTrailEnded?: FreeTrailEnded$1;
|
|
858
|
+
subscriptionBoAction?: SubscriptionBackOfficeAction$1;
|
|
859
|
+
unknown?: UnknownSubscriptionEvent$1;
|
|
860
|
+
}
|
|
861
|
+
/** @oneof */
|
|
862
|
+
interface SubscriptionEventPayloadOneOf$1 {
|
|
863
|
+
created?: SubscriptionCreated$1;
|
|
864
|
+
updated?: SubscriptionUpdated$1;
|
|
865
|
+
deleted?: SubscriptionDeleted$1;
|
|
866
|
+
activated?: SubscriptionActivated$1;
|
|
867
|
+
ended?: SubscriptionEnded$1;
|
|
868
|
+
canceled?: SubscriptionCanceled$1;
|
|
869
|
+
paused?: SubscriptionPaused$1;
|
|
870
|
+
resumed?: SubscriptionResumed$1;
|
|
871
|
+
pauseRequested?: PauseSubscriptionRequested$1;
|
|
872
|
+
resumeRequested?: ResumeSubscriptionRequested$1;
|
|
873
|
+
scheduledPauseCanceled?: ScheduledPauseCanceled$1;
|
|
874
|
+
scheduledResumeCanceled?: ScheduledResumeCanceled$1;
|
|
875
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted$1;
|
|
876
|
+
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn$1;
|
|
877
|
+
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff$1;
|
|
878
|
+
cycleReadyToPay?: SubscriptionCycleReadyToPay$1;
|
|
879
|
+
extended?: SubscriptionExtended$1;
|
|
880
|
+
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted$1;
|
|
881
|
+
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid$1;
|
|
882
|
+
revived?: SubscriptionRevived$1;
|
|
883
|
+
billingDateUpdated?: SubscriptionBillingDateUpdated$1;
|
|
884
|
+
futureUpdatesRequested?: FutureUpdatesRequested$1;
|
|
885
|
+
updatesApplied?: UpdatesApplied$1;
|
|
886
|
+
resetPendingUpdates?: ResetPendingUpdates$1;
|
|
887
|
+
gracePeriodStarted?: GracePeriodStarted$1;
|
|
888
|
+
gracePeriodEnded?: GracePeriodEnded$1;
|
|
889
|
+
paymentMethodUpdated?: PaymentMethodUpdated$1;
|
|
890
|
+
collectionMethodUpdated?: SubscriptionCollectionMethodUpdated$1;
|
|
891
|
+
freeTrailStarted?: FreeTrailStarted$1;
|
|
892
|
+
freeTrailEnded?: FreeTrailEnded$1;
|
|
893
|
+
subscriptionBoAction?: SubscriptionBackOfficeAction$1;
|
|
894
|
+
unknown?: UnknownSubscriptionEvent$1;
|
|
895
|
+
}
|
|
896
|
+
interface SubscriptionCreated$1 {
|
|
897
|
+
subscription?: Subscription$1;
|
|
898
|
+
}
|
|
899
|
+
interface SubscriptionUpdated$1 {
|
|
900
|
+
current?: Subscription$1;
|
|
901
|
+
previous?: Subscription$1;
|
|
902
|
+
diff?: SubscriptionDiff$1;
|
|
903
|
+
}
|
|
904
|
+
interface SubscriptionDiff$1 {
|
|
905
|
+
added?: string | null;
|
|
906
|
+
changed?: string | null;
|
|
907
|
+
deleted?: string | null;
|
|
908
|
+
}
|
|
909
|
+
interface SubscriptionDeleted$1 {
|
|
910
|
+
subscriptionId?: string;
|
|
911
|
+
}
|
|
912
|
+
/**
|
|
913
|
+
* Sent each time a subscription status has been set to Active
|
|
914
|
+
* Active shows that a subscription is live and operational.
|
|
915
|
+
* For example:
|
|
916
|
+
* * For subscription with free trial, free trial start date is also the activation date.
|
|
917
|
+
* * For a subscription with future start date, the start date is also the activation date.
|
|
918
|
+
* * When a subscription is resumed from a pause status, the resume date is also the activation date.
|
|
919
|
+
*/
|
|
920
|
+
interface SubscriptionActivated$1 {
|
|
921
|
+
subscription?: Subscription$1;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* Sent each time a subscription status has been set to Ended
|
|
925
|
+
* Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
|
|
926
|
+
* This is different from a Canceled subscription which ends the subscription before a designated end date.
|
|
927
|
+
* Therefore, Ended and Canceled are mutually exclusive.
|
|
928
|
+
*/
|
|
929
|
+
interface SubscriptionEnded$1 {
|
|
930
|
+
subscription?: Subscription$1;
|
|
931
|
+
}
|
|
932
|
+
/**
|
|
933
|
+
* Sent each time a subscription status has been set to Canceled
|
|
934
|
+
* Canceled shows that a subscription was canceled and ended its life cycle as a result of some intervention
|
|
935
|
+
* For example:
|
|
936
|
+
* * A user decided to cancel a subscription before the original end date
|
|
937
|
+
* * A subscription is canceled due to bad payment
|
|
938
|
+
*/
|
|
939
|
+
interface SubscriptionCanceled$1 {
|
|
940
|
+
subscription?: Subscription$1;
|
|
941
|
+
actionDetails?: ActionDetails$1;
|
|
942
|
+
}
|
|
943
|
+
interface ActionDetails$1 {
|
|
944
|
+
initiator?: HistoryActionInitiator$1;
|
|
945
|
+
reason?: string | null;
|
|
946
|
+
}
|
|
947
|
+
interface SubscriptionPaused$1 {
|
|
948
|
+
subscription?: Subscription$1;
|
|
949
|
+
pausePolicy?: PausePolicy$1;
|
|
950
|
+
actionDetails?: ActionDetails$1;
|
|
951
|
+
}
|
|
952
|
+
interface SubscriptionResumed$1 {
|
|
953
|
+
subscription?: Subscription$1;
|
|
954
|
+
actionDetails?: ActionDetails$1;
|
|
955
|
+
}
|
|
956
|
+
interface PauseSubscriptionRequested$1 {
|
|
957
|
+
subscription?: Subscription$1;
|
|
958
|
+
pauseAt?: PauseAt$1;
|
|
959
|
+
pausePolicy?: PausePolicy$1;
|
|
960
|
+
actionDetails?: ActionDetails$1;
|
|
961
|
+
}
|
|
962
|
+
interface ResumeSubscriptionRequested$1 {
|
|
963
|
+
subscription?: Subscription$1;
|
|
964
|
+
resumeAt?: ResumeAt$1;
|
|
965
|
+
actionDetails?: ActionDetails$1;
|
|
966
|
+
}
|
|
967
|
+
interface ScheduledPauseCanceled$1 {
|
|
968
|
+
subscription?: Subscription$1;
|
|
969
|
+
actionDetails?: ActionDetails$1;
|
|
970
|
+
}
|
|
971
|
+
interface ScheduledResumeCanceled$1 {
|
|
972
|
+
subscription?: Subscription$1;
|
|
973
|
+
actionDetails?: ActionDetails$1;
|
|
974
|
+
}
|
|
975
|
+
interface SubscriptionBillingCycleStarted$1 {
|
|
976
|
+
subscription?: Subscription$1;
|
|
977
|
+
/** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
|
|
978
|
+
paymentTransactionId?: string | null;
|
|
979
|
+
}
|
|
980
|
+
interface SubscriptionAutoRenewalTurnedOn$1 {
|
|
981
|
+
subscription?: Subscription$1;
|
|
982
|
+
actionDetails?: ActionDetails$1;
|
|
983
|
+
}
|
|
984
|
+
interface SubscriptionAutoRenewalTurnedOff$1 {
|
|
985
|
+
subscription?: Subscription$1;
|
|
986
|
+
actionDetails?: ActionDetails$1;
|
|
987
|
+
}
|
|
988
|
+
interface SubscriptionCycleReadyToPay$1 {
|
|
989
|
+
subscription?: Subscription$1;
|
|
990
|
+
}
|
|
991
|
+
interface SubscriptionExtended$1 extends SubscriptionExtendedExtendPolicyOneOf$1 {
|
|
992
|
+
extensionPeriod?: Duration$1;
|
|
993
|
+
extensionBillingCycles?: number;
|
|
994
|
+
subscription?: Subscription$1;
|
|
995
|
+
actionDetails?: ActionDetails$1;
|
|
996
|
+
}
|
|
997
|
+
/** @oneof */
|
|
998
|
+
interface SubscriptionExtendedExtendPolicyOneOf$1 {
|
|
999
|
+
extensionPeriod?: Duration$1;
|
|
1000
|
+
extensionBillingCycles?: number;
|
|
1001
|
+
}
|
|
1002
|
+
interface SubscriptionInitialPurchaseCompleted$1 {
|
|
1003
|
+
subscription?: Subscription$1;
|
|
1004
|
+
actionDetails?: ActionDetails$1;
|
|
1005
|
+
paymentTransactionId?: string | null;
|
|
1006
|
+
}
|
|
1007
|
+
interface LatestInvoiceMarkedAsPaid$1 {
|
|
1008
|
+
subscription?: Subscription$1;
|
|
1009
|
+
}
|
|
1010
|
+
interface SubscriptionRevived$1 {
|
|
1011
|
+
subscription?: Subscription$1;
|
|
1012
|
+
}
|
|
1013
|
+
interface SubscriptionBillingDateUpdated$1 {
|
|
1014
|
+
subscription?: Subscription$1;
|
|
1015
|
+
billingDate?: Date;
|
|
1016
|
+
proration?: Proration$1;
|
|
1017
|
+
}
|
|
1018
|
+
interface FutureUpdatesRequested$1 {
|
|
1019
|
+
subscription?: Subscription$1;
|
|
1020
|
+
requestedUpdateData?: SubscriptionUpdateData$1;
|
|
1021
|
+
}
|
|
1022
|
+
interface UpdatesApplied$1 {
|
|
1023
|
+
subscription?: Subscription$1;
|
|
1024
|
+
updateAction?: UpdateAction$1;
|
|
1025
|
+
appliedUpdateData?: SubscriptionUpdateData$1;
|
|
1026
|
+
}
|
|
1027
|
+
declare enum UpdateAction$1 {
|
|
1028
|
+
NONE = "NONE",
|
|
1029
|
+
/** Update subscription immediately, please note proration for updates changing price are not yet supported */
|
|
1030
|
+
IMMEDIATELY = "IMMEDIATELY",
|
|
1031
|
+
/** Request updates that will take affect only at the start of the next billing cycle. */
|
|
1032
|
+
NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
|
|
1033
|
+
/** Reset all pending updates */
|
|
1034
|
+
RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
|
|
1035
|
+
/** Request updates that will take affect only at a specific date. */
|
|
1036
|
+
SPECIFIC_DATE = "SPECIFIC_DATE"
|
|
1037
|
+
}
|
|
1038
|
+
interface ResetPendingUpdates$1 {
|
|
1039
|
+
subscription?: Subscription$1;
|
|
1040
|
+
}
|
|
1041
|
+
interface GracePeriodStarted$1 {
|
|
1042
|
+
subscription?: Subscription$1;
|
|
1043
|
+
}
|
|
1044
|
+
interface GracePeriodEnded$1 {
|
|
1045
|
+
subscription?: Subscription$1;
|
|
1046
|
+
/** Indication for the payment settlement method. */
|
|
1047
|
+
paymentSettlementMethod?: PaymentSettlementMethod$1;
|
|
1048
|
+
}
|
|
1049
|
+
declare enum PaymentSettlementMethod$1 {
|
|
1050
|
+
UNKNOWN = "UNKNOWN",
|
|
1051
|
+
/** System-defined payment settlement. */
|
|
1052
|
+
SYSTEM = "SYSTEM",
|
|
1053
|
+
/** Manually mark the payment as paid. */
|
|
1054
|
+
MARK_AS_PAID = "MARK_AS_PAID",
|
|
1055
|
+
/** Require the customer to pay immediately, by insert a new payment method. */
|
|
1056
|
+
CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
|
|
1057
|
+
}
|
|
1058
|
+
interface PaymentMethodUpdated$1 {
|
|
1059
|
+
subscription?: Subscription$1;
|
|
1060
|
+
initiator?: HistoryActionInitiator$1;
|
|
1061
|
+
paymentMode?: PaymentMode$1;
|
|
1062
|
+
}
|
|
800
1063
|
declare enum PaymentMode$1 {
|
|
801
1064
|
NONE = "NONE",
|
|
802
1065
|
/** The latest invoice of the subscription will be charged. */
|
|
@@ -804,6 +1067,28 @@ declare enum PaymentMode$1 {
|
|
|
804
1067
|
/** An authorization invoice with zero amount will be created. */
|
|
805
1068
|
AUTHORIZATION = "AUTHORIZATION"
|
|
806
1069
|
}
|
|
1070
|
+
interface SubscriptionCollectionMethodUpdated$1 {
|
|
1071
|
+
subscription?: Subscription$1;
|
|
1072
|
+
newCollectionMethod?: CollectionMethodEnumCollectionMethod$1;
|
|
1073
|
+
previousCollectionMethod?: CollectionMethodEnumCollectionMethod$1;
|
|
1074
|
+
}
|
|
1075
|
+
interface FreeTrailStarted$1 {
|
|
1076
|
+
subscription?: Subscription$1;
|
|
1077
|
+
}
|
|
1078
|
+
interface FreeTrailEnded$1 {
|
|
1079
|
+
subscription?: Subscription$1;
|
|
1080
|
+
}
|
|
1081
|
+
interface SubscriptionBackOfficeAction$1 {
|
|
1082
|
+
subscription?: Subscription$1;
|
|
1083
|
+
/** The backoffice method name */
|
|
1084
|
+
name?: string;
|
|
1085
|
+
/** json as string format, to store the flatted request object */
|
|
1086
|
+
params?: string;
|
|
1087
|
+
}
|
|
1088
|
+
/** Defines unknown events restored from the logs */
|
|
1089
|
+
interface UnknownSubscriptionEvent$1 {
|
|
1090
|
+
subscriptionAsString?: string | null;
|
|
1091
|
+
}
|
|
807
1092
|
interface PagingMetadataV2$1 {
|
|
808
1093
|
/** Number of items returned in the response. */
|
|
809
1094
|
count?: number | null;
|
|
@@ -1058,7 +1343,7 @@ interface InvoiceItem$1 extends InvoiceItemPaymentTypeOneOf$1 {
|
|
|
1058
1343
|
* ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
|
|
1059
1344
|
* that belongs to the invoice line item.
|
|
1060
1345
|
*/
|
|
1061
|
-
subscriptionId?: string;
|
|
1346
|
+
subscriptionId?: string | null;
|
|
1062
1347
|
/**
|
|
1063
1348
|
* Name of the invoice line item.
|
|
1064
1349
|
* Typically the product name.
|
|
@@ -1689,6 +1974,172 @@ interface SubscriptionNonNullableFields$1 {
|
|
|
1689
1974
|
specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields$1;
|
|
1690
1975
|
items: ItemNonNullableFields$1[];
|
|
1691
1976
|
}
|
|
1977
|
+
interface SubscriptionCreatedNonNullableFields$1 {
|
|
1978
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
1979
|
+
}
|
|
1980
|
+
interface SubscriptionUpdatedNonNullableFields$1 {
|
|
1981
|
+
current?: SubscriptionNonNullableFields$1;
|
|
1982
|
+
previous?: SubscriptionNonNullableFields$1;
|
|
1983
|
+
}
|
|
1984
|
+
interface SubscriptionDeletedNonNullableFields$1 {
|
|
1985
|
+
subscriptionId: string;
|
|
1986
|
+
}
|
|
1987
|
+
interface SubscriptionActivatedNonNullableFields$1 {
|
|
1988
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
1989
|
+
}
|
|
1990
|
+
interface SubscriptionEndedNonNullableFields$1 {
|
|
1991
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
1992
|
+
}
|
|
1993
|
+
interface ActionDetailsNonNullableFields$1 {
|
|
1994
|
+
initiator: HistoryActionInitiator$1;
|
|
1995
|
+
}
|
|
1996
|
+
interface SubscriptionCanceledNonNullableFields$1 {
|
|
1997
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
1998
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
1999
|
+
}
|
|
2000
|
+
interface SubscriptionPausedNonNullableFields$1 {
|
|
2001
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2002
|
+
pausePolicy: PausePolicy$1;
|
|
2003
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2004
|
+
}
|
|
2005
|
+
interface SubscriptionResumedNonNullableFields$1 {
|
|
2006
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2007
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2008
|
+
}
|
|
2009
|
+
interface PauseSubscriptionRequestedNonNullableFields$1 {
|
|
2010
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2011
|
+
pauseAt: PauseAt$1;
|
|
2012
|
+
pausePolicy: PausePolicy$1;
|
|
2013
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2014
|
+
}
|
|
2015
|
+
interface ResumeSubscriptionRequestedNonNullableFields$1 {
|
|
2016
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2017
|
+
resumeAt: ResumeAt$1;
|
|
2018
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2019
|
+
}
|
|
2020
|
+
interface ScheduledPauseCanceledNonNullableFields$1 {
|
|
2021
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2022
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2023
|
+
}
|
|
2024
|
+
interface ScheduledResumeCanceledNonNullableFields$1 {
|
|
2025
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2026
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2027
|
+
}
|
|
2028
|
+
interface SubscriptionBillingCycleStartedNonNullableFields$1 {
|
|
2029
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2030
|
+
}
|
|
2031
|
+
interface SubscriptionAutoRenewalTurnedOnNonNullableFields$1 {
|
|
2032
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2033
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2034
|
+
}
|
|
2035
|
+
interface SubscriptionAutoRenewalTurnedOffNonNullableFields$1 {
|
|
2036
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2037
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2038
|
+
}
|
|
2039
|
+
interface SubscriptionCycleReadyToPayNonNullableFields$1 {
|
|
2040
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2041
|
+
}
|
|
2042
|
+
interface SubscriptionExtendedNonNullableFields$1 {
|
|
2043
|
+
extensionPeriod?: DurationNonNullableFields$1;
|
|
2044
|
+
extensionBillingCycles: number;
|
|
2045
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2046
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2047
|
+
}
|
|
2048
|
+
interface SubscriptionInitialPurchaseCompletedNonNullableFields$1 {
|
|
2049
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2050
|
+
actionDetails?: ActionDetailsNonNullableFields$1;
|
|
2051
|
+
}
|
|
2052
|
+
interface LatestInvoiceMarkedAsPaidNonNullableFields$1 {
|
|
2053
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2054
|
+
}
|
|
2055
|
+
interface SubscriptionRevivedNonNullableFields$1 {
|
|
2056
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2057
|
+
}
|
|
2058
|
+
interface SubscriptionBillingDateUpdatedNonNullableFields$1 {
|
|
2059
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2060
|
+
proration?: ProrationNonNullableFields$1;
|
|
2061
|
+
}
|
|
2062
|
+
interface FutureUpdatesRequestedNonNullableFields$1 {
|
|
2063
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2064
|
+
requestedUpdateData?: SubscriptionUpdateDataNonNullableFields$1;
|
|
2065
|
+
}
|
|
2066
|
+
interface UpdatesAppliedNonNullableFields$1 {
|
|
2067
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2068
|
+
updateAction: UpdateAction$1;
|
|
2069
|
+
appliedUpdateData?: SubscriptionUpdateDataNonNullableFields$1;
|
|
2070
|
+
}
|
|
2071
|
+
interface ResetPendingUpdatesNonNullableFields$1 {
|
|
2072
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2073
|
+
}
|
|
2074
|
+
interface GracePeriodStartedNonNullableFields$1 {
|
|
2075
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2076
|
+
}
|
|
2077
|
+
interface GracePeriodEndedNonNullableFields$1 {
|
|
2078
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2079
|
+
paymentSettlementMethod: PaymentSettlementMethod$1;
|
|
2080
|
+
}
|
|
2081
|
+
interface PaymentMethodUpdatedNonNullableFields$1 {
|
|
2082
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2083
|
+
initiator: HistoryActionInitiator$1;
|
|
2084
|
+
paymentMode: PaymentMode$1;
|
|
2085
|
+
}
|
|
2086
|
+
interface SubscriptionCollectionMethodUpdatedNonNullableFields$1 {
|
|
2087
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2088
|
+
newCollectionMethod: CollectionMethodEnumCollectionMethod$1;
|
|
2089
|
+
previousCollectionMethod: CollectionMethodEnumCollectionMethod$1;
|
|
2090
|
+
}
|
|
2091
|
+
interface FreeTrailStartedNonNullableFields$1 {
|
|
2092
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2093
|
+
}
|
|
2094
|
+
interface FreeTrailEndedNonNullableFields$1 {
|
|
2095
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2096
|
+
}
|
|
2097
|
+
interface SubscriptionBackOfficeActionNonNullableFields$1 {
|
|
2098
|
+
subscription?: SubscriptionNonNullableFields$1;
|
|
2099
|
+
name: string;
|
|
2100
|
+
params: string;
|
|
2101
|
+
}
|
|
2102
|
+
interface SubscriptionEventNonNullableFields$1 {
|
|
2103
|
+
created?: SubscriptionCreatedNonNullableFields$1;
|
|
2104
|
+
updated?: SubscriptionUpdatedNonNullableFields$1;
|
|
2105
|
+
deleted?: SubscriptionDeletedNonNullableFields$1;
|
|
2106
|
+
activated?: SubscriptionActivatedNonNullableFields$1;
|
|
2107
|
+
ended?: SubscriptionEndedNonNullableFields$1;
|
|
2108
|
+
canceled?: SubscriptionCanceledNonNullableFields$1;
|
|
2109
|
+
paused?: SubscriptionPausedNonNullableFields$1;
|
|
2110
|
+
resumed?: SubscriptionResumedNonNullableFields$1;
|
|
2111
|
+
pauseRequested?: PauseSubscriptionRequestedNonNullableFields$1;
|
|
2112
|
+
resumeRequested?: ResumeSubscriptionRequestedNonNullableFields$1;
|
|
2113
|
+
scheduledPauseCanceled?: ScheduledPauseCanceledNonNullableFields$1;
|
|
2114
|
+
scheduledResumeCanceled?: ScheduledResumeCanceledNonNullableFields$1;
|
|
2115
|
+
billingCycleStarted?: SubscriptionBillingCycleStartedNonNullableFields$1;
|
|
2116
|
+
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOnNonNullableFields$1;
|
|
2117
|
+
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOffNonNullableFields$1;
|
|
2118
|
+
cycleReadyToPay?: SubscriptionCycleReadyToPayNonNullableFields$1;
|
|
2119
|
+
extended?: SubscriptionExtendedNonNullableFields$1;
|
|
2120
|
+
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompletedNonNullableFields$1;
|
|
2121
|
+
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaidNonNullableFields$1;
|
|
2122
|
+
revived?: SubscriptionRevivedNonNullableFields$1;
|
|
2123
|
+
billingDateUpdated?: SubscriptionBillingDateUpdatedNonNullableFields$1;
|
|
2124
|
+
futureUpdatesRequested?: FutureUpdatesRequestedNonNullableFields$1;
|
|
2125
|
+
updatesApplied?: UpdatesAppliedNonNullableFields$1;
|
|
2126
|
+
resetPendingUpdates?: ResetPendingUpdatesNonNullableFields$1;
|
|
2127
|
+
gracePeriodStarted?: GracePeriodStartedNonNullableFields$1;
|
|
2128
|
+
gracePeriodEnded?: GracePeriodEndedNonNullableFields$1;
|
|
2129
|
+
paymentMethodUpdated?: PaymentMethodUpdatedNonNullableFields$1;
|
|
2130
|
+
collectionMethodUpdated?: SubscriptionCollectionMethodUpdatedNonNullableFields$1;
|
|
2131
|
+
freeTrailStarted?: FreeTrailStartedNonNullableFields$1;
|
|
2132
|
+
freeTrailEnded?: FreeTrailEndedNonNullableFields$1;
|
|
2133
|
+
subscriptionBoAction?: SubscriptionBackOfficeActionNonNullableFields$1;
|
|
2134
|
+
}
|
|
2135
|
+
interface SubscriptionHistoryEntryNonNullableFields$1 {
|
|
2136
|
+
entryId: string;
|
|
2137
|
+
slug: string;
|
|
2138
|
+
event?: SubscriptionEventNonNullableFields$1;
|
|
2139
|
+
}
|
|
2140
|
+
interface ListSubscriptionHistoryResponseNonNullableFields$1 {
|
|
2141
|
+
historyEntries: SubscriptionHistoryEntryNonNullableFields$1[];
|
|
2142
|
+
}
|
|
1692
2143
|
interface GetSubscriptionResponseNonNullableFields$1 {
|
|
1693
2144
|
subscription?: SubscriptionNonNullableFields$1;
|
|
1694
2145
|
}
|
|
@@ -1764,7 +2215,6 @@ interface ItemTaxDataNonNullableFields$1 {
|
|
|
1764
2215
|
interface InvoiceItemNonNullableFields$1 {
|
|
1765
2216
|
recurring?: RecurringNonNullableFields$1;
|
|
1766
2217
|
id: string;
|
|
1767
|
-
subscriptionId: string;
|
|
1768
2218
|
name: string;
|
|
1769
2219
|
catalogReference?: CatalogReferenceNonNullableFields$1;
|
|
1770
2220
|
category: ItemCategory$1;
|
|
@@ -2642,6 +3092,20 @@ interface SpecificDateSubscriptionUpdateData {
|
|
|
2642
3092
|
updateData?: SubscriptionUpdateData;
|
|
2643
3093
|
executionDate?: Date;
|
|
2644
3094
|
}
|
|
3095
|
+
interface ListSubscriptionHistoryRequest {
|
|
3096
|
+
subscriptionId: string;
|
|
3097
|
+
/** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
|
|
3098
|
+
mode?: HistoryViewMode;
|
|
3099
|
+
/** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
|
|
3100
|
+
cursor?: CursorPaging;
|
|
3101
|
+
}
|
|
3102
|
+
declare enum HistoryViewMode {
|
|
3103
|
+
UNKNOWN = "UNKNOWN",
|
|
3104
|
+
/** Comprehensive view including all history events. */
|
|
3105
|
+
BACKOFFICE = "BACKOFFICE",
|
|
3106
|
+
/** User-centric view of the history. */
|
|
3107
|
+
USER = "USER"
|
|
3108
|
+
}
|
|
2645
3109
|
interface CursorPaging {
|
|
2646
3110
|
/** Maximum number of items to return in the results. */
|
|
2647
3111
|
limit?: number | null;
|
|
@@ -2653,6 +3117,255 @@ interface CursorPaging {
|
|
|
2653
3117
|
*/
|
|
2654
3118
|
cursor?: string | null;
|
|
2655
3119
|
}
|
|
3120
|
+
interface ListSubscriptionHistoryResponse {
|
|
3121
|
+
/** List of history entries for the subscription. */
|
|
3122
|
+
historyEntries?: SubscriptionHistoryEntry[];
|
|
3123
|
+
/** Paging metadata. A `next` cursor is returned if there are more results. */
|
|
3124
|
+
pagingMetadata?: PagingMetadataV2;
|
|
3125
|
+
}
|
|
3126
|
+
interface SubscriptionHistoryEntry {
|
|
3127
|
+
entryId?: string;
|
|
3128
|
+
/** TODO: add max length? it is not defined in domainevents, so should we? */
|
|
3129
|
+
slug?: string;
|
|
3130
|
+
entryTime?: Date;
|
|
3131
|
+
event?: SubscriptionEvent;
|
|
3132
|
+
}
|
|
3133
|
+
interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
|
|
3134
|
+
created?: SubscriptionCreated;
|
|
3135
|
+
updated?: SubscriptionUpdated;
|
|
3136
|
+
deleted?: SubscriptionDeleted;
|
|
3137
|
+
activated?: SubscriptionActivated;
|
|
3138
|
+
ended?: SubscriptionEnded;
|
|
3139
|
+
canceled?: SubscriptionCanceled;
|
|
3140
|
+
paused?: SubscriptionPaused;
|
|
3141
|
+
resumed?: SubscriptionResumed;
|
|
3142
|
+
pauseRequested?: PauseSubscriptionRequested;
|
|
3143
|
+
resumeRequested?: ResumeSubscriptionRequested;
|
|
3144
|
+
scheduledPauseCanceled?: ScheduledPauseCanceled;
|
|
3145
|
+
scheduledResumeCanceled?: ScheduledResumeCanceled;
|
|
3146
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
3147
|
+
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
|
|
3148
|
+
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
|
|
3149
|
+
cycleReadyToPay?: SubscriptionCycleReadyToPay;
|
|
3150
|
+
extended?: SubscriptionExtended;
|
|
3151
|
+
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
|
|
3152
|
+
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
|
|
3153
|
+
revived?: SubscriptionRevived;
|
|
3154
|
+
billingDateUpdated?: SubscriptionBillingDateUpdated;
|
|
3155
|
+
futureUpdatesRequested?: FutureUpdatesRequested;
|
|
3156
|
+
updatesApplied?: UpdatesApplied;
|
|
3157
|
+
resetPendingUpdates?: ResetPendingUpdates;
|
|
3158
|
+
gracePeriodStarted?: GracePeriodStarted;
|
|
3159
|
+
gracePeriodEnded?: GracePeriodEnded;
|
|
3160
|
+
paymentMethodUpdated?: PaymentMethodUpdated;
|
|
3161
|
+
collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
|
|
3162
|
+
freeTrailStarted?: FreeTrailStarted;
|
|
3163
|
+
freeTrailEnded?: FreeTrailEnded;
|
|
3164
|
+
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
3165
|
+
unknown?: UnknownSubscriptionEvent;
|
|
3166
|
+
}
|
|
3167
|
+
/** @oneof */
|
|
3168
|
+
interface SubscriptionEventPayloadOneOf {
|
|
3169
|
+
created?: SubscriptionCreated;
|
|
3170
|
+
updated?: SubscriptionUpdated;
|
|
3171
|
+
deleted?: SubscriptionDeleted;
|
|
3172
|
+
activated?: SubscriptionActivated;
|
|
3173
|
+
ended?: SubscriptionEnded;
|
|
3174
|
+
canceled?: SubscriptionCanceled;
|
|
3175
|
+
paused?: SubscriptionPaused;
|
|
3176
|
+
resumed?: SubscriptionResumed;
|
|
3177
|
+
pauseRequested?: PauseSubscriptionRequested;
|
|
3178
|
+
resumeRequested?: ResumeSubscriptionRequested;
|
|
3179
|
+
scheduledPauseCanceled?: ScheduledPauseCanceled;
|
|
3180
|
+
scheduledResumeCanceled?: ScheduledResumeCanceled;
|
|
3181
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
3182
|
+
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
|
|
3183
|
+
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
|
|
3184
|
+
cycleReadyToPay?: SubscriptionCycleReadyToPay;
|
|
3185
|
+
extended?: SubscriptionExtended;
|
|
3186
|
+
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
|
|
3187
|
+
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
|
|
3188
|
+
revived?: SubscriptionRevived;
|
|
3189
|
+
billingDateUpdated?: SubscriptionBillingDateUpdated;
|
|
3190
|
+
futureUpdatesRequested?: FutureUpdatesRequested;
|
|
3191
|
+
updatesApplied?: UpdatesApplied;
|
|
3192
|
+
resetPendingUpdates?: ResetPendingUpdates;
|
|
3193
|
+
gracePeriodStarted?: GracePeriodStarted;
|
|
3194
|
+
gracePeriodEnded?: GracePeriodEnded;
|
|
3195
|
+
paymentMethodUpdated?: PaymentMethodUpdated;
|
|
3196
|
+
collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
|
|
3197
|
+
freeTrailStarted?: FreeTrailStarted;
|
|
3198
|
+
freeTrailEnded?: FreeTrailEnded;
|
|
3199
|
+
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
3200
|
+
unknown?: UnknownSubscriptionEvent;
|
|
3201
|
+
}
|
|
3202
|
+
interface SubscriptionCreated {
|
|
3203
|
+
subscription?: Subscription;
|
|
3204
|
+
}
|
|
3205
|
+
interface SubscriptionUpdated {
|
|
3206
|
+
current?: Subscription;
|
|
3207
|
+
previous?: Subscription;
|
|
3208
|
+
diff?: SubscriptionDiff;
|
|
3209
|
+
}
|
|
3210
|
+
interface SubscriptionDiff {
|
|
3211
|
+
added?: string | null;
|
|
3212
|
+
changed?: string | null;
|
|
3213
|
+
deleted?: string | null;
|
|
3214
|
+
}
|
|
3215
|
+
interface SubscriptionDeleted {
|
|
3216
|
+
subscriptionId?: string;
|
|
3217
|
+
}
|
|
3218
|
+
/**
|
|
3219
|
+
* Sent each time a subscription status has been set to Active
|
|
3220
|
+
* Active shows that a subscription is live and operational.
|
|
3221
|
+
* For example:
|
|
3222
|
+
* * For subscription with free trial, free trial start date is also the activation date.
|
|
3223
|
+
* * For a subscription with future start date, the start date is also the activation date.
|
|
3224
|
+
* * When a subscription is resumed from a pause status, the resume date is also the activation date.
|
|
3225
|
+
*/
|
|
3226
|
+
interface SubscriptionActivated {
|
|
3227
|
+
subscription?: Subscription;
|
|
3228
|
+
}
|
|
3229
|
+
/**
|
|
3230
|
+
* Sent each time a subscription status has been set to Ended
|
|
3231
|
+
* Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
|
|
3232
|
+
* This is different from a Canceled subscription which ends the subscription before a designated end date.
|
|
3233
|
+
* Therefore, Ended and Canceled are mutually exclusive.
|
|
3234
|
+
*/
|
|
3235
|
+
interface SubscriptionEnded {
|
|
3236
|
+
subscription?: Subscription;
|
|
3237
|
+
}
|
|
3238
|
+
/**
|
|
3239
|
+
* Sent each time a subscription status has been set to Canceled
|
|
3240
|
+
* Canceled shows that a subscription was canceled and ended its life cycle as a result of some intervention
|
|
3241
|
+
* For example:
|
|
3242
|
+
* * A user decided to cancel a subscription before the original end date
|
|
3243
|
+
* * A subscription is canceled due to bad payment
|
|
3244
|
+
*/
|
|
3245
|
+
interface SubscriptionCanceled {
|
|
3246
|
+
subscription?: Subscription;
|
|
3247
|
+
actionDetails?: ActionDetails;
|
|
3248
|
+
}
|
|
3249
|
+
interface ActionDetails {
|
|
3250
|
+
initiator?: HistoryActionInitiator;
|
|
3251
|
+
reason?: string | null;
|
|
3252
|
+
}
|
|
3253
|
+
interface SubscriptionPaused {
|
|
3254
|
+
subscription?: Subscription;
|
|
3255
|
+
pausePolicy?: PausePolicy;
|
|
3256
|
+
actionDetails?: ActionDetails;
|
|
3257
|
+
}
|
|
3258
|
+
interface SubscriptionResumed {
|
|
3259
|
+
subscription?: Subscription;
|
|
3260
|
+
actionDetails?: ActionDetails;
|
|
3261
|
+
}
|
|
3262
|
+
interface PauseSubscriptionRequested {
|
|
3263
|
+
subscription?: Subscription;
|
|
3264
|
+
pauseAt?: PauseAt;
|
|
3265
|
+
pausePolicy?: PausePolicy;
|
|
3266
|
+
actionDetails?: ActionDetails;
|
|
3267
|
+
}
|
|
3268
|
+
interface ResumeSubscriptionRequested {
|
|
3269
|
+
subscription?: Subscription;
|
|
3270
|
+
resumeAt?: ResumeAt;
|
|
3271
|
+
actionDetails?: ActionDetails;
|
|
3272
|
+
}
|
|
3273
|
+
interface ScheduledPauseCanceled {
|
|
3274
|
+
subscription?: Subscription;
|
|
3275
|
+
actionDetails?: ActionDetails;
|
|
3276
|
+
}
|
|
3277
|
+
interface ScheduledResumeCanceled {
|
|
3278
|
+
subscription?: Subscription;
|
|
3279
|
+
actionDetails?: ActionDetails;
|
|
3280
|
+
}
|
|
3281
|
+
interface SubscriptionBillingCycleStarted {
|
|
3282
|
+
subscription?: Subscription;
|
|
3283
|
+
/** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
|
|
3284
|
+
paymentTransactionId?: string | null;
|
|
3285
|
+
}
|
|
3286
|
+
interface SubscriptionAutoRenewalTurnedOn {
|
|
3287
|
+
subscription?: Subscription;
|
|
3288
|
+
actionDetails?: ActionDetails;
|
|
3289
|
+
}
|
|
3290
|
+
interface SubscriptionAutoRenewalTurnedOff {
|
|
3291
|
+
subscription?: Subscription;
|
|
3292
|
+
actionDetails?: ActionDetails;
|
|
3293
|
+
}
|
|
3294
|
+
interface SubscriptionCycleReadyToPay {
|
|
3295
|
+
subscription?: Subscription;
|
|
3296
|
+
}
|
|
3297
|
+
interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
|
|
3298
|
+
extensionPeriod?: Duration;
|
|
3299
|
+
extensionBillingCycles?: number;
|
|
3300
|
+
subscription?: Subscription;
|
|
3301
|
+
actionDetails?: ActionDetails;
|
|
3302
|
+
}
|
|
3303
|
+
/** @oneof */
|
|
3304
|
+
interface SubscriptionExtendedExtendPolicyOneOf {
|
|
3305
|
+
extensionPeriod?: Duration;
|
|
3306
|
+
extensionBillingCycles?: number;
|
|
3307
|
+
}
|
|
3308
|
+
interface SubscriptionInitialPurchaseCompleted {
|
|
3309
|
+
subscription?: Subscription;
|
|
3310
|
+
actionDetails?: ActionDetails;
|
|
3311
|
+
paymentTransactionId?: string | null;
|
|
3312
|
+
}
|
|
3313
|
+
interface LatestInvoiceMarkedAsPaid {
|
|
3314
|
+
subscription?: Subscription;
|
|
3315
|
+
}
|
|
3316
|
+
interface SubscriptionRevived {
|
|
3317
|
+
subscription?: Subscription;
|
|
3318
|
+
}
|
|
3319
|
+
interface SubscriptionBillingDateUpdated {
|
|
3320
|
+
subscription?: Subscription;
|
|
3321
|
+
billingDate?: Date;
|
|
3322
|
+
proration?: Proration;
|
|
3323
|
+
}
|
|
3324
|
+
interface FutureUpdatesRequested {
|
|
3325
|
+
subscription?: Subscription;
|
|
3326
|
+
requestedUpdateData?: SubscriptionUpdateData;
|
|
3327
|
+
}
|
|
3328
|
+
interface UpdatesApplied {
|
|
3329
|
+
subscription?: Subscription;
|
|
3330
|
+
updateAction?: UpdateAction;
|
|
3331
|
+
appliedUpdateData?: SubscriptionUpdateData;
|
|
3332
|
+
}
|
|
3333
|
+
declare enum UpdateAction {
|
|
3334
|
+
NONE = "NONE",
|
|
3335
|
+
/** Update subscription immediately, please note proration for updates changing price are not yet supported */
|
|
3336
|
+
IMMEDIATELY = "IMMEDIATELY",
|
|
3337
|
+
/** Request updates that will take affect only at the start of the next billing cycle. */
|
|
3338
|
+
NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
|
|
3339
|
+
/** Reset all pending updates */
|
|
3340
|
+
RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
|
|
3341
|
+
/** Request updates that will take affect only at a specific date. */
|
|
3342
|
+
SPECIFIC_DATE = "SPECIFIC_DATE"
|
|
3343
|
+
}
|
|
3344
|
+
interface ResetPendingUpdates {
|
|
3345
|
+
subscription?: Subscription;
|
|
3346
|
+
}
|
|
3347
|
+
interface GracePeriodStarted {
|
|
3348
|
+
subscription?: Subscription;
|
|
3349
|
+
}
|
|
3350
|
+
interface GracePeriodEnded {
|
|
3351
|
+
subscription?: Subscription;
|
|
3352
|
+
/** Indication for the payment settlement method. */
|
|
3353
|
+
paymentSettlementMethod?: PaymentSettlementMethod;
|
|
3354
|
+
}
|
|
3355
|
+
declare enum PaymentSettlementMethod {
|
|
3356
|
+
UNKNOWN = "UNKNOWN",
|
|
3357
|
+
/** System-defined payment settlement. */
|
|
3358
|
+
SYSTEM = "SYSTEM",
|
|
3359
|
+
/** Manually mark the payment as paid. */
|
|
3360
|
+
MARK_AS_PAID = "MARK_AS_PAID",
|
|
3361
|
+
/** Require the customer to pay immediately, by insert a new payment method. */
|
|
3362
|
+
CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
|
|
3363
|
+
}
|
|
3364
|
+
interface PaymentMethodUpdated {
|
|
3365
|
+
subscription?: Subscription;
|
|
3366
|
+
initiator?: HistoryActionInitiator;
|
|
3367
|
+
paymentMode?: PaymentMode;
|
|
3368
|
+
}
|
|
2656
3369
|
declare enum PaymentMode {
|
|
2657
3370
|
NONE = "NONE",
|
|
2658
3371
|
/** The latest invoice of the subscription will be charged. */
|
|
@@ -2660,6 +3373,28 @@ declare enum PaymentMode {
|
|
|
2660
3373
|
/** An authorization invoice with zero amount will be created. */
|
|
2661
3374
|
AUTHORIZATION = "AUTHORIZATION"
|
|
2662
3375
|
}
|
|
3376
|
+
interface SubscriptionCollectionMethodUpdated {
|
|
3377
|
+
subscription?: Subscription;
|
|
3378
|
+
newCollectionMethod?: CollectionMethodEnumCollectionMethod;
|
|
3379
|
+
previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
|
|
3380
|
+
}
|
|
3381
|
+
interface FreeTrailStarted {
|
|
3382
|
+
subscription?: Subscription;
|
|
3383
|
+
}
|
|
3384
|
+
interface FreeTrailEnded {
|
|
3385
|
+
subscription?: Subscription;
|
|
3386
|
+
}
|
|
3387
|
+
interface SubscriptionBackOfficeAction {
|
|
3388
|
+
subscription?: Subscription;
|
|
3389
|
+
/** The backoffice method name */
|
|
3390
|
+
name?: string;
|
|
3391
|
+
/** json as string format, to store the flatted request object */
|
|
3392
|
+
params?: string;
|
|
3393
|
+
}
|
|
3394
|
+
/** Defines unknown events restored from the logs */
|
|
3395
|
+
interface UnknownSubscriptionEvent {
|
|
3396
|
+
subscriptionAsString?: string | null;
|
|
3397
|
+
}
|
|
2663
3398
|
interface PagingMetadataV2 {
|
|
2664
3399
|
/** Number of items returned in the response. */
|
|
2665
3400
|
count?: number | null;
|
|
@@ -2914,7 +3649,7 @@ interface InvoiceItem extends InvoiceItemPaymentTypeOneOf {
|
|
|
2914
3649
|
* ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
|
|
2915
3650
|
* that belongs to the invoice line item.
|
|
2916
3651
|
*/
|
|
2917
|
-
subscriptionId?: string;
|
|
3652
|
+
subscriptionId?: string | null;
|
|
2918
3653
|
/**
|
|
2919
3654
|
* Name of the invoice line item.
|
|
2920
3655
|
* Typically the product name.
|
|
@@ -3545,6 +4280,172 @@ interface SubscriptionNonNullableFields {
|
|
|
3545
4280
|
specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
|
|
3546
4281
|
items: ItemNonNullableFields[];
|
|
3547
4282
|
}
|
|
4283
|
+
interface SubscriptionCreatedNonNullableFields {
|
|
4284
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4285
|
+
}
|
|
4286
|
+
interface SubscriptionUpdatedNonNullableFields {
|
|
4287
|
+
current?: SubscriptionNonNullableFields;
|
|
4288
|
+
previous?: SubscriptionNonNullableFields;
|
|
4289
|
+
}
|
|
4290
|
+
interface SubscriptionDeletedNonNullableFields {
|
|
4291
|
+
subscriptionId: string;
|
|
4292
|
+
}
|
|
4293
|
+
interface SubscriptionActivatedNonNullableFields {
|
|
4294
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4295
|
+
}
|
|
4296
|
+
interface SubscriptionEndedNonNullableFields {
|
|
4297
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4298
|
+
}
|
|
4299
|
+
interface ActionDetailsNonNullableFields {
|
|
4300
|
+
initiator: HistoryActionInitiator;
|
|
4301
|
+
}
|
|
4302
|
+
interface SubscriptionCanceledNonNullableFields {
|
|
4303
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4304
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4305
|
+
}
|
|
4306
|
+
interface SubscriptionPausedNonNullableFields {
|
|
4307
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4308
|
+
pausePolicy: PausePolicy;
|
|
4309
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4310
|
+
}
|
|
4311
|
+
interface SubscriptionResumedNonNullableFields {
|
|
4312
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4313
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4314
|
+
}
|
|
4315
|
+
interface PauseSubscriptionRequestedNonNullableFields {
|
|
4316
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4317
|
+
pauseAt: PauseAt;
|
|
4318
|
+
pausePolicy: PausePolicy;
|
|
4319
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4320
|
+
}
|
|
4321
|
+
interface ResumeSubscriptionRequestedNonNullableFields {
|
|
4322
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4323
|
+
resumeAt: ResumeAt;
|
|
4324
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4325
|
+
}
|
|
4326
|
+
interface ScheduledPauseCanceledNonNullableFields {
|
|
4327
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4328
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4329
|
+
}
|
|
4330
|
+
interface ScheduledResumeCanceledNonNullableFields {
|
|
4331
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4332
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4333
|
+
}
|
|
4334
|
+
interface SubscriptionBillingCycleStartedNonNullableFields {
|
|
4335
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4336
|
+
}
|
|
4337
|
+
interface SubscriptionAutoRenewalTurnedOnNonNullableFields {
|
|
4338
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4339
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4340
|
+
}
|
|
4341
|
+
interface SubscriptionAutoRenewalTurnedOffNonNullableFields {
|
|
4342
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4343
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4344
|
+
}
|
|
4345
|
+
interface SubscriptionCycleReadyToPayNonNullableFields {
|
|
4346
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4347
|
+
}
|
|
4348
|
+
interface SubscriptionExtendedNonNullableFields {
|
|
4349
|
+
extensionPeriod?: DurationNonNullableFields;
|
|
4350
|
+
extensionBillingCycles: number;
|
|
4351
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4352
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4353
|
+
}
|
|
4354
|
+
interface SubscriptionInitialPurchaseCompletedNonNullableFields {
|
|
4355
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4356
|
+
actionDetails?: ActionDetailsNonNullableFields;
|
|
4357
|
+
}
|
|
4358
|
+
interface LatestInvoiceMarkedAsPaidNonNullableFields {
|
|
4359
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4360
|
+
}
|
|
4361
|
+
interface SubscriptionRevivedNonNullableFields {
|
|
4362
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4363
|
+
}
|
|
4364
|
+
interface SubscriptionBillingDateUpdatedNonNullableFields {
|
|
4365
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4366
|
+
proration?: ProrationNonNullableFields;
|
|
4367
|
+
}
|
|
4368
|
+
interface FutureUpdatesRequestedNonNullableFields {
|
|
4369
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4370
|
+
requestedUpdateData?: SubscriptionUpdateDataNonNullableFields;
|
|
4371
|
+
}
|
|
4372
|
+
interface UpdatesAppliedNonNullableFields {
|
|
4373
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4374
|
+
updateAction: UpdateAction;
|
|
4375
|
+
appliedUpdateData?: SubscriptionUpdateDataNonNullableFields;
|
|
4376
|
+
}
|
|
4377
|
+
interface ResetPendingUpdatesNonNullableFields {
|
|
4378
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4379
|
+
}
|
|
4380
|
+
interface GracePeriodStartedNonNullableFields {
|
|
4381
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4382
|
+
}
|
|
4383
|
+
interface GracePeriodEndedNonNullableFields {
|
|
4384
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4385
|
+
paymentSettlementMethod: PaymentSettlementMethod;
|
|
4386
|
+
}
|
|
4387
|
+
interface PaymentMethodUpdatedNonNullableFields {
|
|
4388
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4389
|
+
initiator: HistoryActionInitiator;
|
|
4390
|
+
paymentMode: PaymentMode;
|
|
4391
|
+
}
|
|
4392
|
+
interface SubscriptionCollectionMethodUpdatedNonNullableFields {
|
|
4393
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4394
|
+
newCollectionMethod: CollectionMethodEnumCollectionMethod;
|
|
4395
|
+
previousCollectionMethod: CollectionMethodEnumCollectionMethod;
|
|
4396
|
+
}
|
|
4397
|
+
interface FreeTrailStartedNonNullableFields {
|
|
4398
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4399
|
+
}
|
|
4400
|
+
interface FreeTrailEndedNonNullableFields {
|
|
4401
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4402
|
+
}
|
|
4403
|
+
interface SubscriptionBackOfficeActionNonNullableFields {
|
|
4404
|
+
subscription?: SubscriptionNonNullableFields;
|
|
4405
|
+
name: string;
|
|
4406
|
+
params: string;
|
|
4407
|
+
}
|
|
4408
|
+
interface SubscriptionEventNonNullableFields {
|
|
4409
|
+
created?: SubscriptionCreatedNonNullableFields;
|
|
4410
|
+
updated?: SubscriptionUpdatedNonNullableFields;
|
|
4411
|
+
deleted?: SubscriptionDeletedNonNullableFields;
|
|
4412
|
+
activated?: SubscriptionActivatedNonNullableFields;
|
|
4413
|
+
ended?: SubscriptionEndedNonNullableFields;
|
|
4414
|
+
canceled?: SubscriptionCanceledNonNullableFields;
|
|
4415
|
+
paused?: SubscriptionPausedNonNullableFields;
|
|
4416
|
+
resumed?: SubscriptionResumedNonNullableFields;
|
|
4417
|
+
pauseRequested?: PauseSubscriptionRequestedNonNullableFields;
|
|
4418
|
+
resumeRequested?: ResumeSubscriptionRequestedNonNullableFields;
|
|
4419
|
+
scheduledPauseCanceled?: ScheduledPauseCanceledNonNullableFields;
|
|
4420
|
+
scheduledResumeCanceled?: ScheduledResumeCanceledNonNullableFields;
|
|
4421
|
+
billingCycleStarted?: SubscriptionBillingCycleStartedNonNullableFields;
|
|
4422
|
+
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOnNonNullableFields;
|
|
4423
|
+
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOffNonNullableFields;
|
|
4424
|
+
cycleReadyToPay?: SubscriptionCycleReadyToPayNonNullableFields;
|
|
4425
|
+
extended?: SubscriptionExtendedNonNullableFields;
|
|
4426
|
+
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompletedNonNullableFields;
|
|
4427
|
+
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaidNonNullableFields;
|
|
4428
|
+
revived?: SubscriptionRevivedNonNullableFields;
|
|
4429
|
+
billingDateUpdated?: SubscriptionBillingDateUpdatedNonNullableFields;
|
|
4430
|
+
futureUpdatesRequested?: FutureUpdatesRequestedNonNullableFields;
|
|
4431
|
+
updatesApplied?: UpdatesAppliedNonNullableFields;
|
|
4432
|
+
resetPendingUpdates?: ResetPendingUpdatesNonNullableFields;
|
|
4433
|
+
gracePeriodStarted?: GracePeriodStartedNonNullableFields;
|
|
4434
|
+
gracePeriodEnded?: GracePeriodEndedNonNullableFields;
|
|
4435
|
+
paymentMethodUpdated?: PaymentMethodUpdatedNonNullableFields;
|
|
4436
|
+
collectionMethodUpdated?: SubscriptionCollectionMethodUpdatedNonNullableFields;
|
|
4437
|
+
freeTrailStarted?: FreeTrailStartedNonNullableFields;
|
|
4438
|
+
freeTrailEnded?: FreeTrailEndedNonNullableFields;
|
|
4439
|
+
subscriptionBoAction?: SubscriptionBackOfficeActionNonNullableFields;
|
|
4440
|
+
}
|
|
4441
|
+
interface SubscriptionHistoryEntryNonNullableFields {
|
|
4442
|
+
entryId: string;
|
|
4443
|
+
slug: string;
|
|
4444
|
+
event?: SubscriptionEventNonNullableFields;
|
|
4445
|
+
}
|
|
4446
|
+
interface ListSubscriptionHistoryResponseNonNullableFields {
|
|
4447
|
+
historyEntries: SubscriptionHistoryEntryNonNullableFields[];
|
|
4448
|
+
}
|
|
3548
4449
|
interface GetSubscriptionResponseNonNullableFields {
|
|
3549
4450
|
subscription?: SubscriptionNonNullableFields;
|
|
3550
4451
|
}
|
|
@@ -3620,7 +4521,6 @@ interface ItemTaxDataNonNullableFields {
|
|
|
3620
4521
|
interface InvoiceItemNonNullableFields {
|
|
3621
4522
|
recurring?: RecurringNonNullableFields;
|
|
3622
4523
|
_id: string;
|
|
3623
|
-
subscriptionId: string;
|
|
3624
4524
|
name: string;
|
|
3625
4525
|
catalogReference?: CatalogReferenceNonNullableFields;
|
|
3626
4526
|
category: ItemCategory;
|
|
@@ -3720,6 +4620,9 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
3720
4620
|
__responseType: Q;
|
|
3721
4621
|
__originalResponseType: R;
|
|
3722
4622
|
};
|
|
4623
|
+
declare function listSubscriptionHistory(): __PublicMethodMetaInfo<'GET', {
|
|
4624
|
+
subscriptionId: string;
|
|
4625
|
+
}, ListSubscriptionHistoryRequest, ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields, ListSubscriptionHistoryResponse$1 & ListSubscriptionHistoryResponseNonNullableFields$1>;
|
|
3723
4626
|
declare function customerGetSubscription(): __PublicMethodMetaInfo<'GET', {
|
|
3724
4627
|
id: string;
|
|
3725
4628
|
}, GetSubscriptionRequest, GetSubscriptionRequest$1, GetSubscriptionResponse & GetSubscriptionResponseNonNullableFields, GetSubscriptionResponse$1 & GetSubscriptionResponseNonNullableFields$1>;
|
|
@@ -3814,6 +4717,7 @@ declare const meta_extendSubscription: typeof extendSubscription;
|
|
|
3814
4717
|
declare const meta_getSubscription: typeof getSubscription;
|
|
3815
4718
|
declare const meta_getSubscriptionsStats: typeof getSubscriptionsStats;
|
|
3816
4719
|
declare const meta_initiatePaymentMethodSetup: typeof initiatePaymentMethodSetup;
|
|
4720
|
+
declare const meta_listSubscriptionHistory: typeof listSubscriptionHistory;
|
|
3817
4721
|
declare const meta_listUpcomingCharges: typeof listUpcomingCharges;
|
|
3818
4722
|
declare const meta_markLatestInvoiceAsPaid: typeof markLatestInvoiceAsPaid;
|
|
3819
4723
|
declare const meta_pauseSubscription: typeof pauseSubscription;
|
|
@@ -3827,7 +4731,7 @@ declare const meta_turnOnSubscriptionAutoRenewal: typeof turnOnSubscriptionAutoR
|
|
|
3827
4731
|
declare const meta_updateSubscriptionBillingDate: typeof updateSubscriptionBillingDate;
|
|
3828
4732
|
declare const meta_updateSubscriptionPaymentMethod: typeof updateSubscriptionPaymentMethod;
|
|
3829
4733
|
declare namespace meta {
|
|
3830
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_allowedActions as allowedActions, meta_cancelSubscription as cancelSubscription, meta_countSubscriptions as countSubscriptions, meta_customerAllowedActions as customerAllowedActions, meta_customerCancelSubscription as customerCancelSubscription, meta_customerExtendSubscription as customerExtendSubscription, meta_customerGetSubscription as customerGetSubscription, meta_customerInitiatePaymentMethodSetup as customerInitiatePaymentMethodSetup, meta_customerListUpcomingCharges as customerListUpcomingCharges, meta_customerQuerySubscriptions as customerQuerySubscriptions, meta_customerTurnOffSubscriptionAutoRenewal as customerTurnOffSubscriptionAutoRenewal, meta_customerTurnOnSubscriptionAutoRenewal as customerTurnOnSubscriptionAutoRenewal, meta_customerUpdateSubscriptionPaymentMethod as customerUpdateSubscriptionPaymentMethod, meta_extendSubscription as extendSubscription, meta_getSubscription as getSubscription, meta_getSubscriptionsStats as getSubscriptionsStats, meta_initiatePaymentMethodSetup as initiatePaymentMethodSetup, meta_listUpcomingCharges as listUpcomingCharges, meta_markLatestInvoiceAsPaid as markLatestInvoiceAsPaid, meta_pauseSubscription as pauseSubscription, meta_payCycle as payCycle, meta_previewSubscriptionCharges as previewSubscriptionCharges, meta_querySubscriptions as querySubscriptions, meta_resumeSubscription as resumeSubscription, meta_searchSubscriptions as searchSubscriptions, meta_turnOffSubscriptionAutoRenewal as turnOffSubscriptionAutoRenewal, meta_turnOnSubscriptionAutoRenewal as turnOnSubscriptionAutoRenewal, meta_updateSubscriptionBillingDate as updateSubscriptionBillingDate, meta_updateSubscriptionPaymentMethod as updateSubscriptionPaymentMethod };
|
|
4734
|
+
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_allowedActions as allowedActions, meta_cancelSubscription as cancelSubscription, meta_countSubscriptions as countSubscriptions, meta_customerAllowedActions as customerAllowedActions, meta_customerCancelSubscription as customerCancelSubscription, meta_customerExtendSubscription as customerExtendSubscription, meta_customerGetSubscription as customerGetSubscription, meta_customerInitiatePaymentMethodSetup as customerInitiatePaymentMethodSetup, meta_customerListUpcomingCharges as customerListUpcomingCharges, meta_customerQuerySubscriptions as customerQuerySubscriptions, meta_customerTurnOffSubscriptionAutoRenewal as customerTurnOffSubscriptionAutoRenewal, meta_customerTurnOnSubscriptionAutoRenewal as customerTurnOnSubscriptionAutoRenewal, meta_customerUpdateSubscriptionPaymentMethod as customerUpdateSubscriptionPaymentMethod, meta_extendSubscription as extendSubscription, meta_getSubscription as getSubscription, meta_getSubscriptionsStats as getSubscriptionsStats, meta_initiatePaymentMethodSetup as initiatePaymentMethodSetup, meta_listSubscriptionHistory as listSubscriptionHistory, meta_listUpcomingCharges as listUpcomingCharges, meta_markLatestInvoiceAsPaid as markLatestInvoiceAsPaid, meta_pauseSubscription as pauseSubscription, meta_payCycle as payCycle, meta_previewSubscriptionCharges as previewSubscriptionCharges, meta_querySubscriptions as querySubscriptions, meta_resumeSubscription as resumeSubscription, meta_searchSubscriptions as searchSubscriptions, meta_turnOffSubscriptionAutoRenewal as turnOffSubscriptionAutoRenewal, meta_turnOnSubscriptionAutoRenewal as turnOnSubscriptionAutoRenewal, meta_updateSubscriptionBillingDate as updateSubscriptionBillingDate, meta_updateSubscriptionPaymentMethod as updateSubscriptionPaymentMethod };
|
|
3831
4735
|
}
|
|
3832
4736
|
|
|
3833
4737
|
export { meta as subscriptions };
|