@wix/auto_sdk_pricing-plans_orders 1.0.111 → 1.0.113

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 (49) hide show
  1. package/build/cjs/index.d.ts +155 -155
  2. package/build/cjs/index.js +466 -466
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +489 -489
  5. package/build/cjs/index.typings.js +339 -339
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +259 -259
  8. package/build/cjs/meta.js +344 -344
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +30 -30
  11. package/build/cjs/schemas.js +59 -59
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +155 -155
  14. package/build/es/index.mjs +466 -466
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +489 -489
  17. package/build/es/index.typings.mjs +339 -339
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +259 -259
  20. package/build/es/meta.mjs +344 -344
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +30 -30
  23. package/build/es/schemas.mjs +59 -59
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +155 -155
  26. package/build/internal/cjs/index.js +466 -466
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +489 -489
  29. package/build/internal/cjs/index.typings.js +339 -339
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +259 -259
  32. package/build/internal/cjs/meta.js +344 -344
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +30 -30
  35. package/build/internal/cjs/schemas.js +59 -59
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +155 -155
  38. package/build/internal/es/index.mjs +466 -466
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +489 -489
  41. package/build/internal/es/index.typings.mjs +339 -339
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +259 -259
  44. package/build/internal/es/meta.mjs +344 -344
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +30 -30
  47. package/build/internal/es/schemas.mjs +59 -59
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -635,7 +635,35 @@ interface ActionEvent {
635
635
  }
636
636
  interface Empty {
637
637
  }
638
- interface MemberGetOrderRequest {
638
+ interface OrderPurchased {
639
+ /** Order that was paid for. If a free or an offline order, the order that was created. */
640
+ order?: Order;
641
+ }
642
+ interface OrderStarted {
643
+ /** Order that reached its `startDate`. */
644
+ order?: Order;
645
+ }
646
+ /**
647
+ * Triggered at the start of a new payment cycle for an existing order.
648
+ *
649
+ * This webhook does not trigger at the initial start of an offline order.
650
+ */
651
+ interface OrderCycleStarted {
652
+ /** Order whose new cycle started. */
653
+ order?: Order;
654
+ /** 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. */
655
+ cycleNumber?: number;
656
+ }
657
+ /** Emitted when a recurring order is canceled for the next payment cycle */
658
+ interface OrderAutoRenewCanceled {
659
+ /** Order that is canceled, effective at the end of the current payment cycle. */
660
+ order?: Order;
661
+ }
662
+ interface OrderEnded {
663
+ /** Order that ended. */
664
+ order?: Order;
665
+ }
666
+ interface GetOrderRequest {
639
667
  /**
640
668
  * Order ID.
641
669
  * @format GUID
@@ -658,31 +686,44 @@ declare enum Set {
658
686
  }
659
687
  /** @enumType */
660
688
  type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
661
- interface MemberGetOrderResponse {
662
- /** Requested order. */
689
+ interface GetOrderResponse {
690
+ /** Order. */
663
691
  order?: Order;
664
692
  }
665
- interface MemberListOrdersRequest {
693
+ interface ListOrdersRequest {
666
694
  /**
667
- * Filter by plan IDs.
695
+ * Filter by a buyer's member ID, from the Members API.
696
+ * @format GUID
697
+ */
698
+ buyerIds?: string[];
699
+ /**
700
+ * Filter by plan IDs, from the Plans API.
668
701
  * @format GUID
669
702
  */
670
703
  planIds?: string[];
671
- /** Filter for orders where auto renewal was canceled. */
704
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
672
705
  autoRenewCanceled?: boolean | null;
673
706
  /** Filter by order status. */
674
707
  orderStatuses?: OrderStatusWithLiterals[];
675
708
  /** Filter by payment status. */
676
709
  paymentStatuses?: PaymentStatusWithLiterals[];
677
710
  /**
678
- * Limit the number of pricing plans returned. Default limit is 50.
711
+ * Number of orders to return. See Sorting and Paging for more information.
712
+ *
713
+ * Max: `50`
679
714
  * @min 1
680
715
  * @max 50
681
716
  */
682
717
  limit?: number | null;
683
- /** Number of entries to offset. */
718
+ /** Number of orders to skip in the current sort order. */
684
719
  offset?: number | null;
685
- /** Sorting direction (defaults to ASC) and field to sort by. */
720
+ /**
721
+ * Sort order.
722
+ *
723
+ * Use `ASC` for ascending order or `DESC` for descending order.
724
+ *
725
+ * Default: `DESC`.
726
+ */
686
727
  sorting?: Sorting;
687
728
  /**
688
729
  * Predefined set of fields to return.
@@ -706,8 +747,8 @@ declare enum SortOrder {
706
747
  }
707
748
  /** @enumType */
708
749
  type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
709
- interface MemberListOrdersResponse {
710
- /** Requested orders. */
750
+ interface ListOrdersResponse {
751
+ /** List of orders. */
711
752
  orders?: Order[];
712
753
  /** Object containing paging-related data (number of orders returned, offset). */
713
754
  pagingMetadata?: PagingMetadataV2;
@@ -736,11 +777,7 @@ interface Cursors {
736
777
  */
737
778
  prev?: string | null;
738
779
  }
739
- /**
740
- * TODO: Write orders filter and sort docs page
741
- * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
742
- */
743
- interface QueryOrdersRequest {
780
+ interface OrdersQueryOrdersRequest {
744
781
  /** Query filter. */
745
782
  query?: QueryV2;
746
783
  }
@@ -794,22 +831,84 @@ interface CursorPaging {
794
831
  */
795
832
  cursor?: string | null;
796
833
  }
797
- interface QueryOrdersResponse {
798
- /** Order data. */
834
+ interface OrdersQueryOrdersResponse {
835
+ /** Retrieved orders. */
799
836
  plans?: Order[];
800
837
  /** Paging-related data (number of orders returned, offset). */
801
838
  pagingMetadata?: PagingMetadataV2;
802
839
  }
803
- interface RequestCancellationRequest {
840
+ interface GetOrdersStatsRequest {
841
+ }
842
+ interface GetOrdersStatsResponse {
843
+ /** Total number of orders. */
844
+ totalOrderCount?: number;
845
+ /** Number of active orders. */
846
+ activeOrderCount?: number;
847
+ }
848
+ interface GetAvailableOrderActionsRequest {
849
+ /**
850
+ * Order ID.
851
+ * @format GUID
852
+ */
853
+ _id?: string;
854
+ }
855
+ interface GetAvailableOrderActionsResponse {
856
+ /** Whether the order can be suspended. */
857
+ suspendable?: boolean;
858
+ /** If the order cannot be suspended, a reason is returned here. */
859
+ notSuspendableReason?: ReasonNotSuspendableWithLiterals;
860
+ /** Whether the order can be canceled by the buyer. */
861
+ cancelableByBuyer?: boolean;
862
+ }
863
+ declare enum ReasonNotSuspendable {
864
+ /** Undefined reason. */
865
+ UNDEFINED = "UNDEFINED",
866
+ /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
867
+ PENDING = "PENDING",
868
+ /** Trial orders can't be suspended. */
869
+ TRIAL = "TRIAL",
870
+ /** Canceled orders can't be suspended. */
871
+ CANCELED = "CANCELED",
872
+ /** Ended orders can't be suspended. */
873
+ ENDED = "ENDED",
874
+ /** Paid for orders with future start dates can't be suspended. */
875
+ NOT_STARTED = "NOT_STARTED",
876
+ /** Order is already suspended. */
877
+ ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
878
+ /** Orders based on recurring payments using older stripe versions can't be suspended. */
879
+ OLD_STRIPE = "OLD_STRIPE"
880
+ }
881
+ /** @enumType */
882
+ type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
883
+ interface PostponeEndDateRequest {
804
884
  /**
805
885
  * Order ID.
806
886
  * @format GUID
807
887
  */
808
888
  _id: string;
809
- /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
889
+ /**
890
+ * New end date and time.
891
+ *
892
+ * Must be later than the current end date and time.
893
+ */
894
+ endDate: Date | null;
895
+ }
896
+ interface PostponeEndDateResponse {
897
+ }
898
+ interface OrderEndDatePostponed {
899
+ /** Order whose `endDate` was postponed. */
900
+ order?: Order;
901
+ }
902
+ interface CancelOrderRequest {
903
+ /**
904
+ * Order ID.
905
+ * @format GUID
906
+ */
907
+ _id: string;
908
+ /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
810
909
  effectiveAt: CancellationEffectiveAtWithLiterals;
811
910
  }
812
- interface RequestCancellationResponse {
911
+ interface CancelOrderResponse {
813
912
  }
814
913
  /**
815
914
  * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
@@ -820,6 +919,111 @@ interface OrderCanceled {
820
919
  /** Canceled order. */
821
920
  order?: Order;
822
921
  }
922
+ interface MarkAsPaidRequest {
923
+ /**
924
+ * Order ID.
925
+ * @format GUID
926
+ */
927
+ _id: string;
928
+ }
929
+ interface MarkAsPaidResponse {
930
+ }
931
+ interface OrderMarkedAsPaid {
932
+ /** Order that was marked as paid. */
933
+ order?: Order;
934
+ }
935
+ interface PauseOrderRequest {
936
+ /**
937
+ * Order ID.
938
+ * @format GUID
939
+ */
940
+ _id: string;
941
+ }
942
+ interface PauseOrderResponse {
943
+ }
944
+ interface OrderPaused {
945
+ /** Paused order. */
946
+ order?: Order;
947
+ }
948
+ interface BulkPauseOrderRequest {
949
+ /**
950
+ * List of Order IDs.
951
+ * @format GUID
952
+ * @minSize 1
953
+ * @maxSize 100
954
+ */
955
+ ids?: string[];
956
+ /** Set to true to return Order entity in response. */
957
+ returnFullEntity?: boolean;
958
+ }
959
+ interface BulkPauseOrderResponse {
960
+ /** Orders that were paused. */
961
+ results?: BulkOrderResult[];
962
+ /** Bulk action metadata. */
963
+ bulkActionMetadata?: BulkActionMetadata;
964
+ }
965
+ interface BulkOrderResult {
966
+ /** Item metadata */
967
+ itemMetadata?: ItemMetadata;
968
+ /** The order. */
969
+ order?: Order;
970
+ }
971
+ interface ItemMetadata {
972
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
973
+ _id?: string | null;
974
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
975
+ originalIndex?: number;
976
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
977
+ success?: boolean;
978
+ /** Details about the error in case of failure. */
979
+ error?: ApplicationError;
980
+ }
981
+ interface ApplicationError {
982
+ /** Error code. */
983
+ code?: string;
984
+ /** Description of the error. */
985
+ description?: string;
986
+ /** Data related to the error. */
987
+ data?: Record<string, any> | null;
988
+ }
989
+ interface BulkActionMetadata {
990
+ /** Number of items that were successfully processed. */
991
+ totalSuccesses?: number;
992
+ /** Number of items that couldn't be processed. */
993
+ totalFailures?: number;
994
+ /** Number of failures without details because detailed failure threshold was exceeded. */
995
+ undetailedFailures?: number;
996
+ }
997
+ interface ResumeOrderRequest {
998
+ /**
999
+ * Order ID.
1000
+ * @format GUID
1001
+ */
1002
+ _id: string;
1003
+ }
1004
+ interface ResumeOrderResponse {
1005
+ }
1006
+ interface OrderResumed {
1007
+ /** Resumed order. */
1008
+ order?: Order;
1009
+ }
1010
+ interface BulkResumeOrderRequest {
1011
+ /**
1012
+ * List of Order IDs.
1013
+ * @format GUID
1014
+ * @minSize 1
1015
+ * @maxSize 100
1016
+ */
1017
+ ids?: string[];
1018
+ /** Set to true to return Order entity in response. */
1019
+ returnFullEntity?: boolean;
1020
+ }
1021
+ interface BulkResumeOrderResponse {
1022
+ /** Orders that were resumed. */
1023
+ results?: BulkOrderResult[];
1024
+ /** Bulk action metadata. */
1025
+ bulkActionMetadata?: BulkActionMetadata;
1026
+ }
823
1027
  interface MessageEnvelope {
824
1028
  /**
825
1029
  * App instance ID.
@@ -1222,35 +1426,7 @@ interface SetSubmissionResponse {
1222
1426
  /** Order with submission id */
1223
1427
  order?: Order;
1224
1428
  }
1225
- interface OrderPurchased {
1226
- /** Order that was paid for. If a free or an offline order, the order that was created. */
1227
- order?: Order;
1228
- }
1229
- interface OrderStarted {
1230
- /** Order that reached its `startDate`. */
1231
- order?: Order;
1232
- }
1233
- /**
1234
- * Triggered at the start of a new payment cycle for an existing order.
1235
- *
1236
- * This webhook does not trigger at the initial start of an offline order.
1237
- */
1238
- interface OrderCycleStarted {
1239
- /** Order whose new cycle started. */
1240
- order?: Order;
1241
- /** 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. */
1242
- cycleNumber?: number;
1243
- }
1244
- /** Emitted when a recurring order is canceled for the next payment cycle */
1245
- interface OrderAutoRenewCanceled {
1246
- /** Order that is canceled, effective at the end of the current payment cycle. */
1247
- order?: Order;
1248
- }
1249
- interface OrderEnded {
1250
- /** Order that ended. */
1251
- order?: Order;
1252
- }
1253
- interface GetOrderRequest {
1429
+ interface MemberGetOrderRequest {
1254
1430
  /**
1255
1431
  * Order ID.
1256
1432
  * @format GUID
@@ -1263,44 +1439,31 @@ interface GetOrderRequest {
1263
1439
  */
1264
1440
  fieldSet?: SetWithLiterals;
1265
1441
  }
1266
- interface GetOrderResponse {
1267
- /** Order. */
1442
+ interface MemberGetOrderResponse {
1443
+ /** Requested order. */
1268
1444
  order?: Order;
1269
1445
  }
1270
- interface ListOrdersRequest {
1271
- /**
1272
- * Filter by a buyer's member ID, from the Members API.
1273
- * @format GUID
1274
- */
1275
- buyerIds?: string[];
1446
+ interface MemberListOrdersRequest {
1276
1447
  /**
1277
- * Filter by plan IDs, from the Plans API.
1448
+ * Filter by plan IDs.
1278
1449
  * @format GUID
1279
1450
  */
1280
1451
  planIds?: string[];
1281
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
1452
+ /** Filter for orders where auto renewal was canceled. */
1282
1453
  autoRenewCanceled?: boolean | null;
1283
1454
  /** Filter by order status. */
1284
1455
  orderStatuses?: OrderStatusWithLiterals[];
1285
1456
  /** Filter by payment status. */
1286
1457
  paymentStatuses?: PaymentStatusWithLiterals[];
1287
1458
  /**
1288
- * Number of orders to return. See Sorting and Paging for more information.
1289
- *
1290
- * Max: `50`
1459
+ * Limit the number of pricing plans returned. Default limit is 50.
1291
1460
  * @min 1
1292
1461
  * @max 50
1293
1462
  */
1294
1463
  limit?: number | null;
1295
- /** Number of orders to skip in the current sort order. */
1464
+ /** Number of entries to offset. */
1296
1465
  offset?: number | null;
1297
- /**
1298
- * Sort order.
1299
- *
1300
- * Use `ASC` for ascending order or `DESC` for descending order.
1301
- *
1302
- * Default: `DESC`.
1303
- */
1466
+ /** Sorting direction (defaults to ASC) and field to sort by. */
1304
1467
  sorting?: Sorting;
1305
1468
  /**
1306
1469
  * Predefined set of fields to return.
@@ -1309,199 +1472,36 @@ interface ListOrdersRequest {
1309
1472
  */
1310
1473
  fieldSet?: SetWithLiterals;
1311
1474
  }
1312
- interface ListOrdersResponse {
1313
- /** List of orders. */
1475
+ interface MemberListOrdersResponse {
1476
+ /** Requested orders. */
1314
1477
  orders?: Order[];
1315
1478
  /** Object containing paging-related data (number of orders returned, offset). */
1316
1479
  pagingMetadata?: PagingMetadataV2;
1317
1480
  }
1318
- interface OrdersQueryOrdersRequest {
1481
+ /**
1482
+ * TODO: Write orders filter and sort docs page
1483
+ * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
1484
+ */
1485
+ interface QueryOrdersRequest {
1319
1486
  /** Query filter. */
1320
1487
  query?: QueryV2;
1321
1488
  }
1322
- interface OrdersQueryOrdersResponse {
1323
- /** Retrieved orders. */
1489
+ interface QueryOrdersResponse {
1490
+ /** Order data. */
1324
1491
  plans?: Order[];
1325
1492
  /** Paging-related data (number of orders returned, offset). */
1326
1493
  pagingMetadata?: PagingMetadataV2;
1327
1494
  }
1328
- interface GetOrdersStatsRequest {
1329
- }
1330
- interface GetOrdersStatsResponse {
1331
- /** Total number of orders. */
1332
- totalOrderCount?: number;
1333
- /** Number of active orders. */
1334
- activeOrderCount?: number;
1335
- }
1336
- interface GetAvailableOrderActionsRequest {
1337
- /**
1338
- * Order ID.
1339
- * @format GUID
1340
- */
1341
- _id?: string;
1342
- }
1343
- interface GetAvailableOrderActionsResponse {
1344
- /** Whether the order can be suspended. */
1345
- suspendable?: boolean;
1346
- /** If the order cannot be suspended, a reason is returned here. */
1347
- notSuspendableReason?: ReasonNotSuspendableWithLiterals;
1348
- /** Whether the order can be canceled by the buyer. */
1349
- cancelableByBuyer?: boolean;
1350
- }
1351
- declare enum ReasonNotSuspendable {
1352
- /** Undefined reason. */
1353
- UNDEFINED = "UNDEFINED",
1354
- /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
1355
- PENDING = "PENDING",
1356
- /** Trial orders can't be suspended. */
1357
- TRIAL = "TRIAL",
1358
- /** Canceled orders can't be suspended. */
1359
- CANCELED = "CANCELED",
1360
- /** Ended orders can't be suspended. */
1361
- ENDED = "ENDED",
1362
- /** Paid for orders with future start dates can't be suspended. */
1363
- NOT_STARTED = "NOT_STARTED",
1364
- /** Order is already suspended. */
1365
- ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
1366
- /** Orders based on recurring payments using older stripe versions can't be suspended. */
1367
- OLD_STRIPE = "OLD_STRIPE"
1368
- }
1369
- /** @enumType */
1370
- type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
1371
- interface PostponeEndDateRequest {
1372
- /**
1373
- * Order ID.
1374
- * @format GUID
1375
- */
1376
- _id: string;
1377
- /**
1378
- * New end date and time.
1379
- *
1380
- * Must be later than the current end date and time.
1381
- */
1382
- endDate: Date | null;
1383
- }
1384
- interface PostponeEndDateResponse {
1385
- }
1386
- interface OrderEndDatePostponed {
1387
- /** Order whose `endDate` was postponed. */
1388
- order?: Order;
1389
- }
1390
- interface CancelOrderRequest {
1495
+ interface RequestCancellationRequest {
1391
1496
  /**
1392
1497
  * Order ID.
1393
1498
  * @format GUID
1394
1499
  */
1395
1500
  _id: string;
1396
- /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
1501
+ /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
1397
1502
  effectiveAt: CancellationEffectiveAtWithLiterals;
1398
1503
  }
1399
- interface CancelOrderResponse {
1400
- }
1401
- interface MarkAsPaidRequest {
1402
- /**
1403
- * Order ID.
1404
- * @format GUID
1405
- */
1406
- _id: string;
1407
- }
1408
- interface MarkAsPaidResponse {
1409
- }
1410
- interface OrderMarkedAsPaid {
1411
- /** Order that was marked as paid. */
1412
- order?: Order;
1413
- }
1414
- interface PauseOrderRequest {
1415
- /**
1416
- * Order ID.
1417
- * @format GUID
1418
- */
1419
- _id: string;
1420
- }
1421
- interface PauseOrderResponse {
1422
- }
1423
- interface OrderPaused {
1424
- /** Paused order. */
1425
- order?: Order;
1426
- }
1427
- interface BulkPauseOrderRequest {
1428
- /**
1429
- * List of Order IDs.
1430
- * @format GUID
1431
- * @minSize 1
1432
- * @maxSize 100
1433
- */
1434
- ids?: string[];
1435
- /** Set to true to return Order entity in response. */
1436
- returnFullEntity?: boolean;
1437
- }
1438
- interface BulkPauseOrderResponse {
1439
- /** Orders that were paused. */
1440
- results?: BulkOrderResult[];
1441
- /** Bulk action metadata. */
1442
- bulkActionMetadata?: BulkActionMetadata;
1443
- }
1444
- interface BulkOrderResult {
1445
- /** Item metadata */
1446
- itemMetadata?: ItemMetadata;
1447
- /** The order. */
1448
- order?: Order;
1449
- }
1450
- interface ItemMetadata {
1451
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1452
- _id?: string | null;
1453
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1454
- originalIndex?: number;
1455
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1456
- success?: boolean;
1457
- /** Details about the error in case of failure. */
1458
- error?: ApplicationError;
1459
- }
1460
- interface ApplicationError {
1461
- /** Error code. */
1462
- code?: string;
1463
- /** Description of the error. */
1464
- description?: string;
1465
- /** Data related to the error. */
1466
- data?: Record<string, any> | null;
1467
- }
1468
- interface BulkActionMetadata {
1469
- /** Number of items that were successfully processed. */
1470
- totalSuccesses?: number;
1471
- /** Number of items that couldn't be processed. */
1472
- totalFailures?: number;
1473
- /** Number of failures without details because detailed failure threshold was exceeded. */
1474
- undetailedFailures?: number;
1475
- }
1476
- interface ResumeOrderRequest {
1477
- /**
1478
- * Order ID.
1479
- * @format GUID
1480
- */
1481
- _id: string;
1482
- }
1483
- interface ResumeOrderResponse {
1484
- }
1485
- interface OrderResumed {
1486
- /** Resumed order. */
1487
- order?: Order;
1488
- }
1489
- interface BulkResumeOrderRequest {
1490
- /**
1491
- * List of Order IDs.
1492
- * @format GUID
1493
- * @minSize 1
1494
- * @maxSize 100
1495
- */
1496
- ids?: string[];
1497
- /** Set to true to return Order entity in response. */
1498
- returnFullEntity?: boolean;
1499
- }
1500
- interface BulkResumeOrderResponse {
1501
- /** Orders that were resumed. */
1502
- results?: BulkOrderResult[];
1503
- /** Bulk action metadata. */
1504
- bulkActionMetadata?: BulkActionMetadata;
1504
+ interface RequestCancellationResponse {
1505
1505
  }
1506
1506
  /** @docsIgnore */
1507
1507
  type CreateOnlineOrderApplicationErrors = {
@@ -1854,16 +1854,16 @@ interface AccountInfoMetadata {
1854
1854
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
1855
1855
  parentAccountId?: string;
1856
1856
  }
1857
- interface OrderCanceledEnvelope {
1858
- data: OrderCanceled;
1857
+ interface OrderAutoRenewCanceledEnvelope {
1858
+ data: OrderAutoRenewCanceled;
1859
1859
  metadata: EventMetadata;
1860
1860
  }
1861
1861
  /**
1862
- * Triggered when an order is canceled.
1862
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1863
1863
  *
1864
- * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
1865
- * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
1866
- * + 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.
1864
+ * This webhook is *not* triggered in the following scenarios:
1865
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1866
+ * + 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.
1867
1867
  * @permissionScope Manage Orders
1868
1868
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1869
1869
  * @permissionScope Read Orders
@@ -1874,92 +1874,21 @@ interface OrderCanceledEnvelope {
1874
1874
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1875
1875
  * @permissionId PRICING_PLANS.READ_ORDERS
1876
1876
  * @webhook
1877
- * @eventType wix.pricing_plans.v2.order_canceled
1878
- * @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
1879
- * @slug canceled
1877
+ * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1878
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1879
+ * @slug auto_renew_canceled
1880
1880
  */
1881
- declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1882
- interface OrderCreatedEnvelope {
1883
- entity: Order;
1884
- metadata: EventMetadata;
1885
- }
1886
- /**
1887
- * Triggered when an order is created.
1888
- * @permissionScope Manage Orders
1889
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1890
- * @permissionScope Read Orders
1891
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1892
- * @permissionScope Manage plans and orders of Pricing Plans
1893
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1894
- * @permissionScope Manage Events
1895
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1896
- * @permissionId PRICING_PLANS.READ_ORDERS
1897
- * @webhook
1898
- * @eventType wix.pricing_plans.v2.order_created
1899
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1900
- * @slug created
1901
- */
1902
- declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
1903
- interface OrderStartDateChangedEnvelope {
1904
- data: OrderStartDateChanged;
1905
- metadata: EventMetadata;
1906
- }
1907
- /**
1908
- * Triggered when an order's `startDate` is changed.
1909
- * @permissionScope Manage Orders
1910
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1911
- * @permissionScope Read Orders
1912
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1913
- * @permissionScope Manage plans and orders of Pricing Plans
1914
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1915
- * @permissionScope Manage Events
1916
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1917
- * @permissionId PRICING_PLANS.READ_ORDERS
1918
- * @webhook
1919
- * @eventType wix.pricing_plans.v2.order_start_date_changed
1920
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1921
- * @slug start_date_changed
1922
- */
1923
- declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
1924
- interface OrderUpdatedEnvelope {
1925
- entity: Order;
1926
- metadata: EventMetadata;
1927
- }
1928
- /**
1929
- * Triggered for any of the following update events:
1930
- *
1931
- * + Order is paid for. Order Purchased is also triggered.
1932
- * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
1933
- * + New payment cycle of an order starts. Order Cycle Started is also triggered.
1934
- * + Offline order is marked as paid. Order Marked As Paid is also triggered.
1935
- * + End date of the order is postponed. Order End Date Postponed is also triggered
1936
- * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
1937
- * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
1938
- * @permissionScope Manage Orders
1939
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1940
- * @permissionScope Read Orders
1941
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1942
- * @permissionScope Manage plans and orders of Pricing Plans
1943
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1944
- * @permissionScope Manage Events
1945
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1946
- * @permissionId PRICING_PLANS.READ_ORDERS
1947
- * @webhook
1948
- * @eventType wix.pricing_plans.v2.order_updated
1949
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1950
- * @slug updated
1951
- */
1952
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
1953
- interface OrderAutoRenewCanceledEnvelope {
1954
- data: OrderAutoRenewCanceled;
1881
+ declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1882
+ interface OrderCanceledEnvelope {
1883
+ data: OrderCanceled;
1955
1884
  metadata: EventMetadata;
1956
1885
  }
1957
1886
  /**
1958
- * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1887
+ * Triggered when an order is canceled.
1959
1888
  *
1960
- * This webhook is *not* triggered in the following scenarios:
1961
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1962
- * + 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.
1889
+ * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
1890
+ * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
1891
+ * + 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.
1963
1892
  * @permissionScope Manage Orders
1964
1893
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1965
1894
  * @permissionScope Read Orders
@@ -1970,11 +1899,11 @@ interface OrderAutoRenewCanceledEnvelope {
1970
1899
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1971
1900
  * @permissionId PRICING_PLANS.READ_ORDERS
1972
1901
  * @webhook
1973
- * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1902
+ * @eventType wix.pricing_plans.v2.order_canceled
1974
1903
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1975
- * @slug auto_renew_canceled
1904
+ * @slug canceled
1976
1905
  */
1977
- declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1906
+ declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1978
1907
  interface OrderCycleStartedEnvelope {
1979
1908
  data: OrderCycleStarted;
1980
1909
  metadata: EventMetadata;
@@ -2153,19 +2082,89 @@ interface OrderStartedEnvelope {
2153
2082
  * @slug started
2154
2083
  */
2155
2084
  declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2085
+ interface OrderUpdatedEnvelope {
2086
+ entity: Order;
2087
+ metadata: EventMetadata;
2088
+ }
2156
2089
  /**
2157
- * Retrieves an order for the currently logged-in member by ID.
2090
+ * Triggered for any of the following update events:
2091
+ *
2092
+ * + Order is paid for. Order Purchased is also triggered.
2093
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
2094
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
2095
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
2096
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
2097
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
2098
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
2099
+ * @permissionScope Manage Orders
2100
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2101
+ * @permissionScope Read Orders
2102
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2103
+ * @permissionScope Manage plans and orders of Pricing Plans
2104
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2105
+ * @permissionScope Manage Events
2106
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2107
+ * @permissionId PRICING_PLANS.READ_ORDERS
2108
+ * @webhook
2109
+ * @eventType wix.pricing_plans.v2.order_updated
2110
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2111
+ * @slug updated
2112
+ */
2113
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2114
+ interface OrderCreatedEnvelope {
2115
+ entity: Order;
2116
+ metadata: EventMetadata;
2117
+ }
2118
+ /**
2119
+ * Triggered when an order is created.
2120
+ * @permissionScope Manage Orders
2121
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2122
+ * @permissionScope Read Orders
2123
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2124
+ * @permissionScope Manage plans and orders of Pricing Plans
2125
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2126
+ * @permissionScope Manage Events
2127
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2128
+ * @permissionId PRICING_PLANS.READ_ORDERS
2129
+ * @webhook
2130
+ * @eventType wix.pricing_plans.v2.order_created
2131
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2132
+ * @slug created
2133
+ */
2134
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
2135
+ interface OrderStartDateChangedEnvelope {
2136
+ data: OrderStartDateChanged;
2137
+ metadata: EventMetadata;
2138
+ }
2139
+ /**
2140
+ * Triggered when an order's `startDate` is changed.
2141
+ * @permissionScope Manage Orders
2142
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2143
+ * @permissionScope Read Orders
2144
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2145
+ * @permissionScope Manage plans and orders of Pricing Plans
2146
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2147
+ * @permissionScope Manage Events
2148
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2149
+ * @permissionId PRICING_PLANS.READ_ORDERS
2150
+ * @webhook
2151
+ * @eventType wix.pricing_plans.v2.order_start_date_changed
2152
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2153
+ * @slug start_date_changed
2154
+ */
2155
+ declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
2156
+ /**
2157
+ * Retrieves an order by ID.
2158
2158
  * @param _id - Order ID.
2159
2159
  * @public
2160
2160
  * @requiredField _id
2161
- * @param options - Options for getting a logged-in member's order.
2162
- * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2161
+ * @param options - Options to use when getting an order.
2162
+ * @permissionId PRICING_PLANS.READ_ORDERS
2163
2163
  * @applicableIdentity APP
2164
- * @applicableIdentity MEMBER
2165
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
2164
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2166
2165
  */
2167
- 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>>;
2168
- interface MemberGetOrderOptions {
2166
+ 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>>;
2167
+ interface ManagementGetOrderOptions {
2169
2168
  /**
2170
2169
  * Predefined set of fields to return.
2171
2170
  *
@@ -2174,36 +2173,51 @@ interface MemberGetOrderOptions {
2174
2173
  fieldSet?: SetWithLiterals;
2175
2174
  }
2176
2175
  /**
2177
- * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
2176
+ * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2177
+ *
2178
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2179
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2178
2180
  * @public
2179
2181
  * @param options - Filtering, sorting, and pagination options.
2180
- * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2182
+ * @permissionId PRICING_PLANS.READ_ORDERS
2181
2183
  * @applicableIdentity APP
2182
- * @applicableIdentity MEMBER
2183
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
2184
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2184
2185
  */
2185
- declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `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>>;
2186
- interface MemberListOrdersOptions {
2186
+ 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>>;
2187
+ interface ManagementListOrdersOptions {
2187
2188
  /**
2188
- * Filter by plan IDs.
2189
+ * Filter by a buyer's member ID, from the Members API.
2190
+ * @format GUID
2191
+ */
2192
+ buyerIds?: string[];
2193
+ /**
2194
+ * Filter by plan IDs, from the Plans API.
2189
2195
  * @format GUID
2190
2196
  */
2191
2197
  planIds?: string[];
2192
- /** Filter for orders where auto renewal was canceled. */
2198
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2193
2199
  autoRenewCanceled?: boolean | null;
2194
2200
  /** Filter by order status. */
2195
2201
  orderStatuses?: OrderStatusWithLiterals[];
2196
2202
  /** Filter by payment status. */
2197
2203
  paymentStatuses?: PaymentStatusWithLiterals[];
2198
2204
  /**
2199
- * Limit the number of pricing plans returned. Default limit is 50.
2205
+ * Number of orders to return. See Sorting and Paging for more information.
2206
+ *
2207
+ * Max: `50`
2200
2208
  * @min 1
2201
2209
  * @max 50
2202
2210
  */
2203
2211
  limit?: number | null;
2204
- /** Number of entries to offset. */
2212
+ /** Number of orders to skip in the current sort order. */
2205
2213
  offset?: number | null;
2206
- /** Sorting direction (defaults to ASC) and field to sort by. */
2214
+ /**
2215
+ * Sort order.
2216
+ *
2217
+ * Use `ASC` for ascending order or `DESC` for descending order.
2218
+ *
2219
+ * Default: `DESC`.
2220
+ */
2207
2221
  sorting?: Sorting;
2208
2222
  /**
2209
2223
  * Predefined set of fields to return.
@@ -2213,26 +2227,106 @@ interface MemberListOrdersOptions {
2213
2227
  fieldSet?: SetWithLiterals;
2214
2228
  }
2215
2229
  /**
2216
- * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
2230
+ * 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.
2217
2231
  *
2218
- * There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
2232
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2233
+ * Can't postpone an order with `status`: `PAUSED`.
2234
+ * @param _id - Order ID.
2235
+ * @param endDate - New end date and time.
2219
2236
  *
2220
- * Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
2237
+ * Must be later than the current end date and time.
2238
+ * @public
2239
+ * @requiredField _id
2240
+ * @requiredField endDate
2241
+ * @param options - Options for postponing the end date of an order.
2242
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2243
+ * @applicableIdentity APP
2244
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2245
+ */
2246
+ declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2247
+ /**
2248
+ * Cancels an existing order.
2221
2249
  *
2222
- * >**Note:**
2223
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
2250
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2251
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2252
+ *
2253
+ * #### Canceling during the free trial period.
2254
+ *
2255
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2256
+ * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2257
+ * of the free trial period.
2258
+ *
2259
+ * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2260
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2261
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2262
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2263
+ * Then, the subscription ends and the buyer is not billed.
2224
2264
  * @param _id - Order ID.
2225
- * @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
2265
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2226
2266
  * @public
2227
2267
  * @requiredField _id
2228
2268
  * @requiredField effectiveAt
2229
- * @param options - Options for requesting a cancellation.
2230
- * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
2269
+ * @param options - Options for canceling orders.
2270
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2231
2271
  * @applicableIdentity APP
2232
- * @applicableIdentity MEMBER
2233
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
2272
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2234
2273
  */
2235
- declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2274
+ declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2275
+ /**
2276
+ * Marks an offline order as paid.
2277
+ * > __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.
2278
+ *
2279
+ * Marking an offline order as paid causes the following changes:
2280
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2281
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2282
+ *
2283
+ * An error occurs if you attempt to:
2284
+ * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2285
+ * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
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.MarkAsPaid
2292
+ */
2293
+ declare function markAsPaid(_id: string): Promise<void>;
2294
+ /**
2295
+ * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2296
+ *
2297
+ * Only orders with `status`: `ACTIVE` can be paused.
2298
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2299
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2300
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2301
+ *
2302
+ * To resume a paused order, call Resume Order.
2303
+ * @param _id - Order ID.
2304
+ * @public
2305
+ * @requiredField _id
2306
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2307
+ * @applicableIdentity APP
2308
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2309
+ */
2310
+ declare function pauseOrder(_id: string): Promise<void>;
2311
+ /**
2312
+ * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2313
+ *
2314
+ * Resuming an order causes the following changes:
2315
+ * - The order status changes to `"ACTIVE"`.
2316
+ * - The `pausePeriods` array is updated.
2317
+ * - The `endDate` for the order is adjusted to include the pause period.
2318
+ * - For orders with recurring payments, the payment schedule is restarted.
2319
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2320
+ *
2321
+ * To pause an order, call Pause Order.
2322
+ * @param _id - Order ID.
2323
+ * @public
2324
+ * @requiredField _id
2325
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2326
+ * @applicableIdentity APP
2327
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2328
+ */
2329
+ declare function resumeOrder(_id: string): Promise<void>;
2236
2330
  /**
2237
2331
  * Creates an online order for a site member.
2238
2332
  *
@@ -2428,18 +2522,19 @@ interface GetPricePreviewOptions {
2428
2522
  couponCode?: string | null;
2429
2523
  }
2430
2524
  /**
2431
- * Retrieves an order by ID.
2525
+ * Retrieves an order for the currently logged-in member by ID.
2432
2526
  * @param _id - Order ID.
2433
2527
  * @public
2434
2528
  * @requiredField _id
2435
- * @param options - Options to use when getting an order.
2436
- * @permissionId PRICING_PLANS.READ_ORDERS
2529
+ * @param options - Options for getting a logged-in member's order.
2530
+ * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2437
2531
  * @applicableIdentity APP
2438
- * @returns Order.
2439
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2532
+ * @applicableIdentity MEMBER
2533
+ * @returns Requested order.
2534
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
2440
2535
  */
2441
- 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>>;
2442
- interface ManagementGetOrderOptions {
2536
+ 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>>;
2537
+ interface MemberGetOrderOptions {
2443
2538
  /**
2444
2539
  * Predefined set of fields to return.
2445
2540
  *
@@ -2448,51 +2543,36 @@ interface ManagementGetOrderOptions {
2448
2543
  fieldSet?: SetWithLiterals;
2449
2544
  }
2450
2545
  /**
2451
- * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2452
- *
2453
- * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2454
- * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2546
+ * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
2455
2547
  * @public
2456
2548
  * @param options - Filtering, sorting, and pagination options.
2457
- * @permissionId PRICING_PLANS.READ_ORDERS
2549
+ * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2458
2550
  * @applicableIdentity APP
2459
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2551
+ * @applicableIdentity MEMBER
2552
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
2460
2553
  */
2461
- 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>>;
2462
- interface ManagementListOrdersOptions {
2463
- /**
2464
- * Filter by a buyer's member ID, from the Members API.
2465
- * @format GUID
2466
- */
2467
- buyerIds?: string[];
2554
+ declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `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>>;
2555
+ interface MemberListOrdersOptions {
2468
2556
  /**
2469
- * Filter by plan IDs, from the Plans API.
2557
+ * Filter by plan IDs.
2470
2558
  * @format GUID
2471
2559
  */
2472
2560
  planIds?: string[];
2473
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2561
+ /** Filter for orders where auto renewal was canceled. */
2474
2562
  autoRenewCanceled?: boolean | null;
2475
2563
  /** Filter by order status. */
2476
2564
  orderStatuses?: OrderStatusWithLiterals[];
2477
2565
  /** Filter by payment status. */
2478
2566
  paymentStatuses?: PaymentStatusWithLiterals[];
2479
2567
  /**
2480
- * Number of orders to return. See Sorting and Paging for more information.
2481
- *
2482
- * Max: `50`
2568
+ * Limit the number of pricing plans returned. Default limit is 50.
2483
2569
  * @min 1
2484
2570
  * @max 50
2485
2571
  */
2486
2572
  limit?: number | null;
2487
- /** Number of orders to skip in the current sort order. */
2573
+ /** Number of entries to offset. */
2488
2574
  offset?: number | null;
2489
- /**
2490
- * Sort order.
2491
- *
2492
- * Use `ASC` for ascending order or `DESC` for descending order.
2493
- *
2494
- * Default: `DESC`.
2495
- */
2575
+ /** Sorting direction (defaults to ASC) and field to sort by. */
2496
2576
  sorting?: Sorting;
2497
2577
  /**
2498
2578
  * Predefined set of fields to return.
@@ -2502,105 +2582,25 @@ interface ManagementListOrdersOptions {
2502
2582
  fieldSet?: SetWithLiterals;
2503
2583
  }
2504
2584
  /**
2505
- * 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.
2506
- *
2507
- * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2508
- * Can't postpone an order with `status`: `PAUSED`.
2509
- * @param _id - Order ID.
2510
- * @param endDate - New end date and time.
2511
- *
2512
- * Must be later than the current end date and time.
2513
- * @public
2514
- * @requiredField _id
2515
- * @requiredField endDate
2516
- * @param options - Options for postponing the end date of an order.
2517
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2518
- * @applicableIdentity APP
2519
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2520
- */
2521
- declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2522
- /**
2523
- * Cancels an existing order.
2524
- *
2525
- * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2526
- * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2585
+ * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
2527
2586
  *
2528
- * #### Canceling during the free trial period.
2587
+ * There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
2529
2588
  *
2530
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2531
- * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2532
- * of the free trial period.
2589
+ * Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
2533
2590
  *
2534
- * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2535
- * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2536
- * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2537
- * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2538
- * Then, the subscription ends and the buyer is not billed.
2591
+ * >**Note:**
2592
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
2539
2593
  * @param _id - Order ID.
2540
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2594
+ * @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
2541
2595
  * @public
2542
2596
  * @requiredField _id
2543
2597
  * @requiredField effectiveAt
2544
- * @param options - Options for canceling orders.
2545
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2546
- * @applicableIdentity APP
2547
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2548
- */
2549
- declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2550
- /**
2551
- * Marks an offline order as paid.
2552
- * > __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.
2553
- *
2554
- * Marking an offline order as paid causes the following changes:
2555
- * - The order's `lastPaymentStatus` changes to `"PAID"`.
2556
- * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2557
- *
2558
- * An error occurs if you attempt to:
2559
- * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2560
- * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
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.MarkAsPaid
2567
- */
2568
- declare function markAsPaid(_id: string): Promise<void>;
2569
- /**
2570
- * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2571
- *
2572
- * Only orders with `status`: `ACTIVE` can be paused.
2573
- * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2574
- * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2575
- * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2576
- *
2577
- * To resume a paused order, call Resume Order.
2578
- * @param _id - Order ID.
2579
- * @public
2580
- * @requiredField _id
2581
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2582
- * @applicableIdentity APP
2583
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2584
- */
2585
- declare function pauseOrder(_id: string): Promise<void>;
2586
- /**
2587
- * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2588
- *
2589
- * Resuming an order causes the following changes:
2590
- * - The order status changes to `"ACTIVE"`.
2591
- * - The `pausePeriods` array is updated.
2592
- * - The `endDate` for the order is adjusted to include the pause period.
2593
- * - For orders with recurring payments, the payment schedule is restarted.
2594
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2595
- *
2596
- * To pause an order, call Pause Order.
2597
- * @param _id - Order ID.
2598
- * @public
2599
- * @requiredField _id
2600
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2598
+ * @param options - Options for requesting a cancellation.
2599
+ * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
2601
2600
  * @applicableIdentity APP
2602
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2601
+ * @applicableIdentity MEMBER
2602
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
2603
2603
  */
2604
- declare function resumeOrder(_id: string): Promise<void>;
2604
+ declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2605
2605
 
2606
2606
  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 };