@wix/auto_sdk_pricing-plans_orders 1.0.95 → 1.0.97

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 +803 -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 +461 -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 +803 -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 +461 -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 +803 -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 +461 -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 +803 -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 +461 -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,35 +626,7 @@ interface ActionEvent {
626
626
  }
627
627
  interface Empty {
628
628
  }
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 {
629
+ interface MemberGetOrderRequest {
658
630
  /**
659
631
  * Order ID.
660
632
  * @format GUID
@@ -677,44 +649,31 @@ declare enum Set {
677
649
  }
678
650
  /** @enumType */
679
651
  type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
680
- interface GetOrderResponse {
681
- /** Order. */
652
+ interface MemberGetOrderResponse {
653
+ /** Requested order. */
682
654
  order?: Order;
683
655
  }
684
- interface ListOrdersRequest {
685
- /**
686
- * Filter by a buyer's member ID, from the Members API.
687
- * @format GUID
688
- */
689
- buyerIds?: string[];
656
+ interface MemberListOrdersRequest {
690
657
  /**
691
- * Filter by plan IDs, from the Plans API.
658
+ * Filter by plan IDs.
692
659
  * @format GUID
693
660
  */
694
661
  planIds?: string[];
695
- /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
662
+ /** Filter for orders where auto renewal was canceled. */
696
663
  autoRenewCanceled?: boolean | null;
697
664
  /** Filter by order status. */
698
665
  orderStatuses?: OrderStatusWithLiterals[];
699
666
  /** Filter by payment status. */
700
667
  paymentStatuses?: PaymentStatusWithLiterals[];
701
668
  /**
702
- * Number of orders to return. See Sorting and Paging for more information.
703
- *
704
- * Max: `50`
669
+ * Limit the number of pricing plans returned. Default limit is 50.
705
670
  * @min 1
706
671
  * @max 50
707
672
  */
708
673
  limit?: number | null;
709
- /** Number of orders to skip in the current sort order. */
674
+ /** Number of entries to offset. */
710
675
  offset?: number | null;
711
- /**
712
- * Sort order.
713
- *
714
- * Use `ASC` for ascending order or `DESC` for descending order.
715
- *
716
- * Default: `DESC`.
717
- */
676
+ /** Sorting direction (defaults to ASC) and field to sort by. */
718
677
  sorting?: Sorting;
719
678
  /**
720
679
  * Predefined set of fields to return.
@@ -738,8 +697,8 @@ declare enum SortOrder {
738
697
  }
739
698
  /** @enumType */
740
699
  type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
741
- interface ListOrdersResponse {
742
- /** List of orders. */
700
+ interface MemberListOrdersResponse {
701
+ /** Requested orders. */
743
702
  orders?: Order[];
744
703
  /** Object containing paging-related data (number of orders returned, offset). */
745
704
  pagingMetadata?: PagingMetadataV2;
@@ -768,7 +727,11 @@ interface Cursors {
768
727
  */
769
728
  prev?: string | null;
770
729
  }
771
- interface OrdersQueryOrdersRequest {
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 {
772
735
  /** Query filter. */
773
736
  query?: QueryV2;
774
737
  }
@@ -822,84 +785,22 @@ interface CursorPaging {
822
785
  */
823
786
  cursor?: string | null;
824
787
  }
825
- interface OrdersQueryOrdersResponse {
826
- /** Retrieved orders. */
788
+ interface QueryOrdersResponse {
789
+ /** Order data. */
827
790
  plans?: Order[];
828
791
  /** Paging-related data (number of orders returned, offset). */
829
792
  pagingMetadata?: PagingMetadataV2;
830
793
  }
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 {
875
- /**
876
- * Order ID.
877
- * @format GUID
878
- */
879
- _id: string;
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 {
794
+ interface RequestCancellationRequest {
894
795
  /**
895
796
  * Order ID.
896
797
  * @format GUID
897
798
  */
898
799
  _id: string;
899
- /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
800
+ /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
900
801
  effectiveAt: CancellationEffectiveAtWithLiterals;
901
802
  }
902
- interface CancelOrderResponse {
803
+ interface RequestCancellationResponse {
903
804
  }
904
805
  /**
905
806
  * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
@@ -910,111 +811,6 @@ interface OrderCanceled {
910
811
  /** Canceled order. */
911
812
  order?: Order;
912
813
  }
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
- }
1018
814
  interface MessageEnvelope {
1019
815
  /**
1020
816
  * App instance ID.
@@ -1030,6 +826,8 @@ interface MessageEnvelope {
1030
826
  identity?: IdentificationData;
1031
827
  /** Stringify payload. */
1032
828
  data?: string;
829
+ /** Details related to the account */
830
+ accountInfo?: AccountInfo;
1033
831
  }
1034
832
  interface IdentificationData extends IdentificationDataIdOneOf {
1035
833
  /**
@@ -1104,93 +902,16 @@ interface AccountInfo {
1104
902
  */
1105
903
  siteId?: string | null;
1106
904
  }
1107
- interface MemberGetOrderRequest {
905
+ interface CreateOnlineOrderRequest {
1108
906
  /**
1109
- * Order ID.
907
+ * Plan ID.
1110
908
  * @format GUID
1111
909
  */
1112
- _id: string;
910
+ planId: string;
1113
911
  /**
1114
- * Predefined set of fields to return.
912
+ * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
1115
913
  *
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.
914
+ * Default: Current date and time.
1194
915
  */
1195
916
  startDate?: Date | null;
1196
917
  /**
@@ -1484,185 +1205,466 @@ interface SetSubmissionResponse {
1484
1205
  /** Order with submission id */
1485
1206
  order?: Order;
1486
1207
  }
1487
- /** @docsIgnore */
1488
- type CreateOnlineOrderApplicationErrors = {
1489
- code?: 'MEMBER_REQUIRED';
1490
- description?: string;
1491
- data?: Record<string, any>;
1492
- } | {
1493
- code?: 'archived_plan';
1494
- description?: string;
1495
- data?: Record<string, any>;
1496
- } | {
1497
- code?: 'member_not_found';
1498
- description?: string;
1499
- data?: Record<string, any>;
1500
- } | {
1501
- code?: 'purchases_limit_reached';
1502
- description?: string;
1503
- data?: Record<string, any>;
1504
- } | {
1505
- code?: 'buyer_can_not_pick_future_start_date';
1506
- description?: string;
1507
- data?: Record<string, any>;
1508
- } | {
1509
- code?: 'invalid_start_date';
1510
- description?: string;
1511
- data?: Record<string, any>;
1512
- } | {
1513
- code?: 'accept_payment_feature_missing';
1514
- description?: string;
1515
- data?: Record<string, any>;
1516
- } | {
1517
- code?: 'meta_site_id_missing';
1518
- description?: string;
1519
- data?: Record<string, any>;
1520
- } | {
1521
- code?: 'ERROR_COUPON_IS_DISABLED';
1522
- description?: string;
1523
- data?: CouponsError;
1524
- } | {
1525
- code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1526
- description?: string;
1527
- data?: CouponsError;
1528
- } | {
1529
- code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1530
- description?: string;
1531
- data?: CouponsError;
1532
- } | {
1533
- code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1534
- description?: string;
1535
- data?: CouponsError;
1536
- } | {
1537
- code?: 'ERROR_COUPON_HAS_EXPIRED';
1538
- description?: string;
1539
- data?: CouponsError;
1540
- } | {
1541
- code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1542
- description?: string;
1543
- data?: CouponsError;
1544
- } | {
1545
- code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1546
- description?: string;
1547
- data?: CouponsError;
1548
- } | {
1549
- code?: 'ERROR_INVALID_SUBTOTAL';
1550
- description?: string;
1551
- data?: CouponsError;
1552
- } | {
1553
- code?: 'undefined_not_allowed';
1554
- description?: string;
1555
- data?: Record<string, any>;
1556
- } | {
1557
- code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1558
- description?: string;
1559
- data?: Record<string, any>;
1560
- } | {
1561
- code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1562
- description?: string;
1563
- data?: Record<string, any>;
1564
- };
1565
- /** @docsIgnore */
1566
- type CreateOnlineOrderValidationErrors = {
1567
- ruleName?: 'UNKNOWN_ORDER_METHOD';
1568
- } | {
1569
- ruleName?: 'RECURRING_POS_UNSUPPORTED';
1570
- } | {
1571
- ruleName?: 'invalid_sort_field';
1572
- };
1573
- /** @docsIgnore */
1574
- type CreateOfflineOrderApplicationErrors = {
1575
- code?: 'PRICING_PLANS_NOT_INSTALLED';
1576
- description?: string;
1577
- data?: Record<string, any>;
1578
- } | {
1579
- code?: 'meta_site_id_missing';
1580
- description?: string;
1581
- data?: Record<string, any>;
1582
- } | {
1583
- code?: 'ERROR_COUPON_IS_DISABLED';
1584
- description?: string;
1585
- data?: CouponsError;
1586
- } | {
1587
- code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1588
- description?: string;
1589
- data?: CouponsError;
1590
- } | {
1591
- code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1592
- description?: string;
1593
- data?: CouponsError;
1594
- } | {
1595
- code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1596
- description?: string;
1597
- data?: CouponsError;
1598
- } | {
1599
- code?: 'ERROR_COUPON_HAS_EXPIRED';
1600
- description?: string;
1601
- data?: CouponsError;
1602
- } | {
1603
- code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1604
- description?: string;
1605
- data?: CouponsError;
1606
- } | {
1607
- code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1608
- description?: string;
1609
- data?: CouponsError;
1610
- } | {
1611
- code?: 'ERROR_INVALID_SUBTOTAL';
1612
- description?: string;
1613
- data?: CouponsError;
1614
- } | {
1615
- code?: 'undefined_not_allowed';
1616
- description?: string;
1617
- data?: Record<string, any>;
1618
- } | {
1619
- code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1620
- description?: string;
1621
- data?: Record<string, any>;
1622
- } | {
1623
- code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1624
- description?: string;
1625
- data?: Record<string, any>;
1626
- };
1627
- /** @docsIgnore */
1628
- type CreateOfflineOrderValidationErrors = {
1629
- ruleName?: 'MEMBER_DOESNT_EXIST';
1630
- } | {
1631
- ruleName?: 'invalid_sort_field';
1632
- };
1633
- /** @docsIgnore */
1634
- type GetOnlineOrderPreviewApplicationErrors = {
1635
- code?: 'PRICING_PLANS_NOT_INSTALLED';
1636
- description?: string;
1637
- data?: Record<string, any>;
1638
- } | {
1639
- code?: 'ERROR_COUPON_IS_DISABLED';
1640
- description?: string;
1641
- data?: CouponsError;
1642
- } | {
1643
- code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1644
- description?: string;
1645
- data?: CouponsError;
1646
- } | {
1647
- code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1648
- description?: string;
1649
- data?: CouponsError;
1650
- } | {
1651
- code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1652
- description?: string;
1653
- data?: CouponsError;
1654
- } | {
1655
- code?: 'ERROR_COUPON_HAS_EXPIRED';
1656
- description?: string;
1657
- data?: CouponsError;
1658
- } | {
1659
- code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1660
- description?: string;
1661
- data?: CouponsError;
1662
- } | {
1663
- code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1664
- description?: string;
1665
- data?: CouponsError;
1208
+ interface OrderPurchased {
1209
+ /** Order that was paid for. If a free or an offline order, the order that was created. */
1210
+ order?: Order;
1211
+ }
1212
+ interface OrderStarted {
1213
+ /** Order that reached its `startDate`. */
1214
+ order?: Order;
1215
+ }
1216
+ /**
1217
+ * Triggered at the start of a new payment cycle for an existing order.
1218
+ *
1219
+ * This webhook does not trigger at the initial start of an offline order.
1220
+ */
1221
+ interface OrderCycleStarted {
1222
+ /** Order whose new cycle started. */
1223
+ order?: Order;
1224
+ /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
1225
+ cycleNumber?: number;
1226
+ }
1227
+ /** Emitted when a recurring order is canceled for the next payment cycle */
1228
+ interface OrderAutoRenewCanceled {
1229
+ /** Order that is canceled, effective at the end of the current payment cycle. */
1230
+ order?: Order;
1231
+ }
1232
+ interface OrderEnded {
1233
+ /** Order that ended. */
1234
+ order?: Order;
1235
+ }
1236
+ interface GetOrderRequest {
1237
+ /**
1238
+ * Order ID.
1239
+ * @format GUID
1240
+ */
1241
+ _id: string;
1242
+ /**
1243
+ * Predefined set of fields to return.
1244
+ *
1245
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1246
+ */
1247
+ fieldSet?: SetWithLiterals;
1248
+ }
1249
+ interface GetOrderResponse {
1250
+ /** Order. */
1251
+ order?: Order;
1252
+ }
1253
+ interface ListOrdersRequest {
1254
+ /**
1255
+ * Filter by a buyer's member ID, from the Members API.
1256
+ * @format GUID
1257
+ */
1258
+ buyerIds?: string[];
1259
+ /**
1260
+ * Filter by plan IDs, from the Plans API.
1261
+ * @format GUID
1262
+ */
1263
+ planIds?: string[];
1264
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
1265
+ autoRenewCanceled?: boolean | null;
1266
+ /** Filter by order status. */
1267
+ orderStatuses?: OrderStatusWithLiterals[];
1268
+ /** Filter by payment status. */
1269
+ paymentStatuses?: PaymentStatusWithLiterals[];
1270
+ /**
1271
+ * Number of orders to return. See Sorting and Paging for more information.
1272
+ *
1273
+ * Max: `50`
1274
+ * @min 1
1275
+ * @max 50
1276
+ */
1277
+ limit?: number | null;
1278
+ /** Number of orders to skip in the current sort order. */
1279
+ offset?: number | null;
1280
+ /**
1281
+ * Sort order.
1282
+ *
1283
+ * Use `ASC` for ascending order or `DESC` for descending order.
1284
+ *
1285
+ * Default: `DESC`.
1286
+ */
1287
+ sorting?: Sorting;
1288
+ /**
1289
+ * Predefined set of fields to return.
1290
+ *
1291
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
1292
+ */
1293
+ fieldSet?: SetWithLiterals;
1294
+ }
1295
+ interface ListOrdersResponse {
1296
+ /** List of orders. */
1297
+ orders?: Order[];
1298
+ /** Object containing paging-related data (number of orders returned, offset). */
1299
+ pagingMetadata?: PagingMetadataV2;
1300
+ }
1301
+ interface OrdersQueryOrdersRequest {
1302
+ /** Query filter. */
1303
+ query?: QueryV2;
1304
+ }
1305
+ interface OrdersQueryOrdersResponse {
1306
+ /** Retrieved orders. */
1307
+ plans?: Order[];
1308
+ /** Paging-related data (number of orders returned, offset). */
1309
+ pagingMetadata?: PagingMetadataV2;
1310
+ }
1311
+ interface GetOrdersStatsRequest {
1312
+ }
1313
+ interface GetOrdersStatsResponse {
1314
+ /** Total number of orders. */
1315
+ totalOrderCount?: number;
1316
+ /** Number of active orders. */
1317
+ activeOrderCount?: number;
1318
+ }
1319
+ interface GetAvailableOrderActionsRequest {
1320
+ /**
1321
+ * Order ID.
1322
+ * @format GUID
1323
+ */
1324
+ _id?: string;
1325
+ }
1326
+ interface GetAvailableOrderActionsResponse {
1327
+ /** Whether the order can be suspended. */
1328
+ suspendable?: boolean;
1329
+ /** If the order cannot be suspended, a reason is returned here. */
1330
+ notSuspendableReason?: ReasonNotSuspendableWithLiterals;
1331
+ /** Whether the order can be canceled by the buyer. */
1332
+ cancelableByBuyer?: boolean;
1333
+ }
1334
+ declare enum ReasonNotSuspendable {
1335
+ /** Undefined reason. */
1336
+ UNDEFINED = "UNDEFINED",
1337
+ /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
1338
+ PENDING = "PENDING",
1339
+ /** Trial orders can't be suspended. */
1340
+ TRIAL = "TRIAL",
1341
+ /** Canceled orders can't be suspended. */
1342
+ CANCELED = "CANCELED",
1343
+ /** Ended orders can't be suspended. */
1344
+ ENDED = "ENDED",
1345
+ /** Paid for orders with future start dates can't be suspended. */
1346
+ NOT_STARTED = "NOT_STARTED",
1347
+ /** Order is already suspended. */
1348
+ ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
1349
+ /** Orders based on recurring payments using older stripe versions can't be suspended. */
1350
+ OLD_STRIPE = "OLD_STRIPE"
1351
+ }
1352
+ /** @enumType */
1353
+ type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
1354
+ interface PostponeEndDateRequest {
1355
+ /**
1356
+ * Order ID.
1357
+ * @format GUID
1358
+ */
1359
+ _id: string;
1360
+ /**
1361
+ * New end date and time.
1362
+ *
1363
+ * Must be later than the current end date and time.
1364
+ */
1365
+ endDate: Date | null;
1366
+ }
1367
+ interface PostponeEndDateResponse {
1368
+ }
1369
+ interface OrderEndDatePostponed {
1370
+ /** Order whose `endDate` was postponed. */
1371
+ order?: Order;
1372
+ }
1373
+ interface CancelOrderRequest {
1374
+ /**
1375
+ * Order ID.
1376
+ * @format GUID
1377
+ */
1378
+ _id: string;
1379
+ /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
1380
+ effectiveAt: CancellationEffectiveAtWithLiterals;
1381
+ }
1382
+ interface CancelOrderResponse {
1383
+ }
1384
+ interface MarkAsPaidRequest {
1385
+ /**
1386
+ * Order ID.
1387
+ * @format GUID
1388
+ */
1389
+ _id: string;
1390
+ }
1391
+ interface MarkAsPaidResponse {
1392
+ }
1393
+ interface OrderMarkedAsPaid {
1394
+ /** Order that was marked as paid. */
1395
+ order?: Order;
1396
+ }
1397
+ interface PauseOrderRequest {
1398
+ /**
1399
+ * Order ID.
1400
+ * @format GUID
1401
+ */
1402
+ _id: string;
1403
+ }
1404
+ interface PauseOrderResponse {
1405
+ }
1406
+ interface OrderPaused {
1407
+ /** Paused order. */
1408
+ order?: Order;
1409
+ }
1410
+ interface BulkPauseOrderRequest {
1411
+ /**
1412
+ * List of Order IDs.
1413
+ * @format GUID
1414
+ * @minSize 1
1415
+ * @maxSize 100
1416
+ */
1417
+ ids?: string[];
1418
+ /** Set to true to return Order entity in response. */
1419
+ returnFullEntity?: boolean;
1420
+ }
1421
+ interface BulkPauseOrderResponse {
1422
+ /** Orders that were paused. */
1423
+ results?: BulkOrderResult[];
1424
+ /** Bulk action metadata. */
1425
+ bulkActionMetadata?: BulkActionMetadata;
1426
+ }
1427
+ interface BulkOrderResult {
1428
+ /** Item metadata */
1429
+ itemMetadata?: ItemMetadata;
1430
+ /** The order. */
1431
+ order?: Order;
1432
+ }
1433
+ interface ItemMetadata {
1434
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1435
+ _id?: string | null;
1436
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
1437
+ originalIndex?: number;
1438
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1439
+ success?: boolean;
1440
+ /** Details about the error in case of failure. */
1441
+ error?: ApplicationError;
1442
+ }
1443
+ interface ApplicationError {
1444
+ /** Error code. */
1445
+ code?: string;
1446
+ /** Description of the error. */
1447
+ description?: string;
1448
+ /** Data related to the error. */
1449
+ data?: Record<string, any> | null;
1450
+ }
1451
+ interface BulkActionMetadata {
1452
+ /** Number of items that were successfully processed. */
1453
+ totalSuccesses?: number;
1454
+ /** Number of items that couldn't be processed. */
1455
+ totalFailures?: number;
1456
+ /** Number of failures without details because detailed failure threshold was exceeded. */
1457
+ undetailedFailures?: number;
1458
+ }
1459
+ interface ResumeOrderRequest {
1460
+ /**
1461
+ * Order ID.
1462
+ * @format GUID
1463
+ */
1464
+ _id: string;
1465
+ }
1466
+ interface ResumeOrderResponse {
1467
+ }
1468
+ interface OrderResumed {
1469
+ /** Resumed order. */
1470
+ order?: Order;
1471
+ }
1472
+ interface BulkResumeOrderRequest {
1473
+ /**
1474
+ * List of Order IDs.
1475
+ * @format GUID
1476
+ * @minSize 1
1477
+ * @maxSize 100
1478
+ */
1479
+ ids?: string[];
1480
+ /** Set to true to return Order entity in response. */
1481
+ returnFullEntity?: boolean;
1482
+ }
1483
+ interface BulkResumeOrderResponse {
1484
+ /** Orders that were resumed. */
1485
+ results?: BulkOrderResult[];
1486
+ /** Bulk action metadata. */
1487
+ bulkActionMetadata?: BulkActionMetadata;
1488
+ }
1489
+ /** @docsIgnore */
1490
+ type CreateOnlineOrderApplicationErrors = {
1491
+ code?: 'MEMBER_REQUIRED';
1492
+ description?: string;
1493
+ data?: Record<string, any>;
1494
+ } | {
1495
+ code?: 'archived_plan';
1496
+ description?: string;
1497
+ data?: Record<string, any>;
1498
+ } | {
1499
+ code?: 'member_not_found';
1500
+ description?: string;
1501
+ data?: Record<string, any>;
1502
+ } | {
1503
+ code?: 'purchases_limit_reached';
1504
+ description?: string;
1505
+ data?: Record<string, any>;
1506
+ } | {
1507
+ code?: 'buyer_can_not_pick_future_start_date';
1508
+ description?: string;
1509
+ data?: Record<string, any>;
1510
+ } | {
1511
+ code?: 'invalid_start_date';
1512
+ description?: string;
1513
+ data?: Record<string, any>;
1514
+ } | {
1515
+ code?: 'accept_payment_feature_missing';
1516
+ description?: string;
1517
+ data?: Record<string, any>;
1518
+ } | {
1519
+ code?: 'meta_site_id_missing';
1520
+ description?: string;
1521
+ data?: Record<string, any>;
1522
+ } | {
1523
+ code?: 'ERROR_COUPON_IS_DISABLED';
1524
+ description?: string;
1525
+ data?: CouponsError;
1526
+ } | {
1527
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1528
+ description?: string;
1529
+ data?: CouponsError;
1530
+ } | {
1531
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1532
+ description?: string;
1533
+ data?: CouponsError;
1534
+ } | {
1535
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1536
+ description?: string;
1537
+ data?: CouponsError;
1538
+ } | {
1539
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
1540
+ description?: string;
1541
+ data?: CouponsError;
1542
+ } | {
1543
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1544
+ description?: string;
1545
+ data?: CouponsError;
1546
+ } | {
1547
+ code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1548
+ description?: string;
1549
+ data?: CouponsError;
1550
+ } | {
1551
+ code?: 'ERROR_INVALID_SUBTOTAL';
1552
+ description?: string;
1553
+ data?: CouponsError;
1554
+ } | {
1555
+ code?: 'undefined_not_allowed';
1556
+ description?: string;
1557
+ data?: Record<string, any>;
1558
+ } | {
1559
+ code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1560
+ description?: string;
1561
+ data?: Record<string, any>;
1562
+ } | {
1563
+ code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1564
+ description?: string;
1565
+ data?: Record<string, any>;
1566
+ };
1567
+ /** @docsIgnore */
1568
+ type CreateOnlineOrderValidationErrors = {
1569
+ ruleName?: 'UNKNOWN_ORDER_METHOD';
1570
+ } | {
1571
+ ruleName?: 'RECURRING_POS_UNSUPPORTED';
1572
+ } | {
1573
+ ruleName?: 'invalid_sort_field';
1574
+ };
1575
+ /** @docsIgnore */
1576
+ type CreateOfflineOrderApplicationErrors = {
1577
+ code?: 'PRICING_PLANS_NOT_INSTALLED';
1578
+ description?: string;
1579
+ data?: Record<string, any>;
1580
+ } | {
1581
+ code?: 'meta_site_id_missing';
1582
+ description?: string;
1583
+ data?: Record<string, any>;
1584
+ } | {
1585
+ code?: 'ERROR_COUPON_IS_DISABLED';
1586
+ description?: string;
1587
+ data?: CouponsError;
1588
+ } | {
1589
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1590
+ description?: string;
1591
+ data?: CouponsError;
1592
+ } | {
1593
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1594
+ description?: string;
1595
+ data?: CouponsError;
1596
+ } | {
1597
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1598
+ description?: string;
1599
+ data?: CouponsError;
1600
+ } | {
1601
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
1602
+ description?: string;
1603
+ data?: CouponsError;
1604
+ } | {
1605
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1606
+ description?: string;
1607
+ data?: CouponsError;
1608
+ } | {
1609
+ code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1610
+ description?: string;
1611
+ data?: CouponsError;
1612
+ } | {
1613
+ code?: 'ERROR_INVALID_SUBTOTAL';
1614
+ description?: string;
1615
+ data?: CouponsError;
1616
+ } | {
1617
+ code?: 'undefined_not_allowed';
1618
+ description?: string;
1619
+ data?: Record<string, any>;
1620
+ } | {
1621
+ code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
1622
+ description?: string;
1623
+ data?: Record<string, any>;
1624
+ } | {
1625
+ code?: 'MISSING_BUSINESS_ADDRESS_STATE';
1626
+ description?: string;
1627
+ data?: Record<string, any>;
1628
+ };
1629
+ /** @docsIgnore */
1630
+ type CreateOfflineOrderValidationErrors = {
1631
+ ruleName?: 'MEMBER_DOESNT_EXIST';
1632
+ } | {
1633
+ ruleName?: 'invalid_sort_field';
1634
+ };
1635
+ /** @docsIgnore */
1636
+ type GetOnlineOrderPreviewApplicationErrors = {
1637
+ code?: 'PRICING_PLANS_NOT_INSTALLED';
1638
+ description?: string;
1639
+ data?: Record<string, any>;
1640
+ } | {
1641
+ code?: 'ERROR_COUPON_IS_DISABLED';
1642
+ description?: string;
1643
+ data?: CouponsError;
1644
+ } | {
1645
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
1646
+ description?: string;
1647
+ data?: CouponsError;
1648
+ } | {
1649
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
1650
+ description?: string;
1651
+ data?: CouponsError;
1652
+ } | {
1653
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
1654
+ description?: string;
1655
+ data?: CouponsError;
1656
+ } | {
1657
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
1658
+ description?: string;
1659
+ data?: CouponsError;
1660
+ } | {
1661
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
1662
+ description?: string;
1663
+ data?: CouponsError;
1664
+ } | {
1665
+ code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
1666
+ description?: string;
1667
+ data?: CouponsError;
1666
1668
  } | {
1667
1669
  code?: 'ERROR_INVALID_SUBTOTAL';
1668
1670
  description?: string;
@@ -1793,6 +1795,8 @@ interface BaseEventMetadata {
1793
1795
  eventType?: string;
1794
1796
  /** The identification type and identity data. */
1795
1797
  identity?: IdentificationData;
1798
+ /** Details related to the account */
1799
+ accountInfo?: AccountInfo;
1796
1800
  }
1797
1801
  interface EventMetadata extends BaseEventMetadata {
1798
1802
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
@@ -1833,31 +1837,6 @@ interface AccountInfoMetadata {
1833
1837
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
1834
1838
  parentAccountId?: string;
1835
1839
  }
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;
1861
1840
  interface OrderCanceledEnvelope {
1862
1841
  data: OrderCanceled;
1863
1842
  metadata: EventMetadata;
@@ -1879,64 +1858,16 @@ interface OrderCanceledEnvelope {
1879
1858
  * @permissionId PRICING_PLANS.READ_ORDERS
1880
1859
  * @webhook
1881
1860
  * @eventType wix.pricing_plans.v2.order_canceled
1882
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1861
+ * @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
1883
1862
  * @slug canceled
1884
1863
  */
1885
1864
  declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
1886
- interface OrderCycleStartedEnvelope {
1887
- data: OrderCycleStarted;
1888
- metadata: EventMetadata;
1889
- }
1890
- /**
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.
1894
- * @permissionScope Manage Orders
1895
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1896
- * @permissionScope Read Orders
1897
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1898
- * @permissionScope Manage plans and orders of Pricing Plans
1899
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1900
- * @permissionScope Manage Events
1901
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1902
- * @permissionId PRICING_PLANS.READ_ORDERS
1903
- * @webhook
1904
- * @eventType wix.pricing_plans.v2.order_cycle_started
1905
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1906
- * @slug cycle_started
1907
- */
1908
- declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1909
- interface OrderEndDatePostponedEnvelope {
1910
- data: OrderEndDatePostponed;
1911
- metadata: EventMetadata;
1912
- }
1913
- /**
1914
- * Triggered when an order's `endDate` is postponed.
1915
- * @permissionScope Manage Orders
1916
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1917
- * @permissionScope Read Orders
1918
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1919
- * @permissionScope Manage plans and orders of Pricing Plans
1920
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
1921
- * @permissionScope Manage Events
1922
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1923
- * @permissionId PRICING_PLANS.READ_ORDERS
1924
- * @webhook
1925
- * @eventType wix.pricing_plans.v2.order_end_date_postponed
1926
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1927
- * @slug end_date_postponed
1928
- */
1929
- declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
1930
- interface OrderEndedEnvelope {
1931
- data: OrderEnded;
1865
+ interface OrderCreatedEnvelope {
1866
+ entity: Order;
1932
1867
  metadata: EventMetadata;
1933
1868
  }
1934
1869
  /**
1935
- * Triggered when an order ends.
1936
- *
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`.
1870
+ * Triggered when an order is created.
1940
1871
  * @permissionScope Manage Orders
1941
1872
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1942
1873
  * @permissionScope Read Orders
@@ -1947,17 +1878,17 @@ interface OrderEndedEnvelope {
1947
1878
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1948
1879
  * @permissionId PRICING_PLANS.READ_ORDERS
1949
1880
  * @webhook
1950
- * @eventType wix.pricing_plans.v2.order_ended
1951
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1952
- * @slug ended
1881
+ * @eventType wix.pricing_plans.v2.order_created
1882
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1883
+ * @slug created
1953
1884
  */
1954
- declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
1955
- interface OrderMarkedAsPaidEnvelope {
1956
- data: OrderMarkedAsPaid;
1885
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
1886
+ interface OrderStartDateChangedEnvelope {
1887
+ data: OrderStartDateChanged;
1957
1888
  metadata: EventMetadata;
1958
1889
  }
1959
1890
  /**
1960
- * Triggered when an offline order is marked as paid.
1891
+ * Triggered when an order's `startDate` is changed.
1961
1892
  * @permissionScope Manage Orders
1962
1893
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1963
1894
  * @permissionScope Read Orders
@@ -1968,17 +1899,25 @@ interface OrderMarkedAsPaidEnvelope {
1968
1899
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1969
1900
  * @permissionId PRICING_PLANS.READ_ORDERS
1970
1901
  * @webhook
1971
- * @eventType wix.pricing_plans.v2.order_marked_as_paid
1972
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1973
- * @slug marked_as_paid
1902
+ * @eventType wix.pricing_plans.v2.order_start_date_changed
1903
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1904
+ * @slug start_date_changed
1974
1905
  */
1975
- declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
1976
- interface OrderPausedEnvelope {
1977
- data: OrderPaused;
1906
+ declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
1907
+ interface OrderUpdatedEnvelope {
1908
+ entity: Order;
1978
1909
  metadata: EventMetadata;
1979
1910
  }
1980
1911
  /**
1981
- * Triggered when an order is paused.
1912
+ * Triggered for any of the following update events:
1913
+ *
1914
+ * + Order is paid for. Order Purchased is also triggered.
1915
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
1916
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
1917
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
1918
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
1919
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
1920
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
1982
1921
  * @permissionScope Manage Orders
1983
1922
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1984
1923
  * @permissionScope Read Orders
@@ -1989,21 +1928,21 @@ interface OrderPausedEnvelope {
1989
1928
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1990
1929
  * @permissionId PRICING_PLANS.READ_ORDERS
1991
1930
  * @webhook
1992
- * @eventType wix.pricing_plans.v2.order_paused
1993
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
1994
- * @slug paused
1931
+ * @eventType wix.pricing_plans.v2.order_updated
1932
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
1933
+ * @slug updated
1995
1934
  */
1996
- declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
1997
- interface OrderPurchasedEnvelope {
1998
- data: OrderPurchased;
1935
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
1936
+ interface OrderAutoRenewCanceledEnvelope {
1937
+ data: OrderAutoRenewCanceled;
1999
1938
  metadata: EventMetadata;
2000
1939
  }
2001
1940
  /**
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.
1941
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
1942
+ *
1943
+ * This webhook is *not* triggered in the following scenarios:
1944
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
1945
+ * + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
2007
1946
  * @permissionScope Manage Orders
2008
1947
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2009
1948
  * @permissionScope Read Orders
@@ -2014,17 +1953,19 @@ interface OrderPurchasedEnvelope {
2014
1953
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2015
1954
  * @permissionId PRICING_PLANS.READ_ORDERS
2016
1955
  * @webhook
2017
- * @eventType wix.pricing_plans.v2.order_purchased
1956
+ * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
2018
1957
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2019
- * @slug purchased
1958
+ * @slug auto_renew_canceled
2020
1959
  */
2021
- declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2022
- interface OrderResumedEnvelope {
2023
- data: OrderResumed;
1960
+ declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
1961
+ interface OrderCycleStartedEnvelope {
1962
+ data: OrderCycleStarted;
2024
1963
  metadata: EventMetadata;
2025
1964
  }
2026
1965
  /**
2027
- * Triggered when a paused order is resumed.
1966
+ * Triggered at the start of a new payment cycle for an existing order.
1967
+ *
1968
+ * Not triggered at the initial start of an offline order.
2028
1969
  * @permissionScope Manage Orders
2029
1970
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2030
1971
  * @permissionScope Read Orders
@@ -2035,17 +1976,17 @@ interface OrderResumedEnvelope {
2035
1976
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2036
1977
  * @permissionId PRICING_PLANS.READ_ORDERS
2037
1978
  * @webhook
2038
- * @eventType wix.pricing_plans.v2.order_resumed
1979
+ * @eventType wix.pricing_plans.v2.order_cycle_started
2039
1980
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2040
- * @slug resumed
1981
+ * @slug cycle_started
2041
1982
  */
2042
- declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2043
- interface OrderStartedEnvelope {
2044
- data: OrderStarted;
1983
+ declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
1984
+ interface OrderEndDatePostponedEnvelope {
1985
+ data: OrderEndDatePostponed;
2045
1986
  metadata: EventMetadata;
2046
1987
  }
2047
1988
  /**
2048
- * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
1989
+ * Triggered when an order's `endDate` is postponed.
2049
1990
  * @permissionScope Manage Orders
2050
1991
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2051
1992
  * @permissionScope Read Orders
@@ -2056,25 +1997,21 @@ interface OrderStartedEnvelope {
2056
1997
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2057
1998
  * @permissionId PRICING_PLANS.READ_ORDERS
2058
1999
  * @webhook
2059
- * @eventType wix.pricing_plans.v2.order_started
2000
+ * @eventType wix.pricing_plans.v2.order_end_date_postponed
2060
2001
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2061
- * @slug started
2002
+ * @slug end_date_postponed
2062
2003
  */
2063
- declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2064
- interface OrderUpdatedEnvelope {
2065
- entity: Order;
2004
+ declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
2005
+ interface OrderEndedEnvelope {
2006
+ data: OrderEnded;
2066
2007
  metadata: EventMetadata;
2067
2008
  }
2068
2009
  /**
2069
- * Triggered for any of the following update events:
2010
+ * Triggered when an order ends.
2070
2011
  *
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.
2012
+ * This webhook is triggered:
2013
+ * + When an order expires at the end of the current payment cycle.
2014
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
2078
2015
  * @permissionScope Manage Orders
2079
2016
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2080
2017
  * @permissionScope Read Orders
@@ -2085,17 +2022,17 @@ interface OrderUpdatedEnvelope {
2085
2022
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2086
2023
  * @permissionId PRICING_PLANS.READ_ORDERS
2087
2024
  * @webhook
2088
- * @eventType wix.pricing_plans.v2.order_updated
2025
+ * @eventType wix.pricing_plans.v2.order_ended
2089
2026
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2090
- * @slug updated
2027
+ * @slug ended
2091
2028
  */
2092
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2093
- interface OrderCreatedEnvelope {
2094
- entity: Order;
2029
+ declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
2030
+ interface OrderMarkedAsPaidEnvelope {
2031
+ data: OrderMarkedAsPaid;
2095
2032
  metadata: EventMetadata;
2096
2033
  }
2097
2034
  /**
2098
- * Triggered when an order is created.
2035
+ * Triggered when an offline order is marked as paid.
2099
2036
  * @permissionScope Manage Orders
2100
2037
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2101
2038
  * @permissionScope Read Orders
@@ -2106,17 +2043,17 @@ interface OrderCreatedEnvelope {
2106
2043
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2107
2044
  * @permissionId PRICING_PLANS.READ_ORDERS
2108
2045
  * @webhook
2109
- * @eventType wix.pricing_plans.v2.order_created
2110
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
2111
- * @slug created
2046
+ * @eventType wix.pricing_plans.v2.order_marked_as_paid
2047
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2048
+ * @slug marked_as_paid
2112
2049
  */
2113
- declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
2114
- interface OrderStartDateChangedEnvelope {
2115
- data: OrderStartDateChanged;
2050
+ declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
2051
+ interface OrderPausedEnvelope {
2052
+ data: OrderPaused;
2116
2053
  metadata: EventMetadata;
2117
2054
  }
2118
2055
  /**
2119
- * Triggered when an order's `startDate` is changed.
2056
+ * Triggered when an order is paused.
2120
2057
  * @permissionScope Manage Orders
2121
2058
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2122
2059
  * @permissionScope Read Orders
@@ -2127,185 +2064,78 @@ interface OrderStartDateChangedEnvelope {
2127
2064
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2128
2065
  * @permissionId PRICING_PLANS.READ_ORDERS
2129
2066
  * @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
2067
+ * @eventType wix.pricing_plans.v2.order_paused
2068
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2069
+ * @slug paused
2164
2070
  */
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;
2071
+ declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
2072
+ interface OrderPurchasedEnvelope {
2073
+ data: OrderPurchased;
2074
+ metadata: EventMetadata;
2207
2075
  }
2208
2076
  /**
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
2077
+ * Triggered for any of the following purchase events:
2078
+ * + Order is paid in full.
2079
+ * + At least 1 order cycle payment is paid for.
2080
+ * + Offline order is created, even if not yet marked as paid.
2081
+ * + Free order is created.
2082
+ * @permissionScope Manage Orders
2083
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2084
+ * @permissionScope Read Orders
2085
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2086
+ * @permissionScope Manage plans and orders of Pricing Plans
2087
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2088
+ * @permissionScope Manage Events
2089
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2090
+ * @permissionId PRICING_PLANS.READ_ORDERS
2091
+ * @webhook
2092
+ * @eventType wix.pricing_plans.v2.order_purchased
2093
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2094
+ * @slug purchased
2271
2095
  */
2272
- declare function markAsPaid(_id: string): Promise<void>;
2096
+ declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
2097
+ interface OrderResumedEnvelope {
2098
+ data: OrderResumed;
2099
+ metadata: EventMetadata;
2100
+ }
2273
2101
  /**
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
2102
+ * Triggered when a paused order is resumed.
2103
+ * @permissionScope Manage Orders
2104
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2105
+ * @permissionScope Read Orders
2106
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2107
+ * @permissionScope Manage plans and orders of Pricing Plans
2108
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2109
+ * @permissionScope Manage Events
2110
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2111
+ * @permissionId PRICING_PLANS.READ_ORDERS
2112
+ * @webhook
2113
+ * @eventType wix.pricing_plans.v2.order_resumed
2114
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2115
+ * @slug resumed
2288
2116
  */
2289
- declare function pauseOrder(_id: string): Promise<void>;
2117
+ declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
2118
+ interface OrderStartedEnvelope {
2119
+ data: OrderStarted;
2120
+ metadata: EventMetadata;
2121
+ }
2290
2122
  /**
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
2123
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2124
+ * @permissionScope Manage Orders
2125
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
2126
+ * @permissionScope Read Orders
2127
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
2128
+ * @permissionScope Manage plans and orders of Pricing Plans
2129
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
2130
+ * @permissionScope Manage Events
2131
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2132
+ * @permissionId PRICING_PLANS.READ_ORDERS
2133
+ * @webhook
2134
+ * @eventType wix.pricing_plans.v2.order_started
2135
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
2136
+ * @slug started
2307
2137
  */
2308
- declare function resumeOrder(_id: string): Promise<void>;
2138
+ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
2309
2139
  /**
2310
2140
  * Retrieves an order for the currently logged-in member by ID.
2311
2141
  * @param _id - Order ID.
@@ -2315,10 +2145,9 @@ declare function resumeOrder(_id: string): Promise<void>;
2315
2145
  * @permissionId PRICING_PLANS.READ_OWN_ORDERS
2316
2146
  * @applicableIdentity APP
2317
2147
  * @applicableIdentity MEMBER
2318
- * @returns Requested order.
2319
2148
  * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
2320
2149
  */
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>>;
2150
+ declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<MemberGetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
2322
2151
  interface MemberGetOrderOptions {
2323
2152
  /**
2324
2153
  * Predefined set of fields to return.
@@ -2581,5 +2410,180 @@ interface GetPricePreviewOptions {
2581
2410
  */
2582
2411
  couponCode?: string | null;
2583
2412
  }
2413
+ /**
2414
+ * Retrieves an order by ID.
2415
+ * @param _id - Order ID.
2416
+ * @public
2417
+ * @requiredField _id
2418
+ * @param options - Options to use when getting an order.
2419
+ * @permissionId PRICING_PLANS.READ_ORDERS
2420
+ * @applicableIdentity APP
2421
+ * @returns Order.
2422
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
2423
+ */
2424
+ declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
2425
+ interface ManagementGetOrderOptions {
2426
+ /**
2427
+ * Predefined set of fields to return.
2428
+ *
2429
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2430
+ */
2431
+ fieldSet?: SetWithLiterals;
2432
+ }
2433
+ /**
2434
+ * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
2435
+ *
2436
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
2437
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
2438
+ * @public
2439
+ * @param options - Filtering, sorting, and pagination options.
2440
+ * @permissionId PRICING_PLANS.READ_ORDERS
2441
+ * @applicableIdentity APP
2442
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
2443
+ */
2444
+ declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
2445
+ interface ManagementListOrdersOptions {
2446
+ /**
2447
+ * Filter by a buyer's member ID, from the Members API.
2448
+ * @format GUID
2449
+ */
2450
+ buyerIds?: string[];
2451
+ /**
2452
+ * Filter by plan IDs, from the Plans API.
2453
+ * @format GUID
2454
+ */
2455
+ planIds?: string[];
2456
+ /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
2457
+ autoRenewCanceled?: boolean | null;
2458
+ /** Filter by order status. */
2459
+ orderStatuses?: OrderStatusWithLiterals[];
2460
+ /** Filter by payment status. */
2461
+ paymentStatuses?: PaymentStatusWithLiterals[];
2462
+ /**
2463
+ * Number of orders to return. See Sorting and Paging for more information.
2464
+ *
2465
+ * Max: `50`
2466
+ * @min 1
2467
+ * @max 50
2468
+ */
2469
+ limit?: number | null;
2470
+ /** Number of orders to skip in the current sort order. */
2471
+ offset?: number | null;
2472
+ /**
2473
+ * Sort order.
2474
+ *
2475
+ * Use `ASC` for ascending order or `DESC` for descending order.
2476
+ *
2477
+ * Default: `DESC`.
2478
+ */
2479
+ sorting?: Sorting;
2480
+ /**
2481
+ * Predefined set of fields to return.
2482
+ *
2483
+ * Default: If `fieldSet` is omitted, no order form submission data is returned.
2484
+ */
2485
+ fieldSet?: SetWithLiterals;
2486
+ }
2487
+ /**
2488
+ * Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
2489
+ *
2490
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
2491
+ * Can't postpone an order with `status`: `PAUSED`.
2492
+ * @param _id - Order ID.
2493
+ * @param endDate - New end date and time.
2494
+ *
2495
+ * Must be later than the current end date and time.
2496
+ * @public
2497
+ * @requiredField _id
2498
+ * @requiredField endDate
2499
+ * @param options - Options for postponing the end date of an order.
2500
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2501
+ * @applicableIdentity APP
2502
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
2503
+ */
2504
+ declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
2505
+ /**
2506
+ * Cancels an existing order.
2507
+ *
2508
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2509
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
2510
+ *
2511
+ * #### Canceling during the free trial period.
2512
+ *
2513
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
2514
+ * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
2515
+ * of the free trial period.
2516
+ *
2517
+ * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
2518
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
2519
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
2520
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
2521
+ * Then, the subscription ends and the buyer is not billed.
2522
+ * @param _id - Order ID.
2523
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
2524
+ * @public
2525
+ * @requiredField _id
2526
+ * @requiredField effectiveAt
2527
+ * @param options - Options for canceling orders.
2528
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2529
+ * @applicableIdentity APP
2530
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
2531
+ */
2532
+ declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
2533
+ /**
2534
+ * Marks an offline order as paid.
2535
+ * > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
2536
+ *
2537
+ * Marking an offline order as paid causes the following changes:
2538
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2539
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2540
+ *
2541
+ * An error occurs if you attempt to:
2542
+ * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
2543
+ * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
2544
+ * @param _id - Order ID.
2545
+ * @public
2546
+ * @requiredField _id
2547
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2548
+ * @applicableIdentity APP
2549
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
2550
+ */
2551
+ declare function markAsPaid(_id: string): Promise<void>;
2552
+ /**
2553
+ * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
2554
+ *
2555
+ * Only orders with `status`: `ACTIVE` can be paused.
2556
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
2557
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
2558
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2559
+ *
2560
+ * To resume a paused order, call Resume Order.
2561
+ * @param _id - Order ID.
2562
+ * @public
2563
+ * @requiredField _id
2564
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2565
+ * @applicableIdentity APP
2566
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
2567
+ */
2568
+ declare function pauseOrder(_id: string): Promise<void>;
2569
+ /**
2570
+ * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
2571
+ *
2572
+ * Resuming an order causes the following changes:
2573
+ * - The order status changes to `"ACTIVE"`.
2574
+ * - The `pausePeriods` array is updated.
2575
+ * - The `endDate` for the order is adjusted to include the pause period.
2576
+ * - For orders with recurring payments, the payment schedule is restarted.
2577
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2578
+ *
2579
+ * To pause an order, call Pause Order.
2580
+ * @param _id - Order ID.
2581
+ * @public
2582
+ * @requiredField _id
2583
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
2584
+ * @applicableIdentity APP
2585
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
2586
+ */
2587
+ declare function resumeOrder(_id: string): Promise<void>;
2584
2588
 
2585
2589
  export { type AccountInfo, type ActionEvent, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type OrdersQueryOrdersRequest, type OrdersQueryOrdersResponse, type Paging, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, type QueryOrdersRequest, type QueryOrdersResponse, type QueryV2, type QueryV2PagingMethodOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };