@wix/auto_sdk_pricing-plans_orders 1.0.142 → 1.0.143

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