@wix/auto_sdk_pricing-plans_orders 1.0.97 → 1.0.98

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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +153 -153
  2. package/build/cjs/index.js +642 -642
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +608 -608
  5. package/build/cjs/index.typings.js +507 -507
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +459 -459
  8. package/build/cjs/meta.js +403 -403
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +153 -153
  11. package/build/es/index.mjs +642 -642
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +608 -608
  14. package/build/es/index.typings.mjs +507 -507
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +459 -459
  17. package/build/es/meta.mjs +403 -403
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +153 -153
  20. package/build/internal/cjs/index.js +642 -642
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +608 -608
  23. package/build/internal/cjs/index.typings.js +507 -507
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +459 -459
  26. package/build/internal/cjs/meta.js +403 -403
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +153 -153
  29. package/build/internal/es/index.mjs +642 -642
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +608 -608
  32. package/build/internal/es/index.typings.mjs +507 -507
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +459 -459
  35. package/build/internal/es/meta.mjs +403 -403
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -626,7 +626,35 @@ interface ActionEvent {
626
626
  }
627
627
  interface Empty {
628
628
  }
629
- interface MemberGetOrderRequest {
629
+ interface OrderPurchased {
630
+ /** Order that was paid for. If a free or an offline order, the order that was created. */
631
+ order?: Order;
632
+ }
633
+ interface OrderStarted {
634
+ /** Order that reached its `startDate`. */
635
+ order?: Order;
636
+ }
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. */
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;
647
+ }
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;
652
+ }
653
+ interface OrderEnded {
654
+ /** Order that ended. */
655
+ order?: Order;
656
+ }
657
+ interface GetOrderRequest {
630
658
  /**
631
659
  * Order ID.
632
660
  * @format GUID
@@ -649,31 +677,44 @@ declare enum Set {
649
677
  }
650
678
  /** @enumType */
651
679
  type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
652
- interface MemberGetOrderResponse {
653
- /** Requested order. */
680
+ interface GetOrderResponse {
681
+ /** Order. */
654
682
  order?: Order;
655
683
  }
656
- interface MemberListOrdersRequest {
684
+ interface ListOrdersRequest {
657
685
  /**
658
- * Filter by plan IDs.
686
+ * Filter by a buyer's member ID, from the Members API.
687
+ * @format GUID
688
+ */
689
+ buyerIds?: string[];
690
+ /**
691
+ * Filter by plan IDs, from the Plans API.
659
692
  * @format GUID
660
693
  */
661
694
  planIds?: string[];
662
- /** Filter for orders where auto renewal was canceled. */
695
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
663
696
  autoRenewCanceled?: boolean | null;
664
697
  /** Filter by order status. */
665
698
  orderStatuses?: OrderStatusWithLiterals[];
666
699
  /** Filter by payment status. */
667
700
  paymentStatuses?: PaymentStatusWithLiterals[];
668
701
  /**
669
- * Limit the number of pricing plans returned. Default limit is 50.
702
+ * Number of orders to return. See Sorting and Paging for more information.
703
+ *
704
+ * Max: `50`
670
705
  * @min 1
671
706
  * @max 50
672
707
  */
673
708
  limit?: number | null;
674
- /** Number of entries to offset. */
709
+ /** Number of orders to skip in the current sort order. */
675
710
  offset?: number | null;
676
- /** Sorting direction (defaults to ASC) and field to sort by. */
711
+ /**
712
+ * Sort order.
713
+ *
714
+ * Use `ASC` for ascending order or `DESC` for descending order.
715
+ *
716
+ * Default: `DESC`.
717
+ */
677
718
  sorting?: Sorting;
678
719
  /**
679
720
  * Predefined set of fields to return.
@@ -697,8 +738,8 @@ declare enum SortOrder {
697
738
  }
698
739
  /** @enumType */
699
740
  type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
700
- interface MemberListOrdersResponse {
701
- /** Requested orders. */
741
+ interface ListOrdersResponse {
742
+ /** List of orders. */
702
743
  orders?: Order[];
703
744
  /** Object containing paging-related data (number of orders returned, offset). */
704
745
  pagingMetadata?: PagingMetadataV2;
@@ -727,11 +768,7 @@ interface Cursors {
727
768
  */
728
769
  prev?: string | null;
729
770
  }
730
- /**
731
- * TODO: Write orders filter and sort docs page
732
- * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
733
- */
734
- interface QueryOrdersRequest {
771
+ interface OrdersQueryOrdersRequest {
735
772
  /** Query filter. */
736
773
  query?: QueryV2;
737
774
  }
@@ -785,22 +822,84 @@ interface CursorPaging {
785
822
  */
786
823
  cursor?: string | null;
787
824
  }
788
- interface QueryOrdersResponse {
789
- /** Order data. */
825
+ interface OrdersQueryOrdersResponse {
826
+ /** Retrieved orders. */
790
827
  plans?: Order[];
791
828
  /** Paging-related data (number of orders returned, offset). */
792
829
  pagingMetadata?: PagingMetadataV2;
793
830
  }
794
- interface RequestCancellationRequest {
831
+ interface GetOrdersStatsRequest {
832
+ }
833
+ interface GetOrdersStatsResponse {
834
+ /** Total number of orders. */
835
+ totalOrderCount?: number;
836
+ /** Number of active orders. */
837
+ activeOrderCount?: number;
838
+ }
839
+ interface GetAvailableOrderActionsRequest {
840
+ /**
841
+ * Order ID.
842
+ * @format GUID
843
+ */
844
+ _id?: string;
845
+ }
846
+ interface GetAvailableOrderActionsResponse {
847
+ /** Whether the order can be suspended. */
848
+ suspendable?: boolean;
849
+ /** If the order cannot be suspended, a reason is returned here. */
850
+ notSuspendableReason?: ReasonNotSuspendableWithLiterals;
851
+ /** Whether the order can be canceled by the buyer. */
852
+ cancelableByBuyer?: boolean;
853
+ }
854
+ declare enum ReasonNotSuspendable {
855
+ /** Undefined reason. */
856
+ UNDEFINED = "UNDEFINED",
857
+ /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
858
+ PENDING = "PENDING",
859
+ /** Trial orders can't be suspended. */
860
+ TRIAL = "TRIAL",
861
+ /** Canceled orders can't be suspended. */
862
+ CANCELED = "CANCELED",
863
+ /** Ended orders can't be suspended. */
864
+ ENDED = "ENDED",
865
+ /** Paid for orders with future start dates can't be suspended. */
866
+ NOT_STARTED = "NOT_STARTED",
867
+ /** Order is already suspended. */
868
+ ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
869
+ /** Orders based on recurring payments using older stripe versions can't be suspended. */
870
+ OLD_STRIPE = "OLD_STRIPE"
871
+ }
872
+ /** @enumType */
873
+ type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
874
+ interface PostponeEndDateRequest {
795
875
  /**
796
876
  * Order ID.
797
877
  * @format GUID
798
878
  */
799
879
  _id: string;
800
- /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
880
+ /**
881
+ * New end date and time.
882
+ *
883
+ * Must be later than the current end date and time.
884
+ */
885
+ endDate: Date | null;
886
+ }
887
+ interface PostponeEndDateResponse {
888
+ }
889
+ interface OrderEndDatePostponed {
890
+ /** Order whose `endDate` was postponed. */
891
+ order?: Order;
892
+ }
893
+ interface CancelOrderRequest {
894
+ /**
895
+ * Order ID.
896
+ * @format GUID
897
+ */
898
+ _id: string;
899
+ /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
801
900
  effectiveAt: CancellationEffectiveAtWithLiterals;
802
901
  }
803
- interface RequestCancellationResponse {
902
+ interface CancelOrderResponse {
804
903
  }
805
904
  /**
806
905
  * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
@@ -811,6 +910,111 @@ interface OrderCanceled {
811
910
  /** Canceled order. */
812
911
  order?: Order;
813
912
  }
913
+ interface MarkAsPaidRequest {
914
+ /**
915
+ * Order ID.
916
+ * @format GUID
917
+ */
918
+ _id: string;
919
+ }
920
+ interface MarkAsPaidResponse {
921
+ }
922
+ interface OrderMarkedAsPaid {
923
+ /** Order that was marked as paid. */
924
+ order?: Order;
925
+ }
926
+ interface PauseOrderRequest {
927
+ /**
928
+ * Order ID.
929
+ * @format GUID
930
+ */
931
+ _id: string;
932
+ }
933
+ interface PauseOrderResponse {
934
+ }
935
+ interface OrderPaused {
936
+ /** Paused order. */
937
+ order?: Order;
938
+ }
939
+ interface BulkPauseOrderRequest {
940
+ /**
941
+ * List of Order IDs.
942
+ * @format GUID
943
+ * @minSize 1
944
+ * @maxSize 100
945
+ */
946
+ ids?: string[];
947
+ /** Set to true to return Order entity in response. */
948
+ returnFullEntity?: boolean;
949
+ }
950
+ interface BulkPauseOrderResponse {
951
+ /** Orders that were paused. */
952
+ results?: BulkOrderResult[];
953
+ /** Bulk action metadata. */
954
+ bulkActionMetadata?: BulkActionMetadata;
955
+ }
956
+ interface BulkOrderResult {
957
+ /** Item metadata */
958
+ itemMetadata?: ItemMetadata;
959
+ /** The order. */
960
+ order?: Order;
961
+ }
962
+ interface ItemMetadata {
963
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
964
+ _id?: string | null;
965
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
966
+ originalIndex?: number;
967
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
968
+ success?: boolean;
969
+ /** Details about the error in case of failure. */
970
+ error?: ApplicationError;
971
+ }
972
+ interface ApplicationError {
973
+ /** Error code. */
974
+ code?: string;
975
+ /** Description of the error. */
976
+ description?: string;
977
+ /** Data related to the error. */
978
+ data?: Record<string, any> | null;
979
+ }
980
+ interface BulkActionMetadata {
981
+ /** Number of items that were successfully processed. */
982
+ totalSuccesses?: number;
983
+ /** Number of items that couldn't be processed. */
984
+ totalFailures?: number;
985
+ /** Number of failures without details because detailed failure threshold was exceeded. */
986
+ undetailedFailures?: number;
987
+ }
988
+ interface ResumeOrderRequest {
989
+ /**
990
+ * Order ID.
991
+ * @format GUID
992
+ */
993
+ _id: string;
994
+ }
995
+ interface ResumeOrderResponse {
996
+ }
997
+ interface OrderResumed {
998
+ /** Resumed order. */
999
+ order?: Order;
1000
+ }
1001
+ interface BulkResumeOrderRequest {
1002
+ /**
1003
+ * List of Order IDs.
1004
+ * @format GUID
1005
+ * @minSize 1
1006
+ * @maxSize 100
1007
+ */
1008
+ ids?: string[];
1009
+ /** Set to true to return Order entity in response. */
1010
+ returnFullEntity?: boolean;
1011
+ }
1012
+ interface BulkResumeOrderResponse {
1013
+ /** Orders that were resumed. */
1014
+ results?: BulkOrderResult[];
1015
+ /** Bulk action metadata. */
1016
+ bulkActionMetadata?: BulkActionMetadata;
1017
+ }
814
1018
  interface MessageEnvelope {
815
1019
  /**
816
1020
  * App instance ID.
@@ -902,16 +1106,93 @@ interface AccountInfo {
902
1106
  */
903
1107
  siteId?: string | null;
904
1108
  }
905
- interface CreateOnlineOrderRequest {
1109
+ interface MemberGetOrderRequest {
906
1110
  /**
907
- * Plan ID.
1111
+ * Order ID.
908
1112
  * @format GUID
909
1113
  */
910
- planId: string;
1114
+ _id: string;
911
1115
  /**
912
- * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1116
+ * Predefined set of fields to return.
913
1117
  *
914
- * Default: Current date and time.
1118
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1119
+ */
1120
+ fieldSet?: SetWithLiterals;
1121
+ }
1122
+ interface MemberGetOrderResponse {
1123
+ /** Requested order. */
1124
+ order?: Order;
1125
+ }
1126
+ interface MemberListOrdersRequest {
1127
+ /**
1128
+ * Filter by plan IDs.
1129
+ * @format GUID
1130
+ */
1131
+ planIds?: string[];
1132
+ /** Filter for orders where auto renewal was canceled. */
1133
+ autoRenewCanceled?: boolean | null;
1134
+ /** Filter by order status. */
1135
+ orderStatuses?: OrderStatusWithLiterals[];
1136
+ /** Filter by payment status. */
1137
+ paymentStatuses?: PaymentStatusWithLiterals[];
1138
+ /**
1139
+ * Limit the number of pricing plans returned. Default limit is 50.
1140
+ * @min 1
1141
+ * @max 50
1142
+ */
1143
+ limit?: number | null;
1144
+ /** Number of entries to offset. */
1145
+ offset?: number | null;
1146
+ /** Sorting direction (defaults to ASC) and field to sort by. */
1147
+ sorting?: Sorting;
1148
+ /**
1149
+ * Predefined set of fields to return.
1150
+ *
1151
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1152
+ */
1153
+ fieldSet?: SetWithLiterals;
1154
+ }
1155
+ interface MemberListOrdersResponse {
1156
+ /** Requested orders. */
1157
+ orders?: Order[];
1158
+ /** Object containing paging-related data (number of orders returned, offset). */
1159
+ pagingMetadata?: PagingMetadataV2;
1160
+ }
1161
+ /**
1162
+ * TODO: Write orders filter and sort docs page
1163
+ * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
1164
+ */
1165
+ interface QueryOrdersRequest {
1166
+ /** Query filter. */
1167
+ query?: QueryV2;
1168
+ }
1169
+ interface QueryOrdersResponse {
1170
+ /** Order data. */
1171
+ plans?: Order[];
1172
+ /** Paging-related data (number of orders returned, offset). */
1173
+ pagingMetadata?: PagingMetadataV2;
1174
+ }
1175
+ interface RequestCancellationRequest {
1176
+ /**
1177
+ * Order ID.
1178
+ * @format GUID
1179
+ */
1180
+ _id: string;
1181
+ /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
1182
+ effectiveAt: CancellationEffectiveAtWithLiterals;
1183
+ }
1184
+ interface RequestCancellationResponse {
1185
+ }
1186
+ interface CreateOnlineOrderRequest {
1187
+ /**
1188
+ * Plan ID.
1189
+ * @format GUID
1190
+ */
1191
+ planId: string;
1192
+ /**
1193
+ * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1194
+ *
1195
+ * Default: Current date and time.
915
1196
  */
916
1197
  startDate?: Date | null;
917
1198
  /**
@@ -1205,287 +1486,6 @@ interface SetSubmissionResponse {
1205
1486
  /** Order with submission id */
1206
1487
  order?: Order;
1207
1488
  }
1208
- interface OrderPurchased {
1209
- /** Order that was paid for. If a free or an offline order, the order that was created. */
1210
- order?: Order;
1211
- }
1212
- interface OrderStarted {
1213
- /** Order that reached its `startDate`. */
1214
- order?: Order;
1215
- }
1216
- /**
1217
- * Triggered at the start of a new payment cycle for an existing order.
1218
- *
1219
- * This webhook does not trigger at the initial start of an offline order.
1220
- */
1221
- interface OrderCycleStarted {
1222
- /** Order whose new cycle started. */
1223
- order?: Order;
1224
- /** 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. */
1225
- cycleNumber?: number;
1226
- }
1227
- /** Emitted when a recurring order is canceled for the next payment cycle */
1228
- interface OrderAutoRenewCanceled {
1229
- /** Order that is canceled, effective at the end of the current payment cycle. */
1230
- order?: Order;
1231
- }
1232
- interface OrderEnded {
1233
- /** Order that ended. */
1234
- order?: Order;
1235
- }
1236
- interface GetOrderRequest {
1237
- /**
1238
- * Order ID.
1239
- * @format GUID
1240
- */
1241
- _id: string;
1242
- /**
1243
- * Predefined set of fields to return.
1244
- *
1245
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1246
- */
1247
- fieldSet?: SetWithLiterals;
1248
- }
1249
- interface GetOrderResponse {
1250
- /** Order. */
1251
- order?: Order;
1252
- }
1253
- interface ListOrdersRequest {
1254
- /**
1255
- * Filter by a buyer's member ID, from the Members API.
1256
- * @format GUID
1257
- */
1258
- buyerIds?: string[];
1259
- /**
1260
- * Filter by plan IDs, from the Plans API.
1261
- * @format GUID
1262
- */
1263
- planIds?: string[];
1264
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
1265
- autoRenewCanceled?: boolean | null;
1266
- /** Filter by order status. */
1267
- orderStatuses?: OrderStatusWithLiterals[];
1268
- /** Filter by payment status. */
1269
- paymentStatuses?: PaymentStatusWithLiterals[];
1270
- /**
1271
- * Number of orders to return. See Sorting and Paging for more information.
1272
- *
1273
- * Max: `50`
1274
- * @min 1
1275
- * @max 50
1276
- */
1277
- limit?: number | null;
1278
- /** Number of orders to skip in the current sort order. */
1279
- offset?: number | null;
1280
- /**
1281
- * Sort order.
1282
- *
1283
- * Use `ASC` for ascending order or `DESC` for descending order.
1284
- *
1285
- * Default: `DESC`.
1286
- */
1287
- sorting?: Sorting;
1288
- /**
1289
- * Predefined set of fields to return.
1290
- *
1291
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1292
- */
1293
- fieldSet?: SetWithLiterals;
1294
- }
1295
- interface ListOrdersResponse {
1296
- /** List of orders. */
1297
- orders?: Order[];
1298
- /** Object containing paging-related data (number of orders returned, offset). */
1299
- pagingMetadata?: PagingMetadataV2;
1300
- }
1301
- interface OrdersQueryOrdersRequest {
1302
- /** Query filter. */
1303
- query?: QueryV2;
1304
- }
1305
- interface OrdersQueryOrdersResponse {
1306
- /** Retrieved orders. */
1307
- plans?: Order[];
1308
- /** Paging-related data (number of orders returned, offset). */
1309
- pagingMetadata?: PagingMetadataV2;
1310
- }
1311
- interface GetOrdersStatsRequest {
1312
- }
1313
- interface GetOrdersStatsResponse {
1314
- /** Total number of orders. */
1315
- totalOrderCount?: number;
1316
- /** Number of active orders. */
1317
- activeOrderCount?: number;
1318
- }
1319
- interface GetAvailableOrderActionsRequest {
1320
- /**
1321
- * Order ID.
1322
- * @format GUID
1323
- */
1324
- _id?: string;
1325
- }
1326
- interface GetAvailableOrderActionsResponse {
1327
- /** Whether the order can be suspended. */
1328
- suspendable?: boolean;
1329
- /** If the order cannot be suspended, a reason is returned here. */
1330
- notSuspendableReason?: ReasonNotSuspendableWithLiterals;
1331
- /** Whether the order can be canceled by the buyer. */
1332
- cancelableByBuyer?: boolean;
1333
- }
1334
- declare enum ReasonNotSuspendable {
1335
- /** Undefined reason. */
1336
- UNDEFINED = "UNDEFINED",
1337
- /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
1338
- PENDING = "PENDING",
1339
- /** Trial orders can't be suspended. */
1340
- TRIAL = "TRIAL",
1341
- /** Canceled orders can't be suspended. */
1342
- CANCELED = "CANCELED",
1343
- /** Ended orders can't be suspended. */
1344
- ENDED = "ENDED",
1345
- /** Paid for orders with future start dates can't be suspended. */
1346
- NOT_STARTED = "NOT_STARTED",
1347
- /** Order is already suspended. */
1348
- ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
1349
- /** Orders based on recurring payments using older stripe versions can't be suspended. */
1350
- OLD_STRIPE = "OLD_STRIPE"
1351
- }
1352
- /** @enumType */
1353
- type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
1354
- interface PostponeEndDateRequest {
1355
- /**
1356
- * Order ID.
1357
- * @format GUID
1358
- */
1359
- _id: string;
1360
- /**
1361
- * New end date and time.
1362
- *
1363
- * Must be later than the current end date and time.
1364
- */
1365
- endDate: Date | null;
1366
- }
1367
- interface PostponeEndDateResponse {
1368
- }
1369
- interface OrderEndDatePostponed {
1370
- /** Order whose `endDate` was postponed. */
1371
- order?: Order;
1372
- }
1373
- interface CancelOrderRequest {
1374
- /**
1375
- * Order ID.
1376
- * @format GUID
1377
- */
1378
- _id: string;
1379
- /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
1380
- effectiveAt: CancellationEffectiveAtWithLiterals;
1381
- }
1382
- interface CancelOrderResponse {
1383
- }
1384
- interface MarkAsPaidRequest {
1385
- /**
1386
- * Order ID.
1387
- * @format GUID
1388
- */
1389
- _id: string;
1390
- }
1391
- interface MarkAsPaidResponse {
1392
- }
1393
- interface OrderMarkedAsPaid {
1394
- /** Order that was marked as paid. */
1395
- order?: Order;
1396
- }
1397
- interface PauseOrderRequest {
1398
- /**
1399
- * Order ID.
1400
- * @format GUID
1401
- */
1402
- _id: string;
1403
- }
1404
- interface PauseOrderResponse {
1405
- }
1406
- interface OrderPaused {
1407
- /** Paused order. */
1408
- order?: Order;
1409
- }
1410
- interface BulkPauseOrderRequest {
1411
- /**
1412
- * List of Order IDs.
1413
- * @format GUID
1414
- * @minSize 1
1415
- * @maxSize 100
1416
- */
1417
- ids?: string[];
1418
- /** Set to true to return Order entity in response. */
1419
- returnFullEntity?: boolean;
1420
- }
1421
- interface BulkPauseOrderResponse {
1422
- /** Orders that were paused. */
1423
- results?: BulkOrderResult[];
1424
- /** Bulk action metadata. */
1425
- bulkActionMetadata?: BulkActionMetadata;
1426
- }
1427
- interface BulkOrderResult {
1428
- /** Item metadata */
1429
- itemMetadata?: ItemMetadata;
1430
- /** The order. */
1431
- order?: Order;
1432
- }
1433
- interface ItemMetadata {
1434
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1435
- _id?: string | null;
1436
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1437
- originalIndex?: number;
1438
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1439
- success?: boolean;
1440
- /** Details about the error in case of failure. */
1441
- error?: ApplicationError;
1442
- }
1443
- interface ApplicationError {
1444
- /** Error code. */
1445
- code?: string;
1446
- /** Description of the error. */
1447
- description?: string;
1448
- /** Data related to the error. */
1449
- data?: Record<string, any> | null;
1450
- }
1451
- interface BulkActionMetadata {
1452
- /** Number of items that were successfully processed. */
1453
- totalSuccesses?: number;
1454
- /** Number of items that couldn't be processed. */
1455
- totalFailures?: number;
1456
- /** Number of failures without details because detailed failure threshold was exceeded. */
1457
- undetailedFailures?: number;
1458
- }
1459
- interface ResumeOrderRequest {
1460
- /**
1461
- * Order ID.
1462
- * @format GUID
1463
- */
1464
- _id: string;
1465
- }
1466
- interface ResumeOrderResponse {
1467
- }
1468
- interface OrderResumed {
1469
- /** Resumed order. */
1470
- order?: Order;
1471
- }
1472
- interface BulkResumeOrderRequest {
1473
- /**
1474
- * List of Order IDs.
1475
- * @format GUID
1476
- * @minSize 1
1477
- * @maxSize 100
1478
- */
1479
- ids?: string[];
1480
- /** Set to true to return Order entity in response. */
1481
- returnFullEntity?: boolean;
1482
- }
1483
- interface BulkResumeOrderResponse {
1484
- /** Orders that were resumed. */
1485
- results?: BulkOrderResult[];
1486
- /** Bulk action metadata. */
1487
- bulkActionMetadata?: BulkActionMetadata;
1488
- }
1489
1489
  /** @docsIgnore */
1490
1490
  type CreateOnlineOrderApplicationErrors = {
1491
1491
  code?: 'MEMBER_REQUIRED';
@@ -1837,6 +1837,31 @@ interface AccountInfoMetadata {
1837
1837
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
1838
1838
  parentAccountId?: string;
1839
1839
  }
1840
+ interface OrderAutoRenewCanceledEnvelope {
1841
+ data: OrderAutoRenewCanceled;
1842
+ metadata: EventMetadata;
1843
+ }
1844
+ /**
1845
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1846
+ *
1847
+ * This webhook is *not* triggered in the following scenarios:
1848
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1849
+ * + 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.
1850
+ * @permissionScope Manage Orders
1851
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1852
+ * @permissionScope Read Orders
1853
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1854
+ * @permissionScope Manage plans and orders of Pricing Plans
1855
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1856
+ * @permissionScope Manage Events
1857
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1858
+ * @permissionId PRICING_PLANS.READ_ORDERS
1859
+ * @webhook
1860
+ * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1861
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1862
+ * @slug auto_renew_canceled
1863
+ */
1864
+ declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1840
1865
  interface OrderCanceledEnvelope {
1841
1866
  data: OrderCanceled;
1842
1867
  metadata: EventMetadata;
@@ -1858,16 +1883,18 @@ interface OrderCanceledEnvelope {
1858
1883
  * @permissionId PRICING_PLANS.READ_ORDERS
1859
1884
  * @webhook
1860
1885
  * @eventType wix.pricing_plans.v2.order_canceled
1861
- * @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
1886
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1862
1887
  * @slug canceled
1863
1888
  */
1864
1889
  declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1865
- interface OrderCreatedEnvelope {
1866
- entity: Order;
1890
+ interface OrderCycleStartedEnvelope {
1891
+ data: OrderCycleStarted;
1867
1892
  metadata: EventMetadata;
1868
1893
  }
1869
1894
  /**
1870
- * Triggered when an order is created.
1895
+ * Triggered at the start of a new payment cycle for an existing order.
1896
+ *
1897
+ * Not triggered at the initial start of an offline order.
1871
1898
  * @permissionScope Manage Orders
1872
1899
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1873
1900
  * @permissionScope Read Orders
@@ -1878,17 +1905,17 @@ interface OrderCreatedEnvelope {
1878
1905
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1879
1906
  * @permissionId PRICING_PLANS.READ_ORDERS
1880
1907
  * @webhook
1881
- * @eventType wix.pricing_plans.v2.order_created
1882
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1883
- * @slug created
1908
+ * @eventType wix.pricing_plans.v2.order_cycle_started
1909
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1910
+ * @slug cycle_started
1884
1911
  */
1885
- declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
1886
- interface OrderStartDateChangedEnvelope {
1887
- data: OrderStartDateChanged;
1912
+ declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1913
+ interface OrderEndDatePostponedEnvelope {
1914
+ data: OrderEndDatePostponed;
1888
1915
  metadata: EventMetadata;
1889
1916
  }
1890
1917
  /**
1891
- * Triggered when an order's `startDate` is changed.
1918
+ * Triggered when an order's `endDate` is postponed.
1892
1919
  * @permissionScope Manage Orders
1893
1920
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1894
1921
  * @permissionScope Read Orders
@@ -1899,25 +1926,21 @@ interface OrderStartDateChangedEnvelope {
1899
1926
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1900
1927
  * @permissionId PRICING_PLANS.READ_ORDERS
1901
1928
  * @webhook
1902
- * @eventType wix.pricing_plans.v2.order_start_date_changed
1903
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1904
- * @slug start_date_changed
1929
+ * @eventType wix.pricing_plans.v2.order_end_date_postponed
1930
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1931
+ * @slug end_date_postponed
1905
1932
  */
1906
- declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
1907
- interface OrderUpdatedEnvelope {
1908
- entity: Order;
1933
+ declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
1934
+ interface OrderEndedEnvelope {
1935
+ data: OrderEnded;
1909
1936
  metadata: EventMetadata;
1910
1937
  }
1911
1938
  /**
1912
- * Triggered for any of the following update events:
1939
+ * Triggered when an order ends.
1913
1940
  *
1914
- * + Order is paid for. Order Purchased is also triggered.
1915
- * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
1916
- * + New payment cycle of an order starts. Order Cycle Started is also triggered.
1917
- * + Offline order is marked as paid. Order Marked As Paid is also triggered.
1918
- * + End date of the order is postponed. Order End Date Postponed is also triggered
1919
- * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
1920
- * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
1941
+ * This webhook is triggered:
1942
+ * + When an order expires at the end of the current payment cycle.
1943
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
1921
1944
  * @permissionScope Manage Orders
1922
1945
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1923
1946
  * @permissionScope Read Orders
@@ -1928,21 +1951,17 @@ interface OrderUpdatedEnvelope {
1928
1951
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1929
1952
  * @permissionId PRICING_PLANS.READ_ORDERS
1930
1953
  * @webhook
1931
- * @eventType wix.pricing_plans.v2.order_updated
1932
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1933
- * @slug updated
1954
+ * @eventType wix.pricing_plans.v2.order_ended
1955
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1956
+ * @slug ended
1934
1957
  */
1935
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
1936
- interface OrderAutoRenewCanceledEnvelope {
1937
- data: OrderAutoRenewCanceled;
1958
+ declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
1959
+ interface OrderMarkedAsPaidEnvelope {
1960
+ data: OrderMarkedAsPaid;
1938
1961
  metadata: EventMetadata;
1939
1962
  }
1940
1963
  /**
1941
- * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1942
- *
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.
1964
+ * Triggered when an offline order is marked as paid.
1946
1965
  * @permissionScope Manage Orders
1947
1966
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1948
1967
  * @permissionScope Read Orders
@@ -1953,19 +1972,17 @@ interface OrderAutoRenewCanceledEnvelope {
1953
1972
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1954
1973
  * @permissionId PRICING_PLANS.READ_ORDERS
1955
1974
  * @webhook
1956
- * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1975
+ * @eventType wix.pricing_plans.v2.order_marked_as_paid
1957
1976
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1958
- * @slug auto_renew_canceled
1977
+ * @slug marked_as_paid
1959
1978
  */
1960
- declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1961
- interface OrderCycleStartedEnvelope {
1962
- data: OrderCycleStarted;
1979
+ declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
1980
+ interface OrderPausedEnvelope {
1981
+ data: OrderPaused;
1963
1982
  metadata: EventMetadata;
1964
1983
  }
1965
1984
  /**
1966
- * Triggered at the start of a new payment cycle for an existing order.
1967
- *
1968
- * Not triggered at the initial start of an offline order.
1985
+ * Triggered when an order is paused.
1969
1986
  * @permissionScope Manage Orders
1970
1987
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1971
1988
  * @permissionScope Read Orders
@@ -1976,17 +1993,21 @@ interface OrderCycleStartedEnvelope {
1976
1993
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1977
1994
  * @permissionId PRICING_PLANS.READ_ORDERS
1978
1995
  * @webhook
1979
- * @eventType wix.pricing_plans.v2.order_cycle_started
1996
+ * @eventType wix.pricing_plans.v2.order_paused
1980
1997
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1981
- * @slug cycle_started
1998
+ * @slug paused
1982
1999
  */
1983
- declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1984
- interface OrderEndDatePostponedEnvelope {
1985
- data: OrderEndDatePostponed;
2000
+ declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2001
+ interface OrderPurchasedEnvelope {
2002
+ data: OrderPurchased;
1986
2003
  metadata: EventMetadata;
1987
2004
  }
1988
2005
  /**
1989
- * Triggered when an order's `endDate` is postponed.
2006
+ * Triggered for any of the following purchase events:
2007
+ * + Order is paid in full.
2008
+ * + At least 1 order cycle payment is paid for.
2009
+ * + Offline order is created, even if not yet marked as paid.
2010
+ * + Free order is created.
1990
2011
  * @permissionScope Manage Orders
1991
2012
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1992
2013
  * @permissionScope Read Orders
@@ -1997,21 +2018,17 @@ interface OrderEndDatePostponedEnvelope {
1997
2018
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1998
2019
  * @permissionId PRICING_PLANS.READ_ORDERS
1999
2020
  * @webhook
2000
- * @eventType wix.pricing_plans.v2.order_end_date_postponed
2021
+ * @eventType wix.pricing_plans.v2.order_purchased
2001
2022
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2002
- * @slug end_date_postponed
2023
+ * @slug purchased
2003
2024
  */
2004
- declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
2005
- interface OrderEndedEnvelope {
2006
- data: OrderEnded;
2025
+ declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2026
+ interface OrderResumedEnvelope {
2027
+ data: OrderResumed;
2007
2028
  metadata: EventMetadata;
2008
2029
  }
2009
2030
  /**
2010
- * Triggered when an order ends.
2011
- *
2012
- * This webhook is triggered:
2013
- * + When an order expires at the end of the current payment cycle.
2014
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
2031
+ * Triggered when a paused order is resumed.
2015
2032
  * @permissionScope Manage Orders
2016
2033
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2017
2034
  * @permissionScope Read Orders
@@ -2022,17 +2039,17 @@ interface OrderEndedEnvelope {
2022
2039
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2023
2040
  * @permissionId PRICING_PLANS.READ_ORDERS
2024
2041
  * @webhook
2025
- * @eventType wix.pricing_plans.v2.order_ended
2042
+ * @eventType wix.pricing_plans.v2.order_resumed
2026
2043
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2027
- * @slug ended
2044
+ * @slug resumed
2028
2045
  */
2029
- declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
2030
- interface OrderMarkedAsPaidEnvelope {
2031
- data: OrderMarkedAsPaid;
2046
+ declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2047
+ interface OrderStartedEnvelope {
2048
+ data: OrderStarted;
2032
2049
  metadata: EventMetadata;
2033
2050
  }
2034
2051
  /**
2035
- * Triggered when an offline order is marked as paid.
2052
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2036
2053
  * @permissionScope Manage Orders
2037
2054
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2038
2055
  * @permissionScope Read Orders
@@ -2043,17 +2060,25 @@ interface OrderMarkedAsPaidEnvelope {
2043
2060
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2044
2061
  * @permissionId PRICING_PLANS.READ_ORDERS
2045
2062
  * @webhook
2046
- * @eventType wix.pricing_plans.v2.order_marked_as_paid
2063
+ * @eventType wix.pricing_plans.v2.order_started
2047
2064
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2048
- * @slug marked_as_paid
2065
+ * @slug started
2049
2066
  */
2050
- declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
2051
- interface OrderPausedEnvelope {
2052
- data: OrderPaused;
2067
+ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2068
+ interface OrderUpdatedEnvelope {
2069
+ entity: Order;
2053
2070
  metadata: EventMetadata;
2054
2071
  }
2055
2072
  /**
2056
- * Triggered when an order is paused.
2073
+ * Triggered for any of the following update events:
2074
+ *
2075
+ * + Order is paid for. Order Purchased is also triggered.
2076
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
2077
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
2078
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
2079
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
2080
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
2081
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
2057
2082
  * @permissionScope Manage Orders
2058
2083
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2059
2084
  * @permissionScope Read Orders
@@ -2064,21 +2089,17 @@ interface OrderPausedEnvelope {
2064
2089
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2065
2090
  * @permissionId PRICING_PLANS.READ_ORDERS
2066
2091
  * @webhook
2067
- * @eventType wix.pricing_plans.v2.order_paused
2092
+ * @eventType wix.pricing_plans.v2.order_updated
2068
2093
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2069
- * @slug paused
2094
+ * @slug updated
2070
2095
  */
2071
- declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2072
- interface OrderPurchasedEnvelope {
2073
- data: OrderPurchased;
2096
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2097
+ interface OrderCreatedEnvelope {
2098
+ entity: Order;
2074
2099
  metadata: EventMetadata;
2075
2100
  }
2076
2101
  /**
2077
- * Triggered for any of the following purchase events:
2078
- * + Order is paid in full.
2079
- * + At least 1 order cycle payment is paid for.
2080
- * + Offline order is created, even if not yet marked as paid.
2081
- * + Free order is created.
2102
+ * Triggered when an order is created.
2082
2103
  * @permissionScope Manage Orders
2083
2104
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2084
2105
  * @permissionScope Read Orders
@@ -2089,53 +2110,206 @@ interface OrderPurchasedEnvelope {
2089
2110
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2090
2111
  * @permissionId PRICING_PLANS.READ_ORDERS
2091
2112
  * @webhook
2092
- * @eventType wix.pricing_plans.v2.order_purchased
2093
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2094
- * @slug purchased
2113
+ * @eventType wix.pricing_plans.v2.order_created
2114
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2115
+ * @slug created
2116
+ */
2117
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
2118
+ interface OrderStartDateChangedEnvelope {
2119
+ data: OrderStartDateChanged;
2120
+ metadata: EventMetadata;
2121
+ }
2122
+ /**
2123
+ * Triggered when an order's `startDate` is changed.
2124
+ * @permissionScope Manage Orders
2125
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2126
+ * @permissionScope Read Orders
2127
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2128
+ * @permissionScope Manage plans and orders of Pricing Plans
2129
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2130
+ * @permissionScope Manage Events
2131
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2132
+ * @permissionId PRICING_PLANS.READ_ORDERS
2133
+ * @webhook
2134
+ * @eventType wix.pricing_plans.v2.order_start_date_changed
2135
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2136
+ * @slug start_date_changed
2137
+ */
2138
+ declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
2139
+ /**
2140
+ * Retrieves an order by ID.
2141
+ * @param _id - Order ID.
2142
+ * @public
2143
+ * @requiredField _id
2144
+ * @param options - Options to use when getting an order.
2145
+ * @permissionId PRICING_PLANS.READ_ORDERS
2146
+ * @applicableIdentity APP
2147
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2148
+ */
2149
+ declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
2150
+ interface ManagementGetOrderOptions {
2151
+ /**
2152
+ * Predefined set of fields to return.
2153
+ *
2154
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2155
+ */
2156
+ fieldSet?: SetWithLiterals;
2157
+ }
2158
+ /**
2159
+ * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2160
+ *
2161
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2162
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2163
+ * @public
2164
+ * @param options - Filtering, sorting, and pagination options.
2165
+ * @permissionId PRICING_PLANS.READ_ORDERS
2166
+ * @applicableIdentity APP
2167
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2168
+ */
2169
+ declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
2170
+ interface ManagementListOrdersOptions {
2171
+ /**
2172
+ * Filter by a buyer's member ID, from the Members API.
2173
+ * @format GUID
2174
+ */
2175
+ buyerIds?: string[];
2176
+ /**
2177
+ * Filter by plan IDs, from the Plans API.
2178
+ * @format GUID
2179
+ */
2180
+ planIds?: string[];
2181
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2182
+ autoRenewCanceled?: boolean | null;
2183
+ /** Filter by order status. */
2184
+ orderStatuses?: OrderStatusWithLiterals[];
2185
+ /** Filter by payment status. */
2186
+ paymentStatuses?: PaymentStatusWithLiterals[];
2187
+ /**
2188
+ * Number of orders to return. See Sorting and Paging for more information.
2189
+ *
2190
+ * Max: `50`
2191
+ * @min 1
2192
+ * @max 50
2193
+ */
2194
+ limit?: number | null;
2195
+ /** Number of orders to skip in the current sort order. */
2196
+ offset?: number | null;
2197
+ /**
2198
+ * Sort order.
2199
+ *
2200
+ * Use `ASC` for ascending order or `DESC` for descending order.
2201
+ *
2202
+ * Default: `DESC`.
2203
+ */
2204
+ sorting?: Sorting;
2205
+ /**
2206
+ * Predefined set of fields to return.
2207
+ *
2208
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2209
+ */
2210
+ fieldSet?: SetWithLiterals;
2211
+ }
2212
+ /**
2213
+ * 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.
2214
+ *
2215
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2216
+ * Can't postpone an order with `status`: `PAUSED`.
2217
+ * @param _id - Order ID.
2218
+ * @param endDate - New end date and time.
2219
+ *
2220
+ * Must be later than the current end date and time.
2221
+ * @public
2222
+ * @requiredField _id
2223
+ * @requiredField endDate
2224
+ * @param options - Options for postponing the end date of an order.
2225
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2226
+ * @applicableIdentity APP
2227
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2228
+ */
2229
+ declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2230
+ /**
2231
+ * Cancels an existing order.
2232
+ *
2233
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2234
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2235
+ *
2236
+ * #### Canceling during the free trial period.
2237
+ *
2238
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2239
+ * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2240
+ * of the free trial period.
2241
+ *
2242
+ * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2243
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2244
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2245
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2246
+ * Then, the subscription ends and the buyer is not billed.
2247
+ * @param _id - Order ID.
2248
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2249
+ * @public
2250
+ * @requiredField _id
2251
+ * @requiredField effectiveAt
2252
+ * @param options - Options for canceling orders.
2253
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2254
+ * @applicableIdentity APP
2255
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2256
+ */
2257
+ declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2258
+ /**
2259
+ * Marks an offline order as paid.
2260
+ * > __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.
2261
+ *
2262
+ * Marking an offline order as paid causes the following changes:
2263
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2264
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2265
+ *
2266
+ * An error occurs if you attempt to:
2267
+ * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2268
+ * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2269
+ * @param _id - Order ID.
2270
+ * @public
2271
+ * @requiredField _id
2272
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2273
+ * @applicableIdentity APP
2274
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2095
2275
  */
2096
- declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2097
- interface OrderResumedEnvelope {
2098
- data: OrderResumed;
2099
- metadata: EventMetadata;
2100
- }
2276
+ declare function markAsPaid(_id: string): Promise<void>;
2101
2277
  /**
2102
- * Triggered when a paused order is resumed.
2103
- * @permissionScope Manage Orders
2104
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2105
- * @permissionScope Read Orders
2106
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2107
- * @permissionScope Manage plans and orders of Pricing Plans
2108
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2109
- * @permissionScope Manage Events
2110
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2111
- * @permissionId PRICING_PLANS.READ_ORDERS
2112
- * @webhook
2113
- * @eventType wix.pricing_plans.v2.order_resumed
2114
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2115
- * @slug resumed
2278
+ * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2279
+ *
2280
+ * Only orders with `status`: `ACTIVE` can be paused.
2281
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2282
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2283
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2284
+ *
2285
+ * To resume a paused order, call Resume Order.
2286
+ * @param _id - Order ID.
2287
+ * @public
2288
+ * @requiredField _id
2289
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2290
+ * @applicableIdentity APP
2291
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2116
2292
  */
2117
- declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2118
- interface OrderStartedEnvelope {
2119
- data: OrderStarted;
2120
- metadata: EventMetadata;
2121
- }
2293
+ declare function pauseOrder(_id: string): Promise<void>;
2122
2294
  /**
2123
- * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2124
- * @permissionScope Manage Orders
2125
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2126
- * @permissionScope Read Orders
2127
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2128
- * @permissionScope Manage plans and orders of Pricing Plans
2129
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2130
- * @permissionScope Manage Events
2131
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2132
- * @permissionId PRICING_PLANS.READ_ORDERS
2133
- * @webhook
2134
- * @eventType wix.pricing_plans.v2.order_started
2135
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2136
- * @slug started
2295
+ * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2296
+ *
2297
+ * Resuming an order causes the following changes:
2298
+ * - The order status changes to `"ACTIVE"`.
2299
+ * - The `pausePeriods` array is updated.
2300
+ * - The `endDate` for the order is adjusted to include the pause period.
2301
+ * - For orders with recurring payments, the payment schedule is restarted.
2302
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2303
+ *
2304
+ * To pause an order, call Pause Order.
2305
+ * @param _id - Order ID.
2306
+ * @public
2307
+ * @requiredField _id
2308
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2309
+ * @applicableIdentity APP
2310
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2137
2311
  */
2138
- declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2312
+ declare function resumeOrder(_id: string): Promise<void>;
2139
2313
  /**
2140
2314
  * Retrieves an order for the currently logged-in member by ID.
2141
2315
  * @param _id - Order ID.
@@ -2145,9 +2319,10 @@ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void |
2145
2319
  * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2146
2320
  * @applicableIdentity APP
2147
2321
  * @applicableIdentity MEMBER
2322
+ * @returns Requested order.
2148
2323
  * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
2149
2324
  */
2150
- declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<MemberGetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
2325
+ declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
2151
2326
  interface MemberGetOrderOptions {
2152
2327
  /**
2153
2328
  * Predefined set of fields to return.
@@ -2410,180 +2585,5 @@ interface GetPricePreviewOptions {
2410
2585
  */
2411
2586
  couponCode?: string | null;
2412
2587
  }
2413
- /**
2414
- * Retrieves an order by ID.
2415
- * @param _id - Order ID.
2416
- * @public
2417
- * @requiredField _id
2418
- * @param options - Options to use when getting an order.
2419
- * @permissionId PRICING_PLANS.READ_ORDERS
2420
- * @applicableIdentity APP
2421
- * @returns Order.
2422
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2423
- */
2424
- declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
2425
- interface ManagementGetOrderOptions {
2426
- /**
2427
- * Predefined set of fields to return.
2428
- *
2429
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2430
- */
2431
- fieldSet?: SetWithLiterals;
2432
- }
2433
- /**
2434
- * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2435
- *
2436
- * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2437
- * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2438
- * @public
2439
- * @param options - Filtering, sorting, and pagination options.
2440
- * @permissionId PRICING_PLANS.READ_ORDERS
2441
- * @applicableIdentity APP
2442
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2443
- */
2444
- declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
2445
- interface ManagementListOrdersOptions {
2446
- /**
2447
- * Filter by a buyer's member ID, from the Members API.
2448
- * @format GUID
2449
- */
2450
- buyerIds?: string[];
2451
- /**
2452
- * Filter by plan IDs, from the Plans API.
2453
- * @format GUID
2454
- */
2455
- planIds?: string[];
2456
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2457
- autoRenewCanceled?: boolean | null;
2458
- /** Filter by order status. */
2459
- orderStatuses?: OrderStatusWithLiterals[];
2460
- /** Filter by payment status. */
2461
- paymentStatuses?: PaymentStatusWithLiterals[];
2462
- /**
2463
- * Number of orders to return. See Sorting and Paging for more information.
2464
- *
2465
- * Max: `50`
2466
- * @min 1
2467
- * @max 50
2468
- */
2469
- limit?: number | null;
2470
- /** Number of orders to skip in the current sort order. */
2471
- offset?: number | null;
2472
- /**
2473
- * Sort order.
2474
- *
2475
- * Use `ASC` for ascending order or `DESC` for descending order.
2476
- *
2477
- * Default: `DESC`.
2478
- */
2479
- sorting?: Sorting;
2480
- /**
2481
- * Predefined set of fields to return.
2482
- *
2483
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2484
- */
2485
- fieldSet?: SetWithLiterals;
2486
- }
2487
- /**
2488
- * 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.
2489
- *
2490
- * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2491
- * Can't postpone an order with `status`: `PAUSED`.
2492
- * @param _id - Order ID.
2493
- * @param endDate - New end date and time.
2494
- *
2495
- * Must be later than the current end date and time.
2496
- * @public
2497
- * @requiredField _id
2498
- * @requiredField endDate
2499
- * @param options - Options for postponing the end date of an order.
2500
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2501
- * @applicableIdentity APP
2502
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2503
- */
2504
- declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2505
- /**
2506
- * Cancels an existing order.
2507
- *
2508
- * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2509
- * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2510
- *
2511
- * #### Canceling during the free trial period.
2512
- *
2513
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2514
- * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2515
- * of the free trial period.
2516
- *
2517
- * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2518
- * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2519
- * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2520
- * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2521
- * Then, the subscription ends and the buyer is not billed.
2522
- * @param _id - Order ID.
2523
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2524
- * @public
2525
- * @requiredField _id
2526
- * @requiredField effectiveAt
2527
- * @param options - Options for canceling orders.
2528
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2529
- * @applicableIdentity APP
2530
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2531
- */
2532
- declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2533
- /**
2534
- * Marks an offline order as paid.
2535
- * > __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.
2536
- *
2537
- * Marking an offline order as paid causes the following changes:
2538
- * - The order's `lastPaymentStatus` changes to `"PAID"`.
2539
- * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2540
- *
2541
- * An error occurs if you attempt to:
2542
- * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2543
- * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2544
- * @param _id - Order ID.
2545
- * @public
2546
- * @requiredField _id
2547
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2548
- * @applicableIdentity APP
2549
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2550
- */
2551
- declare function markAsPaid(_id: string): Promise<void>;
2552
- /**
2553
- * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2554
- *
2555
- * Only orders with `status`: `ACTIVE` can be paused.
2556
- * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2557
- * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2558
- * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2559
- *
2560
- * To resume a paused order, call Resume Order.
2561
- * @param _id - Order ID.
2562
- * @public
2563
- * @requiredField _id
2564
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2565
- * @applicableIdentity APP
2566
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2567
- */
2568
- declare function pauseOrder(_id: string): Promise<void>;
2569
- /**
2570
- * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2571
- *
2572
- * Resuming an order causes the following changes:
2573
- * - The order status changes to `"ACTIVE"`.
2574
- * - The `pausePeriods` array is updated.
2575
- * - The `endDate` for the order is adjusted to include the pause period.
2576
- * - For orders with recurring payments, the payment schedule is restarted.
2577
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2578
- *
2579
- * To pause an order, call Pause Order.
2580
- * @param _id - Order ID.
2581
- * @public
2582
- * @requiredField _id
2583
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2584
- * @applicableIdentity APP
2585
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2586
- */
2587
- declare function resumeOrder(_id: string): Promise<void>;
2588
2588
 
2589
- export { type AccountInfo, type ActionEvent, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type OrdersQueryOrdersRequest, type OrdersQueryOrdersResponse, type Paging, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, type QueryOrdersRequest, type QueryOrdersResponse, type QueryV2, type QueryV2PagingMethodOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };
2589
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type OrdersQueryOrdersRequest, type OrdersQueryOrdersResponse, type Paging, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, type QueryOrdersRequest, type QueryOrdersResponse, type QueryV2, type QueryV2PagingMethodOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };