@wix/auto_sdk_pricing-plans_orders 1.0.93 → 1.0.94

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 +711 -711
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +799 -799
  5. package/build/cjs/index.typings.js +577 -577
  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 +711 -711
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +799 -799
  14. package/build/es/index.typings.mjs +577 -577
  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 +711 -711
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +799 -799
  23. package/build/internal/cjs/index.typings.js +577 -577
  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 +711 -711
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +799 -799
  32. package/build/internal/es/index.typings.mjs +577 -577
  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
@@ -635,35 +635,7 @@ interface ActionEvent {
635
635
  }
636
636
  interface Empty {
637
637
  }
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 {
638
+ interface MemberGetOrderRequest {
667
639
  /**
668
640
  * Order ID.
669
641
  * @format GUID
@@ -686,44 +658,31 @@ declare enum Set {
686
658
  }
687
659
  /** @enumType */
688
660
  type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
689
- interface GetOrderResponse {
690
- /** Order. */
661
+ interface MemberGetOrderResponse {
662
+ /** Requested order. */
691
663
  order?: Order;
692
664
  }
693
- interface ListOrdersRequest {
694
- /**
695
- * Filter by a buyer's member ID, from the Members API.
696
- * @format GUID
697
- */
698
- buyerIds?: string[];
665
+ interface MemberListOrdersRequest {
699
666
  /**
700
- * Filter by plan IDs, from the Plans API.
667
+ * Filter by plan IDs.
701
668
  * @format GUID
702
669
  */
703
670
  planIds?: string[];
704
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
671
+ /** Filter for orders where auto renewal was canceled. */
705
672
  autoRenewCanceled?: boolean | null;
706
673
  /** Filter by order status. */
707
674
  orderStatuses?: OrderStatusWithLiterals[];
708
675
  /** Filter by payment status. */
709
676
  paymentStatuses?: PaymentStatusWithLiterals[];
710
677
  /**
711
- * Number of orders to return. See Sorting and Paging for more information.
712
- *
713
- * Max: `50`
678
+ * Limit the number of pricing plans returned. Default limit is 50.
714
679
  * @min 1
715
680
  * @max 50
716
681
  */
717
682
  limit?: number | null;
718
- /** Number of orders to skip in the current sort order. */
683
+ /** Number of entries to offset. */
719
684
  offset?: number | null;
720
- /**
721
- * Sort order.
722
- *
723
- * Use `ASC` for ascending order or `DESC` for descending order.
724
- *
725
- * Default: `DESC`.
726
- */
685
+ /** Sorting direction (defaults to ASC) and field to sort by. */
727
686
  sorting?: Sorting;
728
687
  /**
729
688
  * Predefined set of fields to return.
@@ -747,8 +706,8 @@ declare enum SortOrder {
747
706
  }
748
707
  /** @enumType */
749
708
  type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
750
- interface ListOrdersResponse {
751
- /** List of orders. */
709
+ interface MemberListOrdersResponse {
710
+ /** Requested orders. */
752
711
  orders?: Order[];
753
712
  /** Object containing paging-related data (number of orders returned, offset). */
754
713
  pagingMetadata?: PagingMetadataV2;
@@ -777,7 +736,11 @@ interface Cursors {
777
736
  */
778
737
  prev?: string | null;
779
738
  }
780
- interface OrdersQueryOrdersRequest {
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 {
781
744
  /** Query filter. */
782
745
  query?: QueryV2;
783
746
  }
@@ -831,84 +794,22 @@ interface CursorPaging {
831
794
  */
832
795
  cursor?: string | null;
833
796
  }
834
- interface OrdersQueryOrdersResponse {
835
- /** Retrieved orders. */
797
+ interface QueryOrdersResponse {
798
+ /** Order data. */
836
799
  plans?: Order[];
837
800
  /** Paging-related data (number of orders returned, offset). */
838
801
  pagingMetadata?: PagingMetadataV2;
839
802
  }
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 {
884
- /**
885
- * Order ID.
886
- * @format GUID
887
- */
888
- _id: string;
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 {
803
+ interface RequestCancellationRequest {
903
804
  /**
904
805
  * Order ID.
905
806
  * @format GUID
906
807
  */
907
808
  _id: string;
908
- /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
809
+ /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
909
810
  effectiveAt: CancellationEffectiveAtWithLiterals;
910
811
  }
911
- interface CancelOrderResponse {
812
+ interface RequestCancellationResponse {
912
813
  }
913
814
  /**
914
815
  * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
@@ -919,111 +820,6 @@ interface OrderCanceled {
919
820
  /** Canceled order. */
920
821
  order?: Order;
921
822
  }
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
- }
1027
823
  interface MessageEnvelope {
1028
824
  /**
1029
825
  * App instance ID.
@@ -1113,93 +909,16 @@ interface AccountInfo {
1113
909
  */
1114
910
  siteId?: string | null;
1115
911
  }
1116
- interface MemberGetOrderRequest {
912
+ interface CreateOnlineOrderRequest {
1117
913
  /**
1118
- * Order ID.
914
+ * Plan ID.
1119
915
  * @format GUID
1120
916
  */
1121
- _id: string;
917
+ planId: string;
1122
918
  /**
1123
- * Predefined set of fields to return.
919
+ * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1124
920
  *
1125
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1126
- */
1127
- fieldSet?: SetWithLiterals;
1128
- }
1129
- interface MemberGetOrderResponse {
1130
- /** Requested order. */
1131
- order?: Order;
1132
- }
1133
- interface MemberListOrdersRequest {
1134
- /**
1135
- * Filter by plan IDs.
1136
- * @format GUID
1137
- */
1138
- planIds?: string[];
1139
- /** Filter for orders where auto renewal was canceled. */
1140
- autoRenewCanceled?: boolean | null;
1141
- /** Filter by order status. */
1142
- orderStatuses?: OrderStatusWithLiterals[];
1143
- /** Filter by payment status. */
1144
- paymentStatuses?: PaymentStatusWithLiterals[];
1145
- /**
1146
- * Limit the number of pricing plans returned. Default limit is 50.
1147
- * @min 1
1148
- * @max 50
1149
- */
1150
- limit?: number | null;
1151
- /** Number of entries to offset. */
1152
- offset?: number | null;
1153
- /** Sorting direction (defaults to ASC) and field to sort by. */
1154
- sorting?: Sorting;
1155
- /**
1156
- * Predefined set of fields to return.
1157
- *
1158
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
1159
- */
1160
- fieldSet?: SetWithLiterals;
1161
- }
1162
- interface MemberListOrdersResponse {
1163
- /** Requested orders. */
1164
- orders?: Order[];
1165
- /** Object containing paging-related data (number of orders returned, offset). */
1166
- pagingMetadata?: PagingMetadataV2;
1167
- }
1168
- /**
1169
- * TODO: Write orders filter and sort docs page
1170
- * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
1171
- */
1172
- interface QueryOrdersRequest {
1173
- /** Query filter. */
1174
- query?: QueryV2;
1175
- }
1176
- interface QueryOrdersResponse {
1177
- /** Order data. */
1178
- plans?: Order[];
1179
- /** Paging-related data (number of orders returned, offset). */
1180
- pagingMetadata?: PagingMetadataV2;
1181
- }
1182
- interface RequestCancellationRequest {
1183
- /**
1184
- * Order ID.
1185
- * @format GUID
1186
- */
1187
- _id: string;
1188
- /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
1189
- effectiveAt: CancellationEffectiveAtWithLiterals;
1190
- }
1191
- interface RequestCancellationResponse {
1192
- }
1193
- interface CreateOnlineOrderRequest {
1194
- /**
1195
- * Plan ID.
1196
- * @format GUID
1197
- */
1198
- planId: string;
1199
- /**
1200
- * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1201
- *
1202
- * Default: Current date and time.
921
+ * Default: Current date and time.
1203
922
  */
1204
923
  startDate?: Date | null;
1205
924
  /**
@@ -1501,185 +1220,466 @@ interface SetSubmissionResponse {
1501
1220
  /** Order with submission id */
1502
1221
  order?: Order;
1503
1222
  }
1504
- /** @docsIgnore */
1505
- type CreateOnlineOrderApplicationErrors = {
1506
- code?: 'MEMBER_REQUIRED';
1507
- description?: string;
1508
- data?: Record<string, any>;
1509
- } | {
1510
- code?: 'archived_plan';
1511
- description?: string;
1512
- data?: Record<string, any>;
1513
- } | {
1514
- code?: 'member_not_found';
1515
- description?: string;
1516
- data?: Record<string, any>;
1517
- } | {
1518
- code?: 'purchases_limit_reached';
1519
- description?: string;
1520
- data?: Record<string, any>;
1521
- } | {
1522
- code?: 'buyer_can_not_pick_future_start_date';
1523
- description?: string;
1524
- data?: Record<string, any>;
1525
- } | {
1526
- code?: 'invalid_start_date';
1527
- description?: string;
1528
- data?: Record<string, any>;
1529
- } | {
1530
- code?: 'accept_payment_feature_missing';
1531
- description?: string;
1532
- data?: Record<string, any>;
1533
- } | {
1534
- code?: 'meta_site_id_missing';
1535
- description?: string;
1536
- data?: Record<string, any>;
1537
- } | {
1538
- code?: 'ERROR_COUPON_IS_DISABLED';
1539
- description?: string;
1540
- data?: CouponsError;
1541
- } | {
1542
- code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1543
- description?: string;
1544
- data?: CouponsError;
1545
- } | {
1546
- code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1547
- description?: string;
1548
- data?: CouponsError;
1549
- } | {
1550
- code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1551
- description?: string;
1552
- data?: CouponsError;
1553
- } | {
1554
- code?: 'ERROR_COUPON_HAS_EXPIRED';
1555
- description?: string;
1556
- data?: CouponsError;
1557
- } | {
1558
- code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1559
- description?: string;
1560
- data?: CouponsError;
1561
- } | {
1562
- code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1563
- description?: string;
1564
- data?: CouponsError;
1565
- } | {
1566
- code?: 'ERROR_INVALID_SUBTOTAL';
1567
- description?: string;
1568
- data?: CouponsError;
1569
- } | {
1570
- code?: 'undefined_not_allowed';
1571
- description?: string;
1572
- data?: Record<string, any>;
1573
- } | {
1574
- code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1575
- description?: string;
1576
- data?: Record<string, any>;
1577
- } | {
1578
- code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1579
- description?: string;
1580
- data?: Record<string, any>;
1581
- };
1582
- /** @docsIgnore */
1583
- type CreateOnlineOrderValidationErrors = {
1584
- ruleName?: 'UNKNOWN_ORDER_METHOD';
1585
- } | {
1586
- ruleName?: 'RECURRING_POS_UNSUPPORTED';
1587
- } | {
1588
- ruleName?: 'invalid_sort_field';
1589
- };
1590
- /** @docsIgnore */
1591
- type CreateOfflineOrderApplicationErrors = {
1592
- code?: 'PRICING_PLANS_NOT_INSTALLED';
1593
- description?: string;
1594
- data?: Record<string, any>;
1595
- } | {
1596
- code?: 'meta_site_id_missing';
1597
- description?: string;
1598
- data?: Record<string, any>;
1599
- } | {
1600
- code?: 'ERROR_COUPON_IS_DISABLED';
1601
- description?: string;
1602
- data?: CouponsError;
1603
- } | {
1604
- code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1605
- description?: string;
1606
- data?: CouponsError;
1607
- } | {
1608
- code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1609
- description?: string;
1610
- data?: CouponsError;
1611
- } | {
1612
- code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1613
- description?: string;
1614
- data?: CouponsError;
1615
- } | {
1616
- code?: 'ERROR_COUPON_HAS_EXPIRED';
1617
- description?: string;
1618
- data?: CouponsError;
1619
- } | {
1620
- code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1621
- description?: string;
1622
- data?: CouponsError;
1623
- } | {
1624
- code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1625
- description?: string;
1626
- data?: CouponsError;
1627
- } | {
1628
- code?: 'ERROR_INVALID_SUBTOTAL';
1629
- description?: string;
1630
- data?: CouponsError;
1631
- } | {
1632
- code?: 'undefined_not_allowed';
1633
- description?: string;
1634
- data?: Record<string, any>;
1635
- } | {
1636
- code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1637
- description?: string;
1638
- data?: Record<string, any>;
1639
- } | {
1640
- code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1641
- description?: string;
1642
- data?: Record<string, any>;
1643
- };
1644
- /** @docsIgnore */
1645
- type CreateOfflineOrderValidationErrors = {
1646
- ruleName?: 'MEMBER_DOESNT_EXIST';
1647
- } | {
1648
- ruleName?: 'invalid_sort_field';
1649
- };
1650
- /** @docsIgnore */
1651
- type GetOnlineOrderPreviewApplicationErrors = {
1652
- code?: 'PRICING_PLANS_NOT_INSTALLED';
1653
- description?: string;
1654
- data?: Record<string, any>;
1655
- } | {
1656
- code?: 'ERROR_COUPON_IS_DISABLED';
1657
- description?: string;
1658
- data?: CouponsError;
1659
- } | {
1660
- code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1661
- description?: string;
1662
- data?: CouponsError;
1663
- } | {
1664
- code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1665
- description?: string;
1666
- data?: CouponsError;
1667
- } | {
1668
- code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1669
- description?: string;
1670
- data?: CouponsError;
1671
- } | {
1672
- code?: 'ERROR_COUPON_HAS_EXPIRED';
1673
- description?: string;
1674
- data?: CouponsError;
1675
- } | {
1676
- code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1677
- description?: string;
1678
- data?: CouponsError;
1679
- } | {
1680
- code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1681
- description?: string;
1682
- data?: CouponsError;
1223
+ interface OrderPurchased {
1224
+ /** Order that was paid for. If a free or an offline order, the order that was created. */
1225
+ order?: Order;
1226
+ }
1227
+ interface OrderStarted {
1228
+ /** Order that reached its `startDate`. */
1229
+ order?: Order;
1230
+ }
1231
+ /**
1232
+ * Triggered at the start of a new payment cycle for an existing order.
1233
+ *
1234
+ * This webhook does not trigger at the initial start of an offline order.
1235
+ */
1236
+ interface OrderCycleStarted {
1237
+ /** Order whose new cycle started. */
1238
+ order?: Order;
1239
+ /** 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. */
1240
+ cycleNumber?: number;
1241
+ }
1242
+ /** Emitted when a recurring order is canceled for the next payment cycle */
1243
+ interface OrderAutoRenewCanceled {
1244
+ /** Order that is canceled, effective at the end of the current payment cycle. */
1245
+ order?: Order;
1246
+ }
1247
+ interface OrderEnded {
1248
+ /** Order that ended. */
1249
+ order?: Order;
1250
+ }
1251
+ interface GetOrderRequest {
1252
+ /**
1253
+ * Order ID.
1254
+ * @format GUID
1255
+ */
1256
+ _id: string;
1257
+ /**
1258
+ * Predefined set of fields to return.
1259
+ *
1260
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1261
+ */
1262
+ fieldSet?: SetWithLiterals;
1263
+ }
1264
+ interface GetOrderResponse {
1265
+ /** Order. */
1266
+ order?: Order;
1267
+ }
1268
+ interface ListOrdersRequest {
1269
+ /**
1270
+ * Filter by a buyer's member ID, from the Members API.
1271
+ * @format GUID
1272
+ */
1273
+ buyerIds?: string[];
1274
+ /**
1275
+ * Filter by plan IDs, from the Plans API.
1276
+ * @format GUID
1277
+ */
1278
+ planIds?: string[];
1279
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
1280
+ autoRenewCanceled?: boolean | null;
1281
+ /** Filter by order status. */
1282
+ orderStatuses?: OrderStatusWithLiterals[];
1283
+ /** Filter by payment status. */
1284
+ paymentStatuses?: PaymentStatusWithLiterals[];
1285
+ /**
1286
+ * Number of orders to return. See Sorting and Paging for more information.
1287
+ *
1288
+ * Max: `50`
1289
+ * @min 1
1290
+ * @max 50
1291
+ */
1292
+ limit?: number | null;
1293
+ /** Number of orders to skip in the current sort order. */
1294
+ offset?: number | null;
1295
+ /**
1296
+ * Sort order.
1297
+ *
1298
+ * Use `ASC` for ascending order or `DESC` for descending order.
1299
+ *
1300
+ * Default: `DESC`.
1301
+ */
1302
+ sorting?: Sorting;
1303
+ /**
1304
+ * Predefined set of fields to return.
1305
+ *
1306
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1307
+ */
1308
+ fieldSet?: SetWithLiterals;
1309
+ }
1310
+ interface ListOrdersResponse {
1311
+ /** List of orders. */
1312
+ orders?: Order[];
1313
+ /** Object containing paging-related data (number of orders returned, offset). */
1314
+ pagingMetadata?: PagingMetadataV2;
1315
+ }
1316
+ interface OrdersQueryOrdersRequest {
1317
+ /** Query filter. */
1318
+ query?: QueryV2;
1319
+ }
1320
+ interface OrdersQueryOrdersResponse {
1321
+ /** Retrieved orders. */
1322
+ plans?: Order[];
1323
+ /** Paging-related data (number of orders returned, offset). */
1324
+ pagingMetadata?: PagingMetadataV2;
1325
+ }
1326
+ interface GetOrdersStatsRequest {
1327
+ }
1328
+ interface GetOrdersStatsResponse {
1329
+ /** Total number of orders. */
1330
+ totalOrderCount?: number;
1331
+ /** Number of active orders. */
1332
+ activeOrderCount?: number;
1333
+ }
1334
+ interface GetAvailableOrderActionsRequest {
1335
+ /**
1336
+ * Order ID.
1337
+ * @format GUID
1338
+ */
1339
+ _id?: string;
1340
+ }
1341
+ interface GetAvailableOrderActionsResponse {
1342
+ /** Whether the order can be suspended. */
1343
+ suspendable?: boolean;
1344
+ /** If the order cannot be suspended, a reason is returned here. */
1345
+ notSuspendableReason?: ReasonNotSuspendableWithLiterals;
1346
+ /** Whether the order can be canceled by the buyer. */
1347
+ cancelableByBuyer?: boolean;
1348
+ }
1349
+ declare enum ReasonNotSuspendable {
1350
+ /** Undefined reason. */
1351
+ UNDEFINED = "UNDEFINED",
1352
+ /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
1353
+ PENDING = "PENDING",
1354
+ /** Trial orders can't be suspended. */
1355
+ TRIAL = "TRIAL",
1356
+ /** Canceled orders can't be suspended. */
1357
+ CANCELED = "CANCELED",
1358
+ /** Ended orders can't be suspended. */
1359
+ ENDED = "ENDED",
1360
+ /** Paid for orders with future start dates can't be suspended. */
1361
+ NOT_STARTED = "NOT_STARTED",
1362
+ /** Order is already suspended. */
1363
+ ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
1364
+ /** Orders based on recurring payments using older stripe versions can't be suspended. */
1365
+ OLD_STRIPE = "OLD_STRIPE"
1366
+ }
1367
+ /** @enumType */
1368
+ type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
1369
+ interface PostponeEndDateRequest {
1370
+ /**
1371
+ * Order ID.
1372
+ * @format GUID
1373
+ */
1374
+ _id: string;
1375
+ /**
1376
+ * New end date and time.
1377
+ *
1378
+ * Must be later than the current end date and time.
1379
+ */
1380
+ endDate: Date | null;
1381
+ }
1382
+ interface PostponeEndDateResponse {
1383
+ }
1384
+ interface OrderEndDatePostponed {
1385
+ /** Order whose `endDate` was postponed. */
1386
+ order?: Order;
1387
+ }
1388
+ interface CancelOrderRequest {
1389
+ /**
1390
+ * Order ID.
1391
+ * @format GUID
1392
+ */
1393
+ _id: string;
1394
+ /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
1395
+ effectiveAt: CancellationEffectiveAtWithLiterals;
1396
+ }
1397
+ interface CancelOrderResponse {
1398
+ }
1399
+ interface MarkAsPaidRequest {
1400
+ /**
1401
+ * Order ID.
1402
+ * @format GUID
1403
+ */
1404
+ _id: string;
1405
+ }
1406
+ interface MarkAsPaidResponse {
1407
+ }
1408
+ interface OrderMarkedAsPaid {
1409
+ /** Order that was marked as paid. */
1410
+ order?: Order;
1411
+ }
1412
+ interface PauseOrderRequest {
1413
+ /**
1414
+ * Order ID.
1415
+ * @format GUID
1416
+ */
1417
+ _id: string;
1418
+ }
1419
+ interface PauseOrderResponse {
1420
+ }
1421
+ interface OrderPaused {
1422
+ /** Paused order. */
1423
+ order?: Order;
1424
+ }
1425
+ interface BulkPauseOrderRequest {
1426
+ /**
1427
+ * List of Order IDs.
1428
+ * @format GUID
1429
+ * @minSize 1
1430
+ * @maxSize 100
1431
+ */
1432
+ ids?: string[];
1433
+ /** Set to true to return Order entity in response. */
1434
+ returnFullEntity?: boolean;
1435
+ }
1436
+ interface BulkPauseOrderResponse {
1437
+ /** Orders that were paused. */
1438
+ results?: BulkOrderResult[];
1439
+ /** Bulk action metadata. */
1440
+ bulkActionMetadata?: BulkActionMetadata;
1441
+ }
1442
+ interface BulkOrderResult {
1443
+ /** Item metadata */
1444
+ itemMetadata?: ItemMetadata;
1445
+ /** The order. */
1446
+ order?: Order;
1447
+ }
1448
+ interface ItemMetadata {
1449
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1450
+ _id?: string | null;
1451
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
1452
+ originalIndex?: number;
1453
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1454
+ success?: boolean;
1455
+ /** Details about the error in case of failure. */
1456
+ error?: ApplicationError;
1457
+ }
1458
+ interface ApplicationError {
1459
+ /** Error code. */
1460
+ code?: string;
1461
+ /** Description of the error. */
1462
+ description?: string;
1463
+ /** Data related to the error. */
1464
+ data?: Record<string, any> | null;
1465
+ }
1466
+ interface BulkActionMetadata {
1467
+ /** Number of items that were successfully processed. */
1468
+ totalSuccesses?: number;
1469
+ /** Number of items that couldn't be processed. */
1470
+ totalFailures?: number;
1471
+ /** Number of failures without details because detailed failure threshold was exceeded. */
1472
+ undetailedFailures?: number;
1473
+ }
1474
+ interface ResumeOrderRequest {
1475
+ /**
1476
+ * Order ID.
1477
+ * @format GUID
1478
+ */
1479
+ _id: string;
1480
+ }
1481
+ interface ResumeOrderResponse {
1482
+ }
1483
+ interface OrderResumed {
1484
+ /** Resumed order. */
1485
+ order?: Order;
1486
+ }
1487
+ interface BulkResumeOrderRequest {
1488
+ /**
1489
+ * List of Order IDs.
1490
+ * @format GUID
1491
+ * @minSize 1
1492
+ * @maxSize 100
1493
+ */
1494
+ ids?: string[];
1495
+ /** Set to true to return Order entity in response. */
1496
+ returnFullEntity?: boolean;
1497
+ }
1498
+ interface BulkResumeOrderResponse {
1499
+ /** Orders that were resumed. */
1500
+ results?: BulkOrderResult[];
1501
+ /** Bulk action metadata. */
1502
+ bulkActionMetadata?: BulkActionMetadata;
1503
+ }
1504
+ /** @docsIgnore */
1505
+ type CreateOnlineOrderApplicationErrors = {
1506
+ code?: 'MEMBER_REQUIRED';
1507
+ description?: string;
1508
+ data?: Record<string, any>;
1509
+ } | {
1510
+ code?: 'archived_plan';
1511
+ description?: string;
1512
+ data?: Record<string, any>;
1513
+ } | {
1514
+ code?: 'member_not_found';
1515
+ description?: string;
1516
+ data?: Record<string, any>;
1517
+ } | {
1518
+ code?: 'purchases_limit_reached';
1519
+ description?: string;
1520
+ data?: Record<string, any>;
1521
+ } | {
1522
+ code?: 'buyer_can_not_pick_future_start_date';
1523
+ description?: string;
1524
+ data?: Record<string, any>;
1525
+ } | {
1526
+ code?: 'invalid_start_date';
1527
+ description?: string;
1528
+ data?: Record<string, any>;
1529
+ } | {
1530
+ code?: 'accept_payment_feature_missing';
1531
+ description?: string;
1532
+ data?: Record<string, any>;
1533
+ } | {
1534
+ code?: 'meta_site_id_missing';
1535
+ description?: string;
1536
+ data?: Record<string, any>;
1537
+ } | {
1538
+ code?: 'ERROR_COUPON_IS_DISABLED';
1539
+ description?: string;
1540
+ data?: CouponsError;
1541
+ } | {
1542
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1543
+ description?: string;
1544
+ data?: CouponsError;
1545
+ } | {
1546
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1547
+ description?: string;
1548
+ data?: CouponsError;
1549
+ } | {
1550
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1551
+ description?: string;
1552
+ data?: CouponsError;
1553
+ } | {
1554
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
1555
+ description?: string;
1556
+ data?: CouponsError;
1557
+ } | {
1558
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1559
+ description?: string;
1560
+ data?: CouponsError;
1561
+ } | {
1562
+ code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1563
+ description?: string;
1564
+ data?: CouponsError;
1565
+ } | {
1566
+ code?: 'ERROR_INVALID_SUBTOTAL';
1567
+ description?: string;
1568
+ data?: CouponsError;
1569
+ } | {
1570
+ code?: 'undefined_not_allowed';
1571
+ description?: string;
1572
+ data?: Record<string, any>;
1573
+ } | {
1574
+ code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1575
+ description?: string;
1576
+ data?: Record<string, any>;
1577
+ } | {
1578
+ code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1579
+ description?: string;
1580
+ data?: Record<string, any>;
1581
+ };
1582
+ /** @docsIgnore */
1583
+ type CreateOnlineOrderValidationErrors = {
1584
+ ruleName?: 'UNKNOWN_ORDER_METHOD';
1585
+ } | {
1586
+ ruleName?: 'RECURRING_POS_UNSUPPORTED';
1587
+ } | {
1588
+ ruleName?: 'invalid_sort_field';
1589
+ };
1590
+ /** @docsIgnore */
1591
+ type CreateOfflineOrderApplicationErrors = {
1592
+ code?: 'PRICING_PLANS_NOT_INSTALLED';
1593
+ description?: string;
1594
+ data?: Record<string, any>;
1595
+ } | {
1596
+ code?: 'meta_site_id_missing';
1597
+ description?: string;
1598
+ data?: Record<string, any>;
1599
+ } | {
1600
+ code?: 'ERROR_COUPON_IS_DISABLED';
1601
+ description?: string;
1602
+ data?: CouponsError;
1603
+ } | {
1604
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1605
+ description?: string;
1606
+ data?: CouponsError;
1607
+ } | {
1608
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1609
+ description?: string;
1610
+ data?: CouponsError;
1611
+ } | {
1612
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1613
+ description?: string;
1614
+ data?: CouponsError;
1615
+ } | {
1616
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
1617
+ description?: string;
1618
+ data?: CouponsError;
1619
+ } | {
1620
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1621
+ description?: string;
1622
+ data?: CouponsError;
1623
+ } | {
1624
+ code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1625
+ description?: string;
1626
+ data?: CouponsError;
1627
+ } | {
1628
+ code?: 'ERROR_INVALID_SUBTOTAL';
1629
+ description?: string;
1630
+ data?: CouponsError;
1631
+ } | {
1632
+ code?: 'undefined_not_allowed';
1633
+ description?: string;
1634
+ data?: Record<string, any>;
1635
+ } | {
1636
+ code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1637
+ description?: string;
1638
+ data?: Record<string, any>;
1639
+ } | {
1640
+ code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1641
+ description?: string;
1642
+ data?: Record<string, any>;
1643
+ };
1644
+ /** @docsIgnore */
1645
+ type CreateOfflineOrderValidationErrors = {
1646
+ ruleName?: 'MEMBER_DOESNT_EXIST';
1647
+ } | {
1648
+ ruleName?: 'invalid_sort_field';
1649
+ };
1650
+ /** @docsIgnore */
1651
+ type GetOnlineOrderPreviewApplicationErrors = {
1652
+ code?: 'PRICING_PLANS_NOT_INSTALLED';
1653
+ description?: string;
1654
+ data?: Record<string, any>;
1655
+ } | {
1656
+ code?: 'ERROR_COUPON_IS_DISABLED';
1657
+ description?: string;
1658
+ data?: CouponsError;
1659
+ } | {
1660
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1661
+ description?: string;
1662
+ data?: CouponsError;
1663
+ } | {
1664
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1665
+ description?: string;
1666
+ data?: CouponsError;
1667
+ } | {
1668
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1669
+ description?: string;
1670
+ data?: CouponsError;
1671
+ } | {
1672
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
1673
+ description?: string;
1674
+ data?: CouponsError;
1675
+ } | {
1676
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1677
+ description?: string;
1678
+ data?: CouponsError;
1679
+ } | {
1680
+ code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1681
+ description?: string;
1682
+ data?: CouponsError;
1683
1683
  } | {
1684
1684
  code?: 'ERROR_INVALID_SUBTOTAL';
1685
1685
  description?: string;
@@ -1841,31 +1841,6 @@ interface EventMetadata extends BaseEventMetadata {
1841
1841
  */
1842
1842
  entityEventSequence?: string | null;
1843
1843
  }
1844
- interface OrderAutoRenewCanceledEnvelope {
1845
- data: OrderAutoRenewCanceled;
1846
- metadata: EventMetadata;
1847
- }
1848
- /**
1849
- * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1850
- *
1851
- * This webhook is *not* triggered in the following scenarios:
1852
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1853
- * + 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.
1854
- * @permissionScope Manage Orders
1855
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1856
- * @permissionScope Read Orders
1857
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1858
- * @permissionScope Manage plans and orders of Pricing Plans
1859
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1860
- * @permissionScope Manage Events
1861
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1862
- * @permissionId PRICING_PLANS.READ_ORDERS
1863
- * @webhook
1864
- * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
1865
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1866
- * @slug auto_renew_canceled
1867
- */
1868
- declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1869
1844
  interface OrderCanceledEnvelope {
1870
1845
  data: OrderCanceled;
1871
1846
  metadata: EventMetadata;
@@ -1887,64 +1862,16 @@ interface OrderCanceledEnvelope {
1887
1862
  * @permissionId PRICING_PLANS.READ_ORDERS
1888
1863
  * @webhook
1889
1864
  * @eventType wix.pricing_plans.v2.order_canceled
1890
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1865
+ * @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
1891
1866
  * @slug canceled
1892
1867
  */
1893
1868
  declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1894
- interface OrderCycleStartedEnvelope {
1895
- data: OrderCycleStarted;
1896
- metadata: EventMetadata;
1897
- }
1898
- /**
1899
- * Triggered at the start of a new payment cycle for an existing order.
1900
- *
1901
- * Not triggered at the initial start of an offline order.
1902
- * @permissionScope Manage Orders
1903
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1904
- * @permissionScope Read Orders
1905
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1906
- * @permissionScope Manage plans and orders of Pricing Plans
1907
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1908
- * @permissionScope Manage Events
1909
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1910
- * @permissionId PRICING_PLANS.READ_ORDERS
1911
- * @webhook
1912
- * @eventType wix.pricing_plans.v2.order_cycle_started
1913
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1914
- * @slug cycle_started
1915
- */
1916
- declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1917
- interface OrderEndDatePostponedEnvelope {
1918
- data: OrderEndDatePostponed;
1919
- metadata: EventMetadata;
1920
- }
1921
- /**
1922
- * Triggered when an order's `endDate` is postponed.
1923
- * @permissionScope Manage Orders
1924
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1925
- * @permissionScope Read Orders
1926
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1927
- * @permissionScope Manage plans and orders of Pricing Plans
1928
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1929
- * @permissionScope Manage Events
1930
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1931
- * @permissionId PRICING_PLANS.READ_ORDERS
1932
- * @webhook
1933
- * @eventType wix.pricing_plans.v2.order_end_date_postponed
1934
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1935
- * @slug end_date_postponed
1936
- */
1937
- declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
1938
- interface OrderEndedEnvelope {
1939
- data: OrderEnded;
1869
+ interface OrderCreatedEnvelope {
1870
+ entity: Order;
1940
1871
  metadata: EventMetadata;
1941
1872
  }
1942
1873
  /**
1943
- * Triggered when an order ends.
1944
- *
1945
- * This webhook is triggered:
1946
- * + When an order expires at the end of the current payment cycle.
1947
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
1874
+ * Triggered when an order is created.
1948
1875
  * @permissionScope Manage Orders
1949
1876
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1950
1877
  * @permissionScope Read Orders
@@ -1955,17 +1882,17 @@ interface OrderEndedEnvelope {
1955
1882
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1956
1883
  * @permissionId PRICING_PLANS.READ_ORDERS
1957
1884
  * @webhook
1958
- * @eventType wix.pricing_plans.v2.order_ended
1959
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1960
- * @slug ended
1885
+ * @eventType wix.pricing_plans.v2.order_created
1886
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1887
+ * @slug created
1961
1888
  */
1962
- declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
1963
- interface OrderMarkedAsPaidEnvelope {
1964
- data: OrderMarkedAsPaid;
1889
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
1890
+ interface OrderStartDateChangedEnvelope {
1891
+ data: OrderStartDateChanged;
1965
1892
  metadata: EventMetadata;
1966
1893
  }
1967
1894
  /**
1968
- * Triggered when an offline order is marked as paid.
1895
+ * Triggered when an order's `startDate` is changed.
1969
1896
  * @permissionScope Manage Orders
1970
1897
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1971
1898
  * @permissionScope Read Orders
@@ -1976,17 +1903,25 @@ interface OrderMarkedAsPaidEnvelope {
1976
1903
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1977
1904
  * @permissionId PRICING_PLANS.READ_ORDERS
1978
1905
  * @webhook
1979
- * @eventType wix.pricing_plans.v2.order_marked_as_paid
1980
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1981
- * @slug marked_as_paid
1906
+ * @eventType wix.pricing_plans.v2.order_start_date_changed
1907
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1908
+ * @slug start_date_changed
1982
1909
  */
1983
- declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
1984
- interface OrderPausedEnvelope {
1985
- data: OrderPaused;
1910
+ declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
1911
+ interface OrderUpdatedEnvelope {
1912
+ entity: Order;
1986
1913
  metadata: EventMetadata;
1987
1914
  }
1988
1915
  /**
1989
- * Triggered when an order is paused.
1916
+ * Triggered for any of the following update events:
1917
+ *
1918
+ * + Order is paid for. Order Purchased is also triggered.
1919
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
1920
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
1921
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
1922
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
1923
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
1924
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
1990
1925
  * @permissionScope Manage Orders
1991
1926
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1992
1927
  * @permissionScope Read Orders
@@ -1997,21 +1932,21 @@ interface OrderPausedEnvelope {
1997
1932
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1998
1933
  * @permissionId PRICING_PLANS.READ_ORDERS
1999
1934
  * @webhook
2000
- * @eventType wix.pricing_plans.v2.order_paused
2001
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2002
- * @slug paused
1935
+ * @eventType wix.pricing_plans.v2.order_updated
1936
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1937
+ * @slug updated
2003
1938
  */
2004
- declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2005
- interface OrderPurchasedEnvelope {
2006
- data: OrderPurchased;
1939
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
1940
+ interface OrderAutoRenewCanceledEnvelope {
1941
+ data: OrderAutoRenewCanceled;
2007
1942
  metadata: EventMetadata;
2008
1943
  }
2009
1944
  /**
2010
- * Triggered for any of the following purchase events:
2011
- * + Order is paid in full.
2012
- * + At least 1 order cycle payment is paid for.
2013
- * + Offline order is created, even if not yet marked as paid.
2014
- * + Free order is created.
1945
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1946
+ *
1947
+ * This webhook is *not* triggered in the following scenarios:
1948
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1949
+ * + 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.
2015
1950
  * @permissionScope Manage Orders
2016
1951
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2017
1952
  * @permissionScope Read Orders
@@ -2022,17 +1957,19 @@ interface OrderPurchasedEnvelope {
2022
1957
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2023
1958
  * @permissionId PRICING_PLANS.READ_ORDERS
2024
1959
  * @webhook
2025
- * @eventType wix.pricing_plans.v2.order_purchased
1960
+ * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
2026
1961
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2027
- * @slug purchased
1962
+ * @slug auto_renew_canceled
2028
1963
  */
2029
- declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2030
- interface OrderResumedEnvelope {
2031
- data: OrderResumed;
1964
+ declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1965
+ interface OrderCycleStartedEnvelope {
1966
+ data: OrderCycleStarted;
2032
1967
  metadata: EventMetadata;
2033
1968
  }
2034
1969
  /**
2035
- * Triggered when a paused order is resumed.
1970
+ * Triggered at the start of a new payment cycle for an existing order.
1971
+ *
1972
+ * Not triggered at the initial start of an offline order.
2036
1973
  * @permissionScope Manage Orders
2037
1974
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2038
1975
  * @permissionScope Read Orders
@@ -2043,17 +1980,17 @@ interface OrderResumedEnvelope {
2043
1980
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2044
1981
  * @permissionId PRICING_PLANS.READ_ORDERS
2045
1982
  * @webhook
2046
- * @eventType wix.pricing_plans.v2.order_resumed
1983
+ * @eventType wix.pricing_plans.v2.order_cycle_started
2047
1984
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2048
- * @slug resumed
1985
+ * @slug cycle_started
2049
1986
  */
2050
- declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2051
- interface OrderStartedEnvelope {
2052
- data: OrderStarted;
1987
+ declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1988
+ interface OrderEndDatePostponedEnvelope {
1989
+ data: OrderEndDatePostponed;
2053
1990
  metadata: EventMetadata;
2054
1991
  }
2055
1992
  /**
2056
- * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
1993
+ * Triggered when an order's `endDate` is postponed.
2057
1994
  * @permissionScope Manage Orders
2058
1995
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2059
1996
  * @permissionScope Read Orders
@@ -2064,25 +2001,21 @@ interface OrderStartedEnvelope {
2064
2001
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2065
2002
  * @permissionId PRICING_PLANS.READ_ORDERS
2066
2003
  * @webhook
2067
- * @eventType wix.pricing_plans.v2.order_started
2004
+ * @eventType wix.pricing_plans.v2.order_end_date_postponed
2068
2005
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2069
- * @slug started
2006
+ * @slug end_date_postponed
2070
2007
  */
2071
- declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2072
- interface OrderUpdatedEnvelope {
2073
- entity: Order;
2008
+ declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
2009
+ interface OrderEndedEnvelope {
2010
+ data: OrderEnded;
2074
2011
  metadata: EventMetadata;
2075
2012
  }
2076
2013
  /**
2077
- * Triggered for any of the following update events:
2014
+ * Triggered when an order ends.
2078
2015
  *
2079
- * + Order is paid for. Order Purchased is also triggered.
2080
- * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
2081
- * + New payment cycle of an order starts. Order Cycle Started is also triggered.
2082
- * + Offline order is marked as paid. Order Marked As Paid is also triggered.
2083
- * + End date of the order is postponed. Order End Date Postponed is also triggered
2084
- * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
2085
- * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
2016
+ * This webhook is triggered:
2017
+ * + When an order expires at the end of the current payment cycle.
2018
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
2086
2019
  * @permissionScope Manage Orders
2087
2020
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2088
2021
  * @permissionScope Read Orders
@@ -2093,17 +2026,17 @@ interface OrderUpdatedEnvelope {
2093
2026
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2094
2027
  * @permissionId PRICING_PLANS.READ_ORDERS
2095
2028
  * @webhook
2096
- * @eventType wix.pricing_plans.v2.order_updated
2029
+ * @eventType wix.pricing_plans.v2.order_ended
2097
2030
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2098
- * @slug updated
2031
+ * @slug ended
2099
2032
  */
2100
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2101
- interface OrderCreatedEnvelope {
2102
- entity: Order;
2033
+ declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
2034
+ interface OrderMarkedAsPaidEnvelope {
2035
+ data: OrderMarkedAsPaid;
2103
2036
  metadata: EventMetadata;
2104
2037
  }
2105
2038
  /**
2106
- * Triggered when an order is created.
2039
+ * Triggered when an offline order is marked as paid.
2107
2040
  * @permissionScope Manage Orders
2108
2041
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2109
2042
  * @permissionScope Read Orders
@@ -2114,17 +2047,17 @@ interface OrderCreatedEnvelope {
2114
2047
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2115
2048
  * @permissionId PRICING_PLANS.READ_ORDERS
2116
2049
  * @webhook
2117
- * @eventType wix.pricing_plans.v2.order_created
2118
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2119
- * @slug created
2050
+ * @eventType wix.pricing_plans.v2.order_marked_as_paid
2051
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2052
+ * @slug marked_as_paid
2120
2053
  */
2121
- declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
2122
- interface OrderStartDateChangedEnvelope {
2123
- data: OrderStartDateChanged;
2054
+ declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
2055
+ interface OrderPausedEnvelope {
2056
+ data: OrderPaused;
2124
2057
  metadata: EventMetadata;
2125
2058
  }
2126
2059
  /**
2127
- * Triggered when an order's `startDate` is changed.
2060
+ * Triggered when an order is paused.
2128
2061
  * @permissionScope Manage Orders
2129
2062
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2130
2063
  * @permissionScope Read Orders
@@ -2135,185 +2068,78 @@ interface OrderStartDateChangedEnvelope {
2135
2068
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2136
2069
  * @permissionId PRICING_PLANS.READ_ORDERS
2137
2070
  * @webhook
2138
- * @eventType wix.pricing_plans.v2.order_start_date_changed
2139
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2140
- * @slug start_date_changed
2141
- */
2142
- declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
2143
- /**
2144
- * Retrieves an order by ID.
2145
- * @param _id - Order ID.
2146
- * @public
2147
- * @requiredField _id
2148
- * @param options - Options to use when getting an order.
2149
- * @permissionId PRICING_PLANS.READ_ORDERS
2150
- * @applicableIdentity APP
2151
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2152
- */
2153
- 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>>;
2154
- interface ManagementGetOrderOptions {
2155
- /**
2156
- * Predefined set of fields to return.
2157
- *
2158
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2159
- */
2160
- fieldSet?: SetWithLiterals;
2161
- }
2162
- /**
2163
- * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2164
- *
2165
- * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2166
- * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2167
- * @public
2168
- * @param options - Filtering, sorting, and pagination options.
2169
- * @permissionId PRICING_PLANS.READ_ORDERS
2170
- * @applicableIdentity APP
2171
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2071
+ * @eventType wix.pricing_plans.v2.order_paused
2072
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2073
+ * @slug paused
2172
2074
  */
2173
- 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>>;
2174
- interface ManagementListOrdersOptions {
2175
- /**
2176
- * Filter by a buyer's member ID, from the Members API.
2177
- * @format GUID
2178
- */
2179
- buyerIds?: string[];
2180
- /**
2181
- * Filter by plan IDs, from the Plans API.
2182
- * @format GUID
2183
- */
2184
- planIds?: string[];
2185
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2186
- autoRenewCanceled?: boolean | null;
2187
- /** Filter by order status. */
2188
- orderStatuses?: OrderStatusWithLiterals[];
2189
- /** Filter by payment status. */
2190
- paymentStatuses?: PaymentStatusWithLiterals[];
2191
- /**
2192
- * Number of orders to return. See Sorting and Paging for more information.
2193
- *
2194
- * Max: `50`
2195
- * @min 1
2196
- * @max 50
2197
- */
2198
- limit?: number | null;
2199
- /** Number of orders to skip in the current sort order. */
2200
- offset?: number | null;
2201
- /**
2202
- * Sort order.
2203
- *
2204
- * Use `ASC` for ascending order or `DESC` for descending order.
2205
- *
2206
- * Default: `DESC`.
2207
- */
2208
- sorting?: Sorting;
2209
- /**
2210
- * Predefined set of fields to return.
2211
- *
2212
- * Default: If `fieldSet` is omitted, no order form submission data is returned.
2213
- */
2214
- fieldSet?: SetWithLiterals;
2075
+ declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2076
+ interface OrderPurchasedEnvelope {
2077
+ data: OrderPurchased;
2078
+ metadata: EventMetadata;
2215
2079
  }
2216
2080
  /**
2217
- * 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.
2218
- *
2219
- * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2220
- * Can't postpone an order with `status`: `PAUSED`.
2221
- * @param _id - Order ID.
2222
- * @param endDate - New end date and time.
2223
- *
2224
- * Must be later than the current end date and time.
2225
- * @public
2226
- * @requiredField _id
2227
- * @requiredField endDate
2228
- * @param options - Options for postponing the end date of an order.
2229
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2230
- * @applicableIdentity APP
2231
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2232
- */
2233
- declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2234
- /**
2235
- * Cancels an existing order.
2236
- *
2237
- * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2238
- * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2239
- *
2240
- * #### Canceling during the free trial period.
2241
- *
2242
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2243
- * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2244
- * of the free trial period.
2245
- *
2246
- * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2247
- * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2248
- * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2249
- * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2250
- * Then, the subscription ends and the buyer is not billed.
2251
- * @param _id - Order ID.
2252
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2253
- * @public
2254
- * @requiredField _id
2255
- * @requiredField effectiveAt
2256
- * @param options - Options for canceling orders.
2257
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2258
- * @applicableIdentity APP
2259
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2260
- */
2261
- declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2262
- /**
2263
- * Marks an offline order as paid.
2264
- * > __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.
2265
- *
2266
- * Marking an offline order as paid causes the following changes:
2267
- * - The order's `lastPaymentStatus` changes to `"PAID"`.
2268
- * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2269
- *
2270
- * An error occurs if you attempt to:
2271
- * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2272
- * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2273
- * @param _id - Order ID.
2274
- * @public
2275
- * @requiredField _id
2276
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2277
- * @applicableIdentity APP
2278
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2081
+ * Triggered for any of the following purchase events:
2082
+ * + Order is paid in full.
2083
+ * + At least 1 order cycle payment is paid for.
2084
+ * + Offline order is created, even if not yet marked as paid.
2085
+ * + Free order is created.
2086
+ * @permissionScope Manage Orders
2087
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2088
+ * @permissionScope Read Orders
2089
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2090
+ * @permissionScope Manage plans and orders of Pricing Plans
2091
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2092
+ * @permissionScope Manage Events
2093
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2094
+ * @permissionId PRICING_PLANS.READ_ORDERS
2095
+ * @webhook
2096
+ * @eventType wix.pricing_plans.v2.order_purchased
2097
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2098
+ * @slug purchased
2279
2099
  */
2280
- declare function markAsPaid(_id: string): Promise<void>;
2100
+ declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2101
+ interface OrderResumedEnvelope {
2102
+ data: OrderResumed;
2103
+ metadata: EventMetadata;
2104
+ }
2281
2105
  /**
2282
- * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2283
- *
2284
- * Only orders with `status`: `ACTIVE` can be paused.
2285
- * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2286
- * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2287
- * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2288
- *
2289
- * To resume a paused order, call Resume Order.
2290
- * @param _id - Order ID.
2291
- * @public
2292
- * @requiredField _id
2293
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2294
- * @applicableIdentity APP
2295
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2106
+ * Triggered when a paused order is resumed.
2107
+ * @permissionScope Manage Orders
2108
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2109
+ * @permissionScope Read Orders
2110
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2111
+ * @permissionScope Manage plans and orders of Pricing Plans
2112
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2113
+ * @permissionScope Manage Events
2114
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2115
+ * @permissionId PRICING_PLANS.READ_ORDERS
2116
+ * @webhook
2117
+ * @eventType wix.pricing_plans.v2.order_resumed
2118
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2119
+ * @slug resumed
2296
2120
  */
2297
- declare function pauseOrder(_id: string): Promise<void>;
2121
+ declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2122
+ interface OrderStartedEnvelope {
2123
+ data: OrderStarted;
2124
+ metadata: EventMetadata;
2125
+ }
2298
2126
  /**
2299
- * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2300
- *
2301
- * Resuming an order causes the following changes:
2302
- * - The order status changes to `"ACTIVE"`.
2303
- * - The `pausePeriods` array is updated.
2304
- * - The `endDate` for the order is adjusted to include the pause period.
2305
- * - For orders with recurring payments, the payment schedule is restarted.
2306
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2307
- *
2308
- * To pause an order, call Pause Order.
2309
- * @param _id - Order ID.
2310
- * @public
2311
- * @requiredField _id
2312
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
2313
- * @applicableIdentity APP
2314
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2127
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2128
+ * @permissionScope Manage Orders
2129
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2130
+ * @permissionScope Read Orders
2131
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2132
+ * @permissionScope Manage plans and orders of Pricing Plans
2133
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2134
+ * @permissionScope Manage Events
2135
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2136
+ * @permissionId PRICING_PLANS.READ_ORDERS
2137
+ * @webhook
2138
+ * @eventType wix.pricing_plans.v2.order_started
2139
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2140
+ * @slug started
2315
2141
  */
2316
- declare function resumeOrder(_id: string): Promise<void>;
2142
+ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2317
2143
  /**
2318
2144
  * Retrieves an order for the currently logged-in member by ID.
2319
2145
  * @param _id - Order ID.
@@ -2323,10 +2149,9 @@ declare function resumeOrder(_id: string): Promise<void>;
2323
2149
  * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2324
2150
  * @applicableIdentity APP
2325
2151
  * @applicableIdentity MEMBER
2326
- * @returns Requested order.
2327
2152
  * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
2328
2153
  */
2329
- 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>>;
2154
+ 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>>;
2330
2155
  interface MemberGetOrderOptions {
2331
2156
  /**
2332
2157
  * Predefined set of fields to return.
@@ -2589,5 +2414,180 @@ interface GetPricePreviewOptions {
2589
2414
  */
2590
2415
  couponCode?: string | null;
2591
2416
  }
2417
+ /**
2418
+ * Retrieves an order by ID.
2419
+ * @param _id - Order ID.
2420
+ * @public
2421
+ * @requiredField _id
2422
+ * @param options - Options to use when getting an order.
2423
+ * @permissionId PRICING_PLANS.READ_ORDERS
2424
+ * @applicableIdentity APP
2425
+ * @returns Order.
2426
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2427
+ */
2428
+ 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>>;
2429
+ interface ManagementGetOrderOptions {
2430
+ /**
2431
+ * Predefined set of fields to return.
2432
+ *
2433
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2434
+ */
2435
+ fieldSet?: SetWithLiterals;
2436
+ }
2437
+ /**
2438
+ * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2439
+ *
2440
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2441
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2442
+ * @public
2443
+ * @param options - Filtering, sorting, and pagination options.
2444
+ * @permissionId PRICING_PLANS.READ_ORDERS
2445
+ * @applicableIdentity APP
2446
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2447
+ */
2448
+ 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>>;
2449
+ interface ManagementListOrdersOptions {
2450
+ /**
2451
+ * Filter by a buyer's member ID, from the Members API.
2452
+ * @format GUID
2453
+ */
2454
+ buyerIds?: string[];
2455
+ /**
2456
+ * Filter by plan IDs, from the Plans API.
2457
+ * @format GUID
2458
+ */
2459
+ planIds?: string[];
2460
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2461
+ autoRenewCanceled?: boolean | null;
2462
+ /** Filter by order status. */
2463
+ orderStatuses?: OrderStatusWithLiterals[];
2464
+ /** Filter by payment status. */
2465
+ paymentStatuses?: PaymentStatusWithLiterals[];
2466
+ /**
2467
+ * Number of orders to return. See Sorting and Paging for more information.
2468
+ *
2469
+ * Max: `50`
2470
+ * @min 1
2471
+ * @max 50
2472
+ */
2473
+ limit?: number | null;
2474
+ /** Number of orders to skip in the current sort order. */
2475
+ offset?: number | null;
2476
+ /**
2477
+ * Sort order.
2478
+ *
2479
+ * Use `ASC` for ascending order or `DESC` for descending order.
2480
+ *
2481
+ * Default: `DESC`.
2482
+ */
2483
+ sorting?: Sorting;
2484
+ /**
2485
+ * Predefined set of fields to return.
2486
+ *
2487
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2488
+ */
2489
+ fieldSet?: SetWithLiterals;
2490
+ }
2491
+ /**
2492
+ * 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.
2493
+ *
2494
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2495
+ * Can't postpone an order with `status`: `PAUSED`.
2496
+ * @param _id - Order ID.
2497
+ * @param endDate - New end date and time.
2498
+ *
2499
+ * Must be later than the current end date and time.
2500
+ * @public
2501
+ * @requiredField _id
2502
+ * @requiredField endDate
2503
+ * @param options - Options for postponing the end date of an order.
2504
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2505
+ * @applicableIdentity APP
2506
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2507
+ */
2508
+ declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2509
+ /**
2510
+ * Cancels an existing order.
2511
+ *
2512
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2513
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2514
+ *
2515
+ * #### Canceling during the free trial period.
2516
+ *
2517
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2518
+ * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2519
+ * of the free trial period.
2520
+ *
2521
+ * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2522
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2523
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2524
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2525
+ * Then, the subscription ends and the buyer is not billed.
2526
+ * @param _id - Order ID.
2527
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2528
+ * @public
2529
+ * @requiredField _id
2530
+ * @requiredField effectiveAt
2531
+ * @param options - Options for canceling orders.
2532
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2533
+ * @applicableIdentity APP
2534
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2535
+ */
2536
+ declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2537
+ /**
2538
+ * Marks an offline order as paid.
2539
+ * > __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.
2540
+ *
2541
+ * Marking an offline order as paid causes the following changes:
2542
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2543
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2544
+ *
2545
+ * An error occurs if you attempt to:
2546
+ * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2547
+ * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
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.MarkAsPaid
2554
+ */
2555
+ declare function markAsPaid(_id: string): Promise<void>;
2556
+ /**
2557
+ * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2558
+ *
2559
+ * Only orders with `status`: `ACTIVE` can be paused.
2560
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2561
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2562
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2563
+ *
2564
+ * To resume a paused order, call Resume Order.
2565
+ * @param _id - Order ID.
2566
+ * @public
2567
+ * @requiredField _id
2568
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2569
+ * @applicableIdentity APP
2570
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2571
+ */
2572
+ declare function pauseOrder(_id: string): Promise<void>;
2573
+ /**
2574
+ * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2575
+ *
2576
+ * Resuming an order causes the following changes:
2577
+ * - The order status changes to `"ACTIVE"`.
2578
+ * - The `pausePeriods` array is updated.
2579
+ * - The `endDate` for the order is adjusted to include the pause period.
2580
+ * - For orders with recurring payments, the payment schedule is restarted.
2581
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2582
+ *
2583
+ * To pause an order, call Pause Order.
2584
+ * @param _id - Order ID.
2585
+ * @public
2586
+ * @requiredField _id
2587
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2588
+ * @applicableIdentity APP
2589
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2590
+ */
2591
+ declare function resumeOrder(_id: string): Promise<void>;
2592
2592
 
2593
2593
  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 };