@wix/subscription 1.0.31 → 1.0.33

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.
@@ -307,10 +307,32 @@ interface AdditionalFee$1 {
307
307
  *
308
308
  * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
309
309
  * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
310
+ * @deprecated When the fee is added to the invoice.
311
+ *
312
+ * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
313
+ * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
314
+ * @replacedBy cycles
315
+ * @targetRemovalDate 2025-12-31
310
316
  */
311
317
  trigger?: AdditionalFeeTrigger$1;
312
318
  /** Information about the tax of the conditional fee. */
313
319
  tax?: Tax$1;
320
+ /**
321
+ * Specifies the cycles during which the fee will be applied. If this field is provided,
322
+ * it determines the exact range of cycles the fee applies to. The logic is as follows:
323
+ *
324
+ * - `cycle_from`: The first cycle the fee will be added to. Must be greater than 0.
325
+ * - `number_of_cycles`: The number of consecutive cycles the fee will be applied to,
326
+ * starting from `cycle_from`. If not specified, the fee applies to all cycles starting
327
+ * from `cycle_from`.
328
+ *
329
+ * Example:
330
+ * - `cycle_from = 1, number_of_cycles = 3`: Fee applies to cycles 1, 2, and 3.
331
+ * - `cycle_from = 2, number_of_cycles = None`: Fee applies to cycles 2 and onward indefinitely.
332
+ *
333
+ * If `cycles` is not specified (`None`), the fee will only be applied to the first cycle of the subscription.
334
+ */
335
+ cycles?: Cycles$1;
314
336
  }
315
337
  declare enum AdditionalFeeTrigger$1 {
316
338
  UNKNOWN = "UNKNOWN",
@@ -373,6 +395,12 @@ declare enum TaxableAddressType$1 {
373
395
  /** Tax will be calculated using multiple address (from BUSINESS to SHIPPING) */
374
396
  SHIPPING = "SHIPPING"
375
397
  }
398
+ interface Cycles$1 {
399
+ /** The cycle will start. Minimum cycle number is 1 */
400
+ cycleFrom?: number;
401
+ /** Number of cycles to be applied on. In order to apply a on all cycles until the end of the subscription, this field should be empty. */
402
+ numberOfCycles?: number | null;
403
+ }
376
404
  interface ShippingCharges$1 {
377
405
  /**
378
406
  * Amount of the shipping fee in `0.00` format.
@@ -786,147 +814,18 @@ interface SpecificDateSubscriptionUpdateData$1 {
786
814
  updateData?: SubscriptionUpdateData$1;
787
815
  executionDate?: Date | null;
788
816
  }
789
- interface ListSubscriptionHistoryRequest$1 {
790
- subscriptionId: string;
791
- /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
792
- mode?: HistoryViewMode$1;
793
- /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
794
- cursor?: CursorPaging$1;
795
- }
796
- declare enum HistoryViewMode$1 {
797
- UNKNOWN = "UNKNOWN",
798
- /** Comprehensive view including all history events. */
799
- BACKOFFICE = "BACKOFFICE",
800
- /** User-centric view of the history. */
801
- USER = "USER"
802
- }
803
- interface CursorPaging$1 {
804
- /** Maximum number of items to return in the results. */
805
- limit?: number | null;
806
- /**
807
- * Pointer to the next or previous page in the list of results.
808
- *
809
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
810
- * Not relevant for the first request.
811
- */
812
- cursor?: string | null;
813
- }
814
- interface ListSubscriptionHistoryResponse$1 {
815
- /** List of history entries for the subscription. */
816
- historyEntries?: SubscriptionHistoryEntry$1[];
817
- /** Paging metadata. A `next` cursor is returned if there are more results. */
818
- pagingMetadata?: PagingMetadataV2$1;
819
- }
820
- interface SubscriptionHistoryEntry$1 {
821
- entryId?: string;
822
- /** TODO: add max length? it is not defined in domainevents, so should we? */
823
- slug?: string;
824
- entryTime?: Date | null;
825
- event?: SubscriptionEvent$1;
826
- }
827
- interface SubscriptionEvent$1 extends SubscriptionEventPayloadOneOf$1 {
828
- created?: SubscriptionCreated$1;
829
- updated?: SubscriptionUpdated$1;
830
- deleted?: SubscriptionDeleted$1;
831
- activated?: SubscriptionActivated$1;
832
- ended?: SubscriptionEnded$1;
833
- canceled?: SubscriptionCanceled$1;
834
- paused?: SubscriptionPaused$1;
835
- resumed?: SubscriptionResumed$1;
836
- pauseRequested?: PauseSubscriptionRequested$1;
837
- resumeRequested?: ResumeSubscriptionRequested$1;
838
- scheduledPauseCanceled?: ScheduledPauseCanceled$1;
839
- scheduledResumeCanceled?: ScheduledResumeCanceled$1;
840
- billingCycleStarted?: SubscriptionBillingCycleStarted$1;
841
- autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn$1;
842
- autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff$1;
843
- cycleReadyToPay?: SubscriptionCycleReadyToPay$1;
844
- extended?: SubscriptionExtended$1;
845
- initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted$1;
846
- latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid$1;
847
- revived?: SubscriptionRevived$1;
848
- billingDateUpdated?: SubscriptionBillingDateUpdated$1;
849
- futureUpdatesRequested?: FutureUpdatesRequested$1;
850
- updatesApplied?: UpdatesApplied$1;
851
- resetPendingUpdates?: ResetPendingUpdates$1;
852
- gracePeriodStarted?: GracePeriodStarted$1;
853
- gracePeriodEnded?: GracePeriodEnded$1;
854
- paymentMethodUpdated?: PaymentMethodUpdated$1;
855
- collectionMethodUpdated?: SubscriptionCollectionMethodUpdated$1;
856
- freeTrailStarted?: FreeTrailStarted$1;
857
- freeTrailEnded?: FreeTrailEnded$1;
858
- subscriptionBoAction?: SubscriptionBackOfficeAction$1;
859
- unknown?: UnknownSubscriptionEvent$1;
860
- }
861
- /** @oneof */
862
- interface SubscriptionEventPayloadOneOf$1 {
863
- created?: SubscriptionCreated$1;
864
- updated?: SubscriptionUpdated$1;
865
- deleted?: SubscriptionDeleted$1;
866
- activated?: SubscriptionActivated$1;
867
- ended?: SubscriptionEnded$1;
868
- canceled?: SubscriptionCanceled$1;
869
- paused?: SubscriptionPaused$1;
870
- resumed?: SubscriptionResumed$1;
871
- pauseRequested?: PauseSubscriptionRequested$1;
872
- resumeRequested?: ResumeSubscriptionRequested$1;
873
- scheduledPauseCanceled?: ScheduledPauseCanceled$1;
874
- scheduledResumeCanceled?: ScheduledResumeCanceled$1;
875
- billingCycleStarted?: SubscriptionBillingCycleStarted$1;
876
- autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn$1;
877
- autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff$1;
878
- cycleReadyToPay?: SubscriptionCycleReadyToPay$1;
879
- extended?: SubscriptionExtended$1;
880
- initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted$1;
881
- latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid$1;
882
- revived?: SubscriptionRevived$1;
883
- billingDateUpdated?: SubscriptionBillingDateUpdated$1;
884
- futureUpdatesRequested?: FutureUpdatesRequested$1;
885
- updatesApplied?: UpdatesApplied$1;
886
- resetPendingUpdates?: ResetPendingUpdates$1;
887
- gracePeriodStarted?: GracePeriodStarted$1;
888
- gracePeriodEnded?: GracePeriodEnded$1;
889
- paymentMethodUpdated?: PaymentMethodUpdated$1;
890
- collectionMethodUpdated?: SubscriptionCollectionMethodUpdated$1;
891
- freeTrailStarted?: FreeTrailStarted$1;
892
- freeTrailEnded?: FreeTrailEnded$1;
893
- subscriptionBoAction?: SubscriptionBackOfficeAction$1;
894
- unknown?: UnknownSubscriptionEvent$1;
817
+ interface GetSubscriptionRequest$1 {
818
+ id: string;
895
819
  }
896
- interface SubscriptionCreated$1 {
820
+ interface GetSubscriptionResponse$1 {
897
821
  subscription?: Subscription$1;
898
822
  }
899
- interface SubscriptionUpdated$1 {
900
- current?: Subscription$1;
901
- previous?: Subscription$1;
902
- diff?: SubscriptionDiff$1;
903
- }
904
- interface SubscriptionDiff$1 {
905
- added?: string | null;
906
- changed?: string | null;
907
- deleted?: string | null;
908
- }
909
- interface SubscriptionDeleted$1 {
910
- subscriptionId?: string;
911
- }
912
- /**
913
- * Sent each time a subscription status has been set to Active
914
- * Active shows that a subscription is live and operational.
915
- * For example:
916
- * * For subscription with free trial, free trial start date is also the activation date.
917
- * * For a subscription with future start date, the start date is also the activation date.
918
- * * When a subscription is resumed from a pause status, the resume date is also the activation date.
919
- */
920
- interface SubscriptionActivated$1 {
921
- subscription?: Subscription$1;
823
+ interface CustomerCancelSubscriptionRequest$1 {
824
+ id: string;
825
+ /** Optional action reason message */
826
+ reason?: string | null;
922
827
  }
923
- /**
924
- * Sent each time a subscription status has been set to Ended
925
- * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
926
- * This is different from a Canceled subscription which ends the subscription before a designated end date.
927
- * Therefore, Ended and Canceled are mutually exclusive.
928
- */
929
- interface SubscriptionEnded$1 {
828
+ interface CustomerCancelSubscriptionResponse$1 {
930
829
  subscription?: Subscription$1;
931
830
  }
932
831
  /**
@@ -944,48 +843,32 @@ interface ActionDetails$1 {
944
843
  initiator?: HistoryActionInitiator$1;
945
844
  reason?: string | null;
946
845
  }
947
- interface SubscriptionPaused$1 {
948
- subscription?: Subscription$1;
949
- pausePolicy?: PausePolicy$1;
950
- actionDetails?: ActionDetails$1;
951
- }
952
- interface SubscriptionResumed$1 {
953
- subscription?: Subscription$1;
954
- actionDetails?: ActionDetails$1;
955
- }
956
- interface PauseSubscriptionRequested$1 {
957
- subscription?: Subscription$1;
958
- pauseAt?: PauseAt$1;
959
- pausePolicy?: PausePolicy$1;
960
- actionDetails?: ActionDetails$1;
961
- }
962
- interface ResumeSubscriptionRequested$1 {
963
- subscription?: Subscription$1;
964
- resumeAt?: ResumeAt$1;
965
- actionDetails?: ActionDetails$1;
966
- }
967
- interface ScheduledPauseCanceled$1 {
968
- subscription?: Subscription$1;
969
- actionDetails?: ActionDetails$1;
846
+ interface CustomerTurnOnAutoRenewalRequest$1 {
847
+ id: string;
848
+ /** Optional action reason message */
849
+ reason?: string | null;
970
850
  }
971
- interface ScheduledResumeCanceled$1 {
851
+ interface CustomerTurnOnAutoRenewalResponse$1 {
972
852
  subscription?: Subscription$1;
973
- actionDetails?: ActionDetails$1;
974
853
  }
975
- interface SubscriptionBillingCycleStarted$1 {
976
- subscription?: Subscription$1;
977
- /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
978
- paymentTransactionId?: string | null;
854
+ interface CustomerTurnOffAutoRenewalRequest$1 {
855
+ id: string;
856
+ /** Optional action reason message */
857
+ reason?: string | null;
979
858
  }
980
- interface SubscriptionAutoRenewalTurnedOn$1 {
859
+ interface CustomerTurnOffAutoRenewalResponse$1 {
981
860
  subscription?: Subscription$1;
982
- actionDetails?: ActionDetails$1;
983
861
  }
984
- interface SubscriptionAutoRenewalTurnedOff$1 {
985
- subscription?: Subscription$1;
986
- actionDetails?: ActionDetails$1;
862
+ interface CustomerExtendSubscriptionRequest$1 {
863
+ /** The ID of the subscription to be extended */
864
+ id: string;
865
+ /** Optional action reason message */
866
+ reason?: string | null;
867
+ /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
868
+ billingCyclesToAdd: number | null;
987
869
  }
988
- interface SubscriptionCycleReadyToPay$1 {
870
+ interface CustomerExtendSubscriptionResponse$1 {
871
+ /** The now extended subscription */
989
872
  subscription?: Subscription$1;
990
873
  }
991
874
  interface SubscriptionExtended$1 extends SubscriptionExtendedExtendPolicyOneOf$1 {
@@ -999,95 +882,68 @@ interface SubscriptionExtendedExtendPolicyOneOf$1 {
999
882
  extensionPeriod?: Duration$1;
1000
883
  extensionBillingCycles?: number;
1001
884
  }
1002
- interface SubscriptionInitialPurchaseCompleted$1 {
1003
- subscription?: Subscription$1;
1004
- actionDetails?: ActionDetails$1;
1005
- paymentTransactionId?: string | null;
885
+ interface QuerySubscriptionsRequest$1 {
886
+ query?: QueryV2$1;
1006
887
  }
1007
- interface LatestInvoiceMarkedAsPaid$1 {
1008
- subscription?: Subscription$1;
888
+ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
889
+ /** Paging options to limit and skip the number of items. */
890
+ paging?: Paging$1;
891
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
892
+ cursorPaging?: CursorPaging$1;
893
+ /**
894
+ * Filter object.
895
+ *
896
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
897
+ */
898
+ filter?: Record<string, any> | null;
899
+ /**
900
+ * Sort object.
901
+ *
902
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
903
+ */
904
+ sort?: Sorting$1[];
905
+ /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
906
+ fields?: string[];
907
+ /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
908
+ fieldsets?: string[];
1009
909
  }
1010
- interface SubscriptionRevived$1 {
1011
- subscription?: Subscription$1;
910
+ /** @oneof */
911
+ interface QueryV2PagingMethodOneOf$1 {
912
+ /** Paging options to limit and skip the number of items. */
913
+ paging?: Paging$1;
914
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
915
+ cursorPaging?: CursorPaging$1;
1012
916
  }
1013
- interface SubscriptionBillingDateUpdated$1 {
1014
- subscription?: Subscription$1;
1015
- billingDate?: Date | null;
1016
- proration?: Proration$1;
917
+ interface Sorting$1 {
918
+ /** Name of the field to sort by. */
919
+ fieldName?: string;
920
+ /** Sort order. */
921
+ order?: SortOrder$1;
1017
922
  }
1018
- interface FutureUpdatesRequested$1 {
1019
- subscription?: Subscription$1;
1020
- requestedUpdateData?: SubscriptionUpdateData$1;
1021
- }
1022
- interface UpdatesApplied$1 {
1023
- subscription?: Subscription$1;
1024
- updateAction?: UpdateAction$1;
1025
- appliedUpdateData?: SubscriptionUpdateData$1;
1026
- }
1027
- declare enum UpdateAction$1 {
1028
- NONE = "NONE",
1029
- /** Update subscription immediately, please note proration for updates changing price are not yet supported */
1030
- IMMEDIATELY = "IMMEDIATELY",
1031
- /** Request updates that will take affect only at the start of the next billing cycle. */
1032
- NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
1033
- /** Reset all pending updates */
1034
- RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
1035
- /** Request updates that will take affect only at a specific date. */
1036
- SPECIFIC_DATE = "SPECIFIC_DATE"
1037
- }
1038
- interface ResetPendingUpdates$1 {
1039
- subscription?: Subscription$1;
1040
- }
1041
- interface GracePeriodStarted$1 {
1042
- subscription?: Subscription$1;
1043
- }
1044
- interface GracePeriodEnded$1 {
1045
- subscription?: Subscription$1;
1046
- /** Indication for the payment settlement method. */
1047
- paymentSettlementMethod?: PaymentSettlementMethod$1;
1048
- }
1049
- declare enum PaymentSettlementMethod$1 {
1050
- UNKNOWN = "UNKNOWN",
1051
- /** System-defined payment settlement. */
1052
- SYSTEM = "SYSTEM",
1053
- /** Manually mark the payment as paid. */
1054
- MARK_AS_PAID = "MARK_AS_PAID",
1055
- /** Require the customer to pay immediately, by insert a new payment method. */
1056
- CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
1057
- }
1058
- interface PaymentMethodUpdated$1 {
1059
- subscription?: Subscription$1;
1060
- initiator?: HistoryActionInitiator$1;
1061
- paymentMode?: PaymentMode$1;
1062
- }
1063
- declare enum PaymentMode$1 {
1064
- NONE = "NONE",
1065
- /** The latest invoice of the subscription will be charged. */
1066
- CHARGE = "CHARGE",
1067
- /** An authorization invoice with zero amount will be created. */
1068
- AUTHORIZATION = "AUTHORIZATION"
1069
- }
1070
- interface SubscriptionCollectionMethodUpdated$1 {
1071
- subscription?: Subscription$1;
1072
- newCollectionMethod?: CollectionMethodEnumCollectionMethod$1;
1073
- previousCollectionMethod?: CollectionMethodEnumCollectionMethod$1;
1074
- }
1075
- interface FreeTrailStarted$1 {
1076
- subscription?: Subscription$1;
923
+ declare enum SortOrder$1 {
924
+ ASC = "ASC",
925
+ DESC = "DESC"
1077
926
  }
1078
- interface FreeTrailEnded$1 {
1079
- subscription?: Subscription$1;
927
+ interface Paging$1 {
928
+ /** Number of items to load. */
929
+ limit?: number | null;
930
+ /** Number of items to skip in the current sort order. */
931
+ offset?: number | null;
1080
932
  }
1081
- interface SubscriptionBackOfficeAction$1 {
1082
- subscription?: Subscription$1;
1083
- /** The backoffice method name */
1084
- name?: string;
1085
- /** json as string format, to store the flatted request object */
1086
- params?: string;
933
+ interface CursorPaging$1 {
934
+ /** Maximum number of items to return in the results. */
935
+ limit?: number | null;
936
+ /**
937
+ * Pointer to the next or previous page in the list of results.
938
+ *
939
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
940
+ * Not relevant for the first request.
941
+ */
942
+ cursor?: string | null;
1087
943
  }
1088
- /** Defines unknown events restored from the logs */
1089
- interface UnknownSubscriptionEvent$1 {
1090
- subscriptionAsString?: string | null;
944
+ interface QuerySubscriptionsResponse$1 {
945
+ subscriptions?: Subscription$1[];
946
+ metadata?: PagingMetadataV2$1;
1091
947
  }
1092
948
  interface PagingMetadataV2$1 {
1093
949
  /** Number of items returned in the response. */
@@ -1107,100 +963,6 @@ interface Cursors$1 {
1107
963
  /** Cursor pointing to the previous page in the list of results. */
1108
964
  prev?: string | null;
1109
965
  }
1110
- interface GetSubscriptionRequest$1 {
1111
- id: string;
1112
- }
1113
- interface GetSubscriptionResponse$1 {
1114
- subscription?: Subscription$1;
1115
- }
1116
- interface CustomerCancelSubscriptionRequest$1 {
1117
- id: string;
1118
- /** Optional action reason message */
1119
- reason?: string | null;
1120
- }
1121
- interface CustomerCancelSubscriptionResponse$1 {
1122
- subscription?: Subscription$1;
1123
- }
1124
- interface CustomerTurnOnAutoRenewalRequest$1 {
1125
- id: string;
1126
- /** Optional action reason message */
1127
- reason?: string | null;
1128
- }
1129
- interface CustomerTurnOnAutoRenewalResponse$1 {
1130
- subscription?: Subscription$1;
1131
- }
1132
- interface CustomerTurnOffAutoRenewalRequest$1 {
1133
- id: string;
1134
- /** Optional action reason message */
1135
- reason?: string | null;
1136
- }
1137
- interface CustomerTurnOffAutoRenewalResponse$1 {
1138
- subscription?: Subscription$1;
1139
- }
1140
- interface CustomerExtendSubscriptionRequest$1 {
1141
- /** The ID of the subscription to be extended */
1142
- id: string;
1143
- /** Optional action reason message */
1144
- reason?: string | null;
1145
- /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
1146
- billingCyclesToAdd: number | null;
1147
- }
1148
- interface CustomerExtendSubscriptionResponse$1 {
1149
- /** The now extended subscription */
1150
- subscription?: Subscription$1;
1151
- }
1152
- interface QuerySubscriptionsRequest$1 {
1153
- query?: QueryV2$1;
1154
- }
1155
- interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
1156
- /** Paging options to limit and skip the number of items. */
1157
- paging?: Paging$1;
1158
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1159
- cursorPaging?: CursorPaging$1;
1160
- /**
1161
- * Filter object.
1162
- *
1163
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1164
- */
1165
- filter?: Record<string, any> | null;
1166
- /**
1167
- * Sort object.
1168
- *
1169
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1170
- */
1171
- sort?: Sorting$1[];
1172
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
1173
- fields?: string[];
1174
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
1175
- fieldsets?: string[];
1176
- }
1177
- /** @oneof */
1178
- interface QueryV2PagingMethodOneOf$1 {
1179
- /** Paging options to limit and skip the number of items. */
1180
- paging?: Paging$1;
1181
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1182
- cursorPaging?: CursorPaging$1;
1183
- }
1184
- interface Sorting$1 {
1185
- /** Name of the field to sort by. */
1186
- fieldName?: string;
1187
- /** Sort order. */
1188
- order?: SortOrder$1;
1189
- }
1190
- declare enum SortOrder$1 {
1191
- ASC = "ASC",
1192
- DESC = "DESC"
1193
- }
1194
- interface Paging$1 {
1195
- /** Number of items to load. */
1196
- limit?: number | null;
1197
- /** Number of items to skip in the current sort order. */
1198
- offset?: number | null;
1199
- }
1200
- interface QuerySubscriptionsResponse$1 {
1201
- subscriptions?: Subscription$1[];
1202
- metadata?: PagingMetadataV2$1;
1203
- }
1204
966
  interface CountSubscriptionsRequest$1 {
1205
967
  /** Filters to specify which subscriptions are counted. */
1206
968
  filter?: CountSubscriptionFilter$1;
@@ -1504,6 +1266,13 @@ interface InitiatePaymentMethodSetupRequest$1 {
1504
1266
  paymentMode?: PaymentMode$1;
1505
1267
  paymentSettings?: PaymentSettings$1;
1506
1268
  }
1269
+ declare enum PaymentMode$1 {
1270
+ NONE = "NONE",
1271
+ /** The latest invoice of the subscription will be charged. */
1272
+ CHARGE = "CHARGE",
1273
+ /** An authorization invoice with zero amount will be created. */
1274
+ AUTHORIZATION = "AUTHORIZATION"
1275
+ }
1507
1276
  interface PaymentSettings$1 {
1508
1277
  /** Allowed payment providers for Subscriptions, for example to limit subscriptions to be created only with "Wix Payments" provider. */
1509
1278
  allowedProviderIds?: string[];
@@ -1546,6 +1315,64 @@ interface PaymentOrigin$1 {
1546
1315
  interface InitiatePaymentMethodSetupResponse$1 {
1547
1316
  paymentOrderId?: string;
1548
1317
  }
1318
+ interface PayCycleRequest$1 {
1319
+ subscriptionId: string;
1320
+ paymentTestMode?: PaymentTestMode$1;
1321
+ tenantId: string;
1322
+ }
1323
+ declare enum PaymentTestMode$1 {
1324
+ REGULAR = "REGULAR",
1325
+ FAIL_TECHNICAL = "FAIL_TECHNICAL",
1326
+ FAIL_DECLINE = "FAIL_DECLINE",
1327
+ FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
1328
+ }
1329
+ interface PayCycleResponse$1 {
1330
+ invoiceId?: string;
1331
+ paymentOrderId?: string | null;
1332
+ subscription?: Subscription$1;
1333
+ }
1334
+ declare enum ActionInitiator$1 {
1335
+ UNDEFINED = "UNDEFINED",
1336
+ BUSINESS = "BUSINESS",
1337
+ CUSTOMER = "CUSTOMER",
1338
+ SYSTEM = "SYSTEM"
1339
+ }
1340
+ interface SubscriptionBillingCycleStarted$1 {
1341
+ subscription?: Subscription$1;
1342
+ /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
1343
+ paymentTransactionId?: string | null;
1344
+ }
1345
+ /**
1346
+ * Sent each time a subscription status has been set to Active
1347
+ * Active shows that a subscription is live and operational.
1348
+ * For example:
1349
+ * * For subscription with free trial, free trial start date is also the activation date.
1350
+ * * For a subscription with future start date, the start date is also the activation date.
1351
+ * * When a subscription is resumed from a pause status, the resume date is also the activation date.
1352
+ */
1353
+ interface SubscriptionActivated$1 {
1354
+ subscription?: Subscription$1;
1355
+ }
1356
+ /**
1357
+ * Sent each time a subscription status has been set to Ended
1358
+ * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
1359
+ * This is different from a Canceled subscription which ends the subscription before a designated end date.
1360
+ * Therefore, Ended and Canceled are mutually exclusive.
1361
+ */
1362
+ interface SubscriptionEnded$1 {
1363
+ subscription?: Subscription$1;
1364
+ }
1365
+ interface SubscriptionInitialPurchaseCompleted$1 {
1366
+ subscription?: Subscription$1;
1367
+ actionDetails?: ActionDetails$1;
1368
+ paymentTransactionId?: string | null;
1369
+ }
1370
+ interface SubscriptionCycleReadyToPay$1 {
1371
+ subscription?: Subscription$1;
1372
+ }
1373
+ interface SubscriptionRevived$1 {
1374
+ subscription?: Subscription$1;
1375
+ }
1549
1376
  interface UpdateSubscriptionBillingDateRequest$1 {
1550
1377
  /** ID of the subscription to update the billing date for. */
1551
1378
  id: string;
@@ -1566,12 +1393,28 @@ interface UpdateSubscriptionBillingDateResponse$1 {
1566
1393
  /** Updated subscription. */
1567
1394
  subscription?: Subscription$1;
1568
1395
  }
1569
- interface ScheduleAdditionalInfo$1 extends ScheduleAdditionalInfoParamOneOf$1 {
1570
- /**
1571
- * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
1572
- * format. The use of this field may be restricted in various BASS endpoints.
1573
- * For example, in _Bulk Update Subscription Items_ it's only available in
1574
- * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
1396
+ interface SubscriptionBillingDateUpdated$1 {
1397
+ subscription?: Subscription$1;
1398
+ billingDate?: Date | null;
1399
+ proration?: Proration$1;
1400
+ }
1401
+ declare enum UpdateAction$1 {
1402
+ NONE = "NONE",
1403
+ /** Update subscription immediately, please note proration for updates changing price are not yet supported */
1404
+ IMMEDIATELY = "IMMEDIATELY",
1405
+ /** Request updates that will take affect only at the start of the next billing cycle. */
1406
+ NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
1407
+ /** Reset all pending updates */
1408
+ RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
1409
+ /** Request updates that will take affect only at a specific date. */
1410
+ SPECIFIC_DATE = "SPECIFIC_DATE"
1411
+ }
1412
+ interface ScheduleAdditionalInfo$1 extends ScheduleAdditionalInfoParamOneOf$1 {
1413
+ /**
1414
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
1415
+ * format. The use of this field may be restricted in various BASS endpoints.
1416
+ * For example, in _Bulk Update Subscription Items_ it's only available in
1417
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
1575
1418
  * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
1576
1419
  * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
1577
1420
  */
@@ -1614,12 +1457,6 @@ interface ActionContext$1 {
1614
1457
  /** Optional action reason message */
1615
1458
  reason?: string | null;
1616
1459
  }
1617
- declare enum ActionInitiator$1 {
1618
- UNDEFINED = "UNDEFINED",
1619
- BUSINESS = "BUSINESS",
1620
- CUSTOMER = "CUSTOMER",
1621
- SYSTEM = "SYSTEM"
1622
- }
1623
1460
  interface CancelSubscriptionResponse$1 {
1624
1461
  subscription?: Subscription$1;
1625
1462
  }
@@ -1636,6 +1473,21 @@ interface PauseSubscriptionRequest$1 {
1636
1473
  interface PauseSubscriptionResponse$1 {
1637
1474
  subscription?: Subscription$1;
1638
1475
  }
1476
+ interface SubscriptionPaused$1 {
1477
+ subscription?: Subscription$1;
1478
+ pausePolicy?: PausePolicy$1;
1479
+ actionDetails?: ActionDetails$1;
1480
+ }
1481
+ interface PauseSubscriptionRequested$1 {
1482
+ subscription?: Subscription$1;
1483
+ pauseAt?: PauseAt$1;
1484
+ pausePolicy?: PausePolicy$1;
1485
+ actionDetails?: ActionDetails$1;
1486
+ }
1487
+ interface ScheduledPauseCanceled$1 {
1488
+ subscription?: Subscription$1;
1489
+ actionDetails?: ActionDetails$1;
1490
+ }
1639
1491
  interface ResumeSubscriptionRequest$1 {
1640
1492
  id: string;
1641
1493
  resumeAt?: ResumeAt$1;
@@ -1646,6 +1498,19 @@ interface ResumeSubscriptionRequest$1 {
1646
1498
  interface ResumeSubscriptionResponse$1 {
1647
1499
  subscription?: Subscription$1;
1648
1500
  }
1501
+ interface SubscriptionResumed$1 {
1502
+ subscription?: Subscription$1;
1503
+ actionDetails?: ActionDetails$1;
1504
+ }
1505
+ interface ResumeSubscriptionRequested$1 {
1506
+ subscription?: Subscription$1;
1507
+ resumeAt?: ResumeAt$1;
1508
+ actionDetails?: ActionDetails$1;
1509
+ }
1510
+ interface ScheduledResumeCanceled$1 {
1511
+ subscription?: Subscription$1;
1512
+ actionDetails?: ActionDetails$1;
1513
+ }
1649
1514
  interface SearchSubscriptionsRequest$1 extends SearchSubscriptionsRequestPagingMethodOneOf$1 {
1650
1515
  /** Limit number of results and enable to skip rows. The default limit is 25. */
1651
1516
  paging?: Paging$1;
@@ -1677,6 +1542,10 @@ interface TurnOnSubscriptionAutoRenewalRequest$1 {
1677
1542
  interface TurnOnSubscriptionAutoRenewalResponse$1 {
1678
1543
  subscription?: Subscription$1;
1679
1544
  }
1545
+ interface SubscriptionAutoRenewalTurnedOn$1 {
1546
+ subscription?: Subscription$1;
1547
+ actionDetails?: ActionDetails$1;
1548
+ }
1680
1549
  interface TurnOffSubscriptionAutoRenewalRequest$1 {
1681
1550
  id: string;
1682
1551
  actionContext: ActionContext$1;
@@ -1684,6 +1553,10 @@ interface TurnOffSubscriptionAutoRenewalRequest$1 {
1684
1553
  interface TurnOffSubscriptionAutoRenewalResponse$1 {
1685
1554
  subscription?: Subscription$1;
1686
1555
  }
1556
+ interface SubscriptionAutoRenewalTurnedOff$1 {
1557
+ subscription?: Subscription$1;
1558
+ actionDetails?: ActionDetails$1;
1559
+ }
1687
1560
  interface MarkLatestInvoiceAsPaidRequest$1 {
1688
1561
  /** The ID of the offline subscription to mark as paid its latest invoice */
1689
1562
  subscriptionId: string;
@@ -1691,6 +1564,9 @@ interface MarkLatestInvoiceAsPaidRequest$1 {
1691
1564
  interface MarkLatestInvoiceAsPaidResponse$1 {
1692
1565
  subscription?: Subscription$1;
1693
1566
  }
1567
+ interface LatestInvoiceMarkedAsPaid$1 {
1568
+ subscription?: Subscription$1;
1569
+ }
1694
1570
  interface GetSubscriptionsStatsRequest$1 {
1695
1571
  }
1696
1572
  interface GetSubscriptionsStatsResponse$1 {
@@ -1793,6 +1669,19 @@ interface Charge$1 {
1793
1669
  interface PreviewSubscriptionsChargesRequest$1 {
1794
1670
  /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
1795
1671
  subscriptionsBillingDetails?: SubscriptionBillingDetails$1[];
1672
+ /**
1673
+ * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
1674
+ * For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
1675
+ * $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
1676
+ * - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
1677
+ * - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
1678
+ * - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
1679
+ * If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
1680
+ * in this case, charges for cycle 1 through 3.
1681
+ * If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
1682
+ * then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
1683
+ */
1684
+ numberOfNextRecurringCharges?: number | null;
1796
1685
  }
1797
1686
  interface SubscriptionBillingDetails$1 {
1798
1687
  /** External identifier of the subscription */
@@ -1816,21 +1705,173 @@ interface SubscriptionCharges$1 {
1816
1705
  /** Charges for subscription. */
1817
1706
  charges?: Charge$1[];
1818
1707
  }
1819
- interface PayCycleRequest$1 {
1708
+ interface ListSubscriptionHistoryRequest$1 {
1820
1709
  subscriptionId: string;
1821
- paymentTestMode?: PaymentTestMode$1;
1822
- tenantId: string;
1710
+ /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
1711
+ mode?: HistoryViewMode$1;
1712
+ /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
1713
+ cursor?: CursorPaging$1;
1823
1714
  }
1824
- declare enum PaymentTestMode$1 {
1825
- REGULAR = "REGULAR",
1826
- FAIL_TECHNICAL = "FAIL_TECHNICAL",
1827
- FAIL_DECLINE = "FAIL_DECLINE",
1828
- FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
1715
+ declare enum HistoryViewMode$1 {
1716
+ UNKNOWN = "UNKNOWN",
1717
+ /** Comprehensive view including all history events. */
1718
+ BACKOFFICE = "BACKOFFICE",
1719
+ /** User-centric view of the history. */
1720
+ USER = "USER"
1829
1721
  }
1830
- interface PayCycleResponse$1 {
1831
- invoiceId?: string;
1832
- paymentOrderId?: string | null;
1722
+ interface ListSubscriptionHistoryResponse$1 {
1723
+ /** List of history entries for the subscription. */
1724
+ historyEntries?: SubscriptionHistoryEntry$1[];
1725
+ /** Paging metadata. A `next` cursor is returned if there are more results. */
1726
+ pagingMetadata?: PagingMetadataV2$1;
1727
+ }
1728
+ interface SubscriptionHistoryEntry$1 {
1729
+ entryId?: string;
1730
+ /** TODO: add max length? it is not defined in domainevents, so should we? */
1731
+ slug?: string;
1732
+ entryTime?: Date | null;
1733
+ event?: SubscriptionEvent$1;
1734
+ }
1735
+ interface SubscriptionEvent$1 extends SubscriptionEventPayloadOneOf$1 {
1736
+ created?: SubscriptionCreated$1;
1737
+ updated?: SubscriptionUpdated$1;
1738
+ deleted?: SubscriptionDeleted$1;
1739
+ activated?: SubscriptionActivated$1;
1740
+ ended?: SubscriptionEnded$1;
1741
+ canceled?: SubscriptionCanceled$1;
1742
+ paused?: SubscriptionPaused$1;
1743
+ resumed?: SubscriptionResumed$1;
1744
+ pauseRequested?: PauseSubscriptionRequested$1;
1745
+ resumeRequested?: ResumeSubscriptionRequested$1;
1746
+ scheduledPauseCanceled?: ScheduledPauseCanceled$1;
1747
+ scheduledResumeCanceled?: ScheduledResumeCanceled$1;
1748
+ billingCycleStarted?: SubscriptionBillingCycleStarted$1;
1749
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn$1;
1750
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff$1;
1751
+ cycleReadyToPay?: SubscriptionCycleReadyToPay$1;
1752
+ extended?: SubscriptionExtended$1;
1753
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted$1;
1754
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid$1;
1755
+ revived?: SubscriptionRevived$1;
1756
+ billingDateUpdated?: SubscriptionBillingDateUpdated$1;
1757
+ futureUpdatesRequested?: FutureUpdatesRequested$1;
1758
+ updatesApplied?: UpdatesApplied$1;
1759
+ resetPendingUpdates?: ResetPendingUpdates$1;
1760
+ gracePeriodStarted?: GracePeriodStarted$1;
1761
+ gracePeriodEnded?: GracePeriodEnded$1;
1762
+ paymentMethodUpdated?: PaymentMethodUpdated$1;
1763
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated$1;
1764
+ freeTrailStarted?: FreeTrailStarted$1;
1765
+ freeTrailEnded?: FreeTrailEnded$1;
1766
+ subscriptionBoAction?: SubscriptionBackOfficeAction$1;
1767
+ unknown?: UnknownSubscriptionEvent$1;
1768
+ }
1769
+ /** @oneof */
1770
+ interface SubscriptionEventPayloadOneOf$1 {
1771
+ created?: SubscriptionCreated$1;
1772
+ updated?: SubscriptionUpdated$1;
1773
+ deleted?: SubscriptionDeleted$1;
1774
+ activated?: SubscriptionActivated$1;
1775
+ ended?: SubscriptionEnded$1;
1776
+ canceled?: SubscriptionCanceled$1;
1777
+ paused?: SubscriptionPaused$1;
1778
+ resumed?: SubscriptionResumed$1;
1779
+ pauseRequested?: PauseSubscriptionRequested$1;
1780
+ resumeRequested?: ResumeSubscriptionRequested$1;
1781
+ scheduledPauseCanceled?: ScheduledPauseCanceled$1;
1782
+ scheduledResumeCanceled?: ScheduledResumeCanceled$1;
1783
+ billingCycleStarted?: SubscriptionBillingCycleStarted$1;
1784
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn$1;
1785
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff$1;
1786
+ cycleReadyToPay?: SubscriptionCycleReadyToPay$1;
1787
+ extended?: SubscriptionExtended$1;
1788
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted$1;
1789
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid$1;
1790
+ revived?: SubscriptionRevived$1;
1791
+ billingDateUpdated?: SubscriptionBillingDateUpdated$1;
1792
+ futureUpdatesRequested?: FutureUpdatesRequested$1;
1793
+ updatesApplied?: UpdatesApplied$1;
1794
+ resetPendingUpdates?: ResetPendingUpdates$1;
1795
+ gracePeriodStarted?: GracePeriodStarted$1;
1796
+ gracePeriodEnded?: GracePeriodEnded$1;
1797
+ paymentMethodUpdated?: PaymentMethodUpdated$1;
1798
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated$1;
1799
+ freeTrailStarted?: FreeTrailStarted$1;
1800
+ freeTrailEnded?: FreeTrailEnded$1;
1801
+ subscriptionBoAction?: SubscriptionBackOfficeAction$1;
1802
+ unknown?: UnknownSubscriptionEvent$1;
1803
+ }
1804
+ interface SubscriptionCreated$1 {
1805
+ subscription?: Subscription$1;
1806
+ }
1807
+ interface SubscriptionUpdated$1 {
1808
+ current?: Subscription$1;
1809
+ previous?: Subscription$1;
1810
+ diff?: SubscriptionDiff$1;
1811
+ }
1812
+ interface SubscriptionDiff$1 {
1813
+ added?: string | null;
1814
+ changed?: string | null;
1815
+ deleted?: string | null;
1816
+ }
1817
+ interface SubscriptionDeleted$1 {
1818
+ subscriptionId?: string;
1819
+ }
1820
+ interface FutureUpdatesRequested$1 {
1821
+ subscription?: Subscription$1;
1822
+ requestedUpdateData?: SubscriptionUpdateData$1;
1823
+ }
1824
+ interface UpdatesApplied$1 {
1825
+ subscription?: Subscription$1;
1826
+ updateAction?: UpdateAction$1;
1827
+ appliedUpdateData?: SubscriptionUpdateData$1;
1828
+ }
1829
+ interface ResetPendingUpdates$1 {
1830
+ subscription?: Subscription$1;
1831
+ }
1832
+ interface GracePeriodStarted$1 {
1833
+ subscription?: Subscription$1;
1834
+ }
1835
+ interface GracePeriodEnded$1 {
1836
+ subscription?: Subscription$1;
1837
+ /** Indication for the payment settlement method. */
1838
+ paymentSettlementMethod?: PaymentSettlementMethod$1;
1839
+ }
1840
+ declare enum PaymentSettlementMethod$1 {
1841
+ UNKNOWN = "UNKNOWN",
1842
+ /** System-defined payment settlement. */
1843
+ SYSTEM = "SYSTEM",
1844
+ /** Manually mark the payment as paid. */
1845
+ MARK_AS_PAID = "MARK_AS_PAID",
1846
+ /** Require the customer to pay immediately, by insert a new payment method. */
1847
+ CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
1848
+ }
1849
+ interface PaymentMethodUpdated$1 {
1850
+ subscription?: Subscription$1;
1851
+ initiator?: HistoryActionInitiator$1;
1852
+ paymentMode?: PaymentMode$1;
1853
+ }
1854
+ interface SubscriptionCollectionMethodUpdated$1 {
1833
1855
  subscription?: Subscription$1;
1856
+ newCollectionMethod?: CollectionMethodEnumCollectionMethod$1;
1857
+ previousCollectionMethod?: CollectionMethodEnumCollectionMethod$1;
1858
+ }
1859
+ interface FreeTrailStarted$1 {
1860
+ subscription?: Subscription$1;
1861
+ }
1862
+ interface FreeTrailEnded$1 {
1863
+ subscription?: Subscription$1;
1864
+ }
1865
+ interface SubscriptionBackOfficeAction$1 {
1866
+ subscription?: Subscription$1;
1867
+ /** The backoffice method name */
1868
+ name?: string;
1869
+ /** json as string format, to store the flatted request object */
1870
+ params?: string;
1871
+ }
1872
+ /** Defines unknown events restored from the logs */
1873
+ interface UnknownSubscriptionEvent$1 {
1874
+ subscriptionAsString?: string | null;
1834
1875
  }
1835
1876
  interface CustomerNonNullableFields$1 {
1836
1877
  visitorId: string;
@@ -1865,11 +1906,15 @@ interface TaxNonNullableFields$1 {
1865
1906
  percentage: string;
1866
1907
  dynamic?: DynamicTaxNonNullableFields$1;
1867
1908
  }
1909
+ interface CyclesNonNullableFields$1 {
1910
+ cycleFrom: number;
1911
+ }
1868
1912
  interface AdditionalFeeNonNullableFields$1 {
1869
1913
  name: string;
1870
1914
  amount: string;
1871
1915
  trigger: AdditionalFeeTrigger$1;
1872
1916
  tax?: TaxNonNullableFields$1;
1917
+ cycles?: CyclesNonNullableFields$1;
1873
1918
  }
1874
1919
  interface DiscountCyclesNonNullableFields$1 {
1875
1920
  cycleFrom: number;
@@ -2001,17 +2046,177 @@ interface SubscriptionNonNullableFields$1 {
2001
2046
  specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields$1;
2002
2047
  items: ItemNonNullableFields$1[];
2003
2048
  }
2004
- interface SubscriptionCreatedNonNullableFields$1 {
2049
+ interface GetSubscriptionResponseNonNullableFields$1 {
2005
2050
  subscription?: SubscriptionNonNullableFields$1;
2006
2051
  }
2007
- interface SubscriptionUpdatedNonNullableFields$1 {
2008
- current?: SubscriptionNonNullableFields$1;
2009
- previous?: SubscriptionNonNullableFields$1;
2010
- }
2011
- interface SubscriptionDeletedNonNullableFields$1 {
2012
- subscriptionId: string;
2013
- }
2014
- interface SubscriptionActivatedNonNullableFields$1 {
2052
+ interface CustomerCancelSubscriptionResponseNonNullableFields$1 {
2053
+ subscription?: SubscriptionNonNullableFields$1;
2054
+ }
2055
+ interface CustomerTurnOnAutoRenewalResponseNonNullableFields$1 {
2056
+ subscription?: SubscriptionNonNullableFields$1;
2057
+ }
2058
+ interface CustomerTurnOffAutoRenewalResponseNonNullableFields$1 {
2059
+ subscription?: SubscriptionNonNullableFields$1;
2060
+ }
2061
+ interface CustomerExtendSubscriptionResponseNonNullableFields$1 {
2062
+ subscription?: SubscriptionNonNullableFields$1;
2063
+ }
2064
+ interface QuerySubscriptionsResponseNonNullableFields$1 {
2065
+ subscriptions: SubscriptionNonNullableFields$1[];
2066
+ }
2067
+ interface UpdateSubscriptionPaymentMethodResponseNonNullableFields$1 {
2068
+ subscription?: SubscriptionNonNullableFields$1;
2069
+ }
2070
+ interface ActionNonNullableFields$1 {
2071
+ actionType: ActionType$1;
2072
+ pausePolicies: PausePolicy$1[];
2073
+ pauseAt: PauseAt$1[];
2074
+ resumeAt: ResumeAt$1[];
2075
+ extendPolicies: ExtendPolicyType$1[];
2076
+ }
2077
+ interface CustomerAllowedActionsResponseNonNullableFields$1 {
2078
+ actions: ActionNonNullableFields$1[];
2079
+ }
2080
+ interface RecurringNonNullableFields$1 {
2081
+ cycleNumber: number;
2082
+ }
2083
+ interface InvoiceDiscountNonNullableFields$1 {
2084
+ amount: string;
2085
+ percentage: string;
2086
+ origin?: DiscountOriginNonNullableFields$1;
2087
+ }
2088
+ interface InvoiceApplicationFeeNonNullableFields$1 {
2089
+ amount: string;
2090
+ discount?: InvoiceDiscountNonNullableFields$1;
2091
+ }
2092
+ interface PriceDetailsNonNullableFields$1 {
2093
+ price: string;
2094
+ tax?: TaxNonNullableFields$1;
2095
+ discount?: InvoiceDiscountNonNullableFields$1;
2096
+ applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields$1;
2097
+ }
2098
+ interface LineItemTaxSummaryNonNullableFields$1 {
2099
+ aggregatedTaxAmount: string;
2100
+ aggregatedTaxRate: string;
2101
+ taxableAmount: string;
2102
+ }
2103
+ interface TaxBreakdownNonNullableFields$1 {
2104
+ taxType: string;
2105
+ taxRate: string;
2106
+ jurisdictionType: string;
2107
+ }
2108
+ interface ItemTaxDataNonNullableFields$1 {
2109
+ lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields$1;
2110
+ taxBreakdowns: TaxBreakdownNonNullableFields$1[];
2111
+ }
2112
+ interface InvoiceItemNonNullableFields$1 {
2113
+ recurring?: RecurringNonNullableFields$1;
2114
+ id: string;
2115
+ name: string;
2116
+ catalogReference?: CatalogReferenceNonNullableFields$1;
2117
+ category: ItemCategory$1;
2118
+ quantity: number;
2119
+ priceDetails?: PriceDetailsNonNullableFields$1;
2120
+ totals?: TotalsNonNullableFields$1;
2121
+ taxData?: ItemTaxDataNonNullableFields$1;
2122
+ }
2123
+ interface SubscriptionChargeNonNullableFields$1 {
2124
+ cycle: number;
2125
+ totals?: TotalsNonNullableFields$1;
2126
+ invoiceItems: InvoiceItemNonNullableFields$1[];
2127
+ discount?: InvoiceDiscountNonNullableFields$1;
2128
+ }
2129
+ interface CustomerListUpcomingChargesResponseNonNullableFields$1 {
2130
+ upcomingCharge?: SubscriptionChargeNonNullableFields$1;
2131
+ }
2132
+ interface InitiatePaymentMethodSetupResponseNonNullableFields$1 {
2133
+ paymentOrderId: string;
2134
+ }
2135
+ interface PayCycleResponseNonNullableFields$1 {
2136
+ invoiceId: string;
2137
+ subscription?: SubscriptionNonNullableFields$1;
2138
+ }
2139
+ interface UpdateSubscriptionBillingDateResponseNonNullableFields$1 {
2140
+ subscription?: SubscriptionNonNullableFields$1;
2141
+ }
2142
+ interface CancelSubscriptionResponseNonNullableFields$1 {
2143
+ subscription?: SubscriptionNonNullableFields$1;
2144
+ }
2145
+ interface PauseSubscriptionResponseNonNullableFields$1 {
2146
+ subscription?: SubscriptionNonNullableFields$1;
2147
+ }
2148
+ interface ResumeSubscriptionResponseNonNullableFields$1 {
2149
+ subscription?: SubscriptionNonNullableFields$1;
2150
+ }
2151
+ interface SearchSubscriptionsResponseNonNullableFields$1 {
2152
+ subscriptions: SubscriptionNonNullableFields$1[];
2153
+ }
2154
+ interface CountByStatusNonNullableFields$1 {
2155
+ status: SubscriptionStatusEnumSubscriptionStatus$1;
2156
+ count: number;
2157
+ }
2158
+ interface CountSubscriptionsResponseNonNullableFields$1 {
2159
+ countByStatus: CountByStatusNonNullableFields$1[];
2160
+ total: number;
2161
+ }
2162
+ interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields$1 {
2163
+ subscription?: SubscriptionNonNullableFields$1;
2164
+ }
2165
+ interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields$1 {
2166
+ subscription?: SubscriptionNonNullableFields$1;
2167
+ }
2168
+ interface MarkLatestInvoiceAsPaidResponseNonNullableFields$1 {
2169
+ subscription?: SubscriptionNonNullableFields$1;
2170
+ }
2171
+ interface AmountByStatusNonNullableFields$1 {
2172
+ status: SubscriptionStatusEnumSubscriptionStatus$1;
2173
+ amount: number;
2174
+ }
2175
+ interface GetSubscriptionsStatsResponseNonNullableFields$1 {
2176
+ amountByStatuses: AmountByStatusNonNullableFields$1[];
2177
+ total: number;
2178
+ }
2179
+ interface ExtendSubscriptionResponseNonNullableFields$1 {
2180
+ subscription?: SubscriptionNonNullableFields$1;
2181
+ }
2182
+ interface UnsupportedReasonNonNullableFields$1 {
2183
+ code: string;
2184
+ }
2185
+ interface UnsupportedActionNonNullableFields$1 {
2186
+ actionType: ActionType$1;
2187
+ reasons: UnsupportedReasonNonNullableFields$1[];
2188
+ }
2189
+ interface AllowedActionsResponseNonNullableFields$1 {
2190
+ actions: ActionNonNullableFields$1[];
2191
+ unsupportedActions: UnsupportedActionNonNullableFields$1[];
2192
+ }
2193
+ interface ListUpcomingChargesResponseNonNullableFields$1 {
2194
+ upcomingCharges: SubscriptionChargeNonNullableFields$1[];
2195
+ }
2196
+ interface ChargeNonNullableFields$1 {
2197
+ cycleFrom: number;
2198
+ totals?: TotalsNonNullableFields$1;
2199
+ }
2200
+ interface PreviewSubscriptionChargesResponseNonNullableFields$1 {
2201
+ charges: ChargeNonNullableFields$1[];
2202
+ }
2203
+ interface SubscriptionChargesNonNullableFields$1 {
2204
+ charges: ChargeNonNullableFields$1[];
2205
+ }
2206
+ interface PreviewSubscriptionsChargesResponseNonNullableFields$1 {
2207
+ subscriptionsCharges: SubscriptionChargesNonNullableFields$1[];
2208
+ }
2209
+ interface SubscriptionCreatedNonNullableFields$1 {
2210
+ subscription?: SubscriptionNonNullableFields$1;
2211
+ }
2212
+ interface SubscriptionUpdatedNonNullableFields$1 {
2213
+ current?: SubscriptionNonNullableFields$1;
2214
+ previous?: SubscriptionNonNullableFields$1;
2215
+ }
2216
+ interface SubscriptionDeletedNonNullableFields$1 {
2217
+ subscriptionId: string;
2218
+ }
2219
+ interface SubscriptionActivatedNonNullableFields$1 {
2015
2220
  subscription?: SubscriptionNonNullableFields$1;
2016
2221
  }
2017
2222
  interface SubscriptionEndedNonNullableFields$1 {
@@ -2167,166 +2372,6 @@ interface SubscriptionHistoryEntryNonNullableFields$1 {
2167
2372
  interface ListSubscriptionHistoryResponseNonNullableFields$1 {
2168
2373
  historyEntries: SubscriptionHistoryEntryNonNullableFields$1[];
2169
2374
  }
2170
- interface GetSubscriptionResponseNonNullableFields$1 {
2171
- subscription?: SubscriptionNonNullableFields$1;
2172
- }
2173
- interface CustomerCancelSubscriptionResponseNonNullableFields$1 {
2174
- subscription?: SubscriptionNonNullableFields$1;
2175
- }
2176
- interface CustomerTurnOnAutoRenewalResponseNonNullableFields$1 {
2177
- subscription?: SubscriptionNonNullableFields$1;
2178
- }
2179
- interface CustomerTurnOffAutoRenewalResponseNonNullableFields$1 {
2180
- subscription?: SubscriptionNonNullableFields$1;
2181
- }
2182
- interface CustomerExtendSubscriptionResponseNonNullableFields$1 {
2183
- subscription?: SubscriptionNonNullableFields$1;
2184
- }
2185
- interface QuerySubscriptionsResponseNonNullableFields$1 {
2186
- subscriptions: SubscriptionNonNullableFields$1[];
2187
- }
2188
- interface UpdateSubscriptionPaymentMethodResponseNonNullableFields$1 {
2189
- subscription?: SubscriptionNonNullableFields$1;
2190
- }
2191
- interface ActionNonNullableFields$1 {
2192
- actionType: ActionType$1;
2193
- pausePolicies: PausePolicy$1[];
2194
- pauseAt: PauseAt$1[];
2195
- resumeAt: ResumeAt$1[];
2196
- extendPolicies: ExtendPolicyType$1[];
2197
- }
2198
- interface CustomerAllowedActionsResponseNonNullableFields$1 {
2199
- actions: ActionNonNullableFields$1[];
2200
- }
2201
- interface RecurringNonNullableFields$1 {
2202
- cycleNumber: number;
2203
- }
2204
- interface InvoiceDiscountNonNullableFields$1 {
2205
- amount: string;
2206
- percentage: string;
2207
- origin?: DiscountOriginNonNullableFields$1;
2208
- }
2209
- interface InvoiceApplicationFeeNonNullableFields$1 {
2210
- amount: string;
2211
- discount?: InvoiceDiscountNonNullableFields$1;
2212
- }
2213
- interface PriceDetailsNonNullableFields$1 {
2214
- price: string;
2215
- tax?: TaxNonNullableFields$1;
2216
- discount?: InvoiceDiscountNonNullableFields$1;
2217
- applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields$1;
2218
- }
2219
- interface LineItemTaxSummaryNonNullableFields$1 {
2220
- aggregatedTaxAmount: string;
2221
- aggregatedTaxRate: string;
2222
- taxableAmount: string;
2223
- }
2224
- interface TaxBreakdownNonNullableFields$1 {
2225
- taxType: string;
2226
- taxRate: string;
2227
- jurisdictionType: string;
2228
- }
2229
- interface ItemTaxDataNonNullableFields$1 {
2230
- lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields$1;
2231
- taxBreakdowns: TaxBreakdownNonNullableFields$1[];
2232
- }
2233
- interface InvoiceItemNonNullableFields$1 {
2234
- recurring?: RecurringNonNullableFields$1;
2235
- id: string;
2236
- name: string;
2237
- catalogReference?: CatalogReferenceNonNullableFields$1;
2238
- category: ItemCategory$1;
2239
- quantity: number;
2240
- priceDetails?: PriceDetailsNonNullableFields$1;
2241
- totals?: TotalsNonNullableFields$1;
2242
- taxData?: ItemTaxDataNonNullableFields$1;
2243
- }
2244
- interface SubscriptionChargeNonNullableFields$1 {
2245
- cycle: number;
2246
- totals?: TotalsNonNullableFields$1;
2247
- invoiceItems: InvoiceItemNonNullableFields$1[];
2248
- discount?: InvoiceDiscountNonNullableFields$1;
2249
- }
2250
- interface CustomerListUpcomingChargesResponseNonNullableFields$1 {
2251
- upcomingCharge?: SubscriptionChargeNonNullableFields$1;
2252
- }
2253
- interface InitiatePaymentMethodSetupResponseNonNullableFields$1 {
2254
- paymentOrderId: string;
2255
- }
2256
- interface UpdateSubscriptionBillingDateResponseNonNullableFields$1 {
2257
- subscription?: SubscriptionNonNullableFields$1;
2258
- }
2259
- interface CancelSubscriptionResponseNonNullableFields$1 {
2260
- subscription?: SubscriptionNonNullableFields$1;
2261
- }
2262
- interface PauseSubscriptionResponseNonNullableFields$1 {
2263
- subscription?: SubscriptionNonNullableFields$1;
2264
- }
2265
- interface ResumeSubscriptionResponseNonNullableFields$1 {
2266
- subscription?: SubscriptionNonNullableFields$1;
2267
- }
2268
- interface SearchSubscriptionsResponseNonNullableFields$1 {
2269
- subscriptions: SubscriptionNonNullableFields$1[];
2270
- }
2271
- interface CountByStatusNonNullableFields$1 {
2272
- status: SubscriptionStatusEnumSubscriptionStatus$1;
2273
- count: number;
2274
- }
2275
- interface CountSubscriptionsResponseNonNullableFields$1 {
2276
- countByStatus: CountByStatusNonNullableFields$1[];
2277
- total: number;
2278
- }
2279
- interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields$1 {
2280
- subscription?: SubscriptionNonNullableFields$1;
2281
- }
2282
- interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields$1 {
2283
- subscription?: SubscriptionNonNullableFields$1;
2284
- }
2285
- interface MarkLatestInvoiceAsPaidResponseNonNullableFields$1 {
2286
- subscription?: SubscriptionNonNullableFields$1;
2287
- }
2288
- interface AmountByStatusNonNullableFields$1 {
2289
- status: SubscriptionStatusEnumSubscriptionStatus$1;
2290
- amount: number;
2291
- }
2292
- interface GetSubscriptionsStatsResponseNonNullableFields$1 {
2293
- amountByStatuses: AmountByStatusNonNullableFields$1[];
2294
- total: number;
2295
- }
2296
- interface ExtendSubscriptionResponseNonNullableFields$1 {
2297
- subscription?: SubscriptionNonNullableFields$1;
2298
- }
2299
- interface UnsupportedReasonNonNullableFields$1 {
2300
- code: string;
2301
- }
2302
- interface UnsupportedActionNonNullableFields$1 {
2303
- actionType: ActionType$1;
2304
- reasons: UnsupportedReasonNonNullableFields$1[];
2305
- }
2306
- interface AllowedActionsResponseNonNullableFields$1 {
2307
- actions: ActionNonNullableFields$1[];
2308
- unsupportedActions: UnsupportedActionNonNullableFields$1[];
2309
- }
2310
- interface ListUpcomingChargesResponseNonNullableFields$1 {
2311
- upcomingCharges: SubscriptionChargeNonNullableFields$1[];
2312
- }
2313
- interface ChargeNonNullableFields$1 {
2314
- cycleFrom: number;
2315
- totals?: TotalsNonNullableFields$1;
2316
- }
2317
- interface PreviewSubscriptionChargesResponseNonNullableFields$1 {
2318
- charges: ChargeNonNullableFields$1[];
2319
- }
2320
- interface SubscriptionChargesNonNullableFields$1 {
2321
- charges: ChargeNonNullableFields$1[];
2322
- }
2323
- interface PreviewSubscriptionsChargesResponseNonNullableFields$1 {
2324
- subscriptionsCharges: SubscriptionChargesNonNullableFields$1[];
2325
- }
2326
- interface PayCycleResponseNonNullableFields$1 {
2327
- invoiceId: string;
2328
- subscription?: SubscriptionNonNullableFields$1;
2329
- }
2330
2375
 
2331
2376
  interface Subscription {
2332
2377
  /**
@@ -2637,10 +2682,32 @@ interface AdditionalFee {
2637
2682
  *
2638
2683
  * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
2639
2684
  * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
2685
+ * @deprecated When the fee is added to the invoice.
2686
+ *
2687
+ * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
2688
+ * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
2689
+ * @replacedBy cycles
2690
+ * @targetRemovalDate 2025-12-31
2640
2691
  */
2641
2692
  trigger?: AdditionalFeeTrigger;
2642
2693
  /** Information about the tax of the conditional fee. */
2643
2694
  tax?: Tax;
2695
+ /**
2696
+ * Specifies the cycles during which the fee will be applied. If this field is provided,
2697
+ * it determines the exact range of cycles the fee applies to. The logic is as follows:
2698
+ *
2699
+ * - `cycle_from`: The first cycle the fee will be added to. Must be greater than 0.
2700
+ * - `number_of_cycles`: The number of consecutive cycles the fee will be applied to,
2701
+ * starting from `cycle_from`. If not specified, the fee applies to all cycles starting
2702
+ * from `cycle_from`.
2703
+ *
2704
+ * Example:
2705
+ * - `cycle_from = 1, number_of_cycles = 3`: Fee applies to cycles 1, 2, and 3.
2706
+ * - `cycle_from = 2, number_of_cycles = None`: Fee applies to cycles 2 and onward indefinitely.
2707
+ *
2708
+ * If `cycles` is not specified (`None`), the fee will only be applied to the first cycle of the subscription.
2709
+ */
2710
+ cycles?: Cycles;
2644
2711
  }
2645
2712
  declare enum AdditionalFeeTrigger {
2646
2713
  UNKNOWN = "UNKNOWN",
@@ -2703,6 +2770,12 @@ declare enum TaxableAddressType {
2703
2770
  /** Tax will be calculated using multiple address (from BUSINESS to SHIPPING) */
2704
2771
  SHIPPING = "SHIPPING"
2705
2772
  }
2773
+ interface Cycles {
2774
+ /** The cycle will start. Minimum cycle number is 1 */
2775
+ cycleFrom?: number;
2776
+ /** Number of cycles to be applied on. In order to apply a on all cycles until the end of the subscription, this field should be empty. */
2777
+ numberOfCycles?: number | null;
2778
+ }
2706
2779
  interface ShippingCharges {
2707
2780
  /**
2708
2781
  * Amount of the shipping fee in `0.00` format.
@@ -3116,147 +3189,18 @@ interface SpecificDateSubscriptionUpdateData {
3116
3189
  updateData?: SubscriptionUpdateData;
3117
3190
  executionDate?: Date | null;
3118
3191
  }
3119
- interface ListSubscriptionHistoryRequest {
3120
- subscriptionId: string;
3121
- /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
3122
- mode?: HistoryViewMode;
3123
- /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
3124
- cursor?: CursorPaging;
3125
- }
3126
- declare enum HistoryViewMode {
3127
- UNKNOWN = "UNKNOWN",
3128
- /** Comprehensive view including all history events. */
3129
- BACKOFFICE = "BACKOFFICE",
3130
- /** User-centric view of the history. */
3131
- USER = "USER"
3132
- }
3133
- interface CursorPaging {
3134
- /** Maximum number of items to return in the results. */
3135
- limit?: number | null;
3136
- /**
3137
- * Pointer to the next or previous page in the list of results.
3138
- *
3139
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
3140
- * Not relevant for the first request.
3141
- */
3142
- cursor?: string | null;
3143
- }
3144
- interface ListSubscriptionHistoryResponse {
3145
- /** List of history entries for the subscription. */
3146
- historyEntries?: SubscriptionHistoryEntry[];
3147
- /** Paging metadata. A `next` cursor is returned if there are more results. */
3148
- pagingMetadata?: PagingMetadataV2;
3149
- }
3150
- interface SubscriptionHistoryEntry {
3151
- entryId?: string;
3152
- /** TODO: add max length? it is not defined in domainevents, so should we? */
3153
- slug?: string;
3154
- entryTime?: Date | null;
3155
- event?: SubscriptionEvent;
3156
- }
3157
- interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
3158
- created?: SubscriptionCreated;
3159
- updated?: SubscriptionUpdated;
3160
- deleted?: SubscriptionDeleted;
3161
- activated?: SubscriptionActivated;
3162
- ended?: SubscriptionEnded;
3163
- canceled?: SubscriptionCanceled;
3164
- paused?: SubscriptionPaused;
3165
- resumed?: SubscriptionResumed;
3166
- pauseRequested?: PauseSubscriptionRequested;
3167
- resumeRequested?: ResumeSubscriptionRequested;
3168
- scheduledPauseCanceled?: ScheduledPauseCanceled;
3169
- scheduledResumeCanceled?: ScheduledResumeCanceled;
3170
- billingCycleStarted?: SubscriptionBillingCycleStarted;
3171
- autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
3172
- autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
3173
- cycleReadyToPay?: SubscriptionCycleReadyToPay;
3174
- extended?: SubscriptionExtended;
3175
- initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
3176
- latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
3177
- revived?: SubscriptionRevived;
3178
- billingDateUpdated?: SubscriptionBillingDateUpdated;
3179
- futureUpdatesRequested?: FutureUpdatesRequested;
3180
- updatesApplied?: UpdatesApplied;
3181
- resetPendingUpdates?: ResetPendingUpdates;
3182
- gracePeriodStarted?: GracePeriodStarted;
3183
- gracePeriodEnded?: GracePeriodEnded;
3184
- paymentMethodUpdated?: PaymentMethodUpdated;
3185
- collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
3186
- freeTrailStarted?: FreeTrailStarted;
3187
- freeTrailEnded?: FreeTrailEnded;
3188
- subscriptionBoAction?: SubscriptionBackOfficeAction;
3189
- unknown?: UnknownSubscriptionEvent;
3190
- }
3191
- /** @oneof */
3192
- interface SubscriptionEventPayloadOneOf {
3193
- created?: SubscriptionCreated;
3194
- updated?: SubscriptionUpdated;
3195
- deleted?: SubscriptionDeleted;
3196
- activated?: SubscriptionActivated;
3197
- ended?: SubscriptionEnded;
3198
- canceled?: SubscriptionCanceled;
3199
- paused?: SubscriptionPaused;
3200
- resumed?: SubscriptionResumed;
3201
- pauseRequested?: PauseSubscriptionRequested;
3202
- resumeRequested?: ResumeSubscriptionRequested;
3203
- scheduledPauseCanceled?: ScheduledPauseCanceled;
3204
- scheduledResumeCanceled?: ScheduledResumeCanceled;
3205
- billingCycleStarted?: SubscriptionBillingCycleStarted;
3206
- autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
3207
- autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
3208
- cycleReadyToPay?: SubscriptionCycleReadyToPay;
3209
- extended?: SubscriptionExtended;
3210
- initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
3211
- latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
3212
- revived?: SubscriptionRevived;
3213
- billingDateUpdated?: SubscriptionBillingDateUpdated;
3214
- futureUpdatesRequested?: FutureUpdatesRequested;
3215
- updatesApplied?: UpdatesApplied;
3216
- resetPendingUpdates?: ResetPendingUpdates;
3217
- gracePeriodStarted?: GracePeriodStarted;
3218
- gracePeriodEnded?: GracePeriodEnded;
3219
- paymentMethodUpdated?: PaymentMethodUpdated;
3220
- collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
3221
- freeTrailStarted?: FreeTrailStarted;
3222
- freeTrailEnded?: FreeTrailEnded;
3223
- subscriptionBoAction?: SubscriptionBackOfficeAction;
3224
- unknown?: UnknownSubscriptionEvent;
3192
+ interface GetSubscriptionRequest {
3193
+ _id: string;
3225
3194
  }
3226
- interface SubscriptionCreated {
3195
+ interface GetSubscriptionResponse {
3227
3196
  subscription?: Subscription;
3228
3197
  }
3229
- interface SubscriptionUpdated {
3230
- current?: Subscription;
3231
- previous?: Subscription;
3232
- diff?: SubscriptionDiff;
3233
- }
3234
- interface SubscriptionDiff {
3235
- added?: string | null;
3236
- changed?: string | null;
3237
- deleted?: string | null;
3238
- }
3239
- interface SubscriptionDeleted {
3240
- subscriptionId?: string;
3241
- }
3242
- /**
3243
- * Sent each time a subscription status has been set to Active
3244
- * Active shows that a subscription is live and operational.
3245
- * For example:
3246
- * * For subscription with free trial, free trial start date is also the activation date.
3247
- * * For a subscription with future start date, the start date is also the activation date.
3248
- * * When a subscription is resumed from a pause status, the resume date is also the activation date.
3249
- */
3250
- interface SubscriptionActivated {
3251
- subscription?: Subscription;
3198
+ interface CustomerCancelSubscriptionRequest {
3199
+ _id: string;
3200
+ /** Optional action reason message */
3201
+ reason?: string | null;
3252
3202
  }
3253
- /**
3254
- * Sent each time a subscription status has been set to Ended
3255
- * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
3256
- * This is different from a Canceled subscription which ends the subscription before a designated end date.
3257
- * Therefore, Ended and Canceled are mutually exclusive.
3258
- */
3259
- interface SubscriptionEnded {
3203
+ interface CustomerCancelSubscriptionResponse {
3260
3204
  subscription?: Subscription;
3261
3205
  }
3262
3206
  /**
@@ -3274,48 +3218,32 @@ interface ActionDetails {
3274
3218
  initiator?: HistoryActionInitiator;
3275
3219
  reason?: string | null;
3276
3220
  }
3277
- interface SubscriptionPaused {
3278
- subscription?: Subscription;
3279
- pausePolicy?: PausePolicy;
3280
- actionDetails?: ActionDetails;
3281
- }
3282
- interface SubscriptionResumed {
3283
- subscription?: Subscription;
3284
- actionDetails?: ActionDetails;
3221
+ interface CustomerTurnOnAutoRenewalRequest {
3222
+ _id: string;
3223
+ /** Optional action reason message */
3224
+ reason?: string | null;
3285
3225
  }
3286
- interface PauseSubscriptionRequested {
3226
+ interface CustomerTurnOnAutoRenewalResponse {
3287
3227
  subscription?: Subscription;
3288
- pauseAt?: PauseAt;
3289
- pausePolicy?: PausePolicy;
3290
- actionDetails?: ActionDetails;
3291
3228
  }
3292
- interface ResumeSubscriptionRequested {
3293
- subscription?: Subscription;
3294
- resumeAt?: ResumeAt;
3295
- actionDetails?: ActionDetails;
3229
+ interface CustomerTurnOffAutoRenewalRequest {
3230
+ _id: string;
3231
+ /** Optional action reason message */
3232
+ reason?: string | null;
3296
3233
  }
3297
- interface ScheduledPauseCanceled {
3234
+ interface CustomerTurnOffAutoRenewalResponse {
3298
3235
  subscription?: Subscription;
3299
- actionDetails?: ActionDetails;
3300
3236
  }
3301
- interface ScheduledResumeCanceled {
3302
- subscription?: Subscription;
3303
- actionDetails?: ActionDetails;
3304
- }
3305
- interface SubscriptionBillingCycleStarted {
3306
- subscription?: Subscription;
3307
- /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
3308
- paymentTransactionId?: string | null;
3309
- }
3310
- interface SubscriptionAutoRenewalTurnedOn {
3311
- subscription?: Subscription;
3312
- actionDetails?: ActionDetails;
3313
- }
3314
- interface SubscriptionAutoRenewalTurnedOff {
3315
- subscription?: Subscription;
3316
- actionDetails?: ActionDetails;
3237
+ interface CustomerExtendSubscriptionRequest {
3238
+ /** The ID of the subscription to be extended */
3239
+ _id: string;
3240
+ /** Optional action reason message */
3241
+ reason?: string | null;
3242
+ /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
3243
+ billingCyclesToAdd: number | null;
3317
3244
  }
3318
- interface SubscriptionCycleReadyToPay {
3245
+ interface CustomerExtendSubscriptionResponse {
3246
+ /** The now extended subscription */
3319
3247
  subscription?: Subscription;
3320
3248
  }
3321
3249
  interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
@@ -3329,156 +3257,6 @@ interface SubscriptionExtendedExtendPolicyOneOf {
3329
3257
  extensionPeriod?: Duration;
3330
3258
  extensionBillingCycles?: number;
3331
3259
  }
3332
- interface SubscriptionInitialPurchaseCompleted {
3333
- subscription?: Subscription;
3334
- actionDetails?: ActionDetails;
3335
- paymentTransactionId?: string | null;
3336
- }
3337
- interface LatestInvoiceMarkedAsPaid {
3338
- subscription?: Subscription;
3339
- }
3340
- interface SubscriptionRevived {
3341
- subscription?: Subscription;
3342
- }
3343
- interface SubscriptionBillingDateUpdated {
3344
- subscription?: Subscription;
3345
- billingDate?: Date | null;
3346
- proration?: Proration;
3347
- }
3348
- interface FutureUpdatesRequested {
3349
- subscription?: Subscription;
3350
- requestedUpdateData?: SubscriptionUpdateData;
3351
- }
3352
- interface UpdatesApplied {
3353
- subscription?: Subscription;
3354
- updateAction?: UpdateAction;
3355
- appliedUpdateData?: SubscriptionUpdateData;
3356
- }
3357
- declare enum UpdateAction {
3358
- NONE = "NONE",
3359
- /** Update subscription immediately, please note proration for updates changing price are not yet supported */
3360
- IMMEDIATELY = "IMMEDIATELY",
3361
- /** Request updates that will take affect only at the start of the next billing cycle. */
3362
- NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
3363
- /** Reset all pending updates */
3364
- RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
3365
- /** Request updates that will take affect only at a specific date. */
3366
- SPECIFIC_DATE = "SPECIFIC_DATE"
3367
- }
3368
- interface ResetPendingUpdates {
3369
- subscription?: Subscription;
3370
- }
3371
- interface GracePeriodStarted {
3372
- subscription?: Subscription;
3373
- }
3374
- interface GracePeriodEnded {
3375
- subscription?: Subscription;
3376
- /** Indication for the payment settlement method. */
3377
- paymentSettlementMethod?: PaymentSettlementMethod;
3378
- }
3379
- declare enum PaymentSettlementMethod {
3380
- UNKNOWN = "UNKNOWN",
3381
- /** System-defined payment settlement. */
3382
- SYSTEM = "SYSTEM",
3383
- /** Manually mark the payment as paid. */
3384
- MARK_AS_PAID = "MARK_AS_PAID",
3385
- /** Require the customer to pay immediately, by insert a new payment method. */
3386
- CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
3387
- }
3388
- interface PaymentMethodUpdated {
3389
- subscription?: Subscription;
3390
- initiator?: HistoryActionInitiator;
3391
- paymentMode?: PaymentMode;
3392
- }
3393
- declare enum PaymentMode {
3394
- NONE = "NONE",
3395
- /** The latest invoice of the subscription will be charged. */
3396
- CHARGE = "CHARGE",
3397
- /** An authorization invoice with zero amount will be created. */
3398
- AUTHORIZATION = "AUTHORIZATION"
3399
- }
3400
- interface SubscriptionCollectionMethodUpdated {
3401
- subscription?: Subscription;
3402
- newCollectionMethod?: CollectionMethodEnumCollectionMethod;
3403
- previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
3404
- }
3405
- interface FreeTrailStarted {
3406
- subscription?: Subscription;
3407
- }
3408
- interface FreeTrailEnded {
3409
- subscription?: Subscription;
3410
- }
3411
- interface SubscriptionBackOfficeAction {
3412
- subscription?: Subscription;
3413
- /** The backoffice method name */
3414
- name?: string;
3415
- /** json as string format, to store the flatted request object */
3416
- params?: string;
3417
- }
3418
- /** Defines unknown events restored from the logs */
3419
- interface UnknownSubscriptionEvent {
3420
- subscriptionAsString?: string | null;
3421
- }
3422
- interface PagingMetadataV2 {
3423
- /** Number of items returned in the response. */
3424
- count?: number | null;
3425
- /** Offset that was requested. */
3426
- offset?: number | null;
3427
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
3428
- total?: number | null;
3429
- /** Flag that indicates the server failed to calculate the `total` field. */
3430
- tooManyToCount?: boolean | null;
3431
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
3432
- cursors?: Cursors;
3433
- }
3434
- interface Cursors {
3435
- /** Cursor string pointing to the next page in the list of results. */
3436
- next?: string | null;
3437
- /** Cursor pointing to the previous page in the list of results. */
3438
- prev?: string | null;
3439
- }
3440
- interface GetSubscriptionRequest {
3441
- _id: string;
3442
- }
3443
- interface GetSubscriptionResponse {
3444
- subscription?: Subscription;
3445
- }
3446
- interface CustomerCancelSubscriptionRequest {
3447
- _id: string;
3448
- /** Optional action reason message */
3449
- reason?: string | null;
3450
- }
3451
- interface CustomerCancelSubscriptionResponse {
3452
- subscription?: Subscription;
3453
- }
3454
- interface CustomerTurnOnAutoRenewalRequest {
3455
- _id: string;
3456
- /** Optional action reason message */
3457
- reason?: string | null;
3458
- }
3459
- interface CustomerTurnOnAutoRenewalResponse {
3460
- subscription?: Subscription;
3461
- }
3462
- interface CustomerTurnOffAutoRenewalRequest {
3463
- _id: string;
3464
- /** Optional action reason message */
3465
- reason?: string | null;
3466
- }
3467
- interface CustomerTurnOffAutoRenewalResponse {
3468
- subscription?: Subscription;
3469
- }
3470
- interface CustomerExtendSubscriptionRequest {
3471
- /** The ID of the subscription to be extended */
3472
- _id: string;
3473
- /** Optional action reason message */
3474
- reason?: string | null;
3475
- /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
3476
- billingCyclesToAdd: number | null;
3477
- }
3478
- interface CustomerExtendSubscriptionResponse {
3479
- /** The now extended subscription */
3480
- subscription?: Subscription;
3481
- }
3482
3260
  interface QuerySubscriptionsRequest {
3483
3261
  query?: QueryV2;
3484
3262
  }
@@ -3527,10 +3305,39 @@ interface Paging {
3527
3305
  /** Number of items to skip in the current sort order. */
3528
3306
  offset?: number | null;
3529
3307
  }
3308
+ interface CursorPaging {
3309
+ /** Maximum number of items to return in the results. */
3310
+ limit?: number | null;
3311
+ /**
3312
+ * Pointer to the next or previous page in the list of results.
3313
+ *
3314
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
3315
+ * Not relevant for the first request.
3316
+ */
3317
+ cursor?: string | null;
3318
+ }
3530
3319
  interface QuerySubscriptionsResponse {
3531
3320
  subscriptions?: Subscription[];
3532
3321
  metadata?: PagingMetadataV2;
3533
3322
  }
3323
+ interface PagingMetadataV2 {
3324
+ /** Number of items returned in the response. */
3325
+ count?: number | null;
3326
+ /** Offset that was requested. */
3327
+ offset?: number | null;
3328
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
3329
+ total?: number | null;
3330
+ /** Flag that indicates the server failed to calculate the `total` field. */
3331
+ tooManyToCount?: boolean | null;
3332
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
3333
+ cursors?: Cursors;
3334
+ }
3335
+ interface Cursors {
3336
+ /** Cursor string pointing to the next page in the list of results. */
3337
+ next?: string | null;
3338
+ /** Cursor pointing to the previous page in the list of results. */
3339
+ prev?: string | null;
3340
+ }
3534
3341
  interface CountSubscriptionsRequest {
3535
3342
  /** Filters to specify which subscriptions are counted. */
3536
3343
  filter?: CountSubscriptionFilter;
@@ -3834,6 +3641,13 @@ interface InitiatePaymentMethodSetupRequest {
3834
3641
  paymentMode?: PaymentMode;
3835
3642
  paymentSettings?: PaymentSettings;
3836
3643
  }
3644
+ declare enum PaymentMode {
3645
+ NONE = "NONE",
3646
+ /** The latest invoice of the subscription will be charged. */
3647
+ CHARGE = "CHARGE",
3648
+ /** An authorization invoice with zero amount will be created. */
3649
+ AUTHORIZATION = "AUTHORIZATION"
3650
+ }
3837
3651
  interface PaymentSettings {
3838
3652
  /** Allowed payment providers for Subscriptions, for example to limit subscriptions to be created only with "Wix Payments" provider. */
3839
3653
  allowedProviderIds?: string[];
@@ -3876,41 +3690,115 @@ interface PaymentOrigin {
3876
3690
  interface InitiatePaymentMethodSetupResponse {
3877
3691
  paymentOrderId?: string;
3878
3692
  }
3879
- interface UpdateSubscriptionBillingDateRequest {
3880
- /** ID of the subscription to update the billing date for. */
3881
- _id: string;
3882
- /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
3883
- billingDate: Date | null;
3884
- /**
3885
- * Information about how BASS adjusts the total of the next invoice. Extending
3886
- * the current billing cycle results in a higher payment, while shortening it
3887
- * leads to a lower payment. BASS offers automatic calculation of the proration
3888
- * amount based on the number of days added to or removed from the current billing
3889
- * cycle. Alternatively, you can use your own custom method to calculate the
3890
- * proration amount. The custom proration amount can't exceed the total of the
3891
- * current billing cycle.
3892
- */
3893
- proration?: Proration;
3693
+ interface PayCycleRequest {
3694
+ subscriptionId: string;
3695
+ paymentTestMode?: PaymentTestMode;
3696
+ tenantId: string;
3894
3697
  }
3895
- interface UpdateSubscriptionBillingDateResponse {
3896
- /** Updated subscription. */
3698
+ declare enum PaymentTestMode {
3699
+ REGULAR = "REGULAR",
3700
+ FAIL_TECHNICAL = "FAIL_TECHNICAL",
3701
+ FAIL_DECLINE = "FAIL_DECLINE",
3702
+ FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
3703
+ }
3704
+ interface PayCycleResponse {
3705
+ invoiceId?: string;
3706
+ paymentOrderId?: string | null;
3897
3707
  subscription?: Subscription;
3898
3708
  }
3899
- interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
3900
- /**
3901
- * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
3902
- * format. The use of this field may be restricted in various BASS endpoints.
3903
- * For example, in _Bulk Update Subscription Items_ it's only available in
3904
- * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
3905
- * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
3906
- * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
3907
- */
3908
- specificDate?: Date | null;
3909
- /**
3910
- * When the update becomes effective, as number of billing cycles from now.
3911
- * The use of this field may be restricted in various BASS endpoints.
3912
- * For example, in _Pause Subscription_ it's only available in
3913
- * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
3709
+ declare enum ActionInitiator {
3710
+ UNDEFINED = "UNDEFINED",
3711
+ BUSINESS = "BUSINESS",
3712
+ CUSTOMER = "CUSTOMER",
3713
+ SYSTEM = "SYSTEM"
3714
+ }
3715
+ interface SubscriptionBillingCycleStarted {
3716
+ subscription?: Subscription;
3717
+ /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
3718
+ paymentTransactionId?: string | null;
3719
+ }
3720
+ /**
3721
+ * Sent each time a subscription status has been set to Active
3722
+ * Active shows that a subscription is live and operational.
3723
+ * For example:
3724
+ * * For subscription with free trial, free trial start date is also the activation date.
3725
+ * * For a subscription with future start date, the start date is also the activation date.
3726
+ * * When a subscription is resumed from a pause status, the resume date is also the activation date.
3727
+ */
3728
+ interface SubscriptionActivated {
3729
+ subscription?: Subscription;
3730
+ }
3731
+ /**
3732
+ * Sent each time a subscription status has been set to Ended
3733
+ * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
3734
+ * This is different from a Canceled subscription which ends the subscription before a designated end date.
3735
+ * Therefore, Ended and Canceled are mutually exclusive.
3736
+ */
3737
+ interface SubscriptionEnded {
3738
+ subscription?: Subscription;
3739
+ }
3740
+ interface SubscriptionInitialPurchaseCompleted {
3741
+ subscription?: Subscription;
3742
+ actionDetails?: ActionDetails;
3743
+ paymentTransactionId?: string | null;
3744
+ }
3745
+ interface SubscriptionCycleReadyToPay {
3746
+ subscription?: Subscription;
3747
+ }
3748
+ interface SubscriptionRevived {
3749
+ subscription?: Subscription;
3750
+ }
3751
+ interface UpdateSubscriptionBillingDateRequest {
3752
+ /** ID of the subscription to update the billing date for. */
3753
+ _id: string;
3754
+ /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
3755
+ billingDate: Date | null;
3756
+ /**
3757
+ * Information about how BASS adjusts the total of the next invoice. Extending
3758
+ * the current billing cycle results in a higher payment, while shortening it
3759
+ * leads to a lower payment. BASS offers automatic calculation of the proration
3760
+ * amount based on the number of days added to or removed from the current billing
3761
+ * cycle. Alternatively, you can use your own custom method to calculate the
3762
+ * proration amount. The custom proration amount can't exceed the total of the
3763
+ * current billing cycle.
3764
+ */
3765
+ proration?: Proration;
3766
+ }
3767
+ interface UpdateSubscriptionBillingDateResponse {
3768
+ /** Updated subscription. */
3769
+ subscription?: Subscription;
3770
+ }
3771
+ interface SubscriptionBillingDateUpdated {
3772
+ subscription?: Subscription;
3773
+ billingDate?: Date | null;
3774
+ proration?: Proration;
3775
+ }
3776
+ declare enum UpdateAction {
3777
+ NONE = "NONE",
3778
+ /** Update subscription immediately, please note proration for updates changing price are not yet supported */
3779
+ IMMEDIATELY = "IMMEDIATELY",
3780
+ /** Request updates that will take affect only at the start of the next billing cycle. */
3781
+ NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
3782
+ /** Reset all pending updates */
3783
+ RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
3784
+ /** Request updates that will take affect only at a specific date. */
3785
+ SPECIFIC_DATE = "SPECIFIC_DATE"
3786
+ }
3787
+ interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
3788
+ /**
3789
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
3790
+ * format. The use of this field may be restricted in various BASS endpoints.
3791
+ * For example, in _Bulk Update Subscription Items_ it's only available in
3792
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
3793
+ * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
3794
+ * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
3795
+ */
3796
+ specificDate?: Date | null;
3797
+ /**
3798
+ * When the update becomes effective, as number of billing cycles from now.
3799
+ * The use of this field may be restricted in various BASS endpoints.
3800
+ * For example, in _Pause Subscription_ it's only available in
3801
+ * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
3914
3802
  * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
3915
3803
  */
3916
3804
  numberOfCycles?: number;
@@ -3944,12 +3832,6 @@ interface ActionContext {
3944
3832
  /** Optional action reason message */
3945
3833
  reason?: string | null;
3946
3834
  }
3947
- declare enum ActionInitiator {
3948
- UNDEFINED = "UNDEFINED",
3949
- BUSINESS = "BUSINESS",
3950
- CUSTOMER = "CUSTOMER",
3951
- SYSTEM = "SYSTEM"
3952
- }
3953
3835
  interface CancelSubscriptionResponse {
3954
3836
  subscription?: Subscription;
3955
3837
  }
@@ -3966,6 +3848,21 @@ interface PauseSubscriptionRequest {
3966
3848
  interface PauseSubscriptionResponse {
3967
3849
  subscription?: Subscription;
3968
3850
  }
3851
+ interface SubscriptionPaused {
3852
+ subscription?: Subscription;
3853
+ pausePolicy?: PausePolicy;
3854
+ actionDetails?: ActionDetails;
3855
+ }
3856
+ interface PauseSubscriptionRequested {
3857
+ subscription?: Subscription;
3858
+ pauseAt?: PauseAt;
3859
+ pausePolicy?: PausePolicy;
3860
+ actionDetails?: ActionDetails;
3861
+ }
3862
+ interface ScheduledPauseCanceled {
3863
+ subscription?: Subscription;
3864
+ actionDetails?: ActionDetails;
3865
+ }
3969
3866
  interface ResumeSubscriptionRequest {
3970
3867
  _id: string;
3971
3868
  resumeAt?: ResumeAt;
@@ -3976,6 +3873,19 @@ interface ResumeSubscriptionRequest {
3976
3873
  interface ResumeSubscriptionResponse {
3977
3874
  subscription?: Subscription;
3978
3875
  }
3876
+ interface SubscriptionResumed {
3877
+ subscription?: Subscription;
3878
+ actionDetails?: ActionDetails;
3879
+ }
3880
+ interface ResumeSubscriptionRequested {
3881
+ subscription?: Subscription;
3882
+ resumeAt?: ResumeAt;
3883
+ actionDetails?: ActionDetails;
3884
+ }
3885
+ interface ScheduledResumeCanceled {
3886
+ subscription?: Subscription;
3887
+ actionDetails?: ActionDetails;
3888
+ }
3979
3889
  interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
3980
3890
  /** Limit number of results and enable to skip rows. The default limit is 25. */
3981
3891
  paging?: Paging;
@@ -4007,6 +3917,10 @@ interface TurnOnSubscriptionAutoRenewalRequest {
4007
3917
  interface TurnOnSubscriptionAutoRenewalResponse {
4008
3918
  subscription?: Subscription;
4009
3919
  }
3920
+ interface SubscriptionAutoRenewalTurnedOn {
3921
+ subscription?: Subscription;
3922
+ actionDetails?: ActionDetails;
3923
+ }
4010
3924
  interface TurnOffSubscriptionAutoRenewalRequest {
4011
3925
  _id: string;
4012
3926
  actionContext: ActionContext;
@@ -4014,6 +3928,10 @@ interface TurnOffSubscriptionAutoRenewalRequest {
4014
3928
  interface TurnOffSubscriptionAutoRenewalResponse {
4015
3929
  subscription?: Subscription;
4016
3930
  }
3931
+ interface SubscriptionAutoRenewalTurnedOff {
3932
+ subscription?: Subscription;
3933
+ actionDetails?: ActionDetails;
3934
+ }
4017
3935
  interface MarkLatestInvoiceAsPaidRequest {
4018
3936
  /** The ID of the offline subscription to mark as paid its latest invoice */
4019
3937
  subscriptionId: string;
@@ -4021,6 +3939,9 @@ interface MarkLatestInvoiceAsPaidRequest {
4021
3939
  interface MarkLatestInvoiceAsPaidResponse {
4022
3940
  subscription?: Subscription;
4023
3941
  }
3942
+ interface LatestInvoiceMarkedAsPaid {
3943
+ subscription?: Subscription;
3944
+ }
4024
3945
  interface GetSubscriptionsStatsRequest {
4025
3946
  }
4026
3947
  interface GetSubscriptionsStatsResponse {
@@ -4123,6 +4044,19 @@ interface Charge {
4123
4044
  interface PreviewSubscriptionsChargesRequest {
4124
4045
  /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
4125
4046
  subscriptionsBillingDetails?: SubscriptionBillingDetails[];
4047
+ /**
4048
+ * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
4049
+ * For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
4050
+ * $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
4051
+ * - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
4052
+ * - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
4053
+ * - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
4054
+ * If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
4055
+ * in this case, charges for cycle 1 through 3.
4056
+ * If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
4057
+ * then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
4058
+ */
4059
+ numberOfNextRecurringCharges?: number | null;
4126
4060
  }
4127
4061
  interface SubscriptionBillingDetails {
4128
4062
  /** External identifier of the subscription */
@@ -4146,21 +4080,173 @@ interface SubscriptionCharges {
4146
4080
  /** Charges for subscription. */
4147
4081
  charges?: Charge[];
4148
4082
  }
4149
- interface PayCycleRequest {
4083
+ interface ListSubscriptionHistoryRequest {
4150
4084
  subscriptionId: string;
4151
- paymentTestMode?: PaymentTestMode;
4152
- tenantId: string;
4085
+ /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
4086
+ mode?: HistoryViewMode;
4087
+ /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
4088
+ cursor?: CursorPaging;
4153
4089
  }
4154
- declare enum PaymentTestMode {
4155
- REGULAR = "REGULAR",
4156
- FAIL_TECHNICAL = "FAIL_TECHNICAL",
4157
- FAIL_DECLINE = "FAIL_DECLINE",
4158
- FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
4090
+ declare enum HistoryViewMode {
4091
+ UNKNOWN = "UNKNOWN",
4092
+ /** Comprehensive view including all history events. */
4093
+ BACKOFFICE = "BACKOFFICE",
4094
+ /** User-centric view of the history. */
4095
+ USER = "USER"
4159
4096
  }
4160
- interface PayCycleResponse {
4161
- invoiceId?: string;
4162
- paymentOrderId?: string | null;
4097
+ interface ListSubscriptionHistoryResponse {
4098
+ /** List of history entries for the subscription. */
4099
+ historyEntries?: SubscriptionHistoryEntry[];
4100
+ /** Paging metadata. A `next` cursor is returned if there are more results. */
4101
+ pagingMetadata?: PagingMetadataV2;
4102
+ }
4103
+ interface SubscriptionHistoryEntry {
4104
+ entryId?: string;
4105
+ /** TODO: add max length? it is not defined in domainevents, so should we? */
4106
+ slug?: string;
4107
+ entryTime?: Date | null;
4108
+ event?: SubscriptionEvent;
4109
+ }
4110
+ interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
4111
+ created?: SubscriptionCreated;
4112
+ updated?: SubscriptionUpdated;
4113
+ deleted?: SubscriptionDeleted;
4114
+ activated?: SubscriptionActivated;
4115
+ ended?: SubscriptionEnded;
4116
+ canceled?: SubscriptionCanceled;
4117
+ paused?: SubscriptionPaused;
4118
+ resumed?: SubscriptionResumed;
4119
+ pauseRequested?: PauseSubscriptionRequested;
4120
+ resumeRequested?: ResumeSubscriptionRequested;
4121
+ scheduledPauseCanceled?: ScheduledPauseCanceled;
4122
+ scheduledResumeCanceled?: ScheduledResumeCanceled;
4123
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
4124
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
4125
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
4126
+ cycleReadyToPay?: SubscriptionCycleReadyToPay;
4127
+ extended?: SubscriptionExtended;
4128
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
4129
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
4130
+ revived?: SubscriptionRevived;
4131
+ billingDateUpdated?: SubscriptionBillingDateUpdated;
4132
+ futureUpdatesRequested?: FutureUpdatesRequested;
4133
+ updatesApplied?: UpdatesApplied;
4134
+ resetPendingUpdates?: ResetPendingUpdates;
4135
+ gracePeriodStarted?: GracePeriodStarted;
4136
+ gracePeriodEnded?: GracePeriodEnded;
4137
+ paymentMethodUpdated?: PaymentMethodUpdated;
4138
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
4139
+ freeTrailStarted?: FreeTrailStarted;
4140
+ freeTrailEnded?: FreeTrailEnded;
4141
+ subscriptionBoAction?: SubscriptionBackOfficeAction;
4142
+ unknown?: UnknownSubscriptionEvent;
4143
+ }
4144
+ /** @oneof */
4145
+ interface SubscriptionEventPayloadOneOf {
4146
+ created?: SubscriptionCreated;
4147
+ updated?: SubscriptionUpdated;
4148
+ deleted?: SubscriptionDeleted;
4149
+ activated?: SubscriptionActivated;
4150
+ ended?: SubscriptionEnded;
4151
+ canceled?: SubscriptionCanceled;
4152
+ paused?: SubscriptionPaused;
4153
+ resumed?: SubscriptionResumed;
4154
+ pauseRequested?: PauseSubscriptionRequested;
4155
+ resumeRequested?: ResumeSubscriptionRequested;
4156
+ scheduledPauseCanceled?: ScheduledPauseCanceled;
4157
+ scheduledResumeCanceled?: ScheduledResumeCanceled;
4158
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
4159
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
4160
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
4161
+ cycleReadyToPay?: SubscriptionCycleReadyToPay;
4162
+ extended?: SubscriptionExtended;
4163
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
4164
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
4165
+ revived?: SubscriptionRevived;
4166
+ billingDateUpdated?: SubscriptionBillingDateUpdated;
4167
+ futureUpdatesRequested?: FutureUpdatesRequested;
4168
+ updatesApplied?: UpdatesApplied;
4169
+ resetPendingUpdates?: ResetPendingUpdates;
4170
+ gracePeriodStarted?: GracePeriodStarted;
4171
+ gracePeriodEnded?: GracePeriodEnded;
4172
+ paymentMethodUpdated?: PaymentMethodUpdated;
4173
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
4174
+ freeTrailStarted?: FreeTrailStarted;
4175
+ freeTrailEnded?: FreeTrailEnded;
4176
+ subscriptionBoAction?: SubscriptionBackOfficeAction;
4177
+ unknown?: UnknownSubscriptionEvent;
4178
+ }
4179
+ interface SubscriptionCreated {
4180
+ subscription?: Subscription;
4181
+ }
4182
+ interface SubscriptionUpdated {
4183
+ current?: Subscription;
4184
+ previous?: Subscription;
4185
+ diff?: SubscriptionDiff;
4186
+ }
4187
+ interface SubscriptionDiff {
4188
+ added?: string | null;
4189
+ changed?: string | null;
4190
+ deleted?: string | null;
4191
+ }
4192
+ interface SubscriptionDeleted {
4193
+ subscriptionId?: string;
4194
+ }
4195
+ interface FutureUpdatesRequested {
4196
+ subscription?: Subscription;
4197
+ requestedUpdateData?: SubscriptionUpdateData;
4198
+ }
4199
+ interface UpdatesApplied {
4200
+ subscription?: Subscription;
4201
+ updateAction?: UpdateAction;
4202
+ appliedUpdateData?: SubscriptionUpdateData;
4203
+ }
4204
+ interface ResetPendingUpdates {
4205
+ subscription?: Subscription;
4206
+ }
4207
+ interface GracePeriodStarted {
4208
+ subscription?: Subscription;
4209
+ }
4210
+ interface GracePeriodEnded {
4211
+ subscription?: Subscription;
4212
+ /** Indication for the payment settlement method. */
4213
+ paymentSettlementMethod?: PaymentSettlementMethod;
4214
+ }
4215
+ declare enum PaymentSettlementMethod {
4216
+ UNKNOWN = "UNKNOWN",
4217
+ /** System-defined payment settlement. */
4218
+ SYSTEM = "SYSTEM",
4219
+ /** Manually mark the payment as paid. */
4220
+ MARK_AS_PAID = "MARK_AS_PAID",
4221
+ /** Require the customer to pay immediately, by insert a new payment method. */
4222
+ CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
4223
+ }
4224
+ interface PaymentMethodUpdated {
4163
4225
  subscription?: Subscription;
4226
+ initiator?: HistoryActionInitiator;
4227
+ paymentMode?: PaymentMode;
4228
+ }
4229
+ interface SubscriptionCollectionMethodUpdated {
4230
+ subscription?: Subscription;
4231
+ newCollectionMethod?: CollectionMethodEnumCollectionMethod;
4232
+ previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
4233
+ }
4234
+ interface FreeTrailStarted {
4235
+ subscription?: Subscription;
4236
+ }
4237
+ interface FreeTrailEnded {
4238
+ subscription?: Subscription;
4239
+ }
4240
+ interface SubscriptionBackOfficeAction {
4241
+ subscription?: Subscription;
4242
+ /** The backoffice method name */
4243
+ name?: string;
4244
+ /** json as string format, to store the flatted request object */
4245
+ params?: string;
4246
+ }
4247
+ /** Defines unknown events restored from the logs */
4248
+ interface UnknownSubscriptionEvent {
4249
+ subscriptionAsString?: string | null;
4164
4250
  }
4165
4251
  interface CustomerNonNullableFields {
4166
4252
  visitorId: string;
@@ -4195,11 +4281,15 @@ interface TaxNonNullableFields {
4195
4281
  percentage: string;
4196
4282
  dynamic?: DynamicTaxNonNullableFields;
4197
4283
  }
4284
+ interface CyclesNonNullableFields {
4285
+ cycleFrom: number;
4286
+ }
4198
4287
  interface AdditionalFeeNonNullableFields {
4199
4288
  name: string;
4200
4289
  amount: string;
4201
4290
  trigger: AdditionalFeeTrigger;
4202
4291
  tax?: TaxNonNullableFields;
4292
+ cycles?: CyclesNonNullableFields;
4203
4293
  }
4204
4294
  interface DiscountCyclesNonNullableFields {
4205
4295
  cycleFrom: number;
@@ -4267,69 +4357,229 @@ interface BillingStatusNonNullableFields {
4267
4357
  updateBillingDateData?: UpdateBillingDateDataNonNullableFields;
4268
4358
  gracePeriodData?: GracePeriodDataNonNullableFields;
4269
4359
  }
4270
- interface SubscriptionPoliciesNonNullableFields {
4271
- customerCanCancel: boolean;
4272
- businessCanExtend: boolean;
4273
- allowEndOfCycleCancellation: boolean;
4360
+ interface SubscriptionPoliciesNonNullableFields {
4361
+ customerCanCancel: boolean;
4362
+ businessCanExtend: boolean;
4363
+ allowEndOfCycleCancellation: boolean;
4364
+ }
4365
+ interface PauseInfoNonNullableFields {
4366
+ pausePolicy: PausePolicy;
4367
+ pauseAt: PauseAt;
4368
+ resumeAt: ResumeAt;
4369
+ }
4370
+ interface CancellationInfoNonNullableFields {
4371
+ initiator: HistoryActionInitiator;
4372
+ }
4373
+ interface FixedPriceNonNullableFields {
4374
+ itemPrice: string;
4375
+ }
4376
+ interface PricingModelNonNullableFields {
4377
+ fixedPrice?: FixedPriceNonNullableFields;
4378
+ }
4379
+ interface ItemChangeNonNullableFields {
4380
+ _id: string;
4381
+ pricingModel?: PricingModelNonNullableFields;
4382
+ tax?: TaxNonNullableFields;
4383
+ }
4384
+ interface CatalogReferenceNonNullableFields {
4385
+ catalogItemId: string;
4386
+ }
4387
+ interface ApplicationFeeNonNullableFields {
4388
+ amount: string;
4389
+ discounts: DiscountNonNullableFields[];
4390
+ }
4391
+ interface ItemNonNullableFields {
4392
+ name: string;
4393
+ catalogReference?: CatalogReferenceNonNullableFields;
4394
+ category: ItemCategory;
4395
+ quantity: number;
4396
+ pricingModel?: PricingModelNonNullableFields;
4397
+ tax?: TaxNonNullableFields;
4398
+ discounts: DiscountNonNullableFields[];
4399
+ applicationFee?: ApplicationFeeNonNullableFields;
4400
+ }
4401
+ interface SubscriptionUpdateDataNonNullableFields {
4402
+ itemsToUpdate: ItemChangeNonNullableFields[];
4403
+ itemsToAdd: ItemNonNullableFields[];
4404
+ numberOfRequests: number;
4405
+ }
4406
+ interface SpecificDateSubscriptionUpdateDataNonNullableFields {
4407
+ updateData?: SubscriptionUpdateDataNonNullableFields;
4408
+ }
4409
+ interface SubscriptionNonNullableFields {
4410
+ name: string;
4411
+ customer?: CustomerNonNullableFields;
4412
+ status: SubscriptionStatusEnumSubscriptionStatus;
4413
+ billingSettings?: BillingSettingsNonNullableFields;
4414
+ billingStatus?: BillingStatusNonNullableFields;
4415
+ shippingAddress?: FullAddressDetailsNonNullableFields;
4416
+ policies?: SubscriptionPoliciesNonNullableFields;
4417
+ pauseInfo?: PauseInfoNonNullableFields;
4418
+ cancellationInfo?: CancellationInfoNonNullableFields;
4419
+ pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
4420
+ bassManaged: boolean;
4421
+ specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
4422
+ items: ItemNonNullableFields[];
4423
+ }
4424
+ interface GetSubscriptionResponseNonNullableFields {
4425
+ subscription?: SubscriptionNonNullableFields;
4426
+ }
4427
+ interface CustomerCancelSubscriptionResponseNonNullableFields {
4428
+ subscription?: SubscriptionNonNullableFields;
4429
+ }
4430
+ interface CustomerTurnOnAutoRenewalResponseNonNullableFields {
4431
+ subscription?: SubscriptionNonNullableFields;
4432
+ }
4433
+ interface CustomerTurnOffAutoRenewalResponseNonNullableFields {
4434
+ subscription?: SubscriptionNonNullableFields;
4435
+ }
4436
+ interface CustomerExtendSubscriptionResponseNonNullableFields {
4437
+ subscription?: SubscriptionNonNullableFields;
4438
+ }
4439
+ interface QuerySubscriptionsResponseNonNullableFields {
4440
+ subscriptions: SubscriptionNonNullableFields[];
4441
+ }
4442
+ interface UpdateSubscriptionPaymentMethodResponseNonNullableFields {
4443
+ subscription?: SubscriptionNonNullableFields;
4444
+ }
4445
+ interface ActionNonNullableFields {
4446
+ actionType: ActionType;
4447
+ pausePolicies: PausePolicy[];
4448
+ pauseAt: PauseAt[];
4449
+ resumeAt: ResumeAt[];
4450
+ extendPolicies: ExtendPolicyType[];
4451
+ }
4452
+ interface CustomerAllowedActionsResponseNonNullableFields {
4453
+ actions: ActionNonNullableFields[];
4454
+ }
4455
+ interface RecurringNonNullableFields {
4456
+ cycleNumber: number;
4457
+ }
4458
+ interface InvoiceDiscountNonNullableFields {
4459
+ amount: string;
4460
+ percentage: string;
4461
+ origin?: DiscountOriginNonNullableFields;
4462
+ }
4463
+ interface InvoiceApplicationFeeNonNullableFields {
4464
+ amount: string;
4465
+ discount?: InvoiceDiscountNonNullableFields;
4466
+ }
4467
+ interface PriceDetailsNonNullableFields {
4468
+ price: string;
4469
+ tax?: TaxNonNullableFields;
4470
+ discount?: InvoiceDiscountNonNullableFields;
4471
+ applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
4472
+ }
4473
+ interface LineItemTaxSummaryNonNullableFields {
4474
+ aggregatedTaxAmount: string;
4475
+ aggregatedTaxRate: string;
4476
+ taxableAmount: string;
4477
+ }
4478
+ interface TaxBreakdownNonNullableFields {
4479
+ taxType: string;
4480
+ taxRate: string;
4481
+ jurisdictionType: string;
4482
+ }
4483
+ interface ItemTaxDataNonNullableFields {
4484
+ lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields;
4485
+ taxBreakdowns: TaxBreakdownNonNullableFields[];
4486
+ }
4487
+ interface InvoiceItemNonNullableFields {
4488
+ recurring?: RecurringNonNullableFields;
4489
+ _id: string;
4490
+ name: string;
4491
+ catalogReference?: CatalogReferenceNonNullableFields;
4492
+ category: ItemCategory;
4493
+ quantity: number;
4494
+ priceDetails?: PriceDetailsNonNullableFields;
4495
+ totals?: TotalsNonNullableFields;
4496
+ taxData?: ItemTaxDataNonNullableFields;
4497
+ }
4498
+ interface SubscriptionChargeNonNullableFields {
4499
+ cycle: number;
4500
+ totals?: TotalsNonNullableFields;
4501
+ invoiceItems: InvoiceItemNonNullableFields[];
4502
+ discount?: InvoiceDiscountNonNullableFields;
4503
+ }
4504
+ interface CustomerListUpcomingChargesResponseNonNullableFields {
4505
+ upcomingCharge?: SubscriptionChargeNonNullableFields;
4506
+ }
4507
+ interface InitiatePaymentMethodSetupResponseNonNullableFields {
4508
+ paymentOrderId: string;
4509
+ }
4510
+ interface PayCycleResponseNonNullableFields {
4511
+ invoiceId: string;
4512
+ subscription?: SubscriptionNonNullableFields;
4513
+ }
4514
+ interface UpdateSubscriptionBillingDateResponseNonNullableFields {
4515
+ subscription?: SubscriptionNonNullableFields;
4516
+ }
4517
+ interface CancelSubscriptionResponseNonNullableFields {
4518
+ subscription?: SubscriptionNonNullableFields;
4519
+ }
4520
+ interface PauseSubscriptionResponseNonNullableFields {
4521
+ subscription?: SubscriptionNonNullableFields;
4522
+ }
4523
+ interface ResumeSubscriptionResponseNonNullableFields {
4524
+ subscription?: SubscriptionNonNullableFields;
4525
+ }
4526
+ interface SearchSubscriptionsResponseNonNullableFields {
4527
+ subscriptions: SubscriptionNonNullableFields[];
4528
+ }
4529
+ interface CountByStatusNonNullableFields {
4530
+ status: SubscriptionStatusEnumSubscriptionStatus;
4531
+ count: number;
4532
+ }
4533
+ interface CountSubscriptionsResponseNonNullableFields {
4534
+ countByStatus: CountByStatusNonNullableFields[];
4535
+ total: number;
4536
+ }
4537
+ interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
4538
+ subscription?: SubscriptionNonNullableFields;
4539
+ }
4540
+ interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
4541
+ subscription?: SubscriptionNonNullableFields;
4274
4542
  }
4275
- interface PauseInfoNonNullableFields {
4276
- pausePolicy: PausePolicy;
4277
- pauseAt: PauseAt;
4278
- resumeAt: ResumeAt;
4543
+ interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
4544
+ subscription?: SubscriptionNonNullableFields;
4279
4545
  }
4280
- interface CancellationInfoNonNullableFields {
4281
- initiator: HistoryActionInitiator;
4546
+ interface AmountByStatusNonNullableFields {
4547
+ status: SubscriptionStatusEnumSubscriptionStatus;
4548
+ amount: number;
4282
4549
  }
4283
- interface FixedPriceNonNullableFields {
4284
- itemPrice: string;
4550
+ interface GetSubscriptionsStatsResponseNonNullableFields {
4551
+ amountByStatuses: AmountByStatusNonNullableFields[];
4552
+ total: number;
4285
4553
  }
4286
- interface PricingModelNonNullableFields {
4287
- fixedPrice?: FixedPriceNonNullableFields;
4554
+ interface ExtendSubscriptionResponseNonNullableFields {
4555
+ subscription?: SubscriptionNonNullableFields;
4288
4556
  }
4289
- interface ItemChangeNonNullableFields {
4290
- _id: string;
4291
- pricingModel?: PricingModelNonNullableFields;
4292
- tax?: TaxNonNullableFields;
4557
+ interface UnsupportedReasonNonNullableFields {
4558
+ code: string;
4293
4559
  }
4294
- interface CatalogReferenceNonNullableFields {
4295
- catalogItemId: string;
4560
+ interface UnsupportedActionNonNullableFields {
4561
+ actionType: ActionType;
4562
+ reasons: UnsupportedReasonNonNullableFields[];
4296
4563
  }
4297
- interface ApplicationFeeNonNullableFields {
4298
- amount: string;
4299
- discounts: DiscountNonNullableFields[];
4564
+ interface AllowedActionsResponseNonNullableFields {
4565
+ actions: ActionNonNullableFields[];
4566
+ unsupportedActions: UnsupportedActionNonNullableFields[];
4300
4567
  }
4301
- interface ItemNonNullableFields {
4302
- name: string;
4303
- catalogReference?: CatalogReferenceNonNullableFields;
4304
- category: ItemCategory;
4305
- quantity: number;
4306
- pricingModel?: PricingModelNonNullableFields;
4307
- tax?: TaxNonNullableFields;
4308
- discounts: DiscountNonNullableFields[];
4309
- applicationFee?: ApplicationFeeNonNullableFields;
4568
+ interface ListUpcomingChargesResponseNonNullableFields {
4569
+ upcomingCharges: SubscriptionChargeNonNullableFields[];
4310
4570
  }
4311
- interface SubscriptionUpdateDataNonNullableFields {
4312
- itemsToUpdate: ItemChangeNonNullableFields[];
4313
- itemsToAdd: ItemNonNullableFields[];
4314
- numberOfRequests: number;
4571
+ interface ChargeNonNullableFields {
4572
+ cycleFrom: number;
4573
+ totals?: TotalsNonNullableFields;
4315
4574
  }
4316
- interface SpecificDateSubscriptionUpdateDataNonNullableFields {
4317
- updateData?: SubscriptionUpdateDataNonNullableFields;
4575
+ interface PreviewSubscriptionChargesResponseNonNullableFields {
4576
+ charges: ChargeNonNullableFields[];
4318
4577
  }
4319
- interface SubscriptionNonNullableFields {
4320
- name: string;
4321
- customer?: CustomerNonNullableFields;
4322
- status: SubscriptionStatusEnumSubscriptionStatus;
4323
- billingSettings?: BillingSettingsNonNullableFields;
4324
- billingStatus?: BillingStatusNonNullableFields;
4325
- shippingAddress?: FullAddressDetailsNonNullableFields;
4326
- policies?: SubscriptionPoliciesNonNullableFields;
4327
- pauseInfo?: PauseInfoNonNullableFields;
4328
- cancellationInfo?: CancellationInfoNonNullableFields;
4329
- pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
4330
- bassManaged: boolean;
4331
- specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
4332
- items: ItemNonNullableFields[];
4578
+ interface SubscriptionChargesNonNullableFields {
4579
+ charges: ChargeNonNullableFields[];
4580
+ }
4581
+ interface PreviewSubscriptionsChargesResponseNonNullableFields {
4582
+ subscriptionsCharges: SubscriptionChargesNonNullableFields[];
4333
4583
  }
4334
4584
  interface SubscriptionCreatedNonNullableFields {
4335
4585
  subscription?: SubscriptionNonNullableFields;
@@ -4497,166 +4747,6 @@ interface SubscriptionHistoryEntryNonNullableFields {
4497
4747
  interface ListSubscriptionHistoryResponseNonNullableFields {
4498
4748
  historyEntries: SubscriptionHistoryEntryNonNullableFields[];
4499
4749
  }
4500
- interface GetSubscriptionResponseNonNullableFields {
4501
- subscription?: SubscriptionNonNullableFields;
4502
- }
4503
- interface CustomerCancelSubscriptionResponseNonNullableFields {
4504
- subscription?: SubscriptionNonNullableFields;
4505
- }
4506
- interface CustomerTurnOnAutoRenewalResponseNonNullableFields {
4507
- subscription?: SubscriptionNonNullableFields;
4508
- }
4509
- interface CustomerTurnOffAutoRenewalResponseNonNullableFields {
4510
- subscription?: SubscriptionNonNullableFields;
4511
- }
4512
- interface CustomerExtendSubscriptionResponseNonNullableFields {
4513
- subscription?: SubscriptionNonNullableFields;
4514
- }
4515
- interface QuerySubscriptionsResponseNonNullableFields {
4516
- subscriptions: SubscriptionNonNullableFields[];
4517
- }
4518
- interface UpdateSubscriptionPaymentMethodResponseNonNullableFields {
4519
- subscription?: SubscriptionNonNullableFields;
4520
- }
4521
- interface ActionNonNullableFields {
4522
- actionType: ActionType;
4523
- pausePolicies: PausePolicy[];
4524
- pauseAt: PauseAt[];
4525
- resumeAt: ResumeAt[];
4526
- extendPolicies: ExtendPolicyType[];
4527
- }
4528
- interface CustomerAllowedActionsResponseNonNullableFields {
4529
- actions: ActionNonNullableFields[];
4530
- }
4531
- interface RecurringNonNullableFields {
4532
- cycleNumber: number;
4533
- }
4534
- interface InvoiceDiscountNonNullableFields {
4535
- amount: string;
4536
- percentage: string;
4537
- origin?: DiscountOriginNonNullableFields;
4538
- }
4539
- interface InvoiceApplicationFeeNonNullableFields {
4540
- amount: string;
4541
- discount?: InvoiceDiscountNonNullableFields;
4542
- }
4543
- interface PriceDetailsNonNullableFields {
4544
- price: string;
4545
- tax?: TaxNonNullableFields;
4546
- discount?: InvoiceDiscountNonNullableFields;
4547
- applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
4548
- }
4549
- interface LineItemTaxSummaryNonNullableFields {
4550
- aggregatedTaxAmount: string;
4551
- aggregatedTaxRate: string;
4552
- taxableAmount: string;
4553
- }
4554
- interface TaxBreakdownNonNullableFields {
4555
- taxType: string;
4556
- taxRate: string;
4557
- jurisdictionType: string;
4558
- }
4559
- interface ItemTaxDataNonNullableFields {
4560
- lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields;
4561
- taxBreakdowns: TaxBreakdownNonNullableFields[];
4562
- }
4563
- interface InvoiceItemNonNullableFields {
4564
- recurring?: RecurringNonNullableFields;
4565
- _id: string;
4566
- name: string;
4567
- catalogReference?: CatalogReferenceNonNullableFields;
4568
- category: ItemCategory;
4569
- quantity: number;
4570
- priceDetails?: PriceDetailsNonNullableFields;
4571
- totals?: TotalsNonNullableFields;
4572
- taxData?: ItemTaxDataNonNullableFields;
4573
- }
4574
- interface SubscriptionChargeNonNullableFields {
4575
- cycle: number;
4576
- totals?: TotalsNonNullableFields;
4577
- invoiceItems: InvoiceItemNonNullableFields[];
4578
- discount?: InvoiceDiscountNonNullableFields;
4579
- }
4580
- interface CustomerListUpcomingChargesResponseNonNullableFields {
4581
- upcomingCharge?: SubscriptionChargeNonNullableFields;
4582
- }
4583
- interface InitiatePaymentMethodSetupResponseNonNullableFields {
4584
- paymentOrderId: string;
4585
- }
4586
- interface UpdateSubscriptionBillingDateResponseNonNullableFields {
4587
- subscription?: SubscriptionNonNullableFields;
4588
- }
4589
- interface CancelSubscriptionResponseNonNullableFields {
4590
- subscription?: SubscriptionNonNullableFields;
4591
- }
4592
- interface PauseSubscriptionResponseNonNullableFields {
4593
- subscription?: SubscriptionNonNullableFields;
4594
- }
4595
- interface ResumeSubscriptionResponseNonNullableFields {
4596
- subscription?: SubscriptionNonNullableFields;
4597
- }
4598
- interface SearchSubscriptionsResponseNonNullableFields {
4599
- subscriptions: SubscriptionNonNullableFields[];
4600
- }
4601
- interface CountByStatusNonNullableFields {
4602
- status: SubscriptionStatusEnumSubscriptionStatus;
4603
- count: number;
4604
- }
4605
- interface CountSubscriptionsResponseNonNullableFields {
4606
- countByStatus: CountByStatusNonNullableFields[];
4607
- total: number;
4608
- }
4609
- interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
4610
- subscription?: SubscriptionNonNullableFields;
4611
- }
4612
- interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
4613
- subscription?: SubscriptionNonNullableFields;
4614
- }
4615
- interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
4616
- subscription?: SubscriptionNonNullableFields;
4617
- }
4618
- interface AmountByStatusNonNullableFields {
4619
- status: SubscriptionStatusEnumSubscriptionStatus;
4620
- amount: number;
4621
- }
4622
- interface GetSubscriptionsStatsResponseNonNullableFields {
4623
- amountByStatuses: AmountByStatusNonNullableFields[];
4624
- total: number;
4625
- }
4626
- interface ExtendSubscriptionResponseNonNullableFields {
4627
- subscription?: SubscriptionNonNullableFields;
4628
- }
4629
- interface UnsupportedReasonNonNullableFields {
4630
- code: string;
4631
- }
4632
- interface UnsupportedActionNonNullableFields {
4633
- actionType: ActionType;
4634
- reasons: UnsupportedReasonNonNullableFields[];
4635
- }
4636
- interface AllowedActionsResponseNonNullableFields {
4637
- actions: ActionNonNullableFields[];
4638
- unsupportedActions: UnsupportedActionNonNullableFields[];
4639
- }
4640
- interface ListUpcomingChargesResponseNonNullableFields {
4641
- upcomingCharges: SubscriptionChargeNonNullableFields[];
4642
- }
4643
- interface ChargeNonNullableFields {
4644
- cycleFrom: number;
4645
- totals?: TotalsNonNullableFields;
4646
- }
4647
- interface PreviewSubscriptionChargesResponseNonNullableFields {
4648
- charges: ChargeNonNullableFields[];
4649
- }
4650
- interface SubscriptionChargesNonNullableFields {
4651
- charges: ChargeNonNullableFields[];
4652
- }
4653
- interface PreviewSubscriptionsChargesResponseNonNullableFields {
4654
- subscriptionsCharges: SubscriptionChargesNonNullableFields[];
4655
- }
4656
- interface PayCycleResponseNonNullableFields {
4657
- invoiceId: string;
4658
- subscription?: SubscriptionNonNullableFields;
4659
- }
4660
4750
 
4661
4751
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4662
4752
  getUrl: (context: any) => string;
@@ -4668,9 +4758,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
4668
4758
  __responseType: Q;
4669
4759
  __originalResponseType: R;
4670
4760
  };
4671
- declare function listSubscriptionHistory(): __PublicMethodMetaInfo<'GET', {
4672
- subscriptionId: string;
4673
- }, ListSubscriptionHistoryRequest, ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields, ListSubscriptionHistoryResponse$1 & ListSubscriptionHistoryResponseNonNullableFields$1>;
4674
4761
  declare function customerGetSubscription(): __PublicMethodMetaInfo<'GET', {
4675
4762
  id: string;
4676
4763
  }, GetSubscriptionRequest, GetSubscriptionRequest$1, GetSubscriptionResponse & GetSubscriptionResponseNonNullableFields, GetSubscriptionResponse$1 & GetSubscriptionResponseNonNullableFields$1>;
@@ -4699,6 +4786,9 @@ declare function customerListUpcomingCharges(): __PublicMethodMetaInfo<'GET', {
4699
4786
  declare function customerInitiatePaymentMethodSetup(): __PublicMethodMetaInfo<'POST', {
4700
4787
  id: string;
4701
4788
  }, InitiatePaymentMethodSetupRequest, InitiatePaymentMethodSetupRequest$1, InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields, InitiatePaymentMethodSetupResponse$1 & InitiatePaymentMethodSetupResponseNonNullableFields$1>;
4789
+ declare function payCycle(): __PublicMethodMetaInfo<'POST', {
4790
+ subscriptionId: string;
4791
+ }, PayCycleRequest, PayCycleRequest$1, PayCycleResponse & PayCycleResponseNonNullableFields, PayCycleResponse$1 & PayCycleResponseNonNullableFields$1>;
4702
4792
  declare function getSubscription(): __PublicMethodMetaInfo<'GET', {
4703
4793
  id: string;
4704
4794
  }, GetSubscriptionRequest, GetSubscriptionRequest$1, GetSubscriptionResponse & GetSubscriptionResponseNonNullableFields, GetSubscriptionResponse$1 & GetSubscriptionResponseNonNullableFields$1>;
@@ -4744,9 +4834,9 @@ declare function previewSubscriptionsCharges(): __PublicMethodMetaInfo<'GET', {}
4744
4834
  declare function initiatePaymentMethodSetup(): __PublicMethodMetaInfo<'POST', {
4745
4835
  id: string;
4746
4836
  }, InitiatePaymentMethodSetupRequest, InitiatePaymentMethodSetupRequest$1, InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields, InitiatePaymentMethodSetupResponse$1 & InitiatePaymentMethodSetupResponseNonNullableFields$1>;
4747
- declare function payCycle(): __PublicMethodMetaInfo<'POST', {
4837
+ declare function listSubscriptionHistory(): __PublicMethodMetaInfo<'GET', {
4748
4838
  subscriptionId: string;
4749
- }, PayCycleRequest, PayCycleRequest$1, PayCycleResponse & PayCycleResponseNonNullableFields, PayCycleResponse$1 & PayCycleResponseNonNullableFields$1>;
4839
+ }, ListSubscriptionHistoryRequest, ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields, ListSubscriptionHistoryResponse$1 & ListSubscriptionHistoryResponseNonNullableFields$1>;
4750
4840
 
4751
4841
  type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
4752
4842
  declare const meta_allowedActions: typeof allowedActions;