@wix/auto_sdk_pricing-plans_orders 1.0.143 → 1.0.145

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.
@@ -626,314 +626,345 @@ interface ActionEvent {
626
626
  }
627
627
  interface Empty {
628
628
  }
629
- interface CreateOnlineOrderRequest {
630
- /**
631
- * Plan ID.
632
- * @format GUID
633
- */
634
- planId: string;
635
- /**
636
- * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
637
- *
638
- * Default: Current date and time.
639
- */
640
- startDate?: Date | null;
641
- /**
642
- * Coupon code to apply.
643
- * @minLength 1
644
- * @maxLength 20
645
- */
646
- couponCode?: string | null;
647
- /** Provided if checkout is initiated on buyer's behalf. */
648
- onBehalf?: OnBehalf;
649
- /**
650
- * Submission ID of the form submitted with this order.
651
- *
652
- * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
653
- * An invalid submission ID is dropped and the order is created without a submission.
654
- * @format GUID
655
- */
656
- submissionId?: string | null;
629
+ interface OrderPurchased {
630
+ /** Order that was paid for. If a free or an offline order, the order that was created. */
631
+ order?: Order;
657
632
  }
658
- interface OnBehalf {
659
- /**
660
- * Member ID.
661
- * @format GUID
662
- */
663
- memberId?: string;
664
- /** Method by which checkout is initiated. */
665
- orderMethod?: OrderMethodWithLiterals;
633
+ interface OrderStarted {
634
+ /** Order that reached its `startDate`. */
635
+ order?: Order;
666
636
  }
667
- interface CreateOnlineOrderResponse {
668
- /** Created online order. */
637
+ /**
638
+ * Triggered at the start of a new payment cycle for an existing order.
639
+ *
640
+ * This webhook does not trigger at the initial start of an offline order.
641
+ */
642
+ interface OrderCycleStarted {
643
+ /** Order whose new cycle started. */
669
644
  order?: Order;
645
+ /** 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. */
646
+ cycleNumber?: number;
670
647
  }
671
- interface CouponsError {
672
- /** Coupon code. */
673
- couponCode?: string;
674
- /** Plan ID. */
675
- planId?: string;
648
+ /** Emitted when a recurring order is canceled for the next payment cycle */
649
+ interface OrderAutoRenewCanceled {
650
+ /** Order that is canceled, effective at the end of the current payment cycle. */
651
+ order?: Order;
676
652
  }
677
- interface CreateGuestOnlineOrderRequest {
653
+ interface OrderEnded {
654
+ /** Order that ended. */
655
+ order?: Order;
656
+ }
657
+ interface GetOrderRequest {
678
658
  /**
679
- * Plan ID.
659
+ * Order ID.
680
660
  * @format GUID
681
661
  */
682
- planId?: string;
662
+ _id: string;
683
663
  /**
684
- * Start date for the ordered plan.
664
+ * Predefined set of fields to return.
685
665
  *
686
- * Default: Current date
687
- */
688
- startDate?: Date | null;
689
- /**
690
- * Coupon code to apply.
691
- * @minLength 1
692
- * @maxLength 20
693
- */
694
- couponCode?: string | null;
695
- /** Captcha data to prove you are not a robot */
696
- captcha?: Captcha;
697
- /** Visitor info */
698
- guest?: Guest;
699
- /**
700
- * Form submission id that was submitted together with the order
701
- * @format GUID
666
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
702
667
  */
703
- submissionId?: string | null;
704
- }
705
- interface Captcha {
706
- /** Token from captcha */
707
- token?: string;
668
+ fieldSet?: SetWithLiterals;
708
669
  }
709
- interface Guest {
710
- /**
711
- * Email for checkout
712
- * @format EMAIL
713
- */
714
- email?: string;
670
+ declare enum Set {
671
+ /** Same behavior as `BASIC`.` */
672
+ UNKNOWN_SET = "UNKNOWN_SET",
673
+ /** Doesn't return any order form submission data. */
674
+ BASIC = "BASIC",
675
+ /** Returns all order form submission data. */
676
+ FULL = "FULL"
715
677
  }
716
- interface CreateGuestOnlineOrderResponse {
678
+ /** @enumType */
679
+ type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
680
+ interface GetOrderResponse {
717
681
  /** Order. */
718
682
  order?: Order;
719
683
  }
720
- interface CreateOfflineOrderRequest {
684
+ interface ListOrdersRequest {
721
685
  /**
722
- * ID of the plan being ordered, from the Plans API.
686
+ * Filter by a buyer's member ID, from the Members API.
723
687
  * @format GUID
724
688
  */
725
- planId: string;
689
+ buyerIds?: string[];
726
690
  /**
727
- * ID of the member ordering the plan, from the Members API.
691
+ * Filter by plan IDs, from the Plans API.
728
692
  * @format GUID
729
693
  */
730
- memberId: string;
694
+ planIds?: string[];
695
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
696
+ autoRenewCanceled?: boolean | null;
697
+ /** Filter by order status. */
698
+ orderStatuses?: OrderStatusWithLiterals[];
699
+ /** Filter by payment status. */
700
+ paymentStatuses?: PaymentStatusWithLiterals[];
731
701
  /**
732
- * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
702
+ * Number of orders to return. See Sorting and Paging for more information.
733
703
  *
734
- * Default: Current date and time.
704
+ * Max: `50`
705
+ * @min 1
706
+ * @max 50
735
707
  */
736
- startDate?: Date | null;
708
+ limit?: number | null;
709
+ /** Number of orders to skip in the current sort order. */
710
+ offset?: number | null;
737
711
  /**
738
- * Whether the order is paid.
712
+ * Sort order.
739
713
  *
740
- * Default: `false`
741
- */
742
- paid?: boolean | null;
743
- /**
744
- * Coupon code to apply, from the Coupons API.
745
- * @minLength 1
746
- * @maxLength 20
714
+ * Use `ASC` for ascending order or `DESC` for descending order.
715
+ *
716
+ * Default: `DESC`.
747
717
  */
748
- couponCode?: string | null;
718
+ sorting?: Sorting;
749
719
  /**
750
- * Form submission ID that was submitted with the order.
720
+ * Predefined set of fields to return.
751
721
  *
752
- * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
753
- * An invalid submission ID is dropped and the order is created without a submission.
754
- * @format GUID
722
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
755
723
  */
756
- submissionId?: string | null;
757
- }
758
- interface CreateOfflineOrderResponse {
759
- /** Order. */
760
- order?: Order;
724
+ fieldSet?: SetWithLiterals;
761
725
  }
762
- interface CreateExternalOrderRequest {
726
+ interface Sorting {
763
727
  /**
764
- * Plan ID.
765
- * @format GUID
728
+ * Name of the field to sort by.
729
+ * @maxLength 512
766
730
  */
767
- planId?: string;
731
+ fieldName?: string;
732
+ /** Sort order. */
733
+ order?: SortOrderWithLiterals;
768
734
  /**
769
- * Form submission id that was submitted together with the order
770
- * @format GUID
735
+ * Origin point for geo-distance sorting on a GEO field
736
+ * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
771
737
  */
772
- submissionId?: string | null;
738
+ origin?: AddressLocation;
773
739
  }
774
- interface CreateExternalOrderResponse {
775
- /** Created order */
776
- order?: Order;
740
+ declare enum SortOrder {
741
+ ASC = "ASC",
742
+ DESC = "DESC"
777
743
  }
778
- interface GetOnlineOrderPreviewRequest {
779
- /**
780
- * Plan ID.
781
- * @format GUID
782
- */
783
- planId: string;
784
- /**
785
- * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
786
- *
787
- * Default: Current date and time.
788
- */
789
- startDate?: Date | null;
790
- /**
791
- * Coupon code to apply.
792
- * @minLength 1
793
- * @maxLength 20
794
- */
795
- couponCode?: string | null;
744
+ /** @enumType */
745
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
746
+ interface AddressLocation {
747
+ /** Address latitude. */
748
+ latitude?: number | null;
749
+ /** Address longitude. */
750
+ longitude?: number | null;
796
751
  }
797
- interface GetOnlineOrderPreviewResponse {
798
- /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
799
- order?: Order;
800
- /** Whether the member has already reached purchase limit for the order's plan. */
801
- purchaseLimitExceeded?: boolean;
752
+ interface ListOrdersResponse {
753
+ /** List of orders. */
754
+ orders?: Order[];
755
+ /** Object containing paging-related data (number of orders returned, offset). */
756
+ pagingMetadata?: PagingMetadataV2;
802
757
  }
803
- interface GetGuestOnlineOrderPreviewRequest {
804
- /**
805
- * Plan ID.
806
- * @format GUID
807
- */
808
- planId?: string;
809
- /**
810
- * Start date for the ordered plan.
811
- *
812
- * Default: Current date
813
- */
814
- startDate?: Date | null;
815
- /**
816
- * Coupon code to apply.
817
- * @minLength 1
818
- * @maxLength 20
819
- */
820
- couponCode?: string | null;
758
+ interface PagingMetadataV2 {
759
+ /** Number of items returned in the response. */
760
+ count?: number | null;
761
+ /** Offset that was requested. */
762
+ offset?: number | null;
763
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
764
+ total?: number | null;
765
+ /** Flag that indicates the server failed to calculate the `total` field. */
766
+ tooManyToCount?: boolean | null;
767
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
768
+ cursors?: Cursors;
769
+ }
770
+ interface Cursors {
821
771
  /**
822
- * Email for checkout
823
- * @format EMAIL
772
+ * Cursor string pointing to the next page in the list of results.
773
+ * @maxLength 16000
824
774
  */
825
- email?: string;
826
- }
827
- interface GetGuestOnlineOrderPreviewResponse {
828
- /** Will be missing if limit is exceeded */
829
- order?: Order;
775
+ next?: string | null;
830
776
  /**
831
- * Whether the purchase limit has already been reached for this plan by this email.
832
- * Always false for plans without purchase limits.
777
+ * Cursor pointing to the previous page in the list of results.
778
+ * @maxLength 16000
833
779
  */
834
- purchaseLimitExceeded?: boolean;
780
+ prev?: string | null;
835
781
  }
836
- interface GetOfflineOrderPreviewRequest {
782
+ interface GetOrdersStatsRequest {
783
+ }
784
+ interface GetOrdersStatsResponse {
785
+ /** Total number of orders. */
786
+ totalOrderCount?: number;
787
+ /** Number of active orders. */
788
+ activeOrderCount?: number;
789
+ }
790
+ interface GetAvailableOrderActionsRequest {
837
791
  /**
838
- * ID of the plan of the previewed order, from the Plans API.
792
+ * Order ID.
839
793
  * @format GUID
840
794
  */
841
- planId: string;
795
+ _id?: string;
796
+ }
797
+ interface GetAvailableOrderActionsResponse {
798
+ /** Whether the order can be suspended. */
799
+ suspendable?: boolean;
800
+ /** If the order cannot be suspended, a reason is returned here. */
801
+ notSuspendableReason?: ReasonNotSuspendableWithLiterals;
802
+ /** Whether the order can be canceled by the buyer. */
803
+ cancelableByBuyer?: boolean;
804
+ }
805
+ declare enum ReasonNotSuspendable {
806
+ /** Undefined reason. */
807
+ UNDEFINED = "UNDEFINED",
808
+ /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
809
+ PENDING = "PENDING",
810
+ /** Trial orders can't be suspended. */
811
+ TRIAL = "TRIAL",
812
+ /** Canceled orders can't be suspended. */
813
+ CANCELED = "CANCELED",
814
+ /** Ended orders can't be suspended. */
815
+ ENDED = "ENDED",
816
+ /** Paid for orders with future start dates can't be suspended. */
817
+ NOT_STARTED = "NOT_STARTED",
818
+ /** Order is already suspended. */
819
+ ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
820
+ /** Orders based on recurring payments using older stripe versions can't be suspended. */
821
+ OLD_STRIPE = "OLD_STRIPE"
822
+ }
823
+ /** @enumType */
824
+ type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
825
+ interface PostponeEndDateRequest {
842
826
  /**
843
- * Member ID of the buyer the previewed order is for, from the Members API.
827
+ * Order ID.
844
828
  * @format GUID
845
829
  */
846
- memberId: string;
830
+ _id: string;
847
831
  /**
848
- * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
832
+ * New end date and time.
849
833
  *
850
- * Default: Current date and time.
851
- */
852
- startDate?: Date | null;
853
- /**
854
- * Coupon code to apply, from the Coupons API.
855
- * @minLength 1
856
- * @maxLength 20
834
+ * Must be later than the current end date and time.
857
835
  */
858
- couponCode?: string | null;
836
+ endDate: Date | null;
859
837
  }
860
- interface GetOfflineOrderPreviewResponse {
861
- /** The previewed order, as if the plan had been ordered. */
838
+ interface PostponeEndDateResponse {
839
+ }
840
+ interface OrderEndDatePostponed {
841
+ /** Order whose `endDate` was postponed. */
862
842
  order?: Order;
863
- /**
864
- * Whether this previewed order would exceed the permitted amount of purchases available
865
- * for this plan for this buyer.
866
- *
867
- * Always `false` for plans that do not have purchase limits.
868
- */
869
- purchaseLimitExceeded?: boolean;
870
843
  }
871
- interface GetPricePreviewRequest {
844
+ interface CancelOrderRequest {
872
845
  /**
873
- * ID of plan to preview.
846
+ * Order ID.
874
847
  * @format GUID
875
848
  */
876
- planId: string;
877
- /**
878
- * Coupon code to apply, from the Coupons API.
879
- * @minLength 1
880
- * @maxLength 20
881
- */
882
- couponCode?: string | null;
849
+ _id: string;
850
+ /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
851
+ effectiveAt: CancellationEffectiveAtWithLiterals;
883
852
  }
884
- interface GetPricePreviewResponse {
885
- /** Pricing details. */
886
- prices?: SpannedPrice[];
853
+ interface CancelOrderResponse {
887
854
  }
888
- interface ChangeStartDateRequest {
855
+ /**
856
+ * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
857
+ *
858
+ * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
859
+ */
860
+ interface OrderCanceled {
861
+ /** Canceled order. */
862
+ order?: Order;
863
+ }
864
+ interface MarkAsPaidRequest {
889
865
  /**
890
- * Draft order ID.
866
+ * Order ID.
891
867
  * @format GUID
892
868
  */
893
- orderId?: string;
894
- /** New valid from date (timestamp). */
895
- startDate?: Date | null;
869
+ _id: string;
896
870
  }
897
- interface ChangeStartDateResponse {
898
- /** Updated draft order. */
899
- order?: Order;
871
+ interface MarkAsPaidResponse {
900
872
  }
901
- interface OrderStartDateChanged {
902
- /** Order whose `startDate` changed. */
873
+ interface OrderMarkedAsPaid {
874
+ /** Order that was marked as paid. */
903
875
  order?: Order;
904
876
  }
905
- interface ApplyCouponRequest {
877
+ interface PauseOrderRequest {
906
878
  /**
907
- * Draft order ID.
879
+ * Order ID.
908
880
  * @format GUID
909
881
  */
910
- orderId?: string;
882
+ _id: string;
883
+ }
884
+ interface PauseOrderResponse {
885
+ }
886
+ interface OrderPaused {
887
+ /** Paused order. */
888
+ order?: Order;
889
+ }
890
+ interface BulkPauseOrderRequest {
911
891
  /**
912
- * Coupon code to apply.
913
- * @minLength 1
914
- * @maxLength 20
892
+ * List of Order IDs.
893
+ * @format GUID
894
+ * @minSize 1
895
+ * @maxSize 100
915
896
  */
916
- couponCode?: string;
897
+ ids?: string[];
898
+ /** Set to true to return Order entity in response. */
899
+ returnFullEntity?: boolean;
917
900
  }
918
- interface ApplyCouponResponse {
919
- /** Order with applied coupon and recalculated tax. */
901
+ interface BulkPauseOrderResponse {
902
+ /** Orders that were paused. */
903
+ results?: BulkOrderResult[];
904
+ /** Bulk action metadata. */
905
+ bulkActionMetadata?: BulkActionMetadata;
906
+ }
907
+ interface BulkOrderResult {
908
+ /** Item metadata */
909
+ itemMetadata?: ItemMetadata;
910
+ /** The order. */
920
911
  order?: Order;
921
912
  }
922
- interface SetSubmissionRequest {
913
+ interface ItemMetadata {
914
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
915
+ _id?: string | null;
916
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
917
+ originalIndex?: number;
918
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
919
+ success?: boolean;
920
+ /** Details about the error in case of failure. */
921
+ error?: ApplicationError;
922
+ }
923
+ interface ApplicationError {
924
+ /** Error code. */
925
+ code?: string;
926
+ /** Description of the error. */
927
+ description?: string;
928
+ /** Data related to the error. */
929
+ data?: Record<string, any> | null;
930
+ }
931
+ interface BulkActionMetadata {
932
+ /** Number of items that were successfully processed. */
933
+ totalSuccesses?: number;
934
+ /** Number of items that couldn't be processed. */
935
+ totalFailures?: number;
936
+ /** Number of failures without details because detailed failure threshold was exceeded. */
937
+ undetailedFailures?: number;
938
+ }
939
+ interface ResumeOrderRequest {
923
940
  /**
924
941
  * Order ID.
925
942
  * @format GUID
926
943
  */
927
- orderId?: string;
944
+ _id: string;
945
+ }
946
+ interface ResumeOrderResponse {
947
+ }
948
+ interface OrderResumed {
949
+ /** Resumed order. */
950
+ order?: Order;
951
+ }
952
+ interface BulkResumeOrderRequest {
928
953
  /**
929
- * Submission ID.
954
+ * List of Order IDs.
930
955
  * @format GUID
956
+ * @minSize 1
957
+ * @maxSize 100
931
958
  */
932
- submissionId?: string;
959
+ ids?: string[];
960
+ /** Set to true to return Order entity in response. */
961
+ returnFullEntity?: boolean;
933
962
  }
934
- interface SetSubmissionResponse {
935
- /** Order with submission id */
936
- order?: Order;
963
+ interface BulkResumeOrderResponse {
964
+ /** Orders that were resumed. */
965
+ results?: BulkOrderResult[];
966
+ /** Bulk action metadata. */
967
+ bulkActionMetadata?: BulkActionMetadata;
937
968
  }
938
969
  interface MessageEnvelope {
939
970
  /**
@@ -1026,345 +1057,314 @@ interface AccountInfo {
1026
1057
  */
1027
1058
  siteId?: string | null;
1028
1059
  }
1029
- interface OrderPurchased {
1030
- /** Order that was paid for. If a free or an offline order, the order that was created. */
1031
- order?: Order;
1032
- }
1033
- interface OrderStarted {
1034
- /** Order that reached its `startDate`. */
1035
- order?: Order;
1036
- }
1037
- /**
1038
- * Triggered at the start of a new payment cycle for an existing order.
1039
- *
1040
- * This webhook does not trigger at the initial start of an offline order.
1041
- */
1042
- interface OrderCycleStarted {
1043
- /** Order whose new cycle started. */
1044
- order?: Order;
1045
- /** 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. */
1046
- cycleNumber?: number;
1060
+ interface CreateOnlineOrderRequest {
1061
+ /**
1062
+ * Plan ID.
1063
+ * @format GUID
1064
+ */
1065
+ planId: string;
1066
+ /**
1067
+ * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1068
+ *
1069
+ * Default: Current date and time.
1070
+ */
1071
+ startDate?: Date | null;
1072
+ /**
1073
+ * Coupon code to apply.
1074
+ * @minLength 1
1075
+ * @maxLength 20
1076
+ */
1077
+ couponCode?: string | null;
1078
+ /** Provided if checkout is initiated on buyer's behalf. */
1079
+ onBehalf?: OnBehalf;
1080
+ /**
1081
+ * Submission ID of the form submitted with this order.
1082
+ *
1083
+ * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
1084
+ * An invalid submission ID is dropped and the order is created without a submission.
1085
+ * @format GUID
1086
+ */
1087
+ submissionId?: string | null;
1047
1088
  }
1048
- /** Emitted when a recurring order is canceled for the next payment cycle */
1049
- interface OrderAutoRenewCanceled {
1050
- /** Order that is canceled, effective at the end of the current payment cycle. */
1051
- order?: Order;
1089
+ interface OnBehalf {
1090
+ /**
1091
+ * Member ID.
1092
+ * @format GUID
1093
+ */
1094
+ memberId?: string;
1095
+ /** Method by which checkout is initiated. */
1096
+ orderMethod?: OrderMethodWithLiterals;
1052
1097
  }
1053
- interface OrderEnded {
1054
- /** Order that ended. */
1098
+ interface CreateOnlineOrderResponse {
1099
+ /** Created online order. */
1055
1100
  order?: Order;
1056
1101
  }
1057
- interface GetOrderRequest {
1102
+ interface CouponsError {
1103
+ /** Coupon code. */
1104
+ couponCode?: string;
1105
+ /** Plan ID. */
1106
+ planId?: string;
1107
+ }
1108
+ interface CreateGuestOnlineOrderRequest {
1058
1109
  /**
1059
- * Order ID.
1110
+ * Plan ID.
1060
1111
  * @format GUID
1061
1112
  */
1062
- _id: string;
1113
+ planId?: string;
1063
1114
  /**
1064
- * Predefined set of fields to return.
1115
+ * Start date for the ordered plan.
1065
1116
  *
1066
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1117
+ * Default: Current date
1067
1118
  */
1068
- fieldSet?: SetWithLiterals;
1119
+ startDate?: Date | null;
1120
+ /**
1121
+ * Coupon code to apply.
1122
+ * @minLength 1
1123
+ * @maxLength 20
1124
+ */
1125
+ couponCode?: string | null;
1126
+ /** Captcha data to prove you are not a robot */
1127
+ captcha?: Captcha;
1128
+ /** Visitor info */
1129
+ guest?: Guest;
1130
+ /**
1131
+ * Form submission id that was submitted together with the order
1132
+ * @format GUID
1133
+ */
1134
+ submissionId?: string | null;
1069
1135
  }
1070
- declare enum Set {
1071
- /** Same behavior as `BASIC`.` */
1072
- UNKNOWN_SET = "UNKNOWN_SET",
1073
- /** Doesn't return any order form submission data. */
1074
- BASIC = "BASIC",
1075
- /** Returns all order form submission data. */
1076
- FULL = "FULL"
1136
+ interface Captcha {
1137
+ /** Token from captcha */
1138
+ token?: string;
1077
1139
  }
1078
- /** @enumType */
1079
- type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
1080
- interface GetOrderResponse {
1140
+ interface Guest {
1141
+ /**
1142
+ * Email for checkout
1143
+ * @format EMAIL
1144
+ */
1145
+ email?: string;
1146
+ }
1147
+ interface CreateGuestOnlineOrderResponse {
1081
1148
  /** Order. */
1082
1149
  order?: Order;
1083
1150
  }
1084
- interface ListOrdersRequest {
1151
+ interface CreateOfflineOrderRequest {
1085
1152
  /**
1086
- * Filter by a buyer's member ID, from the Members API.
1153
+ * ID of the plan being ordered, from the Plans API.
1087
1154
  * @format GUID
1088
1155
  */
1089
- buyerIds?: string[];
1156
+ planId: string;
1090
1157
  /**
1091
- * Filter by plan IDs, from the Plans API.
1158
+ * ID of the member ordering the plan, from the Members API.
1092
1159
  * @format GUID
1093
1160
  */
1094
- planIds?: string[];
1095
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
1096
- autoRenewCanceled?: boolean | null;
1097
- /** Filter by order status. */
1098
- orderStatuses?: OrderStatusWithLiterals[];
1099
- /** Filter by payment status. */
1100
- paymentStatuses?: PaymentStatusWithLiterals[];
1161
+ memberId: string;
1101
1162
  /**
1102
- * Number of orders to return. See Sorting and Paging for more information.
1163
+ * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1103
1164
  *
1104
- * Max: `50`
1105
- * @min 1
1106
- * @max 50
1165
+ * Default: Current date and time.
1107
1166
  */
1108
- limit?: number | null;
1109
- /** Number of orders to skip in the current sort order. */
1110
- offset?: number | null;
1167
+ startDate?: Date | null;
1111
1168
  /**
1112
- * Sort order.
1113
- *
1114
- * Use `ASC` for ascending order or `DESC` for descending order.
1169
+ * Whether the order is paid.
1115
1170
  *
1116
- * Default: `DESC`.
1171
+ * Default: `false`
1117
1172
  */
1118
- sorting?: Sorting;
1173
+ paid?: boolean | null;
1119
1174
  /**
1120
- * Predefined set of fields to return.
1175
+ * Coupon code to apply, from the Coupons API.
1176
+ * @minLength 1
1177
+ * @maxLength 20
1178
+ */
1179
+ couponCode?: string | null;
1180
+ /**
1181
+ * Form submission ID that was submitted with the order.
1121
1182
  *
1122
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1183
+ * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
1184
+ * An invalid submission ID is dropped and the order is created without a submission.
1185
+ * @format GUID
1123
1186
  */
1124
- fieldSet?: SetWithLiterals;
1187
+ submissionId?: string | null;
1125
1188
  }
1126
- interface Sorting {
1189
+ interface CreateOfflineOrderResponse {
1190
+ /** Order. */
1191
+ order?: Order;
1192
+ }
1193
+ interface CreateExternalOrderRequest {
1127
1194
  /**
1128
- * Name of the field to sort by.
1129
- * @maxLength 512
1195
+ * Plan ID.
1196
+ * @format GUID
1130
1197
  */
1131
- fieldName?: string;
1132
- /** Sort order. */
1133
- order?: SortOrderWithLiterals;
1198
+ planId?: string;
1134
1199
  /**
1135
- * Origin point for geo-distance sorting on a GEO field
1136
- * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
1200
+ * Form submission id that was submitted together with the order
1201
+ * @format GUID
1137
1202
  */
1138
- origin?: AddressLocation;
1139
- }
1140
- declare enum SortOrder {
1141
- ASC = "ASC",
1142
- DESC = "DESC"
1143
- }
1144
- /** @enumType */
1145
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1146
- interface AddressLocation {
1147
- /** Address latitude. */
1148
- latitude?: number | null;
1149
- /** Address longitude. */
1150
- longitude?: number | null;
1151
- }
1152
- interface ListOrdersResponse {
1153
- /** List of orders. */
1154
- orders?: Order[];
1155
- /** Object containing paging-related data (number of orders returned, offset). */
1156
- pagingMetadata?: PagingMetadataV2;
1203
+ submissionId?: string | null;
1157
1204
  }
1158
- interface PagingMetadataV2 {
1159
- /** Number of items returned in the response. */
1160
- count?: number | null;
1161
- /** Offset that was requested. */
1162
- offset?: number | null;
1163
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1164
- total?: number | null;
1165
- /** Flag that indicates the server failed to calculate the `total` field. */
1166
- tooManyToCount?: boolean | null;
1167
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1168
- cursors?: Cursors;
1205
+ interface CreateExternalOrderResponse {
1206
+ /** Created order */
1207
+ order?: Order;
1169
1208
  }
1170
- interface Cursors {
1209
+ interface GetOnlineOrderPreviewRequest {
1171
1210
  /**
1172
- * Cursor string pointing to the next page in the list of results.
1173
- * @maxLength 16000
1211
+ * Plan ID.
1212
+ * @format GUID
1174
1213
  */
1175
- next?: string | null;
1214
+ planId: string;
1176
1215
  /**
1177
- * Cursor pointing to the previous page in the list of results.
1178
- * @maxLength 16000
1216
+ * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1217
+ *
1218
+ * Default: Current date and time.
1179
1219
  */
1180
- prev?: string | null;
1181
- }
1182
- interface GetOrdersStatsRequest {
1220
+ startDate?: Date | null;
1221
+ /**
1222
+ * Coupon code to apply.
1223
+ * @minLength 1
1224
+ * @maxLength 20
1225
+ */
1226
+ couponCode?: string | null;
1183
1227
  }
1184
- interface GetOrdersStatsResponse {
1185
- /** Total number of orders. */
1186
- totalOrderCount?: number;
1187
- /** Number of active orders. */
1188
- activeOrderCount?: number;
1228
+ interface GetOnlineOrderPreviewResponse {
1229
+ /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
1230
+ order?: Order;
1231
+ /** Whether the member has already reached purchase limit for the order's plan. */
1232
+ purchaseLimitExceeded?: boolean;
1189
1233
  }
1190
- interface GetAvailableOrderActionsRequest {
1234
+ interface GetGuestOnlineOrderPreviewRequest {
1191
1235
  /**
1192
- * Order ID.
1236
+ * Plan ID.
1193
1237
  * @format GUID
1194
1238
  */
1195
- _id?: string;
1196
- }
1197
- interface GetAvailableOrderActionsResponse {
1198
- /** Whether the order can be suspended. */
1199
- suspendable?: boolean;
1200
- /** If the order cannot be suspended, a reason is returned here. */
1201
- notSuspendableReason?: ReasonNotSuspendableWithLiterals;
1202
- /** Whether the order can be canceled by the buyer. */
1203
- cancelableByBuyer?: boolean;
1239
+ planId?: string;
1240
+ /**
1241
+ * Start date for the ordered plan.
1242
+ *
1243
+ * Default: Current date
1244
+ */
1245
+ startDate?: Date | null;
1246
+ /**
1247
+ * Coupon code to apply.
1248
+ * @minLength 1
1249
+ * @maxLength 20
1250
+ */
1251
+ couponCode?: string | null;
1252
+ /**
1253
+ * Email for checkout
1254
+ * @format EMAIL
1255
+ */
1256
+ email?: string;
1204
1257
  }
1205
- declare enum ReasonNotSuspendable {
1206
- /** Undefined reason. */
1207
- UNDEFINED = "UNDEFINED",
1208
- /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
1209
- PENDING = "PENDING",
1210
- /** Trial orders can't be suspended. */
1211
- TRIAL = "TRIAL",
1212
- /** Canceled orders can't be suspended. */
1213
- CANCELED = "CANCELED",
1214
- /** Ended orders can't be suspended. */
1215
- ENDED = "ENDED",
1216
- /** Paid for orders with future start dates can't be suspended. */
1217
- NOT_STARTED = "NOT_STARTED",
1218
- /** Order is already suspended. */
1219
- ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
1220
- /** Orders based on recurring payments using older stripe versions can't be suspended. */
1221
- OLD_STRIPE = "OLD_STRIPE"
1258
+ interface GetGuestOnlineOrderPreviewResponse {
1259
+ /** Will be missing if limit is exceeded */
1260
+ order?: Order;
1261
+ /**
1262
+ * Whether the purchase limit has already been reached for this plan by this email.
1263
+ * Always false for plans without purchase limits.
1264
+ */
1265
+ purchaseLimitExceeded?: boolean;
1222
1266
  }
1223
- /** @enumType */
1224
- type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
1225
- interface PostponeEndDateRequest {
1267
+ interface GetOfflineOrderPreviewRequest {
1226
1268
  /**
1227
- * Order ID.
1269
+ * ID of the plan of the previewed order, from the Plans API.
1228
1270
  * @format GUID
1229
1271
  */
1230
- _id: string;
1272
+ planId: string;
1231
1273
  /**
1232
- * New end date and time.
1274
+ * Member ID of the buyer the previewed order is for, from the Members API.
1275
+ * @format GUID
1276
+ */
1277
+ memberId: string;
1278
+ /**
1279
+ * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1233
1280
  *
1234
- * Must be later than the current end date and time.
1281
+ * Default: Current date and time.
1235
1282
  */
1236
- endDate: Date | null;
1237
- }
1238
- interface PostponeEndDateResponse {
1239
- }
1240
- interface OrderEndDatePostponed {
1241
- /** Order whose `endDate` was postponed. */
1242
- order?: Order;
1243
- }
1244
- interface CancelOrderRequest {
1283
+ startDate?: Date | null;
1245
1284
  /**
1246
- * Order ID.
1247
- * @format GUID
1285
+ * Coupon code to apply, from the Coupons API.
1286
+ * @minLength 1
1287
+ * @maxLength 20
1248
1288
  */
1249
- _id: string;
1250
- /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
1251
- effectiveAt: CancellationEffectiveAtWithLiterals;
1252
- }
1253
- interface CancelOrderResponse {
1289
+ couponCode?: string | null;
1254
1290
  }
1255
- /**
1256
- * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
1257
- *
1258
- * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
1259
- */
1260
- interface OrderCanceled {
1261
- /** Canceled order. */
1291
+ interface GetOfflineOrderPreviewResponse {
1292
+ /** The previewed order, as if the plan had been ordered. */
1262
1293
  order?: Order;
1294
+ /**
1295
+ * Whether this previewed order would exceed the permitted amount of purchases available
1296
+ * for this plan for this buyer.
1297
+ *
1298
+ * Always `false` for plans that do not have purchase limits.
1299
+ */
1300
+ purchaseLimitExceeded?: boolean;
1263
1301
  }
1264
- interface MarkAsPaidRequest {
1302
+ interface GetPricePreviewRequest {
1265
1303
  /**
1266
- * Order ID.
1304
+ * ID of plan to preview.
1267
1305
  * @format GUID
1268
1306
  */
1269
- _id: string;
1270
- }
1271
- interface MarkAsPaidResponse {
1307
+ planId: string;
1308
+ /**
1309
+ * Coupon code to apply, from the Coupons API.
1310
+ * @minLength 1
1311
+ * @maxLength 20
1312
+ */
1313
+ couponCode?: string | null;
1272
1314
  }
1273
- interface OrderMarkedAsPaid {
1274
- /** Order that was marked as paid. */
1275
- order?: Order;
1315
+ interface GetPricePreviewResponse {
1316
+ /** Pricing details. */
1317
+ prices?: SpannedPrice[];
1276
1318
  }
1277
- interface PauseOrderRequest {
1319
+ interface ChangeStartDateRequest {
1278
1320
  /**
1279
- * Order ID.
1321
+ * Draft order ID.
1280
1322
  * @format GUID
1281
1323
  */
1282
- _id: string;
1324
+ orderId?: string;
1325
+ /** New valid from date (timestamp). */
1326
+ startDate?: Date | null;
1283
1327
  }
1284
- interface PauseOrderResponse {
1328
+ interface ChangeStartDateResponse {
1329
+ /** Updated draft order. */
1330
+ order?: Order;
1285
1331
  }
1286
- interface OrderPaused {
1287
- /** Paused order. */
1332
+ interface OrderStartDateChanged {
1333
+ /** Order whose `startDate` changed. */
1288
1334
  order?: Order;
1289
1335
  }
1290
- interface BulkPauseOrderRequest {
1336
+ interface ApplyCouponRequest {
1291
1337
  /**
1292
- * List of Order IDs.
1338
+ * Draft order ID.
1293
1339
  * @format GUID
1294
- * @minSize 1
1295
- * @maxSize 100
1296
1340
  */
1297
- ids?: string[];
1298
- /** Set to true to return Order entity in response. */
1299
- returnFullEntity?: boolean;
1300
- }
1301
- interface BulkPauseOrderResponse {
1302
- /** Orders that were paused. */
1303
- results?: BulkOrderResult[];
1304
- /** Bulk action metadata. */
1305
- bulkActionMetadata?: BulkActionMetadata;
1341
+ orderId?: string;
1342
+ /**
1343
+ * Coupon code to apply.
1344
+ * @minLength 1
1345
+ * @maxLength 20
1346
+ */
1347
+ couponCode?: string;
1306
1348
  }
1307
- interface BulkOrderResult {
1308
- /** Item metadata */
1309
- itemMetadata?: ItemMetadata;
1310
- /** The order. */
1349
+ interface ApplyCouponResponse {
1350
+ /** Order with applied coupon and recalculated tax. */
1311
1351
  order?: Order;
1312
1352
  }
1313
- interface ItemMetadata {
1314
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1315
- _id?: string | null;
1316
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1317
- originalIndex?: number;
1318
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1319
- success?: boolean;
1320
- /** Details about the error in case of failure. */
1321
- error?: ApplicationError;
1322
- }
1323
- interface ApplicationError {
1324
- /** Error code. */
1325
- code?: string;
1326
- /** Description of the error. */
1327
- description?: string;
1328
- /** Data related to the error. */
1329
- data?: Record<string, any> | null;
1330
- }
1331
- interface BulkActionMetadata {
1332
- /** Number of items that were successfully processed. */
1333
- totalSuccesses?: number;
1334
- /** Number of items that couldn't be processed. */
1335
- totalFailures?: number;
1336
- /** Number of failures without details because detailed failure threshold was exceeded. */
1337
- undetailedFailures?: number;
1338
- }
1339
- interface ResumeOrderRequest {
1353
+ interface SetSubmissionRequest {
1340
1354
  /**
1341
1355
  * Order ID.
1342
1356
  * @format GUID
1343
1357
  */
1344
- _id: string;
1345
- }
1346
- interface ResumeOrderResponse {
1347
- }
1348
- interface OrderResumed {
1349
- /** Resumed order. */
1350
- order?: Order;
1351
- }
1352
- interface BulkResumeOrderRequest {
1358
+ orderId?: string;
1353
1359
  /**
1354
- * List of Order IDs.
1360
+ * Submission ID.
1355
1361
  * @format GUID
1356
- * @minSize 1
1357
- * @maxSize 100
1358
1362
  */
1359
- ids?: string[];
1360
- /** Set to true to return Order entity in response. */
1361
- returnFullEntity?: boolean;
1363
+ submissionId?: string;
1362
1364
  }
1363
- interface BulkResumeOrderResponse {
1364
- /** Orders that were resumed. */
1365
- results?: BulkOrderResult[];
1366
- /** Bulk action metadata. */
1367
- bulkActionMetadata?: BulkActionMetadata;
1365
+ interface SetSubmissionResponse {
1366
+ /** Order with submission id */
1367
+ order?: Order;
1368
1368
  }
1369
1369
  interface MemberGetOrderRequest {
1370
1370
  /**
@@ -1779,84 +1779,7 @@ interface AccountInfoMetadata {
1779
1779
  siteId?: string;
1780
1780
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
1781
1781
  parentAccountId?: string;
1782
- }
1783
- interface OrderCreatedEnvelope {
1784
- entity: Order;
1785
- metadata: EventMetadata;
1786
- }
1787
- /**
1788
- * Triggered when an order is created.
1789
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1790
- * @permissionScopeId SCOPE.RENTALS.MANAGE
1791
- * @permissionScope Manage Orders
1792
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1793
- * @permissionScope Read Orders
1794
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1795
- * @permissionScope Manage plans and orders of Pricing Plans
1796
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1797
- * @permissionScope Manage Events
1798
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1799
- * @permissionId PRICING_PLANS.READ_ORDERS
1800
- * @webhook
1801
- * @eventType wix.pricing_plans.v2.order_created
1802
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1803
- * @slug created
1804
- */
1805
- declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
1806
- interface OrderStartDateChangedEnvelope {
1807
- data: OrderStartDateChanged;
1808
- metadata: EventMetadata;
1809
- }
1810
- /**
1811
- * Triggered when an order's `startDate` is changed.
1812
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1813
- * @permissionScopeId SCOPE.RENTALS.MANAGE
1814
- * @permissionScope Manage Orders
1815
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1816
- * @permissionScope Read Orders
1817
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1818
- * @permissionScope Manage plans and orders of Pricing Plans
1819
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1820
- * @permissionScope Manage Events
1821
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1822
- * @permissionId PRICING_PLANS.READ_ORDERS
1823
- * @webhook
1824
- * @eventType wix.pricing_plans.v2.order_start_date_changed
1825
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1826
- * @slug start_date_changed
1827
- */
1828
- declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
1829
- interface OrderUpdatedEnvelope {
1830
- entity: Order;
1831
- metadata: EventMetadata;
1832
- }
1833
- /**
1834
- * Triggered for any of the following update events:
1835
- *
1836
- * + Order is paid for. Order Purchased is also triggered.
1837
- * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
1838
- * + New payment cycle of an order starts. Order Cycle Started is also triggered.
1839
- * + Offline order is marked as paid. Order Marked As Paid is also triggered.
1840
- * + End date of the order is postponed. Order End Date Postponed is also triggered
1841
- * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
1842
- * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
1843
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1844
- * @permissionScopeId SCOPE.RENTALS.MANAGE
1845
- * @permissionScope Manage Orders
1846
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1847
- * @permissionScope Read Orders
1848
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1849
- * @permissionScope Manage plans and orders of Pricing Plans
1850
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1851
- * @permissionScope Manage Events
1852
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1853
- * @permissionId PRICING_PLANS.READ_ORDERS
1854
- * @webhook
1855
- * @eventType wix.pricing_plans.v2.order_updated
1856
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1857
- * @slug updated
1858
- */
1859
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
1782
+ }
1860
1783
  interface OrderAutoRenewCanceledEnvelope {
1861
1784
  data: OrderAutoRenewCanceled;
1862
1785
  metadata: EventMetadata;
@@ -1967,8 +1890,9 @@ interface OrderEndedEnvelope {
1967
1890
  * Triggered when an order ends.
1968
1891
  *
1969
1892
  * This webhook is triggered:
1970
- * + When an order expires at the end of the current payment cycle.
1893
+ * + When an order reaches its `endDate`.
1971
1894
  * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
1895
+ * + At the end of the current payment cycle, when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1972
1896
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1973
1897
  * @permissionScopeId SCOPE.RENTALS.MANAGE
1974
1898
  * @permissionScope Manage Orders
@@ -2058,53 +1982,304 @@ interface OrderPurchasedEnvelope {
2058
1982
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2059
1983
  * @slug purchased
2060
1984
  */
2061
- declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2062
- interface OrderResumedEnvelope {
2063
- data: OrderResumed;
2064
- metadata: EventMetadata;
2065
- }
1985
+ declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
1986
+ interface OrderResumedEnvelope {
1987
+ data: OrderResumed;
1988
+ metadata: EventMetadata;
1989
+ }
1990
+ /**
1991
+ * Triggered when a paused order is resumed.
1992
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1993
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
1994
+ * @permissionScope Manage Orders
1995
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1996
+ * @permissionScope Read Orders
1997
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1998
+ * @permissionScope Manage plans and orders of Pricing Plans
1999
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2000
+ * @permissionScope Manage Events
2001
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2002
+ * @permissionId PRICING_PLANS.READ_ORDERS
2003
+ * @webhook
2004
+ * @eventType wix.pricing_plans.v2.order_resumed
2005
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2006
+ * @slug resumed
2007
+ */
2008
+ declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2009
+ interface OrderStartedEnvelope {
2010
+ data: OrderStarted;
2011
+ metadata: EventMetadata;
2012
+ }
2013
+ /**
2014
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2015
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2016
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
2017
+ * @permissionScope Manage Orders
2018
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2019
+ * @permissionScope Read Orders
2020
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2021
+ * @permissionScope Manage plans and orders of Pricing Plans
2022
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2023
+ * @permissionScope Manage Events
2024
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2025
+ * @permissionId PRICING_PLANS.READ_ORDERS
2026
+ * @webhook
2027
+ * @eventType wix.pricing_plans.v2.order_started
2028
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2029
+ * @slug started
2030
+ */
2031
+ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2032
+ interface OrderUpdatedEnvelope {
2033
+ entity: Order;
2034
+ metadata: EventMetadata;
2035
+ }
2036
+ /**
2037
+ * Triggered for any of the following update events:
2038
+ *
2039
+ * + Order is paid for. Order Purchased is also triggered.
2040
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
2041
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
2042
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
2043
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
2044
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
2045
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
2046
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2047
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
2048
+ * @permissionScope Manage Orders
2049
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2050
+ * @permissionScope Read Orders
2051
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2052
+ * @permissionScope Manage plans and orders of Pricing Plans
2053
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2054
+ * @permissionScope Manage Events
2055
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2056
+ * @permissionId PRICING_PLANS.READ_ORDERS
2057
+ * @webhook
2058
+ * @eventType wix.pricing_plans.v2.order_updated
2059
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2060
+ * @slug updated
2061
+ */
2062
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2063
+ interface OrderCreatedEnvelope {
2064
+ entity: Order;
2065
+ metadata: EventMetadata;
2066
+ }
2067
+ /**
2068
+ * Triggered when an order is created.
2069
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2070
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
2071
+ * @permissionScope Manage Orders
2072
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2073
+ * @permissionScope Read Orders
2074
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2075
+ * @permissionScope Manage plans and orders of Pricing Plans
2076
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2077
+ * @permissionScope Manage Events
2078
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2079
+ * @permissionId PRICING_PLANS.READ_ORDERS
2080
+ * @webhook
2081
+ * @eventType wix.pricing_plans.v2.order_created
2082
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2083
+ * @slug created
2084
+ */
2085
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
2086
+ interface OrderStartDateChangedEnvelope {
2087
+ data: OrderStartDateChanged;
2088
+ metadata: EventMetadata;
2089
+ }
2090
+ /**
2091
+ * Triggered when an order's `startDate` is changed.
2092
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2093
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
2094
+ * @permissionScope Manage Orders
2095
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2096
+ * @permissionScope Read Orders
2097
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2098
+ * @permissionScope Manage plans and orders of Pricing Plans
2099
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2100
+ * @permissionScope Manage Events
2101
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2102
+ * @permissionId PRICING_PLANS.READ_ORDERS
2103
+ * @webhook
2104
+ * @eventType wix.pricing_plans.v2.order_start_date_changed
2105
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2106
+ * @slug start_date_changed
2107
+ */
2108
+ declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
2109
+ /**
2110
+ * Retrieves an order by ID.
2111
+ * @param _id - Order ID.
2112
+ * @public
2113
+ * @requiredField _id
2114
+ * @param options - Options to use when getting an order.
2115
+ * @permissionId PRICING_PLANS.READ_ORDERS
2116
+ * @applicableIdentity APP
2117
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2118
+ */
2119
+ 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`, 5>>;
2120
+ interface ManagementGetOrderOptions {
2121
+ /**
2122
+ * Predefined set of fields to return.
2123
+ *
2124
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2125
+ */
2126
+ fieldSet?: SetWithLiterals;
2127
+ }
2128
+ /**
2129
+ * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2130
+ *
2131
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2132
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2133
+ * @public
2134
+ * @param options - Filtering, sorting, and pagination options.
2135
+ * @permissionId PRICING_PLANS.READ_ORDERS
2136
+ * @applicableIdentity APP
2137
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2138
+ */
2139
+ 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`, 4>>;
2140
+ interface ManagementListOrdersOptions {
2141
+ /**
2142
+ * Filter by a buyer's member ID, from the Members API.
2143
+ * @format GUID
2144
+ */
2145
+ buyerIds?: string[];
2146
+ /**
2147
+ * Filter by plan IDs, from the Plans API.
2148
+ * @format GUID
2149
+ */
2150
+ planIds?: string[];
2151
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2152
+ autoRenewCanceled?: boolean | null;
2153
+ /** Filter by order status. */
2154
+ orderStatuses?: OrderStatusWithLiterals[];
2155
+ /** Filter by payment status. */
2156
+ paymentStatuses?: PaymentStatusWithLiterals[];
2157
+ /**
2158
+ * Number of orders to return. See Sorting and Paging for more information.
2159
+ *
2160
+ * Max: `50`
2161
+ * @min 1
2162
+ * @max 50
2163
+ */
2164
+ limit?: number | null;
2165
+ /** Number of orders to skip in the current sort order. */
2166
+ offset?: number | null;
2167
+ /**
2168
+ * Sort order.
2169
+ *
2170
+ * Use `ASC` for ascending order or `DESC` for descending order.
2171
+ *
2172
+ * Default: `DESC`.
2173
+ */
2174
+ sorting?: Sorting;
2175
+ /**
2176
+ * Predefined set of fields to return.
2177
+ *
2178
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2179
+ */
2180
+ fieldSet?: SetWithLiterals;
2181
+ }
2182
+ /**
2183
+ * 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.
2184
+ *
2185
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2186
+ * Can't postpone an order with `status`: `PAUSED`.
2187
+ * @param _id - Order ID.
2188
+ * @param endDate - New end date and time.
2189
+ *
2190
+ * Must be later than the current end date and time.
2191
+ * @public
2192
+ * @requiredField _id
2193
+ * @requiredField endDate
2194
+ * @param options - Options for postponing the end date of an order.
2195
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2196
+ * @applicableIdentity APP
2197
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2198
+ */
2199
+ declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2200
+ /**
2201
+ * Cancels an existing order.
2202
+ *
2203
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2204
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2205
+ *
2206
+ * #### Canceling during the free trial period.
2207
+ *
2208
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2209
+ * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2210
+ * of the free trial period.
2211
+ *
2212
+ * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2213
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2214
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2215
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2216
+ * Then, the subscription ends and the buyer is not billed.
2217
+ * @param _id - Order ID.
2218
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2219
+ * @public
2220
+ * @requiredField _id
2221
+ * @requiredField effectiveAt
2222
+ * @param options - Options for canceling orders.
2223
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2224
+ * @applicableIdentity APP
2225
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2226
+ */
2227
+ declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2228
+ /**
2229
+ * Marks an offline order as paid.
2230
+ * > __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.
2231
+ *
2232
+ * Marking an offline order as paid causes the following changes:
2233
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2234
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2235
+ *
2236
+ * An error occurs if you attempt to:
2237
+ * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2238
+ * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2239
+ * @param _id - Order ID.
2240
+ * @public
2241
+ * @requiredField _id
2242
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2243
+ * @applicableIdentity APP
2244
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2245
+ */
2246
+ declare function markAsPaid(_id: string): Promise<void>;
2066
2247
  /**
2067
- * Triggered when a paused order is resumed.
2068
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2069
- * @permissionScopeId SCOPE.RENTALS.MANAGE
2070
- * @permissionScope Manage Orders
2071
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2072
- * @permissionScope Read Orders
2073
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2074
- * @permissionScope Manage plans and orders of Pricing Plans
2075
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2076
- * @permissionScope Manage Events
2077
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2078
- * @permissionId PRICING_PLANS.READ_ORDERS
2079
- * @webhook
2080
- * @eventType wix.pricing_plans.v2.order_resumed
2081
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2082
- * @slug resumed
2248
+ * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2249
+ *
2250
+ * Only orders with `status`: `ACTIVE` can be paused.
2251
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2252
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2253
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2254
+ *
2255
+ * To resume a paused order, call Resume Order.
2256
+ * @param _id - Order ID.
2257
+ * @public
2258
+ * @requiredField _id
2259
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2260
+ * @applicableIdentity APP
2261
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2083
2262
  */
2084
- declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2085
- interface OrderStartedEnvelope {
2086
- data: OrderStarted;
2087
- metadata: EventMetadata;
2088
- }
2263
+ declare function pauseOrder(_id: string): Promise<void>;
2089
2264
  /**
2090
- * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2091
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
2092
- * @permissionScopeId SCOPE.RENTALS.MANAGE
2093
- * @permissionScope Manage Orders
2094
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2095
- * @permissionScope Read Orders
2096
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2097
- * @permissionScope Manage plans and orders of Pricing Plans
2098
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2099
- * @permissionScope Manage Events
2100
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2101
- * @permissionId PRICING_PLANS.READ_ORDERS
2102
- * @webhook
2103
- * @eventType wix.pricing_plans.v2.order_started
2104
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2105
- * @slug started
2265
+ * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2266
+ *
2267
+ * Resuming an order causes the following changes:
2268
+ * - The order status changes to `"ACTIVE"`.
2269
+ * - The `pausePeriods` array is updated.
2270
+ * - The `endDate` for the order is adjusted to include the pause period.
2271
+ * - For orders with recurring payments, the payment schedule is restarted.
2272
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2273
+ *
2274
+ * To pause an order, call Pause Order.
2275
+ * @param _id - Order ID.
2276
+ * @public
2277
+ * @requiredField _id
2278
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2279
+ * @applicableIdentity APP
2280
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2106
2281
  */
2107
- declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2282
+ declare function resumeOrder(_id: string): Promise<void>;
2108
2283
  /**
2109
2284
  * Creates an online order for a site member.
2110
2285
  *
@@ -2305,180 +2480,6 @@ interface GetPricePreviewOptions {
2305
2480
  */
2306
2481
  couponCode?: string | null;
2307
2482
  }
2308
- /**
2309
- * Retrieves an order by ID.
2310
- * @param _id - Order ID.
2311
- * @public
2312
- * @requiredField _id
2313
- * @param options - Options to use when getting an order.
2314
- * @permissionId PRICING_PLANS.READ_ORDERS
2315
- * @applicableIdentity APP
2316
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2317
- */
2318
- 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`, 5>>;
2319
- interface ManagementGetOrderOptions {
2320
- /**
2321
- * Predefined set of fields to return.
2322
- *
2323
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2324
- */
2325
- fieldSet?: SetWithLiterals;
2326
- }
2327
- /**
2328
- * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2329
- *
2330
- * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2331
- * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2332
- * @public
2333
- * @param options - Filtering, sorting, and pagination options.
2334
- * @permissionId PRICING_PLANS.READ_ORDERS
2335
- * @applicableIdentity APP
2336
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2337
- */
2338
- 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`, 4>>;
2339
- interface ManagementListOrdersOptions {
2340
- /**
2341
- * Filter by a buyer's member ID, from the Members API.
2342
- * @format GUID
2343
- */
2344
- buyerIds?: string[];
2345
- /**
2346
- * Filter by plan IDs, from the Plans API.
2347
- * @format GUID
2348
- */
2349
- planIds?: string[];
2350
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2351
- autoRenewCanceled?: boolean | null;
2352
- /** Filter by order status. */
2353
- orderStatuses?: OrderStatusWithLiterals[];
2354
- /** Filter by payment status. */
2355
- paymentStatuses?: PaymentStatusWithLiterals[];
2356
- /**
2357
- * Number of orders to return. See Sorting and Paging for more information.
2358
- *
2359
- * Max: `50`
2360
- * @min 1
2361
- * @max 50
2362
- */
2363
- limit?: number | null;
2364
- /** Number of orders to skip in the current sort order. */
2365
- offset?: number | null;
2366
- /**
2367
- * Sort order.
2368
- *
2369
- * Use `ASC` for ascending order or `DESC` for descending order.
2370
- *
2371
- * Default: `DESC`.
2372
- */
2373
- sorting?: Sorting;
2374
- /**
2375
- * Predefined set of fields to return.
2376
- *
2377
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2378
- */
2379
- fieldSet?: SetWithLiterals;
2380
- }
2381
- /**
2382
- * 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.
2383
- *
2384
- * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2385
- * Can't postpone an order with `status`: `PAUSED`.
2386
- * @param _id - Order ID.
2387
- * @param endDate - New end date and time.
2388
- *
2389
- * Must be later than the current end date and time.
2390
- * @public
2391
- * @requiredField _id
2392
- * @requiredField endDate
2393
- * @param options - Options for postponing the end date of an order.
2394
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2395
- * @applicableIdentity APP
2396
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2397
- */
2398
- declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2399
- /**
2400
- * Cancels an existing order.
2401
- *
2402
- * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2403
- * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2404
- *
2405
- * #### Canceling during the free trial period.
2406
- *
2407
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2408
- * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2409
- * of the free trial period.
2410
- *
2411
- * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2412
- * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2413
- * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2414
- * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2415
- * Then, the subscription ends and the buyer is not billed.
2416
- * @param _id - Order ID.
2417
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2418
- * @public
2419
- * @requiredField _id
2420
- * @requiredField effectiveAt
2421
- * @param options - Options for canceling orders.
2422
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2423
- * @applicableIdentity APP
2424
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2425
- */
2426
- declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2427
- /**
2428
- * Marks an offline order as paid.
2429
- * > __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.
2430
- *
2431
- * Marking an offline order as paid causes the following changes:
2432
- * - The order's `lastPaymentStatus` changes to `"PAID"`.
2433
- * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2434
- *
2435
- * An error occurs if you attempt to:
2436
- * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2437
- * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2438
- * @param _id - Order ID.
2439
- * @public
2440
- * @requiredField _id
2441
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2442
- * @applicableIdentity APP
2443
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2444
- */
2445
- declare function markAsPaid(_id: string): Promise<void>;
2446
- /**
2447
- * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2448
- *
2449
- * Only orders with `status`: `ACTIVE` can be paused.
2450
- * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2451
- * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2452
- * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2453
- *
2454
- * To resume a paused order, call Resume Order.
2455
- * @param _id - Order ID.
2456
- * @public
2457
- * @requiredField _id
2458
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2459
- * @applicableIdentity APP
2460
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2461
- */
2462
- declare function pauseOrder(_id: string): Promise<void>;
2463
- /**
2464
- * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2465
- *
2466
- * Resuming an order causes the following changes:
2467
- * - The order status changes to `"ACTIVE"`.
2468
- * - The `pausePeriods` array is updated.
2469
- * - The `endDate` for the order is adjusted to include the pause period.
2470
- * - For orders with recurring payments, the payment schedule is restarted.
2471
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2472
- *
2473
- * To pause an order, call Pause Order.
2474
- * @param _id - Order ID.
2475
- * @public
2476
- * @requiredField _id
2477
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2478
- * @applicableIdentity APP
2479
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2480
- */
2481
- declare function resumeOrder(_id: string): Promise<void>;
2482
2483
  /**
2483
2484
  * Retrieves an order for the currently logged-in member by ID.
2484
2485
  * @param _id - Order ID.