@wix/auto_sdk_pricing-plans_orders 1.0.124 → 1.0.125

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.
@@ -666,373 +666,316 @@ interface ActionEvent {
666
666
  }
667
667
  interface Empty {
668
668
  }
669
- interface OrderPurchased {
670
- /** Order that was paid for. If a free or an offline order, the order that was created. */
671
- order?: Order;
672
- }
673
- interface OrderStarted {
674
- /** Order that reached its `startDate`. */
675
- order?: Order;
669
+ interface CreateOnlineOrderRequest {
670
+ /**
671
+ * Plan ID.
672
+ * @format GUID
673
+ */
674
+ planId: string;
675
+ /**
676
+ * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
677
+ *
678
+ * Default: Current date and time.
679
+ */
680
+ startDate?: Date | null;
681
+ /**
682
+ * Coupon code to apply.
683
+ * @minLength 1
684
+ * @maxLength 20
685
+ */
686
+ couponCode?: string | null;
687
+ /** Provided if checkout is initiated on buyer's behalf. */
688
+ onBehalf?: OnBehalf;
689
+ /**
690
+ * Submission ID of the form submitted with this order.
691
+ * @format GUID
692
+ */
693
+ submissionId?: string | null;
676
694
  }
677
- /**
678
- * Triggered at the start of a new payment cycle for an existing order.
679
- *
680
- * This webhook does not trigger at the initial start of an offline order.
681
- */
682
- interface OrderCycleStarted {
683
- /** Order whose new cycle started. */
684
- order?: Order;
685
- /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
686
- cycleNumber?: number;
695
+ interface OnBehalf {
696
+ /**
697
+ * Member ID.
698
+ * @format GUID
699
+ */
700
+ memberId?: string;
701
+ /** Method by which checkout is initiated. */
702
+ orderMethod?: OrderMethodWithLiterals;
687
703
  }
688
- /** Emitted when a recurring order is canceled for the next payment cycle */
689
- interface OrderAutoRenewCanceled {
690
- /** Order that is canceled, effective at the end of the current payment cycle. */
704
+ interface CreateOnlineOrderResponse {
705
+ /** Created online order. */
691
706
  order?: Order;
692
707
  }
693
- interface OrderEnded {
694
- /** Order that ended. */
695
- order?: Order;
708
+ interface CouponsError {
709
+ /** Coupon code. */
710
+ couponCode?: string;
711
+ /** Plan ID. */
712
+ planId?: string;
696
713
  }
697
- interface GetOrderRequest {
714
+ interface CreateGuestOnlineOrderRequest {
698
715
  /**
699
- * Order ID.
716
+ * Plan ID.
700
717
  * @format GUID
701
718
  */
702
- _id: string;
719
+ planId?: string;
703
720
  /**
704
- * Predefined set of fields to return.
721
+ * Start date for the ordered plan.
705
722
  *
706
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
723
+ * Default: Current date
707
724
  */
708
- fieldSet?: SetWithLiterals;
725
+ startDate?: Date | null;
726
+ /**
727
+ * Coupon code to apply.
728
+ * @minLength 1
729
+ * @maxLength 20
730
+ */
731
+ couponCode?: string | null;
732
+ /** Captcha data to prove you are not a robot */
733
+ captcha?: Captcha;
734
+ /** Visitor info */
735
+ guest?: Guest;
736
+ /**
737
+ * Form submission id that was submitted together with the order
738
+ * @format GUID
739
+ */
740
+ submissionId?: string | null;
709
741
  }
710
- declare enum Set {
711
- /** Same behavior as `BASIC`.` */
712
- UNKNOWN_SET = "UNKNOWN_SET",
713
- /** Doesn't return any order form submission data. */
714
- BASIC = "BASIC",
715
- /** Returns all order form submission data. */
716
- FULL = "FULL"
742
+ interface Captcha {
743
+ /** Token from captcha */
744
+ token?: string;
717
745
  }
718
- /** @enumType */
719
- type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
720
- interface GetOrderResponse {
746
+ interface Guest {
747
+ /**
748
+ * Email for checkout
749
+ * @format EMAIL
750
+ */
751
+ email?: string;
752
+ }
753
+ interface CreateGuestOnlineOrderResponse {
721
754
  /** Order. */
722
755
  order?: Order;
723
756
  }
724
- interface ListOrdersRequest {
757
+ interface CreateOfflineOrderRequest {
725
758
  /**
726
- * Filter by a buyer's member ID, from the Members API.
759
+ * ID of the plan being ordered, from the Plans API.
727
760
  * @format GUID
728
761
  */
729
- buyerIds?: string[];
762
+ planId: string;
730
763
  /**
731
- * Filter by plan IDs, from the Plans API.
764
+ * ID of the member ordering the plan, from the Members API.
732
765
  * @format GUID
733
766
  */
734
- planIds?: string[];
735
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
736
- autoRenewCanceled?: boolean | null;
737
- /** Filter by order status. */
738
- orderStatuses?: OrderStatusWithLiterals[];
739
- /** Filter by payment status. */
740
- paymentStatuses?: PaymentStatusWithLiterals[];
767
+ memberId: string;
741
768
  /**
742
- * Number of orders to return. See Sorting and Paging for more information.
769
+ * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
743
770
  *
744
- * Max: `50`
745
- * @min 1
746
- * @max 50
771
+ * Default: Current date and time.
747
772
  */
748
- limit?: number | null;
749
- /** Number of orders to skip in the current sort order. */
750
- offset?: number | null;
773
+ startDate?: Date | null;
751
774
  /**
752
- * Sort order.
753
- *
754
- * Use `ASC` for ascending order or `DESC` for descending order.
775
+ * Whether the order is paid.
755
776
  *
756
- * Default: `DESC`.
777
+ * Default: `false`
757
778
  */
758
- sorting?: Sorting;
779
+ paid?: boolean | null;
759
780
  /**
760
- * Predefined set of fields to return.
761
- *
762
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
781
+ * Coupon code to apply, from the Coupons API.
782
+ * @minLength 1
783
+ * @maxLength 20
763
784
  */
764
- fieldSet?: SetWithLiterals;
785
+ couponCode?: string | null;
765
786
  /**
766
- * Filter by order IDs.
767
- * @internal
787
+ * Form submission ID that was submitted with the order.
768
788
  * @format GUID
769
- * @maxSize 50
770
789
  */
771
- orderIds?: string[];
790
+ submissionId?: string | null;
772
791
  }
773
- interface Sorting {
792
+ interface CreateOfflineOrderResponse {
793
+ /** Order. */
794
+ order?: Order;
795
+ }
796
+ interface CreateExternalOrderRequest {
774
797
  /**
775
- * Name of the field to sort by.
776
- * @maxLength 512
798
+ * Plan ID.
799
+ * @format GUID
777
800
  */
778
- fieldName?: string;
779
- /** Sort order. */
780
- order?: SortOrderWithLiterals;
801
+ planId?: string;
781
802
  /**
782
- * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
783
- * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
784
- *
785
- * If multiple filters are provided, they are combined with AND operator.
803
+ * Form submission id that was submitted together with the order
804
+ * @format GUID
805
+ */
806
+ submissionId?: string | null;
807
+ }
808
+ interface CreateExternalOrderResponse {
809
+ /** Created order */
810
+ order?: Order;
811
+ }
812
+ interface GetOnlineOrderPreviewRequest {
813
+ /**
814
+ * Plan ID.
815
+ * @format GUID
816
+ */
817
+ planId: string;
818
+ /**
819
+ * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
786
820
  *
787
- * Example:
788
- * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
789
- * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
790
- * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
791
- * @internal
792
- * @maxSize 10
821
+ * Default: Current date and time.
793
822
  */
794
- selectItemsBy?: Record<string, any>[] | null;
823
+ startDate?: Date | null;
795
824
  /**
796
- * Origin point for geo-distance sorting on a GEO field
797
- * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
825
+ * Coupon code to apply.
826
+ * @minLength 1
827
+ * @maxLength 20
798
828
  */
799
- origin?: AddressLocation;
800
- }
801
- declare enum SortOrder {
802
- ASC = "ASC",
803
- DESC = "DESC"
804
- }
805
- /** @enumType */
806
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
807
- interface AddressLocation {
808
- /** Address latitude. */
809
- latitude?: number | null;
810
- /** Address longitude. */
811
- longitude?: number | null;
829
+ couponCode?: string | null;
812
830
  }
813
- interface ListOrdersResponse {
814
- /** List of orders. */
815
- orders?: Order[];
816
- /** Object containing paging-related data (number of orders returned, offset). */
817
- pagingMetadata?: PagingMetadataV2;
831
+ interface GetOnlineOrderPreviewResponse {
832
+ /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
833
+ order?: Order;
834
+ /** Whether the member has already reached purchase limit for the order's plan. */
835
+ purchaseLimitExceeded?: boolean;
818
836
  }
819
- interface PagingMetadataV2 {
820
- /** Number of items returned in the response. */
821
- count?: number | null;
822
- /** Offset that was requested. */
823
- offset?: number | null;
824
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
825
- total?: number | null;
826
- /** Flag that indicates the server failed to calculate the `total` field. */
827
- tooManyToCount?: boolean | null;
828
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
829
- cursors?: Cursors;
837
+ interface GetGuestOnlineOrderPreviewRequest {
830
838
  /**
831
- * Indicates if there are more results after the current page.
832
- * If `true`, another page of results can be retrieved.
833
- * If `false`, this is the last page.
834
- * @internal
839
+ * Plan ID.
840
+ * @format GUID
835
841
  */
836
- hasNext?: boolean | null;
837
- }
838
- interface Cursors {
842
+ planId?: string;
839
843
  /**
840
- * Cursor string pointing to the next page in the list of results.
841
- * @maxLength 16000
844
+ * Start date for the ordered plan.
845
+ *
846
+ * Default: Current date
842
847
  */
843
- next?: string | null;
848
+ startDate?: Date | null;
844
849
  /**
845
- * Cursor pointing to the previous page in the list of results.
846
- * @maxLength 16000
850
+ * Coupon code to apply.
851
+ * @minLength 1
852
+ * @maxLength 20
847
853
  */
848
- prev?: string | null;
849
- }
850
- interface GetOrdersStatsRequest {
854
+ couponCode?: string | null;
855
+ /**
856
+ * Email for checkout
857
+ * @format EMAIL
858
+ */
859
+ email?: string;
851
860
  }
852
- interface GetOrdersStatsResponse {
853
- /** Total number of orders. */
854
- totalOrderCount?: number;
855
- /** Number of active orders. */
856
- activeOrderCount?: number;
861
+ interface GetGuestOnlineOrderPreviewResponse {
862
+ /** Will be missing if limit is exceeded */
863
+ order?: Order;
864
+ /**
865
+ * Whether the purchase limit has already been reached for this plan by this email.
866
+ * Always false for plans without purchase limits.
867
+ */
868
+ purchaseLimitExceeded?: boolean;
857
869
  }
858
- interface GetAvailableOrderActionsRequest {
870
+ interface GetOfflineOrderPreviewRequest {
859
871
  /**
860
- * Order ID.
872
+ * ID of the plan of the previewed order, from the Plans API.
861
873
  * @format GUID
862
874
  */
863
- _id?: string;
864
- }
865
- interface GetAvailableOrderActionsResponse {
866
- /** Whether the order can be suspended. */
867
- suspendable?: boolean;
868
- /** If the order cannot be suspended, a reason is returned here. */
869
- notSuspendableReason?: ReasonNotSuspendableWithLiterals;
870
- /** Whether the order can be canceled by the buyer. */
871
- cancelableByBuyer?: boolean;
875
+ planId: string;
876
+ /**
877
+ * Member ID of the buyer the previewed order is for, from the Members API.
878
+ * @format GUID
879
+ */
880
+ memberId: string;
881
+ /**
882
+ * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
883
+ *
884
+ * Default: Current date and time.
885
+ */
886
+ startDate?: Date | null;
887
+ /**
888
+ * Coupon code to apply, from the Coupons API.
889
+ * @minLength 1
890
+ * @maxLength 20
891
+ */
892
+ couponCode?: string | null;
872
893
  }
873
- declare enum ReasonNotSuspendable {
874
- /** Undefined reason. */
875
- UNDEFINED = "UNDEFINED",
876
- /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
877
- PENDING = "PENDING",
878
- /** Trial orders can't be suspended. */
879
- TRIAL = "TRIAL",
880
- /** Canceled orders can't be suspended. */
881
- CANCELED = "CANCELED",
882
- /** Ended orders can't be suspended. */
883
- ENDED = "ENDED",
884
- /** Paid for orders with future start dates can't be suspended. */
885
- NOT_STARTED = "NOT_STARTED",
886
- /** Order is already suspended. */
887
- ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
888
- /** Orders based on recurring payments using older stripe versions can't be suspended. */
889
- OLD_STRIPE = "OLD_STRIPE"
894
+ interface GetOfflineOrderPreviewResponse {
895
+ /** The previewed order, as if the plan had been ordered. */
896
+ order?: Order;
897
+ /**
898
+ * Whether this previewed order would exceed the permitted amount of purchases available
899
+ * for this plan for this buyer.
900
+ *
901
+ * Always `false` for plans that do not have purchase limits.
902
+ */
903
+ purchaseLimitExceeded?: boolean;
890
904
  }
891
- /** @enumType */
892
- type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
893
- interface PostponeEndDateRequest {
905
+ interface GetPricePreviewRequest {
894
906
  /**
895
- * Order ID.
907
+ * ID of plan to preview.
896
908
  * @format GUID
897
909
  */
898
- _id: string;
910
+ planId: string;
899
911
  /**
900
- * New end date and time.
901
- *
902
- * Must be later than the current end date and time.
912
+ * Coupon code to apply, from the Coupons API.
913
+ * @minLength 1
914
+ * @maxLength 20
903
915
  */
904
- endDate: Date | null;
905
- }
906
- interface PostponeEndDateResponse {
907
- }
908
- interface OrderEndDatePostponed {
909
- /** Order whose `endDate` was postponed. */
910
- order?: Order;
916
+ couponCode?: string | null;
911
917
  }
912
- interface CancelOrderRequest {
918
+ interface GetPricePreviewResponse {
913
919
  /**
914
- * Order ID.
915
- * @format GUID
920
+ * @internal
921
+ * @internal
922
+ * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
923
+ * @replacedBy prices
924
+ * @targetRemovalDate 2022-10-01
916
925
  */
917
- _id: string;
918
- /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
919
- effectiveAt: CancellationEffectiveAtWithLiterals;
920
- }
921
- interface CancelOrderResponse {
922
- }
923
- /**
924
- * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
925
- *
926
- * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
927
- */
928
- interface OrderCanceled {
929
- /** Canceled order. */
930
- order?: Order;
926
+ price?: PriceDetails;
927
+ /** Pricing details. */
928
+ prices?: SpannedPrice[];
931
929
  }
932
- interface MarkAsPaidRequest {
930
+ interface ChangeStartDateRequest {
933
931
  /**
934
- * Order ID.
932
+ * Draft order ID.
935
933
  * @format GUID
936
934
  */
937
- _id: string;
935
+ orderId?: string;
936
+ /** New valid from date (timestamp). */
937
+ startDate?: Date | null;
938
938
  }
939
- interface MarkAsPaidResponse {
939
+ interface ChangeStartDateResponse {
940
+ /** Updated draft order. */
941
+ order?: Order;
940
942
  }
941
- interface OrderMarkedAsPaid {
942
- /** Order that was marked as paid. */
943
+ interface OrderStartDateChanged {
944
+ /** Order whose `startDate` changed. */
943
945
  order?: Order;
944
946
  }
945
- interface PauseOrderRequest {
947
+ interface ApplyCouponRequest {
946
948
  /**
947
- * Order ID.
949
+ * Draft order ID.
948
950
  * @format GUID
949
951
  */
950
- _id: string;
951
- }
952
- interface PauseOrderResponse {
953
- }
954
- interface OrderPaused {
955
- /** Paused order. */
956
- order?: Order;
957
- }
958
- interface BulkPauseOrderRequest {
952
+ orderId?: string;
959
953
  /**
960
- * List of Order IDs.
961
- * @format GUID
962
- * @minSize 1
963
- * @maxSize 100
954
+ * Coupon code to apply.
955
+ * @minLength 1
956
+ * @maxLength 20
964
957
  */
965
- ids?: string[];
966
- /** Set to true to return Order entity in response. */
967
- returnFullEntity?: boolean;
968
- }
969
- interface BulkPauseOrderResponse {
970
- /** Orders that were paused. */
971
- results?: BulkOrderResult[];
972
- /** Bulk action metadata. */
973
- bulkActionMetadata?: BulkActionMetadata;
958
+ couponCode?: string;
974
959
  }
975
- interface BulkOrderResult {
976
- /** Item metadata */
977
- itemMetadata?: ItemMetadata;
978
- /** The order. */
960
+ interface ApplyCouponResponse {
961
+ /** Order with applied coupon and recalculated tax. */
979
962
  order?: Order;
980
963
  }
981
- interface ItemMetadata {
982
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
983
- _id?: string | null;
984
- /** Index of the item within the request array. Allows for correlation between request and response items. */
985
- originalIndex?: number;
986
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
987
- success?: boolean;
988
- /** Details about the error in case of failure. */
989
- error?: ApplicationError;
990
- }
991
- interface ApplicationError {
992
- /** Error code. */
993
- code?: string;
994
- /** Description of the error. */
995
- description?: string;
996
- /** Data related to the error. */
997
- data?: Record<string, any> | null;
998
- }
999
- interface BulkActionMetadata {
1000
- /** Number of items that were successfully processed. */
1001
- totalSuccesses?: number;
1002
- /** Number of items that couldn't be processed. */
1003
- totalFailures?: number;
1004
- /** Number of failures without details because detailed failure threshold was exceeded. */
1005
- undetailedFailures?: number;
1006
- }
1007
- interface ResumeOrderRequest {
964
+ interface SetSubmissionRequest {
1008
965
  /**
1009
966
  * Order ID.
1010
967
  * @format GUID
1011
968
  */
1012
- _id: string;
1013
- }
1014
- interface ResumeOrderResponse {
1015
- }
1016
- interface OrderResumed {
1017
- /** Resumed order. */
1018
- order?: Order;
1019
- }
1020
- interface BulkResumeOrderRequest {
969
+ orderId?: string;
1021
970
  /**
1022
- * List of Order IDs.
971
+ * Submission ID.
1023
972
  * @format GUID
1024
- * @minSize 1
1025
- * @maxSize 100
1026
973
  */
1027
- ids?: string[];
1028
- /** Set to true to return Order entity in response. */
1029
- returnFullEntity?: boolean;
974
+ submissionId?: string;
1030
975
  }
1031
- interface BulkResumeOrderResponse {
1032
- /** Orders that were resumed. */
1033
- results?: BulkOrderResult[];
1034
- /** Bulk action metadata. */
1035
- bulkActionMetadata?: BulkActionMetadata;
976
+ interface SetSubmissionResponse {
977
+ /** Order with submission id */
978
+ order?: Order;
1036
979
  }
1037
980
  interface MessageEnvelope {
1038
981
  /**
@@ -1125,316 +1068,373 @@ interface AccountInfo {
1125
1068
  */
1126
1069
  siteId?: string | null;
1127
1070
  }
1128
- interface CreateOnlineOrderRequest {
1129
- /**
1130
- * Plan ID.
1131
- * @format GUID
1132
- */
1133
- planId: string;
1134
- /**
1135
- * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1136
- *
1137
- * Default: Current date and time.
1138
- */
1139
- startDate?: Date | null;
1140
- /**
1141
- * Coupon code to apply.
1142
- * @minLength 1
1143
- * @maxLength 20
1144
- */
1145
- couponCode?: string | null;
1146
- /** Provided if checkout is initiated on buyer's behalf. */
1147
- onBehalf?: OnBehalf;
1148
- /**
1149
- * Submission ID of the form submitted with this order.
1150
- * @format GUID
1151
- */
1152
- submissionId?: string | null;
1071
+ interface OrderPurchased {
1072
+ /** Order that was paid for. If a free or an offline order, the order that was created. */
1073
+ order?: Order;
1153
1074
  }
1154
- interface OnBehalf {
1155
- /**
1156
- * Member ID.
1157
- * @format GUID
1158
- */
1159
- memberId?: string;
1160
- /** Method by which checkout is initiated. */
1161
- orderMethod?: OrderMethodWithLiterals;
1075
+ interface OrderStarted {
1076
+ /** Order that reached its `startDate`. */
1077
+ order?: Order;
1162
1078
  }
1163
- interface CreateOnlineOrderResponse {
1164
- /** Created online order. */
1079
+ /**
1080
+ * Triggered at the start of a new payment cycle for an existing order.
1081
+ *
1082
+ * This webhook does not trigger at the initial start of an offline order.
1083
+ */
1084
+ interface OrderCycleStarted {
1085
+ /** Order whose new cycle started. */
1165
1086
  order?: Order;
1087
+ /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
1088
+ cycleNumber?: number;
1166
1089
  }
1167
- interface CouponsError {
1168
- /** Coupon code. */
1169
- couponCode?: string;
1170
- /** Plan ID. */
1171
- planId?: string;
1090
+ /** Emitted when a recurring order is canceled for the next payment cycle */
1091
+ interface OrderAutoRenewCanceled {
1092
+ /** Order that is canceled, effective at the end of the current payment cycle. */
1093
+ order?: Order;
1172
1094
  }
1173
- interface CreateGuestOnlineOrderRequest {
1095
+ interface OrderEnded {
1096
+ /** Order that ended. */
1097
+ order?: Order;
1098
+ }
1099
+ interface GetOrderRequest {
1174
1100
  /**
1175
- * Plan ID.
1101
+ * Order ID.
1176
1102
  * @format GUID
1177
1103
  */
1178
- planId?: string;
1104
+ _id: string;
1179
1105
  /**
1180
- * Start date for the ordered plan.
1106
+ * Predefined set of fields to return.
1181
1107
  *
1182
- * Default: Current date
1183
- */
1184
- startDate?: Date | null;
1185
- /**
1186
- * Coupon code to apply.
1187
- * @minLength 1
1188
- * @maxLength 20
1189
- */
1190
- couponCode?: string | null;
1191
- /** Captcha data to prove you are not a robot */
1192
- captcha?: Captcha;
1193
- /** Visitor info */
1194
- guest?: Guest;
1195
- /**
1196
- * Form submission id that was submitted together with the order
1197
- * @format GUID
1198
- */
1199
- submissionId?: string | null;
1200
- }
1201
- interface Captcha {
1202
- /** Token from captcha */
1203
- token?: string;
1204
- }
1205
- interface Guest {
1206
- /**
1207
- * Email for checkout
1208
- * @format EMAIL
1108
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1209
1109
  */
1210
- email?: string;
1110
+ fieldSet?: SetWithLiterals;
1211
1111
  }
1212
- interface CreateGuestOnlineOrderResponse {
1112
+ declare enum Set {
1113
+ /** Same behavior as `BASIC`.` */
1114
+ UNKNOWN_SET = "UNKNOWN_SET",
1115
+ /** Doesn't return any order form submission data. */
1116
+ BASIC = "BASIC",
1117
+ /** Returns all order form submission data. */
1118
+ FULL = "FULL"
1119
+ }
1120
+ /** @enumType */
1121
+ type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
1122
+ interface GetOrderResponse {
1213
1123
  /** Order. */
1214
1124
  order?: Order;
1215
1125
  }
1216
- interface CreateOfflineOrderRequest {
1126
+ interface ListOrdersRequest {
1217
1127
  /**
1218
- * ID of the plan being ordered, from the Plans API.
1128
+ * Filter by a buyer's member ID, from the Members API.
1219
1129
  * @format GUID
1220
1130
  */
1221
- planId: string;
1131
+ buyerIds?: string[];
1222
1132
  /**
1223
- * ID of the member ordering the plan, from the Members API.
1133
+ * Filter by plan IDs, from the Plans API.
1224
1134
  * @format GUID
1225
1135
  */
1226
- memberId: string;
1136
+ planIds?: string[];
1137
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
1138
+ autoRenewCanceled?: boolean | null;
1139
+ /** Filter by order status. */
1140
+ orderStatuses?: OrderStatusWithLiterals[];
1141
+ /** Filter by payment status. */
1142
+ paymentStatuses?: PaymentStatusWithLiterals[];
1227
1143
  /**
1228
- * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1144
+ * Number of orders to return. See Sorting and Paging for more information.
1229
1145
  *
1230
- * Default: Current date and time.
1146
+ * Max: `50`
1147
+ * @min 1
1148
+ * @max 50
1231
1149
  */
1232
- startDate?: Date | null;
1150
+ limit?: number | null;
1151
+ /** Number of orders to skip in the current sort order. */
1152
+ offset?: number | null;
1233
1153
  /**
1234
- * Whether the order is paid.
1154
+ * Sort order.
1235
1155
  *
1236
- * Default: `false`
1237
- */
1238
- paid?: boolean | null;
1239
- /**
1240
- * Coupon code to apply, from the Coupons API.
1241
- * @minLength 1
1242
- * @maxLength 20
1243
- */
1244
- couponCode?: string | null;
1245
- /**
1246
- * Form submission ID that was submitted with the order.
1247
- * @format GUID
1156
+ * Use `ASC` for ascending order or `DESC` for descending order.
1157
+ *
1158
+ * Default: `DESC`.
1248
1159
  */
1249
- submissionId?: string | null;
1250
- }
1251
- interface CreateOfflineOrderResponse {
1252
- /** Order. */
1253
- order?: Order;
1254
- }
1255
- interface CreateExternalOrderRequest {
1160
+ sorting?: Sorting;
1256
1161
  /**
1257
- * Plan ID.
1258
- * @format GUID
1162
+ * Predefined set of fields to return.
1163
+ *
1164
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1259
1165
  */
1260
- planId?: string;
1166
+ fieldSet?: SetWithLiterals;
1261
1167
  /**
1262
- * Form submission id that was submitted together with the order
1168
+ * Filter by order IDs.
1169
+ * @internal
1263
1170
  * @format GUID
1171
+ * @maxSize 50
1264
1172
  */
1265
- submissionId?: string | null;
1266
- }
1267
- interface CreateExternalOrderResponse {
1268
- /** Created order */
1269
- order?: Order;
1173
+ orderIds?: string[];
1270
1174
  }
1271
- interface GetOnlineOrderPreviewRequest {
1175
+ interface Sorting {
1272
1176
  /**
1273
- * Plan ID.
1274
- * @format GUID
1177
+ * Name of the field to sort by.
1178
+ * @maxLength 512
1275
1179
  */
1276
- planId: string;
1180
+ fieldName?: string;
1181
+ /** Sort order. */
1182
+ order?: SortOrderWithLiterals;
1277
1183
  /**
1278
- * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1184
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
1185
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
1279
1186
  *
1280
- * Default: Current date and time.
1187
+ * If multiple filters are provided, they are combined with AND operator.
1188
+ *
1189
+ * Example:
1190
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
1191
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
1192
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
1193
+ * @internal
1194
+ * @maxSize 10
1281
1195
  */
1282
- startDate?: Date | null;
1196
+ selectItemsBy?: Record<string, any>[] | null;
1283
1197
  /**
1284
- * Coupon code to apply.
1285
- * @minLength 1
1286
- * @maxLength 20
1198
+ * Origin point for geo-distance sorting on a GEO field
1199
+ * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
1287
1200
  */
1288
- couponCode?: string | null;
1201
+ origin?: AddressLocation;
1289
1202
  }
1290
- interface GetOnlineOrderPreviewResponse {
1291
- /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
1292
- order?: Order;
1293
- /** Whether the member has already reached purchase limit for the order's plan. */
1294
- purchaseLimitExceeded?: boolean;
1203
+ declare enum SortOrder {
1204
+ ASC = "ASC",
1205
+ DESC = "DESC"
1295
1206
  }
1296
- interface GetGuestOnlineOrderPreviewRequest {
1297
- /**
1298
- * Plan ID.
1299
- * @format GUID
1300
- */
1301
- planId?: string;
1207
+ /** @enumType */
1208
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1209
+ interface AddressLocation {
1210
+ /** Address latitude. */
1211
+ latitude?: number | null;
1212
+ /** Address longitude. */
1213
+ longitude?: number | null;
1214
+ }
1215
+ interface ListOrdersResponse {
1216
+ /** List of orders. */
1217
+ orders?: Order[];
1218
+ /** Object containing paging-related data (number of orders returned, offset). */
1219
+ pagingMetadata?: PagingMetadataV2;
1220
+ }
1221
+ interface PagingMetadataV2 {
1222
+ /** Number of items returned in the response. */
1223
+ count?: number | null;
1224
+ /** Offset that was requested. */
1225
+ offset?: number | null;
1226
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1227
+ total?: number | null;
1228
+ /** Flag that indicates the server failed to calculate the `total` field. */
1229
+ tooManyToCount?: boolean | null;
1230
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1231
+ cursors?: Cursors;
1302
1232
  /**
1303
- * Start date for the ordered plan.
1304
- *
1305
- * Default: Current date
1233
+ * Indicates if there are more results after the current page.
1234
+ * If `true`, another page of results can be retrieved.
1235
+ * If `false`, this is the last page.
1236
+ * @internal
1306
1237
  */
1307
- startDate?: Date | null;
1238
+ hasNext?: boolean | null;
1239
+ }
1240
+ interface Cursors {
1308
1241
  /**
1309
- * Coupon code to apply.
1310
- * @minLength 1
1311
- * @maxLength 20
1242
+ * Cursor string pointing to the next page in the list of results.
1243
+ * @maxLength 16000
1312
1244
  */
1313
- couponCode?: string | null;
1245
+ next?: string | null;
1314
1246
  /**
1315
- * Email for checkout
1316
- * @format EMAIL
1247
+ * Cursor pointing to the previous page in the list of results.
1248
+ * @maxLength 16000
1317
1249
  */
1318
- email?: string;
1250
+ prev?: string | null;
1319
1251
  }
1320
- interface GetGuestOnlineOrderPreviewResponse {
1321
- /** Will be missing if limit is exceeded */
1322
- order?: Order;
1323
- /**
1324
- * Whether the purchase limit has already been reached for this plan by this email.
1325
- * Always false for plans without purchase limits.
1326
- */
1327
- purchaseLimitExceeded?: boolean;
1252
+ interface GetOrdersStatsRequest {
1328
1253
  }
1329
- interface GetOfflineOrderPreviewRequest {
1254
+ interface GetOrdersStatsResponse {
1255
+ /** Total number of orders. */
1256
+ totalOrderCount?: number;
1257
+ /** Number of active orders. */
1258
+ activeOrderCount?: number;
1259
+ }
1260
+ interface GetAvailableOrderActionsRequest {
1330
1261
  /**
1331
- * ID of the plan of the previewed order, from the Plans API.
1262
+ * Order ID.
1332
1263
  * @format GUID
1333
1264
  */
1334
- planId: string;
1265
+ _id?: string;
1266
+ }
1267
+ interface GetAvailableOrderActionsResponse {
1268
+ /** Whether the order can be suspended. */
1269
+ suspendable?: boolean;
1270
+ /** If the order cannot be suspended, a reason is returned here. */
1271
+ notSuspendableReason?: ReasonNotSuspendableWithLiterals;
1272
+ /** Whether the order can be canceled by the buyer. */
1273
+ cancelableByBuyer?: boolean;
1274
+ }
1275
+ declare enum ReasonNotSuspendable {
1276
+ /** Undefined reason. */
1277
+ UNDEFINED = "UNDEFINED",
1278
+ /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
1279
+ PENDING = "PENDING",
1280
+ /** Trial orders can't be suspended. */
1281
+ TRIAL = "TRIAL",
1282
+ /** Canceled orders can't be suspended. */
1283
+ CANCELED = "CANCELED",
1284
+ /** Ended orders can't be suspended. */
1285
+ ENDED = "ENDED",
1286
+ /** Paid for orders with future start dates can't be suspended. */
1287
+ NOT_STARTED = "NOT_STARTED",
1288
+ /** Order is already suspended. */
1289
+ ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
1290
+ /** Orders based on recurring payments using older stripe versions can't be suspended. */
1291
+ OLD_STRIPE = "OLD_STRIPE"
1292
+ }
1293
+ /** @enumType */
1294
+ type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
1295
+ interface PostponeEndDateRequest {
1335
1296
  /**
1336
- * Member ID of the buyer the previewed order is for, from the Members API.
1297
+ * Order ID.
1337
1298
  * @format GUID
1338
1299
  */
1339
- memberId: string;
1300
+ _id: string;
1340
1301
  /**
1341
- * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1302
+ * New end date and time.
1342
1303
  *
1343
- * Default: Current date and time.
1344
- */
1345
- startDate?: Date | null;
1346
- /**
1347
- * Coupon code to apply, from the Coupons API.
1348
- * @minLength 1
1349
- * @maxLength 20
1304
+ * Must be later than the current end date and time.
1350
1305
  */
1351
- couponCode?: string | null;
1306
+ endDate: Date | null;
1352
1307
  }
1353
- interface GetOfflineOrderPreviewResponse {
1354
- /** The previewed order, as if the plan had been ordered. */
1308
+ interface PostponeEndDateResponse {
1309
+ }
1310
+ interface OrderEndDatePostponed {
1311
+ /** Order whose `endDate` was postponed. */
1355
1312
  order?: Order;
1356
- /**
1357
- * Whether this previewed order would exceed the permitted amount of purchases available
1358
- * for this plan for this buyer.
1359
- *
1360
- * Always `false` for plans that do not have purchase limits.
1361
- */
1362
- purchaseLimitExceeded?: boolean;
1363
1313
  }
1364
- interface GetPricePreviewRequest {
1314
+ interface CancelOrderRequest {
1365
1315
  /**
1366
- * ID of plan to preview.
1316
+ * Order ID.
1367
1317
  * @format GUID
1368
1318
  */
1369
- planId: string;
1370
- /**
1371
- * Coupon code to apply, from the Coupons API.
1372
- * @minLength 1
1373
- * @maxLength 20
1374
- */
1375
- couponCode?: string | null;
1319
+ _id: string;
1320
+ /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
1321
+ effectiveAt: CancellationEffectiveAtWithLiterals;
1376
1322
  }
1377
- interface GetPricePreviewResponse {
1378
- /**
1379
- * @internal
1380
- * @internal
1381
- * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
1382
- * @replacedBy prices
1383
- * @targetRemovalDate 2022-10-01
1384
- */
1385
- price?: PriceDetails;
1386
- /** Pricing details. */
1387
- prices?: SpannedPrice[];
1323
+ interface CancelOrderResponse {
1388
1324
  }
1389
- interface ChangeStartDateRequest {
1325
+ /**
1326
+ * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
1327
+ *
1328
+ * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
1329
+ */
1330
+ interface OrderCanceled {
1331
+ /** Canceled order. */
1332
+ order?: Order;
1333
+ }
1334
+ interface MarkAsPaidRequest {
1390
1335
  /**
1391
- * Draft order ID.
1336
+ * Order ID.
1392
1337
  * @format GUID
1393
1338
  */
1394
- orderId?: string;
1395
- /** New valid from date (timestamp). */
1396
- startDate?: Date | null;
1339
+ _id: string;
1397
1340
  }
1398
- interface ChangeStartDateResponse {
1399
- /** Updated draft order. */
1400
- order?: Order;
1341
+ interface MarkAsPaidResponse {
1401
1342
  }
1402
- interface OrderStartDateChanged {
1403
- /** Order whose `startDate` changed. */
1343
+ interface OrderMarkedAsPaid {
1344
+ /** Order that was marked as paid. */
1404
1345
  order?: Order;
1405
1346
  }
1406
- interface ApplyCouponRequest {
1347
+ interface PauseOrderRequest {
1407
1348
  /**
1408
- * Draft order ID.
1349
+ * Order ID.
1409
1350
  * @format GUID
1410
1351
  */
1411
- orderId?: string;
1352
+ _id: string;
1353
+ }
1354
+ interface PauseOrderResponse {
1355
+ }
1356
+ interface OrderPaused {
1357
+ /** Paused order. */
1358
+ order?: Order;
1359
+ }
1360
+ interface BulkPauseOrderRequest {
1412
1361
  /**
1413
- * Coupon code to apply.
1414
- * @minLength 1
1415
- * @maxLength 20
1362
+ * List of Order IDs.
1363
+ * @format GUID
1364
+ * @minSize 1
1365
+ * @maxSize 100
1416
1366
  */
1417
- couponCode?: string;
1367
+ ids?: string[];
1368
+ /** Set to true to return Order entity in response. */
1369
+ returnFullEntity?: boolean;
1418
1370
  }
1419
- interface ApplyCouponResponse {
1420
- /** Order with applied coupon and recalculated tax. */
1371
+ interface BulkPauseOrderResponse {
1372
+ /** Orders that were paused. */
1373
+ results?: BulkOrderResult[];
1374
+ /** Bulk action metadata. */
1375
+ bulkActionMetadata?: BulkActionMetadata;
1376
+ }
1377
+ interface BulkOrderResult {
1378
+ /** Item metadata */
1379
+ itemMetadata?: ItemMetadata;
1380
+ /** The order. */
1421
1381
  order?: Order;
1422
1382
  }
1423
- interface SetSubmissionRequest {
1383
+ interface ItemMetadata {
1384
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1385
+ _id?: string | null;
1386
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
1387
+ originalIndex?: number;
1388
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1389
+ success?: boolean;
1390
+ /** Details about the error in case of failure. */
1391
+ error?: ApplicationError;
1392
+ }
1393
+ interface ApplicationError {
1394
+ /** Error code. */
1395
+ code?: string;
1396
+ /** Description of the error. */
1397
+ description?: string;
1398
+ /** Data related to the error. */
1399
+ data?: Record<string, any> | null;
1400
+ }
1401
+ interface BulkActionMetadata {
1402
+ /** Number of items that were successfully processed. */
1403
+ totalSuccesses?: number;
1404
+ /** Number of items that couldn't be processed. */
1405
+ totalFailures?: number;
1406
+ /** Number of failures without details because detailed failure threshold was exceeded. */
1407
+ undetailedFailures?: number;
1408
+ }
1409
+ interface ResumeOrderRequest {
1424
1410
  /**
1425
1411
  * Order ID.
1426
1412
  * @format GUID
1427
1413
  */
1428
- orderId?: string;
1414
+ _id: string;
1415
+ }
1416
+ interface ResumeOrderResponse {
1417
+ }
1418
+ interface OrderResumed {
1419
+ /** Resumed order. */
1420
+ order?: Order;
1421
+ }
1422
+ interface BulkResumeOrderRequest {
1429
1423
  /**
1430
- * Submission ID.
1424
+ * List of Order IDs.
1431
1425
  * @format GUID
1426
+ * @minSize 1
1427
+ * @maxSize 100
1432
1428
  */
1433
- submissionId?: string;
1429
+ ids?: string[];
1430
+ /** Set to true to return Order entity in response. */
1431
+ returnFullEntity?: boolean;
1434
1432
  }
1435
- interface SetSubmissionResponse {
1436
- /** Order with submission id */
1437
- order?: Order;
1433
+ interface BulkResumeOrderResponse {
1434
+ /** Orders that were resumed. */
1435
+ results?: BulkOrderResult[];
1436
+ /** Bulk action metadata. */
1437
+ bulkActionMetadata?: BulkActionMetadata;
1438
1438
  }
1439
1439
  interface MemberGetOrderRequest {
1440
1440
  /**
@@ -1850,16 +1850,12 @@ interface AccountInfoMetadata {
1850
1850
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
1851
1851
  parentAccountId?: string;
1852
1852
  }
1853
- interface OrderAutoRenewCanceledEnvelope {
1854
- data: OrderAutoRenewCanceled;
1853
+ interface OrderCreatedEnvelope {
1854
+ entity: Order;
1855
1855
  metadata: EventMetadata;
1856
1856
  }
1857
1857
  /**
1858
- * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1859
- *
1860
- * This webhook is *not* triggered in the following scenarios:
1861
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1862
- * + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
1858
+ * Triggered when an order is created.
1863
1859
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1864
1860
  * @permissionScopeId SCOPE.RENTALS.MANAGE
1865
1861
  * @permissionScope Manage Orders
@@ -1872,21 +1868,17 @@ interface OrderAutoRenewCanceledEnvelope {
1872
1868
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1873
1869
  * @permissionId PRICING_PLANS.READ_ORDERS
1874
1870
  * @webhook
1875
- * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1876
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1877
- * @slug auto_renew_canceled
1871
+ * @eventType wix.pricing_plans.v2.order_created
1872
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1873
+ * @slug created
1878
1874
  */
1879
- declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1880
- interface OrderCanceledEnvelope {
1881
- data: OrderCanceled;
1875
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
1876
+ interface OrderStartDateChangedEnvelope {
1877
+ data: OrderStartDateChanged;
1882
1878
  metadata: EventMetadata;
1883
1879
  }
1884
1880
  /**
1885
- * Triggered when an order is canceled.
1886
- *
1887
- * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
1888
- * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
1889
- * + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
1881
+ * Triggered when an order's `startDate` is changed.
1890
1882
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1891
1883
  * @permissionScopeId SCOPE.RENTALS.MANAGE
1892
1884
  * @permissionScope Manage Orders
@@ -1899,42 +1891,25 @@ interface OrderCanceledEnvelope {
1899
1891
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1900
1892
  * @permissionId PRICING_PLANS.READ_ORDERS
1901
1893
  * @webhook
1902
- * @eventType wix.pricing_plans.v2.order_canceled
1903
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1904
- * @slug canceled
1894
+ * @eventType wix.pricing_plans.v2.order_start_date_changed
1895
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1896
+ * @slug start_date_changed
1905
1897
  */
1906
- declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1907
- interface OrderCycleStartedEnvelope {
1908
- data: OrderCycleStarted;
1898
+ declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
1899
+ interface OrderUpdatedEnvelope {
1900
+ entity: Order;
1909
1901
  metadata: EventMetadata;
1910
1902
  }
1911
1903
  /**
1912
- * Triggered at the start of a new payment cycle for an existing order.
1904
+ * Triggered for any of the following update events:
1913
1905
  *
1914
- * Not triggered at the initial start of an offline order.
1915
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1916
- * @permissionScopeId SCOPE.RENTALS.MANAGE
1917
- * @permissionScope Manage Orders
1918
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1919
- * @permissionScope Read Orders
1920
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1921
- * @permissionScope Manage plans and orders of Pricing Plans
1922
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1923
- * @permissionScope Manage Events
1924
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1925
- * @permissionId PRICING_PLANS.READ_ORDERS
1926
- * @webhook
1927
- * @eventType wix.pricing_plans.v2.order_cycle_started
1928
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1929
- * @slug cycle_started
1930
- */
1931
- declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1932
- interface OrderEndDatePostponedEnvelope {
1933
- data: OrderEndDatePostponed;
1934
- metadata: EventMetadata;
1935
- }
1936
- /**
1937
- * Triggered when an order's `endDate` is postponed.
1906
+ * + Order is paid for. Order Purchased is also triggered.
1907
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
1908
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
1909
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
1910
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
1911
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
1912
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
1938
1913
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1939
1914
  * @permissionScopeId SCOPE.RENTALS.MANAGE
1940
1915
  * @permissionScope Manage Orders
@@ -1947,44 +1922,21 @@ interface OrderEndDatePostponedEnvelope {
1947
1922
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1948
1923
  * @permissionId PRICING_PLANS.READ_ORDERS
1949
1924
  * @webhook
1950
- * @eventType wix.pricing_plans.v2.order_end_date_postponed
1951
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1952
- * @slug end_date_postponed
1925
+ * @eventType wix.pricing_plans.v2.order_updated
1926
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1927
+ * @slug updated
1953
1928
  */
1954
- declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
1955
- interface OrderEndedEnvelope {
1956
- data: OrderEnded;
1929
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
1930
+ interface OrderAutoRenewCanceledEnvelope {
1931
+ data: OrderAutoRenewCanceled;
1957
1932
  metadata: EventMetadata;
1958
1933
  }
1959
1934
  /**
1960
- * Triggered when an order ends.
1935
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1961
1936
  *
1962
- * This webhook is triggered:
1963
- * + When an order expires at the end of the current payment cycle.
1964
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
1965
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1966
- * @permissionScopeId SCOPE.RENTALS.MANAGE
1967
- * @permissionScope Manage Orders
1968
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1969
- * @permissionScope Read Orders
1970
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1971
- * @permissionScope Manage plans and orders of Pricing Plans
1972
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1973
- * @permissionScope Manage Events
1974
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1975
- * @permissionId PRICING_PLANS.READ_ORDERS
1976
- * @webhook
1977
- * @eventType wix.pricing_plans.v2.order_ended
1978
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1979
- * @slug ended
1980
- */
1981
- declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
1982
- interface OrderMarkedAsPaidEnvelope {
1983
- data: OrderMarkedAsPaid;
1984
- metadata: EventMetadata;
1985
- }
1986
- /**
1987
- * Triggered when an offline order is marked as paid.
1937
+ * This webhook is *not* triggered in the following scenarios:
1938
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1939
+ * + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
1988
1940
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1989
1941
  * @permissionScopeId SCOPE.RENTALS.MANAGE
1990
1942
  * @permissionScope Manage Orders
@@ -1997,17 +1949,21 @@ interface OrderMarkedAsPaidEnvelope {
1997
1949
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1998
1950
  * @permissionId PRICING_PLANS.READ_ORDERS
1999
1951
  * @webhook
2000
- * @eventType wix.pricing_plans.v2.order_marked_as_paid
1952
+ * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
2001
1953
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2002
- * @slug marked_as_paid
1954
+ * @slug auto_renew_canceled
2003
1955
  */
2004
- declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
2005
- interface OrderPausedEnvelope {
2006
- data: OrderPaused;
1956
+ declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1957
+ interface OrderCanceledEnvelope {
1958
+ data: OrderCanceled;
2007
1959
  metadata: EventMetadata;
2008
1960
  }
2009
1961
  /**
2010
- * Triggered when an order is paused.
1962
+ * Triggered when an order is canceled.
1963
+ *
1964
+ * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
1965
+ * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
1966
+ * + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
2011
1967
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2012
1968
  * @permissionScopeId SCOPE.RENTALS.MANAGE
2013
1969
  * @permissionScope Manage Orders
@@ -2020,21 +1976,19 @@ interface OrderPausedEnvelope {
2020
1976
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2021
1977
  * @permissionId PRICING_PLANS.READ_ORDERS
2022
1978
  * @webhook
2023
- * @eventType wix.pricing_plans.v2.order_paused
1979
+ * @eventType wix.pricing_plans.v2.order_canceled
2024
1980
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2025
- * @slug paused
1981
+ * @slug canceled
2026
1982
  */
2027
- declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2028
- interface OrderPurchasedEnvelope {
2029
- data: OrderPurchased;
1983
+ declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1984
+ interface OrderCycleStartedEnvelope {
1985
+ data: OrderCycleStarted;
2030
1986
  metadata: EventMetadata;
2031
1987
  }
2032
1988
  /**
2033
- * Triggered for any of the following purchase events:
2034
- * + Order is paid in full.
2035
- * + At least 1 order cycle payment is paid for.
2036
- * + Offline order is created, even if not yet marked as paid.
2037
- * + Free order is created.
1989
+ * Triggered at the start of a new payment cycle for an existing order.
1990
+ *
1991
+ * Not triggered at the initial start of an offline order.
2038
1992
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2039
1993
  * @permissionScopeId SCOPE.RENTALS.MANAGE
2040
1994
  * @permissionScope Manage Orders
@@ -2047,17 +2001,17 @@ interface OrderPurchasedEnvelope {
2047
2001
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2048
2002
  * @permissionId PRICING_PLANS.READ_ORDERS
2049
2003
  * @webhook
2050
- * @eventType wix.pricing_plans.v2.order_purchased
2004
+ * @eventType wix.pricing_plans.v2.order_cycle_started
2051
2005
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2052
- * @slug purchased
2006
+ * @slug cycle_started
2053
2007
  */
2054
- declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2055
- interface OrderResumedEnvelope {
2056
- data: OrderResumed;
2008
+ declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
2009
+ interface OrderEndDatePostponedEnvelope {
2010
+ data: OrderEndDatePostponed;
2057
2011
  metadata: EventMetadata;
2058
2012
  }
2059
2013
  /**
2060
- * Triggered when a paused order is resumed.
2014
+ * Triggered when an order's `endDate` is postponed.
2061
2015
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2062
2016
  * @permissionScopeId SCOPE.RENTALS.MANAGE
2063
2017
  * @permissionScope Manage Orders
@@ -2070,17 +2024,21 @@ interface OrderResumedEnvelope {
2070
2024
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2071
2025
  * @permissionId PRICING_PLANS.READ_ORDERS
2072
2026
  * @webhook
2073
- * @eventType wix.pricing_plans.v2.order_resumed
2027
+ * @eventType wix.pricing_plans.v2.order_end_date_postponed
2074
2028
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2075
- * @slug resumed
2029
+ * @slug end_date_postponed
2076
2030
  */
2077
- declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2078
- interface OrderStartedEnvelope {
2079
- data: OrderStarted;
2031
+ declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
2032
+ interface OrderEndedEnvelope {
2033
+ data: OrderEnded;
2080
2034
  metadata: EventMetadata;
2081
2035
  }
2082
2036
  /**
2083
- * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2037
+ * Triggered when an order ends.
2038
+ *
2039
+ * This webhook is triggered:
2040
+ * + When an order expires at the end of the current payment cycle.
2041
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
2084
2042
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2085
2043
  * @permissionScopeId SCOPE.RENTALS.MANAGE
2086
2044
  * @permissionScope Manage Orders
@@ -2093,25 +2051,17 @@ interface OrderStartedEnvelope {
2093
2051
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2094
2052
  * @permissionId PRICING_PLANS.READ_ORDERS
2095
2053
  * @webhook
2096
- * @eventType wix.pricing_plans.v2.order_started
2054
+ * @eventType wix.pricing_plans.v2.order_ended
2097
2055
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2098
- * @slug started
2056
+ * @slug ended
2099
2057
  */
2100
- declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2101
- interface OrderUpdatedEnvelope {
2102
- entity: Order;
2058
+ declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
2059
+ interface OrderMarkedAsPaidEnvelope {
2060
+ data: OrderMarkedAsPaid;
2103
2061
  metadata: EventMetadata;
2104
2062
  }
2105
2063
  /**
2106
- * Triggered for any of the following update events:
2107
- *
2108
- * + Order is paid for. Order Purchased is also triggered.
2109
- * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
2110
- * + New payment cycle of an order starts. Order Cycle Started is also triggered.
2111
- * + Offline order is marked as paid. Order Marked As Paid is also triggered.
2112
- * + End date of the order is postponed. Order End Date Postponed is also triggered
2113
- * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
2114
- * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
2064
+ * Triggered when an offline order is marked as paid.
2115
2065
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2116
2066
  * @permissionScopeId SCOPE.RENTALS.MANAGE
2117
2067
  * @permissionScope Manage Orders
@@ -2124,17 +2074,17 @@ interface OrderUpdatedEnvelope {
2124
2074
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2125
2075
  * @permissionId PRICING_PLANS.READ_ORDERS
2126
2076
  * @webhook
2127
- * @eventType wix.pricing_plans.v2.order_updated
2077
+ * @eventType wix.pricing_plans.v2.order_marked_as_paid
2128
2078
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2129
- * @slug updated
2079
+ * @slug marked_as_paid
2130
2080
  */
2131
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2132
- interface OrderCreatedEnvelope {
2133
- entity: Order;
2081
+ declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
2082
+ interface OrderPausedEnvelope {
2083
+ data: OrderPaused;
2134
2084
  metadata: EventMetadata;
2135
2085
  }
2136
2086
  /**
2137
- * Triggered when an order is created.
2087
+ * Triggered when an order is paused.
2138
2088
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2139
2089
  * @permissionScopeId SCOPE.RENTALS.MANAGE
2140
2090
  * @permissionScope Manage Orders
@@ -2147,17 +2097,21 @@ interface OrderCreatedEnvelope {
2147
2097
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2148
2098
  * @permissionId PRICING_PLANS.READ_ORDERS
2149
2099
  * @webhook
2150
- * @eventType wix.pricing_plans.v2.order_created
2151
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2152
- * @slug created
2100
+ * @eventType wix.pricing_plans.v2.order_paused
2101
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2102
+ * @slug paused
2153
2103
  */
2154
- declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
2155
- interface OrderStartDateChangedEnvelope {
2156
- data: OrderStartDateChanged;
2104
+ declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2105
+ interface OrderPurchasedEnvelope {
2106
+ data: OrderPurchased;
2157
2107
  metadata: EventMetadata;
2158
2108
  }
2159
2109
  /**
2160
- * Triggered when an order's `startDate` is changed.
2110
+ * Triggered for any of the following purchase events:
2111
+ * + Order is paid in full.
2112
+ * + At least 1 order cycle payment is paid for.
2113
+ * + Offline order is created, even if not yet marked as paid.
2114
+ * + Free order is created.
2161
2115
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2162
2116
  * @permissionScopeId SCOPE.RENTALS.MANAGE
2163
2117
  * @permissionScope Manage Orders
@@ -2167,188 +2121,60 @@ interface OrderStartDateChangedEnvelope {
2167
2121
  * @permissionScope Manage plans and orders of Pricing Plans
2168
2122
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2169
2123
  * @permissionScope Manage Events
2170
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2171
- * @permissionId PRICING_PLANS.READ_ORDERS
2172
- * @webhook
2173
- * @eventType wix.pricing_plans.v2.order_start_date_changed
2174
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2175
- * @slug start_date_changed
2176
- */
2177
- declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
2178
- /**
2179
- * Retrieves an order by ID.
2180
- * @param _id - Order ID.
2181
- * @public
2182
- * @requiredField _id
2183
- * @param options - Options to use when getting an order.
2184
- * @permissionId PRICING_PLANS.READ_ORDERS
2185
- * @applicableIdentity APP
2186
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2187
- */
2188
- declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
2189
- interface ManagementGetOrderOptions {
2190
- /**
2191
- * Predefined set of fields to return.
2192
- *
2193
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2194
- */
2195
- fieldSet?: SetWithLiterals;
2196
- }
2197
- /**
2198
- * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2199
- *
2200
- * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2201
- * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2202
- * @public
2203
- * @param options - Filtering, sorting, and pagination options.
2204
- * @permissionId PRICING_PLANS.READ_ORDERS
2205
- * @applicableIdentity APP
2206
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2207
- */
2208
- declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
2209
- interface ManagementListOrdersOptions {
2210
- /**
2211
- * Filter by a buyer's member ID, from the Members API.
2212
- * @format GUID
2213
- */
2214
- buyerIds?: string[];
2215
- /**
2216
- * Filter by plan IDs, from the Plans API.
2217
- * @format GUID
2218
- */
2219
- planIds?: string[];
2220
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2221
- autoRenewCanceled?: boolean | null;
2222
- /** Filter by order status. */
2223
- orderStatuses?: OrderStatusWithLiterals[];
2224
- /** Filter by payment status. */
2225
- paymentStatuses?: PaymentStatusWithLiterals[];
2226
- /**
2227
- * Number of orders to return. See Sorting and Paging for more information.
2228
- *
2229
- * Max: `50`
2230
- * @min 1
2231
- * @max 50
2232
- */
2233
- limit?: number | null;
2234
- /** Number of orders to skip in the current sort order. */
2235
- offset?: number | null;
2236
- /**
2237
- * Sort order.
2238
- *
2239
- * Use `ASC` for ascending order or `DESC` for descending order.
2240
- *
2241
- * Default: `DESC`.
2242
- */
2243
- sorting?: Sorting;
2244
- /**
2245
- * Predefined set of fields to return.
2246
- *
2247
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2248
- */
2249
- fieldSet?: SetWithLiterals;
2250
- }
2251
- /**
2252
- * Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
2253
- *
2254
- * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2255
- * Can't postpone an order with `status`: `PAUSED`.
2256
- * @param _id - Order ID.
2257
- * @param endDate - New end date and time.
2258
- *
2259
- * Must be later than the current end date and time.
2260
- * @public
2261
- * @requiredField _id
2262
- * @requiredField endDate
2263
- * @param options - Options for postponing the end date of an order.
2264
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2265
- * @applicableIdentity APP
2266
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2267
- */
2268
- declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2269
- /**
2270
- * Cancels an existing order.
2271
- *
2272
- * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2273
- * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2274
- *
2275
- * #### Canceling during the free trial period.
2276
- *
2277
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2278
- * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2279
- * of the free trial period.
2280
- *
2281
- * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2282
- * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2283
- * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2284
- * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2285
- * Then, the subscription ends and the buyer is not billed.
2286
- * @param _id - Order ID.
2287
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2288
- * @public
2289
- * @requiredField _id
2290
- * @requiredField effectiveAt
2291
- * @param options - Options for canceling orders.
2292
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2293
- * @applicableIdentity APP
2294
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2295
- */
2296
- declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2297
- /**
2298
- * Marks an offline order as paid.
2299
- * > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
2300
- *
2301
- * Marking an offline order as paid causes the following changes:
2302
- * - The order's `lastPaymentStatus` changes to `"PAID"`.
2303
- * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2304
- *
2305
- * An error occurs if you attempt to:
2306
- * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2307
- * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2308
- * @param _id - Order ID.
2309
- * @public
2310
- * @requiredField _id
2311
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2312
- * @applicableIdentity APP
2313
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2124
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2125
+ * @permissionId PRICING_PLANS.READ_ORDERS
2126
+ * @webhook
2127
+ * @eventType wix.pricing_plans.v2.order_purchased
2128
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2129
+ * @slug purchased
2314
2130
  */
2315
- declare function markAsPaid(_id: string): Promise<void>;
2131
+ declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2132
+ interface OrderResumedEnvelope {
2133
+ data: OrderResumed;
2134
+ metadata: EventMetadata;
2135
+ }
2316
2136
  /**
2317
- * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2318
- *
2319
- * Only orders with `status`: `ACTIVE` can be paused.
2320
- * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2321
- * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2322
- * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2323
- *
2324
- * To resume a paused order, call Resume Order.
2325
- * @param _id - Order ID.
2326
- * @public
2327
- * @requiredField _id
2328
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2329
- * @applicableIdentity APP
2330
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2137
+ * Triggered when a paused order is resumed.
2138
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2139
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
2140
+ * @permissionScope Manage Orders
2141
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2142
+ * @permissionScope Read Orders
2143
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2144
+ * @permissionScope Manage plans and orders of Pricing Plans
2145
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2146
+ * @permissionScope Manage Events
2147
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2148
+ * @permissionId PRICING_PLANS.READ_ORDERS
2149
+ * @webhook
2150
+ * @eventType wix.pricing_plans.v2.order_resumed
2151
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2152
+ * @slug resumed
2331
2153
  */
2332
- declare function pauseOrder(_id: string): Promise<void>;
2154
+ declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2155
+ interface OrderStartedEnvelope {
2156
+ data: OrderStarted;
2157
+ metadata: EventMetadata;
2158
+ }
2333
2159
  /**
2334
- * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2335
- *
2336
- * Resuming an order causes the following changes:
2337
- * - The order status changes to `"ACTIVE"`.
2338
- * - The `pausePeriods` array is updated.
2339
- * - The `endDate` for the order is adjusted to include the pause period.
2340
- * - For orders with recurring payments, the payment schedule is restarted.
2341
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2342
- *
2343
- * To pause an order, call Pause Order.
2344
- * @param _id - Order ID.
2345
- * @public
2346
- * @requiredField _id
2347
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2348
- * @applicableIdentity APP
2349
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2160
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2161
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2162
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
2163
+ * @permissionScope Manage Orders
2164
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2165
+ * @permissionScope Read Orders
2166
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2167
+ * @permissionScope Manage plans and orders of Pricing Plans
2168
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2169
+ * @permissionScope Manage Events
2170
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2171
+ * @permissionId PRICING_PLANS.READ_ORDERS
2172
+ * @webhook
2173
+ * @eventType wix.pricing_plans.v2.order_started
2174
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2175
+ * @slug started
2350
2176
  */
2351
- declare function resumeOrder(_id: string): Promise<void>;
2177
+ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2352
2178
  /**
2353
2179
  * Creates an online order for a site member.
2354
2180
  *
@@ -2543,6 +2369,180 @@ interface GetPricePreviewOptions {
2543
2369
  */
2544
2370
  couponCode?: string | null;
2545
2371
  }
2372
+ /**
2373
+ * Retrieves an order by ID.
2374
+ * @param _id - Order ID.
2375
+ * @public
2376
+ * @requiredField _id
2377
+ * @param options - Options to use when getting an order.
2378
+ * @permissionId PRICING_PLANS.READ_ORDERS
2379
+ * @applicableIdentity APP
2380
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2381
+ */
2382
+ declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
2383
+ interface ManagementGetOrderOptions {
2384
+ /**
2385
+ * Predefined set of fields to return.
2386
+ *
2387
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2388
+ */
2389
+ fieldSet?: SetWithLiterals;
2390
+ }
2391
+ /**
2392
+ * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2393
+ *
2394
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2395
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2396
+ * @public
2397
+ * @param options - Filtering, sorting, and pagination options.
2398
+ * @permissionId PRICING_PLANS.READ_ORDERS
2399
+ * @applicableIdentity APP
2400
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2401
+ */
2402
+ declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
2403
+ interface ManagementListOrdersOptions {
2404
+ /**
2405
+ * Filter by a buyer's member ID, from the Members API.
2406
+ * @format GUID
2407
+ */
2408
+ buyerIds?: string[];
2409
+ /**
2410
+ * Filter by plan IDs, from the Plans API.
2411
+ * @format GUID
2412
+ */
2413
+ planIds?: string[];
2414
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2415
+ autoRenewCanceled?: boolean | null;
2416
+ /** Filter by order status. */
2417
+ orderStatuses?: OrderStatusWithLiterals[];
2418
+ /** Filter by payment status. */
2419
+ paymentStatuses?: PaymentStatusWithLiterals[];
2420
+ /**
2421
+ * Number of orders to return. See Sorting and Paging for more information.
2422
+ *
2423
+ * Max: `50`
2424
+ * @min 1
2425
+ * @max 50
2426
+ */
2427
+ limit?: number | null;
2428
+ /** Number of orders to skip in the current sort order. */
2429
+ offset?: number | null;
2430
+ /**
2431
+ * Sort order.
2432
+ *
2433
+ * Use `ASC` for ascending order or `DESC` for descending order.
2434
+ *
2435
+ * Default: `DESC`.
2436
+ */
2437
+ sorting?: Sorting;
2438
+ /**
2439
+ * Predefined set of fields to return.
2440
+ *
2441
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2442
+ */
2443
+ fieldSet?: SetWithLiterals;
2444
+ }
2445
+ /**
2446
+ * Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
2447
+ *
2448
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2449
+ * Can't postpone an order with `status`: `PAUSED`.
2450
+ * @param _id - Order ID.
2451
+ * @param endDate - New end date and time.
2452
+ *
2453
+ * Must be later than the current end date and time.
2454
+ * @public
2455
+ * @requiredField _id
2456
+ * @requiredField endDate
2457
+ * @param options - Options for postponing the end date of an order.
2458
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2459
+ * @applicableIdentity APP
2460
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2461
+ */
2462
+ declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2463
+ /**
2464
+ * Cancels an existing order.
2465
+ *
2466
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2467
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2468
+ *
2469
+ * #### Canceling during the free trial period.
2470
+ *
2471
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2472
+ * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2473
+ * of the free trial period.
2474
+ *
2475
+ * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2476
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2477
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2478
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2479
+ * Then, the subscription ends and the buyer is not billed.
2480
+ * @param _id - Order ID.
2481
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2482
+ * @public
2483
+ * @requiredField _id
2484
+ * @requiredField effectiveAt
2485
+ * @param options - Options for canceling orders.
2486
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2487
+ * @applicableIdentity APP
2488
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2489
+ */
2490
+ declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2491
+ /**
2492
+ * Marks an offline order as paid.
2493
+ * > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
2494
+ *
2495
+ * Marking an offline order as paid causes the following changes:
2496
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2497
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2498
+ *
2499
+ * An error occurs if you attempt to:
2500
+ * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2501
+ * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2502
+ * @param _id - Order ID.
2503
+ * @public
2504
+ * @requiredField _id
2505
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2506
+ * @applicableIdentity APP
2507
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2508
+ */
2509
+ declare function markAsPaid(_id: string): Promise<void>;
2510
+ /**
2511
+ * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2512
+ *
2513
+ * Only orders with `status`: `ACTIVE` can be paused.
2514
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2515
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2516
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2517
+ *
2518
+ * To resume a paused order, call Resume Order.
2519
+ * @param _id - Order ID.
2520
+ * @public
2521
+ * @requiredField _id
2522
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2523
+ * @applicableIdentity APP
2524
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2525
+ */
2526
+ declare function pauseOrder(_id: string): Promise<void>;
2527
+ /**
2528
+ * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2529
+ *
2530
+ * Resuming an order causes the following changes:
2531
+ * - The order status changes to `"ACTIVE"`.
2532
+ * - The `pausePeriods` array is updated.
2533
+ * - The `endDate` for the order is adjusted to include the pause period.
2534
+ * - For orders with recurring payments, the payment schedule is restarted.
2535
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2536
+ *
2537
+ * To pause an order, call Pause Order.
2538
+ * @param _id - Order ID.
2539
+ * @public
2540
+ * @requiredField _id
2541
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2542
+ * @applicableIdentity APP
2543
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2544
+ */
2545
+ declare function resumeOrder(_id: string): Promise<void>;
2546
2546
  /**
2547
2547
  * Retrieves an order for the currently logged-in member by ID.
2548
2548
  * @param _id - Order ID.