@wix/auto_sdk_pricing-plans_orders 1.0.94 → 1.0.95

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 +616 -607
  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 +616 -607
  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 +616 -607
  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 +616 -607
  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.
@@ -900,16 +1104,93 @@ interface AccountInfo {
900
1104
  */
901
1105
  siteId?: string | null;
902
1106
  }
903
- interface CreateOnlineOrderRequest {
1107
+ interface MemberGetOrderRequest {
904
1108
  /**
905
- * Plan ID.
1109
+ * Order ID.
906
1110
  * @format GUID
907
1111
  */
908
- planId: string;
1112
+ _id: string;
909
1113
  /**
910
- * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1114
+ * Predefined set of fields to return.
911
1115
  *
912
- * Default: Current date and time.
1116
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1117
+ */
1118
+ fieldSet?: SetWithLiterals;
1119
+ }
1120
+ interface MemberGetOrderResponse {
1121
+ /** Requested order. */
1122
+ order?: Order;
1123
+ }
1124
+ interface MemberListOrdersRequest {
1125
+ /**
1126
+ * Filter by plan IDs.
1127
+ * @format GUID
1128
+ */
1129
+ planIds?: string[];
1130
+ /** Filter for orders where auto renewal was canceled. */
1131
+ autoRenewCanceled?: boolean | null;
1132
+ /** Filter by order status. */
1133
+ orderStatuses?: OrderStatusWithLiterals[];
1134
+ /** Filter by payment status. */
1135
+ paymentStatuses?: PaymentStatusWithLiterals[];
1136
+ /**
1137
+ * Limit the number of pricing plans returned. Default limit is 50.
1138
+ * @min 1
1139
+ * @max 50
1140
+ */
1141
+ limit?: number | null;
1142
+ /** Number of entries to offset. */
1143
+ offset?: number | null;
1144
+ /** Sorting direction (defaults to ASC) and field to sort by. */
1145
+ sorting?: Sorting;
1146
+ /**
1147
+ * Predefined set of fields to return.
1148
+ *
1149
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1150
+ */
1151
+ fieldSet?: SetWithLiterals;
1152
+ }
1153
+ interface MemberListOrdersResponse {
1154
+ /** Requested orders. */
1155
+ orders?: Order[];
1156
+ /** Object containing paging-related data (number of orders returned, offset). */
1157
+ pagingMetadata?: PagingMetadataV2;
1158
+ }
1159
+ /**
1160
+ * TODO: Write orders filter and sort docs page
1161
+ * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
1162
+ */
1163
+ interface QueryOrdersRequest {
1164
+ /** Query filter. */
1165
+ query?: QueryV2;
1166
+ }
1167
+ interface QueryOrdersResponse {
1168
+ /** Order data. */
1169
+ plans?: Order[];
1170
+ /** Paging-related data (number of orders returned, offset). */
1171
+ pagingMetadata?: PagingMetadataV2;
1172
+ }
1173
+ interface RequestCancellationRequest {
1174
+ /**
1175
+ * Order ID.
1176
+ * @format GUID
1177
+ */
1178
+ _id: string;
1179
+ /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
1180
+ effectiveAt: CancellationEffectiveAtWithLiterals;
1181
+ }
1182
+ interface RequestCancellationResponse {
1183
+ }
1184
+ interface CreateOnlineOrderRequest {
1185
+ /**
1186
+ * Plan ID.
1187
+ * @format GUID
1188
+ */
1189
+ planId: string;
1190
+ /**
1191
+ * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1192
+ *
1193
+ * Default: Current date and time.
913
1194
  */
914
1195
  startDate?: Date | null;
915
1196
  /**
@@ -1203,287 +1484,6 @@ interface SetSubmissionResponse {
1203
1484
  /** Order with submission id */
1204
1485
  order?: Order;
1205
1486
  }
1206
- interface OrderPurchased {
1207
- /** Order that was paid for. If a free or an offline order, the order that was created. */
1208
- order?: Order;
1209
- }
1210
- interface OrderStarted {
1211
- /** Order that reached its `startDate`. */
1212
- order?: Order;
1213
- }
1214
- /**
1215
- * Triggered at the start of a new payment cycle for an existing order.
1216
- *
1217
- * This webhook does not trigger at the initial start of an offline order.
1218
- */
1219
- interface OrderCycleStarted {
1220
- /** Order whose new cycle started. */
1221
- order?: Order;
1222
- /** 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. */
1223
- cycleNumber?: number;
1224
- }
1225
- /** Emitted when a recurring order is canceled for the next payment cycle */
1226
- interface OrderAutoRenewCanceled {
1227
- /** Order that is canceled, effective at the end of the current payment cycle. */
1228
- order?: Order;
1229
- }
1230
- interface OrderEnded {
1231
- /** Order that ended. */
1232
- order?: Order;
1233
- }
1234
- interface GetOrderRequest {
1235
- /**
1236
- * Order ID.
1237
- * @format GUID
1238
- */
1239
- _id: string;
1240
- /**
1241
- * Predefined set of fields to return.
1242
- *
1243
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1244
- */
1245
- fieldSet?: SetWithLiterals;
1246
- }
1247
- interface GetOrderResponse {
1248
- /** Order. */
1249
- order?: Order;
1250
- }
1251
- interface ListOrdersRequest {
1252
- /**
1253
- * Filter by a buyer's member ID, from the Members API.
1254
- * @format GUID
1255
- */
1256
- buyerIds?: string[];
1257
- /**
1258
- * Filter by plan IDs, from the Plans API.
1259
- * @format GUID
1260
- */
1261
- planIds?: string[];
1262
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
1263
- autoRenewCanceled?: boolean | null;
1264
- /** Filter by order status. */
1265
- orderStatuses?: OrderStatusWithLiterals[];
1266
- /** Filter by payment status. */
1267
- paymentStatuses?: PaymentStatusWithLiterals[];
1268
- /**
1269
- * Number of orders to return. See Sorting and Paging for more information.
1270
- *
1271
- * Max: `50`
1272
- * @min 1
1273
- * @max 50
1274
- */
1275
- limit?: number | null;
1276
- /** Number of orders to skip in the current sort order. */
1277
- offset?: number | null;
1278
- /**
1279
- * Sort order.
1280
- *
1281
- * Use `ASC` for ascending order or `DESC` for descending order.
1282
- *
1283
- * Default: `DESC`.
1284
- */
1285
- sorting?: Sorting;
1286
- /**
1287
- * Predefined set of fields to return.
1288
- *
1289
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1290
- */
1291
- fieldSet?: SetWithLiterals;
1292
- }
1293
- interface ListOrdersResponse {
1294
- /** List of orders. */
1295
- orders?: Order[];
1296
- /** Object containing paging-related data (number of orders returned, offset). */
1297
- pagingMetadata?: PagingMetadataV2;
1298
- }
1299
- interface OrdersQueryOrdersRequest {
1300
- /** Query filter. */
1301
- query?: QueryV2;
1302
- }
1303
- interface OrdersQueryOrdersResponse {
1304
- /** Retrieved orders. */
1305
- plans?: Order[];
1306
- /** Paging-related data (number of orders returned, offset). */
1307
- pagingMetadata?: PagingMetadataV2;
1308
- }
1309
- interface GetOrdersStatsRequest {
1310
- }
1311
- interface GetOrdersStatsResponse {
1312
- /** Total number of orders. */
1313
- totalOrderCount?: number;
1314
- /** Number of active orders. */
1315
- activeOrderCount?: number;
1316
- }
1317
- interface GetAvailableOrderActionsRequest {
1318
- /**
1319
- * Order ID.
1320
- * @format GUID
1321
- */
1322
- _id?: string;
1323
- }
1324
- interface GetAvailableOrderActionsResponse {
1325
- /** Whether the order can be suspended. */
1326
- suspendable?: boolean;
1327
- /** If the order cannot be suspended, a reason is returned here. */
1328
- notSuspendableReason?: ReasonNotSuspendableWithLiterals;
1329
- /** Whether the order can be canceled by the buyer. */
1330
- cancelableByBuyer?: boolean;
1331
- }
1332
- declare enum ReasonNotSuspendable {
1333
- /** Undefined reason. */
1334
- UNDEFINED = "UNDEFINED",
1335
- /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
1336
- PENDING = "PENDING",
1337
- /** Trial orders can't be suspended. */
1338
- TRIAL = "TRIAL",
1339
- /** Canceled orders can't be suspended. */
1340
- CANCELED = "CANCELED",
1341
- /** Ended orders can't be suspended. */
1342
- ENDED = "ENDED",
1343
- /** Paid for orders with future start dates can't be suspended. */
1344
- NOT_STARTED = "NOT_STARTED",
1345
- /** Order is already suspended. */
1346
- ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
1347
- /** Orders based on recurring payments using older stripe versions can't be suspended. */
1348
- OLD_STRIPE = "OLD_STRIPE"
1349
- }
1350
- /** @enumType */
1351
- type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
1352
- interface PostponeEndDateRequest {
1353
- /**
1354
- * Order ID.
1355
- * @format GUID
1356
- */
1357
- _id: string;
1358
- /**
1359
- * New end date and time.
1360
- *
1361
- * Must be later than the current end date and time.
1362
- */
1363
- endDate: Date | null;
1364
- }
1365
- interface PostponeEndDateResponse {
1366
- }
1367
- interface OrderEndDatePostponed {
1368
- /** Order whose `endDate` was postponed. */
1369
- order?: Order;
1370
- }
1371
- interface CancelOrderRequest {
1372
- /**
1373
- * Order ID.
1374
- * @format GUID
1375
- */
1376
- _id: string;
1377
- /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
1378
- effectiveAt: CancellationEffectiveAtWithLiterals;
1379
- }
1380
- interface CancelOrderResponse {
1381
- }
1382
- interface MarkAsPaidRequest {
1383
- /**
1384
- * Order ID.
1385
- * @format GUID
1386
- */
1387
- _id: string;
1388
- }
1389
- interface MarkAsPaidResponse {
1390
- }
1391
- interface OrderMarkedAsPaid {
1392
- /** Order that was marked as paid. */
1393
- order?: Order;
1394
- }
1395
- interface PauseOrderRequest {
1396
- /**
1397
- * Order ID.
1398
- * @format GUID
1399
- */
1400
- _id: string;
1401
- }
1402
- interface PauseOrderResponse {
1403
- }
1404
- interface OrderPaused {
1405
- /** Paused order. */
1406
- order?: Order;
1407
- }
1408
- interface BulkPauseOrderRequest {
1409
- /**
1410
- * List of Order IDs.
1411
- * @format GUID
1412
- * @minSize 1
1413
- * @maxSize 100
1414
- */
1415
- ids?: string[];
1416
- /** Set to true to return Order entity in response. */
1417
- returnFullEntity?: boolean;
1418
- }
1419
- interface BulkPauseOrderResponse {
1420
- /** Orders that were paused. */
1421
- results?: BulkOrderResult[];
1422
- /** Bulk action metadata. */
1423
- bulkActionMetadata?: BulkActionMetadata;
1424
- }
1425
- interface BulkOrderResult {
1426
- /** Item metadata */
1427
- itemMetadata?: ItemMetadata;
1428
- /** The order. */
1429
- order?: Order;
1430
- }
1431
- interface ItemMetadata {
1432
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1433
- _id?: string | null;
1434
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1435
- originalIndex?: number;
1436
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1437
- success?: boolean;
1438
- /** Details about the error in case of failure. */
1439
- error?: ApplicationError;
1440
- }
1441
- interface ApplicationError {
1442
- /** Error code. */
1443
- code?: string;
1444
- /** Description of the error. */
1445
- description?: string;
1446
- /** Data related to the error. */
1447
- data?: Record<string, any> | null;
1448
- }
1449
- interface BulkActionMetadata {
1450
- /** Number of items that were successfully processed. */
1451
- totalSuccesses?: number;
1452
- /** Number of items that couldn't be processed. */
1453
- totalFailures?: number;
1454
- /** Number of failures without details because detailed failure threshold was exceeded. */
1455
- undetailedFailures?: number;
1456
- }
1457
- interface ResumeOrderRequest {
1458
- /**
1459
- * Order ID.
1460
- * @format GUID
1461
- */
1462
- _id: string;
1463
- }
1464
- interface ResumeOrderResponse {
1465
- }
1466
- interface OrderResumed {
1467
- /** Resumed order. */
1468
- order?: Order;
1469
- }
1470
- interface BulkResumeOrderRequest {
1471
- /**
1472
- * List of Order IDs.
1473
- * @format GUID
1474
- * @minSize 1
1475
- * @maxSize 100
1476
- */
1477
- ids?: string[];
1478
- /** Set to true to return Order entity in response. */
1479
- returnFullEntity?: boolean;
1480
- }
1481
- interface BulkResumeOrderResponse {
1482
- /** Orders that were resumed. */
1483
- results?: BulkOrderResult[];
1484
- /** Bulk action metadata. */
1485
- bulkActionMetadata?: BulkActionMetadata;
1486
- }
1487
1487
  /** @docsIgnore */
1488
1488
  type CreateOnlineOrderApplicationErrors = {
1489
1489
  code?: 'MEMBER_REQUIRED';
@@ -1823,7 +1823,41 @@ interface EventMetadata extends BaseEventMetadata {
1823
1823
  * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1824
1824
  */
1825
1825
  entityEventSequence?: string | null;
1826
+ accountInfo?: AccountInfoMetadata;
1827
+ }
1828
+ interface AccountInfoMetadata {
1829
+ /** ID of the Wix account associated with the event */
1830
+ accountId: string;
1831
+ /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
1832
+ siteId?: string;
1833
+ /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
1834
+ parentAccountId?: string;
1826
1835
  }
1836
+ interface OrderAutoRenewCanceledEnvelope {
1837
+ data: OrderAutoRenewCanceled;
1838
+ metadata: EventMetadata;
1839
+ }
1840
+ /**
1841
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1842
+ *
1843
+ * This webhook is *not* triggered in the following scenarios:
1844
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1845
+ * + 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.
1846
+ * @permissionScope Manage Orders
1847
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1848
+ * @permissionScope Read Orders
1849
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1850
+ * @permissionScope Manage plans and orders of Pricing Plans
1851
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1852
+ * @permissionScope Manage Events
1853
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1854
+ * @permissionId PRICING_PLANS.READ_ORDERS
1855
+ * @webhook
1856
+ * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1857
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1858
+ * @slug auto_renew_canceled
1859
+ */
1860
+ declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1827
1861
  interface OrderCanceledEnvelope {
1828
1862
  data: OrderCanceled;
1829
1863
  metadata: EventMetadata;
@@ -1845,16 +1879,18 @@ interface OrderCanceledEnvelope {
1845
1879
  * @permissionId PRICING_PLANS.READ_ORDERS
1846
1880
  * @webhook
1847
1881
  * @eventType wix.pricing_plans.v2.order_canceled
1848
- * @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
1882
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1849
1883
  * @slug canceled
1850
1884
  */
1851
1885
  declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1852
- interface OrderCreatedEnvelope {
1853
- entity: Order;
1886
+ interface OrderCycleStartedEnvelope {
1887
+ data: OrderCycleStarted;
1854
1888
  metadata: EventMetadata;
1855
1889
  }
1856
1890
  /**
1857
- * Triggered when an order is created.
1891
+ * Triggered at the start of a new payment cycle for an existing order.
1892
+ *
1893
+ * Not triggered at the initial start of an offline order.
1858
1894
  * @permissionScope Manage Orders
1859
1895
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1860
1896
  * @permissionScope Read Orders
@@ -1865,17 +1901,17 @@ interface OrderCreatedEnvelope {
1865
1901
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1866
1902
  * @permissionId PRICING_PLANS.READ_ORDERS
1867
1903
  * @webhook
1868
- * @eventType wix.pricing_plans.v2.order_created
1869
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1870
- * @slug created
1904
+ * @eventType wix.pricing_plans.v2.order_cycle_started
1905
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1906
+ * @slug cycle_started
1871
1907
  */
1872
- declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
1873
- interface OrderStartDateChangedEnvelope {
1874
- data: OrderStartDateChanged;
1908
+ declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1909
+ interface OrderEndDatePostponedEnvelope {
1910
+ data: OrderEndDatePostponed;
1875
1911
  metadata: EventMetadata;
1876
1912
  }
1877
1913
  /**
1878
- * Triggered when an order's `startDate` is changed.
1914
+ * Triggered when an order's `endDate` is postponed.
1879
1915
  * @permissionScope Manage Orders
1880
1916
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1881
1917
  * @permissionScope Read Orders
@@ -1886,25 +1922,21 @@ interface OrderStartDateChangedEnvelope {
1886
1922
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1887
1923
  * @permissionId PRICING_PLANS.READ_ORDERS
1888
1924
  * @webhook
1889
- * @eventType wix.pricing_plans.v2.order_start_date_changed
1890
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1891
- * @slug start_date_changed
1925
+ * @eventType wix.pricing_plans.v2.order_end_date_postponed
1926
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1927
+ * @slug end_date_postponed
1892
1928
  */
1893
- declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
1894
- interface OrderUpdatedEnvelope {
1895
- entity: Order;
1929
+ declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
1930
+ interface OrderEndedEnvelope {
1931
+ data: OrderEnded;
1896
1932
  metadata: EventMetadata;
1897
1933
  }
1898
1934
  /**
1899
- * Triggered for any of the following update events:
1935
+ * Triggered when an order ends.
1900
1936
  *
1901
- * + Order is paid for. Order Purchased is also triggered.
1902
- * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
1903
- * + New payment cycle of an order starts. Order Cycle Started is also triggered.
1904
- * + Offline order is marked as paid. Order Marked As Paid is also triggered.
1905
- * + End date of the order is postponed. Order End Date Postponed is also triggered
1906
- * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
1907
- * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
1937
+ * This webhook is triggered:
1938
+ * + When an order expires at the end of the current payment cycle.
1939
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
1908
1940
  * @permissionScope Manage Orders
1909
1941
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1910
1942
  * @permissionScope Read Orders
@@ -1915,21 +1947,17 @@ interface OrderUpdatedEnvelope {
1915
1947
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1916
1948
  * @permissionId PRICING_PLANS.READ_ORDERS
1917
1949
  * @webhook
1918
- * @eventType wix.pricing_plans.v2.order_updated
1919
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1920
- * @slug updated
1950
+ * @eventType wix.pricing_plans.v2.order_ended
1951
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1952
+ * @slug ended
1921
1953
  */
1922
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
1923
- interface OrderAutoRenewCanceledEnvelope {
1924
- data: OrderAutoRenewCanceled;
1954
+ declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
1955
+ interface OrderMarkedAsPaidEnvelope {
1956
+ data: OrderMarkedAsPaid;
1925
1957
  metadata: EventMetadata;
1926
1958
  }
1927
1959
  /**
1928
- * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1929
- *
1930
- * This webhook is *not* triggered in the following scenarios:
1931
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1932
- * + 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.
1960
+ * Triggered when an offline order is marked as paid.
1933
1961
  * @permissionScope Manage Orders
1934
1962
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1935
1963
  * @permissionScope Read Orders
@@ -1940,19 +1968,17 @@ interface OrderAutoRenewCanceledEnvelope {
1940
1968
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1941
1969
  * @permissionId PRICING_PLANS.READ_ORDERS
1942
1970
  * @webhook
1943
- * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1971
+ * @eventType wix.pricing_plans.v2.order_marked_as_paid
1944
1972
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1945
- * @slug auto_renew_canceled
1973
+ * @slug marked_as_paid
1946
1974
  */
1947
- declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1948
- interface OrderCycleStartedEnvelope {
1949
- data: OrderCycleStarted;
1975
+ declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
1976
+ interface OrderPausedEnvelope {
1977
+ data: OrderPaused;
1950
1978
  metadata: EventMetadata;
1951
1979
  }
1952
1980
  /**
1953
- * Triggered at the start of a new payment cycle for an existing order.
1954
- *
1955
- * Not triggered at the initial start of an offline order.
1981
+ * Triggered when an order is paused.
1956
1982
  * @permissionScope Manage Orders
1957
1983
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1958
1984
  * @permissionScope Read Orders
@@ -1963,17 +1989,21 @@ interface OrderCycleStartedEnvelope {
1963
1989
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1964
1990
  * @permissionId PRICING_PLANS.READ_ORDERS
1965
1991
  * @webhook
1966
- * @eventType wix.pricing_plans.v2.order_cycle_started
1992
+ * @eventType wix.pricing_plans.v2.order_paused
1967
1993
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1968
- * @slug cycle_started
1994
+ * @slug paused
1969
1995
  */
1970
- declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1971
- interface OrderEndDatePostponedEnvelope {
1972
- data: OrderEndDatePostponed;
1996
+ declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
1997
+ interface OrderPurchasedEnvelope {
1998
+ data: OrderPurchased;
1973
1999
  metadata: EventMetadata;
1974
2000
  }
1975
2001
  /**
1976
- * Triggered when an order's `endDate` is postponed.
2002
+ * Triggered for any of the following purchase events:
2003
+ * + Order is paid in full.
2004
+ * + At least 1 order cycle payment is paid for.
2005
+ * + Offline order is created, even if not yet marked as paid.
2006
+ * + Free order is created.
1977
2007
  * @permissionScope Manage Orders
1978
2008
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1979
2009
  * @permissionScope Read Orders
@@ -1984,21 +2014,17 @@ interface OrderEndDatePostponedEnvelope {
1984
2014
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1985
2015
  * @permissionId PRICING_PLANS.READ_ORDERS
1986
2016
  * @webhook
1987
- * @eventType wix.pricing_plans.v2.order_end_date_postponed
2017
+ * @eventType wix.pricing_plans.v2.order_purchased
1988
2018
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1989
- * @slug end_date_postponed
2019
+ * @slug purchased
1990
2020
  */
1991
- declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
1992
- interface OrderEndedEnvelope {
1993
- data: OrderEnded;
2021
+ declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2022
+ interface OrderResumedEnvelope {
2023
+ data: OrderResumed;
1994
2024
  metadata: EventMetadata;
1995
2025
  }
1996
2026
  /**
1997
- * Triggered when an order ends.
1998
- *
1999
- * This webhook is triggered:
2000
- * + When an order expires at the end of the current payment cycle.
2001
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
2027
+ * Triggered when a paused order is resumed.
2002
2028
  * @permissionScope Manage Orders
2003
2029
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2004
2030
  * @permissionScope Read Orders
@@ -2009,17 +2035,17 @@ interface OrderEndedEnvelope {
2009
2035
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2010
2036
  * @permissionId PRICING_PLANS.READ_ORDERS
2011
2037
  * @webhook
2012
- * @eventType wix.pricing_plans.v2.order_ended
2038
+ * @eventType wix.pricing_plans.v2.order_resumed
2013
2039
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2014
- * @slug ended
2040
+ * @slug resumed
2015
2041
  */
2016
- declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
2017
- interface OrderMarkedAsPaidEnvelope {
2018
- data: OrderMarkedAsPaid;
2042
+ declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2043
+ interface OrderStartedEnvelope {
2044
+ data: OrderStarted;
2019
2045
  metadata: EventMetadata;
2020
2046
  }
2021
2047
  /**
2022
- * Triggered when an offline order is marked as paid.
2048
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2023
2049
  * @permissionScope Manage Orders
2024
2050
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2025
2051
  * @permissionScope Read Orders
@@ -2030,17 +2056,25 @@ interface OrderMarkedAsPaidEnvelope {
2030
2056
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2031
2057
  * @permissionId PRICING_PLANS.READ_ORDERS
2032
2058
  * @webhook
2033
- * @eventType wix.pricing_plans.v2.order_marked_as_paid
2059
+ * @eventType wix.pricing_plans.v2.order_started
2034
2060
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2035
- * @slug marked_as_paid
2061
+ * @slug started
2036
2062
  */
2037
- declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
2038
- interface OrderPausedEnvelope {
2039
- data: OrderPaused;
2063
+ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2064
+ interface OrderUpdatedEnvelope {
2065
+ entity: Order;
2040
2066
  metadata: EventMetadata;
2041
2067
  }
2042
2068
  /**
2043
- * Triggered when an order is paused.
2069
+ * Triggered for any of the following update events:
2070
+ *
2071
+ * + Order is paid for. Order Purchased is also triggered.
2072
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
2073
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
2074
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
2075
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
2076
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
2077
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
2044
2078
  * @permissionScope Manage Orders
2045
2079
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2046
2080
  * @permissionScope Read Orders
@@ -2051,21 +2085,17 @@ interface OrderPausedEnvelope {
2051
2085
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2052
2086
  * @permissionId PRICING_PLANS.READ_ORDERS
2053
2087
  * @webhook
2054
- * @eventType wix.pricing_plans.v2.order_paused
2088
+ * @eventType wix.pricing_plans.v2.order_updated
2055
2089
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2056
- * @slug paused
2090
+ * @slug updated
2057
2091
  */
2058
- declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2059
- interface OrderPurchasedEnvelope {
2060
- data: OrderPurchased;
2092
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2093
+ interface OrderCreatedEnvelope {
2094
+ entity: Order;
2061
2095
  metadata: EventMetadata;
2062
2096
  }
2063
2097
  /**
2064
- * Triggered for any of the following purchase events:
2065
- * + Order is paid in full.
2066
- * + At least 1 order cycle payment is paid for.
2067
- * + Offline order is created, even if not yet marked as paid.
2068
- * + Free order is created.
2098
+ * Triggered when an order is created.
2069
2099
  * @permissionScope Manage Orders
2070
2100
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2071
2101
  * @permissionScope Read Orders
@@ -2076,53 +2106,206 @@ interface OrderPurchasedEnvelope {
2076
2106
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2077
2107
  * @permissionId PRICING_PLANS.READ_ORDERS
2078
2108
  * @webhook
2079
- * @eventType wix.pricing_plans.v2.order_purchased
2080
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2081
- * @slug purchased
2109
+ * @eventType wix.pricing_plans.v2.order_created
2110
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2111
+ * @slug created
2112
+ */
2113
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
2114
+ interface OrderStartDateChangedEnvelope {
2115
+ data: OrderStartDateChanged;
2116
+ metadata: EventMetadata;
2117
+ }
2118
+ /**
2119
+ * Triggered when an order's `startDate` is changed.
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_start_date_changed
2131
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2132
+ * @slug start_date_changed
2133
+ */
2134
+ declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
2135
+ /**
2136
+ * Retrieves an order by ID.
2137
+ * @param _id - Order ID.
2138
+ * @public
2139
+ * @requiredField _id
2140
+ * @param options - Options to use when getting an order.
2141
+ * @permissionId PRICING_PLANS.READ_ORDERS
2142
+ * @applicableIdentity APP
2143
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2144
+ */
2145
+ 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>>;
2146
+ interface ManagementGetOrderOptions {
2147
+ /**
2148
+ * Predefined set of fields to return.
2149
+ *
2150
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2151
+ */
2152
+ fieldSet?: SetWithLiterals;
2153
+ }
2154
+ /**
2155
+ * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2156
+ *
2157
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2158
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2159
+ * @public
2160
+ * @param options - Filtering, sorting, and pagination options.
2161
+ * @permissionId PRICING_PLANS.READ_ORDERS
2162
+ * @applicableIdentity APP
2163
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2164
+ */
2165
+ 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>>;
2166
+ interface ManagementListOrdersOptions {
2167
+ /**
2168
+ * Filter by a buyer's member ID, from the Members API.
2169
+ * @format GUID
2170
+ */
2171
+ buyerIds?: string[];
2172
+ /**
2173
+ * Filter by plan IDs, from the Plans API.
2174
+ * @format GUID
2175
+ */
2176
+ planIds?: string[];
2177
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2178
+ autoRenewCanceled?: boolean | null;
2179
+ /** Filter by order status. */
2180
+ orderStatuses?: OrderStatusWithLiterals[];
2181
+ /** Filter by payment status. */
2182
+ paymentStatuses?: PaymentStatusWithLiterals[];
2183
+ /**
2184
+ * Number of orders to return. See Sorting and Paging for more information.
2185
+ *
2186
+ * Max: `50`
2187
+ * @min 1
2188
+ * @max 50
2189
+ */
2190
+ limit?: number | null;
2191
+ /** Number of orders to skip in the current sort order. */
2192
+ offset?: number | null;
2193
+ /**
2194
+ * Sort order.
2195
+ *
2196
+ * Use `ASC` for ascending order or `DESC` for descending order.
2197
+ *
2198
+ * Default: `DESC`.
2199
+ */
2200
+ sorting?: Sorting;
2201
+ /**
2202
+ * Predefined set of fields to return.
2203
+ *
2204
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2205
+ */
2206
+ fieldSet?: SetWithLiterals;
2207
+ }
2208
+ /**
2209
+ * 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.
2210
+ *
2211
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2212
+ * Can't postpone an order with `status`: `PAUSED`.
2213
+ * @param _id - Order ID.
2214
+ * @param endDate - New end date and time.
2215
+ *
2216
+ * Must be later than the current end date and time.
2217
+ * @public
2218
+ * @requiredField _id
2219
+ * @requiredField endDate
2220
+ * @param options - Options for postponing the end date of an order.
2221
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2222
+ * @applicableIdentity APP
2223
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2224
+ */
2225
+ declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2226
+ /**
2227
+ * Cancels an existing order.
2228
+ *
2229
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2230
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2231
+ *
2232
+ * #### Canceling during the free trial period.
2233
+ *
2234
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2235
+ * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2236
+ * of the free trial period.
2237
+ *
2238
+ * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2239
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2240
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2241
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2242
+ * Then, the subscription ends and the buyer is not billed.
2243
+ * @param _id - Order ID.
2244
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2245
+ * @public
2246
+ * @requiredField _id
2247
+ * @requiredField effectiveAt
2248
+ * @param options - Options for canceling orders.
2249
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2250
+ * @applicableIdentity APP
2251
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2252
+ */
2253
+ declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2254
+ /**
2255
+ * Marks an offline order as paid.
2256
+ * > __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.
2257
+ *
2258
+ * Marking an offline order as paid causes the following changes:
2259
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2260
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2261
+ *
2262
+ * An error occurs if you attempt to:
2263
+ * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2264
+ * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2265
+ * @param _id - Order ID.
2266
+ * @public
2267
+ * @requiredField _id
2268
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2269
+ * @applicableIdentity APP
2270
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2082
2271
  */
2083
- declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2084
- interface OrderResumedEnvelope {
2085
- data: OrderResumed;
2086
- metadata: EventMetadata;
2087
- }
2272
+ declare function markAsPaid(_id: string): Promise<void>;
2088
2273
  /**
2089
- * Triggered when a paused order is resumed.
2090
- * @permissionScope Manage Orders
2091
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2092
- * @permissionScope Read Orders
2093
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2094
- * @permissionScope Manage plans and orders of Pricing Plans
2095
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2096
- * @permissionScope Manage Events
2097
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2098
- * @permissionId PRICING_PLANS.READ_ORDERS
2099
- * @webhook
2100
- * @eventType wix.pricing_plans.v2.order_resumed
2101
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2102
- * @slug resumed
2274
+ * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2275
+ *
2276
+ * Only orders with `status`: `ACTIVE` can be paused.
2277
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2278
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2279
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2280
+ *
2281
+ * To resume a paused order, call Resume Order.
2282
+ * @param _id - Order ID.
2283
+ * @public
2284
+ * @requiredField _id
2285
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2286
+ * @applicableIdentity APP
2287
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2103
2288
  */
2104
- declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2105
- interface OrderStartedEnvelope {
2106
- data: OrderStarted;
2107
- metadata: EventMetadata;
2108
- }
2289
+ declare function pauseOrder(_id: string): Promise<void>;
2109
2290
  /**
2110
- * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2111
- * @permissionScope Manage Orders
2112
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2113
- * @permissionScope Read Orders
2114
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2115
- * @permissionScope Manage plans and orders of Pricing Plans
2116
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2117
- * @permissionScope Manage Events
2118
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2119
- * @permissionId PRICING_PLANS.READ_ORDERS
2120
- * @webhook
2121
- * @eventType wix.pricing_plans.v2.order_started
2122
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2123
- * @slug started
2291
+ * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2292
+ *
2293
+ * Resuming an order causes the following changes:
2294
+ * - The order status changes to `"ACTIVE"`.
2295
+ * - The `pausePeriods` array is updated.
2296
+ * - The `endDate` for the order is adjusted to include the pause period.
2297
+ * - For orders with recurring payments, the payment schedule is restarted.
2298
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2299
+ *
2300
+ * To pause an order, call Pause Order.
2301
+ * @param _id - Order ID.
2302
+ * @public
2303
+ * @requiredField _id
2304
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2305
+ * @applicableIdentity APP
2306
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2124
2307
  */
2125
- declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2308
+ declare function resumeOrder(_id: string): Promise<void>;
2126
2309
  /**
2127
2310
  * Retrieves an order for the currently logged-in member by ID.
2128
2311
  * @param _id - Order ID.
@@ -2132,9 +2315,10 @@ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void |
2132
2315
  * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2133
2316
  * @applicableIdentity APP
2134
2317
  * @applicableIdentity MEMBER
2318
+ * @returns Requested order.
2135
2319
  * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
2136
2320
  */
2137
- 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>>;
2321
+ 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>>;
2138
2322
  interface MemberGetOrderOptions {
2139
2323
  /**
2140
2324
  * Predefined set of fields to return.
@@ -2397,180 +2581,5 @@ interface GetPricePreviewOptions {
2397
2581
  */
2398
2582
  couponCode?: string | null;
2399
2583
  }
2400
- /**
2401
- * Retrieves an order by ID.
2402
- * @param _id - Order ID.
2403
- * @public
2404
- * @requiredField _id
2405
- * @param options - Options to use when getting an order.
2406
- * @permissionId PRICING_PLANS.READ_ORDERS
2407
- * @applicableIdentity APP
2408
- * @returns Order.
2409
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2410
- */
2411
- 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>>;
2412
- interface ManagementGetOrderOptions {
2413
- /**
2414
- * Predefined set of fields to return.
2415
- *
2416
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2417
- */
2418
- fieldSet?: SetWithLiterals;
2419
- }
2420
- /**
2421
- * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2422
- *
2423
- * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2424
- * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2425
- * @public
2426
- * @param options - Filtering, sorting, and pagination options.
2427
- * @permissionId PRICING_PLANS.READ_ORDERS
2428
- * @applicableIdentity APP
2429
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2430
- */
2431
- 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>>;
2432
- interface ManagementListOrdersOptions {
2433
- /**
2434
- * Filter by a buyer's member ID, from the Members API.
2435
- * @format GUID
2436
- */
2437
- buyerIds?: string[];
2438
- /**
2439
- * Filter by plan IDs, from the Plans API.
2440
- * @format GUID
2441
- */
2442
- planIds?: string[];
2443
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2444
- autoRenewCanceled?: boolean | null;
2445
- /** Filter by order status. */
2446
- orderStatuses?: OrderStatusWithLiterals[];
2447
- /** Filter by payment status. */
2448
- paymentStatuses?: PaymentStatusWithLiterals[];
2449
- /**
2450
- * Number of orders to return. See Sorting and Paging for more information.
2451
- *
2452
- * Max: `50`
2453
- * @min 1
2454
- * @max 50
2455
- */
2456
- limit?: number | null;
2457
- /** Number of orders to skip in the current sort order. */
2458
- offset?: number | null;
2459
- /**
2460
- * Sort order.
2461
- *
2462
- * Use `ASC` for ascending order or `DESC` for descending order.
2463
- *
2464
- * Default: `DESC`.
2465
- */
2466
- sorting?: Sorting;
2467
- /**
2468
- * Predefined set of fields to return.
2469
- *
2470
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2471
- */
2472
- fieldSet?: SetWithLiterals;
2473
- }
2474
- /**
2475
- * 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.
2476
- *
2477
- * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2478
- * Can't postpone an order with `status`: `PAUSED`.
2479
- * @param _id - Order ID.
2480
- * @param endDate - New end date and time.
2481
- *
2482
- * Must be later than the current end date and time.
2483
- * @public
2484
- * @requiredField _id
2485
- * @requiredField endDate
2486
- * @param options - Options for postponing the end date of an order.
2487
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2488
- * @applicableIdentity APP
2489
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2490
- */
2491
- declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2492
- /**
2493
- * Cancels an existing order.
2494
- *
2495
- * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2496
- * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2497
- *
2498
- * #### Canceling during the free trial period.
2499
- *
2500
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2501
- * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2502
- * of the free trial period.
2503
- *
2504
- * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2505
- * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2506
- * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2507
- * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2508
- * Then, the subscription ends and the buyer is not billed.
2509
- * @param _id - Order ID.
2510
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2511
- * @public
2512
- * @requiredField _id
2513
- * @requiredField effectiveAt
2514
- * @param options - Options for canceling orders.
2515
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2516
- * @applicableIdentity APP
2517
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2518
- */
2519
- declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2520
- /**
2521
- * Marks an offline order as paid.
2522
- * > __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.
2523
- *
2524
- * Marking an offline order as paid causes the following changes:
2525
- * - The order's `lastPaymentStatus` changes to `"PAID"`.
2526
- * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2527
- *
2528
- * An error occurs if you attempt to:
2529
- * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2530
- * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2531
- * @param _id - Order ID.
2532
- * @public
2533
- * @requiredField _id
2534
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2535
- * @applicableIdentity APP
2536
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2537
- */
2538
- declare function markAsPaid(_id: string): Promise<void>;
2539
- /**
2540
- * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2541
- *
2542
- * Only orders with `status`: `ACTIVE` can be paused.
2543
- * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2544
- * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2545
- * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2546
- *
2547
- * To resume a paused order, call Resume Order.
2548
- * @param _id - Order ID.
2549
- * @public
2550
- * @requiredField _id
2551
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2552
- * @applicableIdentity APP
2553
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2554
- */
2555
- declare function pauseOrder(_id: string): Promise<void>;
2556
- /**
2557
- * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2558
- *
2559
- * Resuming an order causes the following changes:
2560
- * - The order status changes to `"ACTIVE"`.
2561
- * - The `pausePeriods` array is updated.
2562
- * - The `endDate` for the order is adjusted to include the pause period.
2563
- * - For orders with recurring payments, the payment schedule is restarted.
2564
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2565
- *
2566
- * To pause an order, call Pause Order.
2567
- * @param _id - Order ID.
2568
- * @public
2569
- * @requiredField _id
2570
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2571
- * @applicableIdentity APP
2572
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2573
- */
2574
- declare function resumeOrder(_id: string): Promise<void>;
2575
2584
 
2576
2585
  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 };