@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.
@@ -785,10 +785,32 @@ interface AdditionalFee {
785
785
  *
786
786
  * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
787
787
  * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
788
+ * @deprecated When the fee is added to the invoice.
789
+ *
790
+ * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
791
+ * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
792
+ * @replacedBy cycles
793
+ * @targetRemovalDate 2025-12-31
788
794
  */
789
795
  trigger?: AdditionalFeeTrigger;
790
796
  /** Information about the tax of the conditional fee. */
791
797
  tax?: Tax;
798
+ /**
799
+ * Specifies the cycles during which the fee will be applied. If this field is provided,
800
+ * it determines the exact range of cycles the fee applies to. The logic is as follows:
801
+ *
802
+ * - `cycle_from`: The first cycle the fee will be added to. Must be greater than 0.
803
+ * - `number_of_cycles`: The number of consecutive cycles the fee will be applied to,
804
+ * starting from `cycle_from`. If not specified, the fee applies to all cycles starting
805
+ * from `cycle_from`.
806
+ *
807
+ * Example:
808
+ * - `cycle_from = 1, number_of_cycles = 3`: Fee applies to cycles 1, 2, and 3.
809
+ * - `cycle_from = 2, number_of_cycles = None`: Fee applies to cycles 2 and onward indefinitely.
810
+ *
811
+ * If `cycles` is not specified (`None`), the fee will only be applied to the first cycle of the subscription.
812
+ */
813
+ cycles?: Cycles;
792
814
  }
793
815
  declare enum AdditionalFeeTrigger {
794
816
  UNKNOWN = "UNKNOWN",
@@ -851,6 +873,12 @@ declare enum TaxableAddressType {
851
873
  /** Tax will be calculated using multiple address (from BUSINESS to SHIPPING) */
852
874
  SHIPPING = "SHIPPING"
853
875
  }
876
+ interface Cycles {
877
+ /** The cycle will start. Minimum cycle number is 1 */
878
+ cycleFrom?: number;
879
+ /** 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. */
880
+ numberOfCycles?: number | null;
881
+ }
854
882
  interface ShippingCharges {
855
883
  /**
856
884
  * Amount of the shipping fee in `0.00` format.
@@ -1273,147 +1301,18 @@ interface SpecificDateSubscriptionUpdateData {
1273
1301
  updateData?: SubscriptionUpdateData;
1274
1302
  executionDate?: Date | null;
1275
1303
  }
1276
- interface ListSubscriptionHistoryRequest {
1277
- subscriptionId: string;
1278
- /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
1279
- mode?: HistoryViewMode;
1280
- /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
1281
- cursor?: CursorPaging;
1282
- }
1283
- declare enum HistoryViewMode {
1284
- UNKNOWN = "UNKNOWN",
1285
- /** Comprehensive view including all history events. */
1286
- BACKOFFICE = "BACKOFFICE",
1287
- /** User-centric view of the history. */
1288
- USER = "USER"
1289
- }
1290
- interface CursorPaging {
1291
- /** Maximum number of items to return in the results. */
1292
- limit?: number | null;
1293
- /**
1294
- * Pointer to the next or previous page in the list of results.
1295
- *
1296
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1297
- * Not relevant for the first request.
1298
- */
1299
- cursor?: string | null;
1300
- }
1301
- interface ListSubscriptionHistoryResponse {
1302
- /** List of history entries for the subscription. */
1303
- historyEntries?: SubscriptionHistoryEntry[];
1304
- /** Paging metadata. A `next` cursor is returned if there are more results. */
1305
- pagingMetadata?: PagingMetadataV2;
1306
- }
1307
- interface SubscriptionHistoryEntry {
1308
- entryId?: string;
1309
- /** TODO: add max length? it is not defined in domainevents, so should we? */
1310
- slug?: string;
1311
- entryTime?: Date | null;
1312
- event?: SubscriptionEvent;
1313
- }
1314
- interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
1315
- created?: SubscriptionCreated;
1316
- updated?: SubscriptionUpdated;
1317
- deleted?: SubscriptionDeleted;
1318
- activated?: SubscriptionActivated;
1319
- ended?: SubscriptionEnded;
1320
- canceled?: SubscriptionCanceled;
1321
- paused?: SubscriptionPaused;
1322
- resumed?: SubscriptionResumed;
1323
- pauseRequested?: PauseSubscriptionRequested;
1324
- resumeRequested?: ResumeSubscriptionRequested;
1325
- scheduledPauseCanceled?: ScheduledPauseCanceled;
1326
- scheduledResumeCanceled?: ScheduledResumeCanceled;
1327
- billingCycleStarted?: SubscriptionBillingCycleStarted;
1328
- autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
1329
- autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
1330
- cycleReadyToPay?: SubscriptionCycleReadyToPay;
1331
- extended?: SubscriptionExtended;
1332
- initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
1333
- latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
1334
- revived?: SubscriptionRevived;
1335
- billingDateUpdated?: SubscriptionBillingDateUpdated;
1336
- futureUpdatesRequested?: FutureUpdatesRequested;
1337
- updatesApplied?: UpdatesApplied;
1338
- resetPendingUpdates?: ResetPendingUpdates;
1339
- gracePeriodStarted?: GracePeriodStarted;
1340
- gracePeriodEnded?: GracePeriodEnded;
1341
- paymentMethodUpdated?: PaymentMethodUpdated;
1342
- collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
1343
- freeTrailStarted?: FreeTrailStarted;
1344
- freeTrailEnded?: FreeTrailEnded;
1345
- subscriptionBoAction?: SubscriptionBackOfficeAction;
1346
- unknown?: UnknownSubscriptionEvent;
1347
- }
1348
- /** @oneof */
1349
- interface SubscriptionEventPayloadOneOf {
1350
- created?: SubscriptionCreated;
1351
- updated?: SubscriptionUpdated;
1352
- deleted?: SubscriptionDeleted;
1353
- activated?: SubscriptionActivated;
1354
- ended?: SubscriptionEnded;
1355
- canceled?: SubscriptionCanceled;
1356
- paused?: SubscriptionPaused;
1357
- resumed?: SubscriptionResumed;
1358
- pauseRequested?: PauseSubscriptionRequested;
1359
- resumeRequested?: ResumeSubscriptionRequested;
1360
- scheduledPauseCanceled?: ScheduledPauseCanceled;
1361
- scheduledResumeCanceled?: ScheduledResumeCanceled;
1362
- billingCycleStarted?: SubscriptionBillingCycleStarted;
1363
- autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
1364
- autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
1365
- cycleReadyToPay?: SubscriptionCycleReadyToPay;
1366
- extended?: SubscriptionExtended;
1367
- initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
1368
- latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
1369
- revived?: SubscriptionRevived;
1370
- billingDateUpdated?: SubscriptionBillingDateUpdated;
1371
- futureUpdatesRequested?: FutureUpdatesRequested;
1372
- updatesApplied?: UpdatesApplied;
1373
- resetPendingUpdates?: ResetPendingUpdates;
1374
- gracePeriodStarted?: GracePeriodStarted;
1375
- gracePeriodEnded?: GracePeriodEnded;
1376
- paymentMethodUpdated?: PaymentMethodUpdated;
1377
- collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
1378
- freeTrailStarted?: FreeTrailStarted;
1379
- freeTrailEnded?: FreeTrailEnded;
1380
- subscriptionBoAction?: SubscriptionBackOfficeAction;
1381
- unknown?: UnknownSubscriptionEvent;
1304
+ interface GetSubscriptionRequest {
1305
+ _id: string;
1382
1306
  }
1383
- interface SubscriptionCreated {
1307
+ interface GetSubscriptionResponse {
1384
1308
  subscription?: Subscription;
1385
1309
  }
1386
- interface SubscriptionUpdated {
1387
- current?: Subscription;
1388
- previous?: Subscription;
1389
- diff?: SubscriptionDiff;
1390
- }
1391
- interface SubscriptionDiff {
1392
- added?: string | null;
1393
- changed?: string | null;
1394
- deleted?: string | null;
1395
- }
1396
- interface SubscriptionDeleted {
1397
- subscriptionId?: string;
1398
- }
1399
- /**
1400
- * Sent each time a subscription status has been set to Active
1401
- * Active shows that a subscription is live and operational.
1402
- * For example:
1403
- * * For subscription with free trial, free trial start date is also the activation date.
1404
- * * For a subscription with future start date, the start date is also the activation date.
1405
- * * When a subscription is resumed from a pause status, the resume date is also the activation date.
1406
- */
1407
- interface SubscriptionActivated {
1408
- subscription?: Subscription;
1310
+ interface CustomerCancelSubscriptionRequest {
1311
+ _id: string;
1312
+ /** Optional action reason message */
1313
+ reason?: string | null;
1409
1314
  }
1410
- /**
1411
- * Sent each time a subscription status has been set to Ended
1412
- * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
1413
- * This is different from a Canceled subscription which ends the subscription before a designated end date.
1414
- * Therefore, Ended and Canceled are mutually exclusive.
1415
- */
1416
- interface SubscriptionEnded {
1315
+ interface CustomerCancelSubscriptionResponse {
1417
1316
  subscription?: Subscription;
1418
1317
  }
1419
1318
  /**
@@ -1431,48 +1330,32 @@ interface ActionDetails {
1431
1330
  initiator?: HistoryActionInitiator;
1432
1331
  reason?: string | null;
1433
1332
  }
1434
- interface SubscriptionPaused {
1435
- subscription?: Subscription;
1436
- pausePolicy?: PausePolicy;
1437
- actionDetails?: ActionDetails;
1438
- }
1439
- interface SubscriptionResumed {
1440
- subscription?: Subscription;
1441
- actionDetails?: ActionDetails;
1442
- }
1443
- interface PauseSubscriptionRequested {
1444
- subscription?: Subscription;
1445
- pauseAt?: PauseAt;
1446
- pausePolicy?: PausePolicy;
1447
- actionDetails?: ActionDetails;
1448
- }
1449
- interface ResumeSubscriptionRequested {
1450
- subscription?: Subscription;
1451
- resumeAt?: ResumeAt;
1452
- actionDetails?: ActionDetails;
1453
- }
1454
- interface ScheduledPauseCanceled {
1455
- subscription?: Subscription;
1456
- actionDetails?: ActionDetails;
1333
+ interface CustomerTurnOnAutoRenewalRequest {
1334
+ _id: string;
1335
+ /** Optional action reason message */
1336
+ reason?: string | null;
1457
1337
  }
1458
- interface ScheduledResumeCanceled {
1338
+ interface CustomerTurnOnAutoRenewalResponse {
1459
1339
  subscription?: Subscription;
1460
- actionDetails?: ActionDetails;
1461
1340
  }
1462
- interface SubscriptionBillingCycleStarted {
1463
- subscription?: Subscription;
1464
- /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
1465
- paymentTransactionId?: string | null;
1341
+ interface CustomerTurnOffAutoRenewalRequest {
1342
+ _id: string;
1343
+ /** Optional action reason message */
1344
+ reason?: string | null;
1466
1345
  }
1467
- interface SubscriptionAutoRenewalTurnedOn {
1346
+ interface CustomerTurnOffAutoRenewalResponse {
1468
1347
  subscription?: Subscription;
1469
- actionDetails?: ActionDetails;
1470
1348
  }
1471
- interface SubscriptionAutoRenewalTurnedOff {
1472
- subscription?: Subscription;
1473
- actionDetails?: ActionDetails;
1349
+ interface CustomerExtendSubscriptionRequest {
1350
+ /** The ID of the subscription to be extended */
1351
+ _id: string;
1352
+ /** Optional action reason message */
1353
+ reason?: string | null;
1354
+ /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
1355
+ billingCyclesToAdd: number | null;
1474
1356
  }
1475
- interface SubscriptionCycleReadyToPay {
1357
+ interface CustomerExtendSubscriptionResponse {
1358
+ /** The now extended subscription */
1476
1359
  subscription?: Subscription;
1477
1360
  }
1478
1361
  interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
@@ -1486,95 +1369,68 @@ interface SubscriptionExtendedExtendPolicyOneOf {
1486
1369
  extensionPeriod?: Duration;
1487
1370
  extensionBillingCycles?: number;
1488
1371
  }
1489
- interface SubscriptionInitialPurchaseCompleted {
1490
- subscription?: Subscription;
1491
- actionDetails?: ActionDetails;
1492
- paymentTransactionId?: string | null;
1372
+ interface QuerySubscriptionsRequest {
1373
+ query?: QueryV2;
1493
1374
  }
1494
- interface LatestInvoiceMarkedAsPaid {
1495
- subscription?: Subscription;
1375
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
1376
+ /** Paging options to limit and skip the number of items. */
1377
+ paging?: Paging;
1378
+ /** 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`. */
1379
+ cursorPaging?: CursorPaging;
1380
+ /**
1381
+ * Filter object.
1382
+ *
1383
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1384
+ */
1385
+ filter?: Record<string, any> | null;
1386
+ /**
1387
+ * Sort object.
1388
+ *
1389
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1390
+ */
1391
+ sort?: Sorting[];
1392
+ /** 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. */
1393
+ fields?: string[];
1394
+ /** 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. */
1395
+ fieldsets?: string[];
1496
1396
  }
1497
- interface SubscriptionRevived {
1498
- subscription?: Subscription;
1397
+ /** @oneof */
1398
+ interface QueryV2PagingMethodOneOf {
1399
+ /** Paging options to limit and skip the number of items. */
1400
+ paging?: Paging;
1401
+ /** 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`. */
1402
+ cursorPaging?: CursorPaging;
1499
1403
  }
1500
- interface SubscriptionBillingDateUpdated {
1501
- subscription?: Subscription;
1502
- billingDate?: Date | null;
1503
- proration?: Proration;
1404
+ interface Sorting {
1405
+ /** Name of the field to sort by. */
1406
+ fieldName?: string;
1407
+ /** Sort order. */
1408
+ order?: SortOrder;
1504
1409
  }
1505
- interface FutureUpdatesRequested {
1506
- subscription?: Subscription;
1507
- requestedUpdateData?: SubscriptionUpdateData;
1508
- }
1509
- interface UpdatesApplied {
1510
- subscription?: Subscription;
1511
- updateAction?: UpdateAction;
1512
- appliedUpdateData?: SubscriptionUpdateData;
1513
- }
1514
- declare enum UpdateAction {
1515
- NONE = "NONE",
1516
- /** Update subscription immediately, please note proration for updates changing price are not yet supported */
1517
- IMMEDIATELY = "IMMEDIATELY",
1518
- /** Request updates that will take affect only at the start of the next billing cycle. */
1519
- NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
1520
- /** Reset all pending updates */
1521
- RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
1522
- /** Request updates that will take affect only at a specific date. */
1523
- SPECIFIC_DATE = "SPECIFIC_DATE"
1524
- }
1525
- interface ResetPendingUpdates {
1526
- subscription?: Subscription;
1527
- }
1528
- interface GracePeriodStarted {
1529
- subscription?: Subscription;
1530
- }
1531
- interface GracePeriodEnded {
1532
- subscription?: Subscription;
1533
- /** Indication for the payment settlement method. */
1534
- paymentSettlementMethod?: PaymentSettlementMethod;
1535
- }
1536
- declare enum PaymentSettlementMethod {
1537
- UNKNOWN = "UNKNOWN",
1538
- /** System-defined payment settlement. */
1539
- SYSTEM = "SYSTEM",
1540
- /** Manually mark the payment as paid. */
1541
- MARK_AS_PAID = "MARK_AS_PAID",
1542
- /** Require the customer to pay immediately, by insert a new payment method. */
1543
- CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
1544
- }
1545
- interface PaymentMethodUpdated {
1546
- subscription?: Subscription;
1547
- initiator?: HistoryActionInitiator;
1548
- paymentMode?: PaymentMode;
1549
- }
1550
- declare enum PaymentMode {
1551
- NONE = "NONE",
1552
- /** The latest invoice of the subscription will be charged. */
1553
- CHARGE = "CHARGE",
1554
- /** An authorization invoice with zero amount will be created. */
1555
- AUTHORIZATION = "AUTHORIZATION"
1556
- }
1557
- interface SubscriptionCollectionMethodUpdated {
1558
- subscription?: Subscription;
1559
- newCollectionMethod?: CollectionMethodEnumCollectionMethod;
1560
- previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
1561
- }
1562
- interface FreeTrailStarted {
1563
- subscription?: Subscription;
1410
+ declare enum SortOrder {
1411
+ ASC = "ASC",
1412
+ DESC = "DESC"
1564
1413
  }
1565
- interface FreeTrailEnded {
1566
- subscription?: Subscription;
1414
+ interface Paging {
1415
+ /** Number of items to load. */
1416
+ limit?: number | null;
1417
+ /** Number of items to skip in the current sort order. */
1418
+ offset?: number | null;
1567
1419
  }
1568
- interface SubscriptionBackOfficeAction {
1569
- subscription?: Subscription;
1570
- /** The backoffice method name */
1571
- name?: string;
1572
- /** json as string format, to store the flatted request object */
1573
- params?: string;
1420
+ interface CursorPaging {
1421
+ /** Maximum number of items to return in the results. */
1422
+ limit?: number | null;
1423
+ /**
1424
+ * Pointer to the next or previous page in the list of results.
1425
+ *
1426
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1427
+ * Not relevant for the first request.
1428
+ */
1429
+ cursor?: string | null;
1574
1430
  }
1575
- /** Defines unknown events restored from the logs */
1576
- interface UnknownSubscriptionEvent {
1577
- subscriptionAsString?: string | null;
1431
+ interface QuerySubscriptionsResponse {
1432
+ subscriptions?: Subscription[];
1433
+ metadata?: PagingMetadataV2;
1578
1434
  }
1579
1435
  interface PagingMetadataV2 {
1580
1436
  /** Number of items returned in the response. */
@@ -1594,100 +1450,6 @@ interface Cursors {
1594
1450
  /** Cursor pointing to the previous page in the list of results. */
1595
1451
  prev?: string | null;
1596
1452
  }
1597
- interface GetSubscriptionRequest {
1598
- _id: string;
1599
- }
1600
- interface GetSubscriptionResponse {
1601
- subscription?: Subscription;
1602
- }
1603
- interface CustomerCancelSubscriptionRequest {
1604
- _id: string;
1605
- /** Optional action reason message */
1606
- reason?: string | null;
1607
- }
1608
- interface CustomerCancelSubscriptionResponse {
1609
- subscription?: Subscription;
1610
- }
1611
- interface CustomerTurnOnAutoRenewalRequest {
1612
- _id: string;
1613
- /** Optional action reason message */
1614
- reason?: string | null;
1615
- }
1616
- interface CustomerTurnOnAutoRenewalResponse {
1617
- subscription?: Subscription;
1618
- }
1619
- interface CustomerTurnOffAutoRenewalRequest {
1620
- _id: string;
1621
- /** Optional action reason message */
1622
- reason?: string | null;
1623
- }
1624
- interface CustomerTurnOffAutoRenewalResponse {
1625
- subscription?: Subscription;
1626
- }
1627
- interface CustomerExtendSubscriptionRequest {
1628
- /** The ID of the subscription to be extended */
1629
- _id: string;
1630
- /** Optional action reason message */
1631
- reason?: string | null;
1632
- /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
1633
- billingCyclesToAdd: number | null;
1634
- }
1635
- interface CustomerExtendSubscriptionResponse {
1636
- /** The now extended subscription */
1637
- subscription?: Subscription;
1638
- }
1639
- interface QuerySubscriptionsRequest {
1640
- query?: QueryV2;
1641
- }
1642
- interface QueryV2 extends QueryV2PagingMethodOneOf {
1643
- /** Paging options to limit and skip the number of items. */
1644
- paging?: Paging;
1645
- /** 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`. */
1646
- cursorPaging?: CursorPaging;
1647
- /**
1648
- * Filter object.
1649
- *
1650
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1651
- */
1652
- filter?: Record<string, any> | null;
1653
- /**
1654
- * Sort object.
1655
- *
1656
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1657
- */
1658
- sort?: Sorting[];
1659
- /** 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. */
1660
- fields?: string[];
1661
- /** 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. */
1662
- fieldsets?: string[];
1663
- }
1664
- /** @oneof */
1665
- interface QueryV2PagingMethodOneOf {
1666
- /** Paging options to limit and skip the number of items. */
1667
- paging?: Paging;
1668
- /** 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`. */
1669
- cursorPaging?: CursorPaging;
1670
- }
1671
- interface Sorting {
1672
- /** Name of the field to sort by. */
1673
- fieldName?: string;
1674
- /** Sort order. */
1675
- order?: SortOrder;
1676
- }
1677
- declare enum SortOrder {
1678
- ASC = "ASC",
1679
- DESC = "DESC"
1680
- }
1681
- interface Paging {
1682
- /** Number of items to load. */
1683
- limit?: number | null;
1684
- /** Number of items to skip in the current sort order. */
1685
- offset?: number | null;
1686
- }
1687
- interface QuerySubscriptionsResponse {
1688
- subscriptions?: Subscription[];
1689
- metadata?: PagingMetadataV2;
1690
- }
1691
1453
  interface CountSubscriptionsRequest {
1692
1454
  /** Filters to specify which subscriptions are counted. */
1693
1455
  filter?: CountSubscriptionFilter;
@@ -1991,6 +1753,13 @@ interface InitiatePaymentMethodSetupRequest {
1991
1753
  paymentMode?: PaymentMode;
1992
1754
  paymentSettings?: PaymentSettings;
1993
1755
  }
1756
+ declare enum PaymentMode {
1757
+ NONE = "NONE",
1758
+ /** The latest invoice of the subscription will be charged. */
1759
+ CHARGE = "CHARGE",
1760
+ /** An authorization invoice with zero amount will be created. */
1761
+ AUTHORIZATION = "AUTHORIZATION"
1762
+ }
1994
1763
  interface PaymentSettings {
1995
1764
  /** Allowed payment providers for Subscriptions, for example to limit subscriptions to be created only with "Wix Payments" provider. */
1996
1765
  allowedProviderIds?: string[];
@@ -2143,21 +1912,12 @@ declare enum WebhookIdentityType {
2143
1912
  WIX_USER = "WIX_USER",
2144
1913
  APP = "APP"
2145
1914
  }
2146
- interface SetIsMigratedEvent {
2147
- subscriptionId?: string;
2148
- }
2149
- interface SubscriptionDelayedSyncEvent {
2150
- subscriptionId?: string;
2151
- }
2152
- interface InvoiceAction extends InvoiceActionActionTypeOneOf {
2153
- payRecurring?: PayRecurringInvoice;
1915
+ interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
1916
+ activeSubscription?: CreateSubscriptionRequest;
2154
1917
  }
2155
1918
  /** @oneof */
2156
- interface InvoiceActionActionTypeOneOf {
2157
- payRecurring?: PayRecurringInvoice;
2158
- }
2159
- interface PayRecurringInvoice {
2160
- invoiceId?: string;
1919
+ interface CreateSubscriptionInStateRequestModeOneOf {
1920
+ activeSubscription?: CreateSubscriptionRequest;
2161
1921
  }
2162
1922
  interface CreateSubscriptionRequest {
2163
1923
  subscription?: Subscription;
@@ -2172,424 +1932,804 @@ interface OriginOverride {
2172
1932
  appId?: string;
2173
1933
  instanceId?: string;
2174
1934
  }
2175
- interface CreateSubscriptionResponse {
2176
- subscription?: Subscription;
2177
- /** Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions. */
2178
- paymentOrderId?: string | null;
2179
- }
2180
- interface UpdateSubscriptionRequest {
2181
- /** Revision is validated if Subscription.revision is set */
2182
- subscription?: Subscription;
1935
+ interface CreateSubscriptionInStateResponse {
1936
+ subscriptionId?: string;
2183
1937
  }
2184
- interface UpdateSubscriptionResponse {
2185
- subscription?: Subscription;
1938
+ interface PayCycleRequest {
1939
+ subscriptionId: string;
1940
+ paymentTestMode?: PaymentTestMode;
1941
+ tenantId: string;
2186
1942
  }
2187
- interface UpdateSubscriptionStartDateRequest {
2188
- /** Subscription ID */
2189
- _id?: string;
2190
- /**
2191
- * Can be updated only if Subscription is in Draft state
2192
- * By setting start_date in the future, end_date will be recalculated for termed Subscriptions
2193
- * cycles_to_pay_on_creation will be set to 1 if no free trial is set
2194
- */
2195
- startDate?: Date | null;
1943
+ declare enum PaymentTestMode {
1944
+ REGULAR = "REGULAR",
1945
+ FAIL_TECHNICAL = "FAIL_TECHNICAL",
1946
+ FAIL_DECLINE = "FAIL_DECLINE",
1947
+ FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
2196
1948
  }
2197
- interface UpdateSubscriptionStartDateResponse {
1949
+ interface PayCycleResponse {
1950
+ invoiceId?: string;
1951
+ paymentOrderId?: string | null;
2198
1952
  subscription?: Subscription;
2199
1953
  }
2200
- interface UpdateSubscriptionPoliciesRequest {
2201
- /** Subscription ID */
1954
+ interface GetFullSubscriptionDataRequest {
2202
1955
  _id?: string;
2203
- cancellableByCustomer?: boolean | null;
2204
1956
  }
2205
- interface UpdateSubscriptionPoliciesResponse {
2206
- /** Updated policies of the subscription */
2207
- policies?: SubscriptionPolicies;
1957
+ interface GetFullSubscriptionDataResponse {
1958
+ subscription?: Subscription;
1959
+ internalSubscriptionData?: InternalSubscriptionData;
2208
1960
  }
2209
- interface UpdateSubscriptionBillingDateRequest {
2210
- /** ID of the subscription to update the billing date for. */
2211
- _id: string;
2212
- /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
2213
- billingDate: Date | null;
2214
- /**
2215
- * Information about how BASS adjusts the total of the next invoice. Extending
2216
- * the current billing cycle results in a higher payment, while shortening it
2217
- * leads to a lower payment. BASS offers automatic calculation of the proration
2218
- * amount based on the number of days added to or removed from the current billing
2219
- * cycle. Alternatively, you can use your own custom method to calculate the
2220
- * proration amount. The custom proration amount can't exceed the total of the
2221
- * current billing cycle.
2222
- */
2223
- proration?: Proration;
1961
+ interface InternalSubscriptionData {
1962
+ originInstanceId?: string;
1963
+ source?: string | null;
1964
+ billingType?: string;
1965
+ isOneTime?: boolean;
1966
+ migrationDetails?: MigrationDetails;
1967
+ pausePaidDuration?: string | null;
1968
+ authorizationPaymentData?: PaymentData;
1969
+ currentCyclePausePeriods?: PausePeriod[];
2224
1970
  }
2225
- interface UpdateSubscriptionBillingDateResponse {
2226
- /** Updated subscription. */
2227
- subscription?: Subscription;
1971
+ interface MigrationDetails {
1972
+ /** system (application) where the Subscription has been created */
1973
+ originSystem?: string;
1974
+ /** date when the Subscription started to be managed in BASS */
1975
+ shiftManagementDate?: Date | null;
2228
1976
  }
2229
- interface UpdateSubscriptionOriginRequest {
2230
- /** ID of the subscription to update origin. */
2231
- _id?: string;
2232
- /** Origin entity ID of the subscription to update. */
2233
- entityId?: string;
1977
+ interface PausePeriod {
1978
+ startDate?: Date | null;
1979
+ endDate?: Date | null;
2234
1980
  }
2235
- interface UpdateSubscriptionOriginResponse {
2236
- /** Updated subscription. */
1981
+ interface GetSubscriptionAndInternalDataRequest {
1982
+ subscriptionId?: string;
1983
+ tenantId?: string;
1984
+ }
1985
+ interface GetSubscriptionAndInternalDataResponse {
2237
1986
  subscription?: Subscription;
1987
+ internalSubscriptionData?: InternalSubscriptionData;
2238
1988
  }
2239
- interface ReviseSubscriptionRequest {
2240
- /** Subscription ID */
1989
+ interface SearchSubscriptionRequest {
2241
1990
  _id?: string;
2242
- /** 0 for no revision, maxSize is 100 */
2243
- items?: Item[];
1991
+ tenantId?: string;
2244
1992
  }
2245
- interface ReviseSubscriptionResponse {
1993
+ interface SearchSubscriptionResponse {
2246
1994
  subscription?: Subscription;
2247
1995
  }
2248
- interface UpdateSubscriptionItemsRequest {
2249
- /** Subscription ID */
2250
- _id?: string;
2251
- /** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
2252
- updateAction?: UpdateAction;
2253
- /** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
2254
- scheduleAdditionalInfo?: ScheduleAdditionalInfo;
2255
- /** Existing items to update */
2256
- itemsToUpdate?: ItemChange[];
2257
- /** Items to add */
2258
- itemsToAdd?: Item[];
2259
- /** Existing items to delete */
2260
- itemsToDelete?: string[] | null;
1996
+ interface UpdatePausePaidDurationRequest {
1997
+ subscriptionId?: string;
1998
+ pausePaidDurationSeconds?: string;
1999
+ tenantId?: string;
2261
2000
  }
2262
- interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
2263
- /**
2264
- * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2265
- * format. The use of this field may be restricted in various BASS endpoints.
2266
- * For example, in _Bulk Update Subscription Items_ it's only available in
2267
- * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2268
- * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2269
- * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2270
- */
2271
- specificDate?: Date | null;
2272
- /**
2273
- * When the update becomes effective, as number of billing cycles from now.
2274
- * The use of this field may be restricted in various BASS endpoints.
2275
- * For example, in _Pause Subscription_ it's only available in
2276
- * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2277
- * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2278
- */
2279
- numberOfCycles?: number;
2001
+ interface UpdatePausePaidDurationResponse {
2280
2002
  }
2281
- /** @oneof */
2282
- interface ScheduleAdditionalInfoParamOneOf {
2283
- /**
2284
- * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2285
- * format. The use of this field may be restricted in various BASS endpoints.
2286
- * For example, in _Bulk Update Subscription Items_ it's only available in
2287
- * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2288
- * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2289
- * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2290
- */
2291
- specificDate?: Date | null;
2292
- /**
2293
- * When the update becomes effective, as number of billing cycles from now.
2294
- * The use of this field may be restricted in various BASS endpoints.
2295
- * For example, in _Pause Subscription_ it's only available in
2296
- * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2297
- * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2298
- */
2299
- numberOfCycles?: number;
2003
+ interface UpdateStatusRequest {
2004
+ subscriptionId?: string;
2005
+ tenantId?: string;
2006
+ status?: SubscriptionStatusEnumSubscriptionStatus;
2300
2007
  }
2301
- interface UpdateSubscriptionItemsResponse {
2008
+ interface UpdateStatusResponse {
2302
2009
  subscription?: Subscription;
2303
2010
  }
2304
- interface BulkUpdateSubscriptionItemsByFilterRequest {
2305
- /**
2306
- * Filter to identify the subscriptions for which items are updated. For
2307
- * supported fields see
2308
- * [Search and Query: Bulk Update Subscription Items By Filter](https://bo.wix.com/wix-docs/rest/drafts/subscriptions-by-billing-by-wix/search-and-query#drafts_subscriptions-by-billing-by-wix_search-and-query_bulk-update-subscription-items-by-filter).
2309
- * Sending an empty subscription filter results in a validation error.
2310
- * In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
2311
- * `subscriptionId` field inside this filter. Passing any other filter results
2312
- * in a failed validation error.
2313
- */
2314
- subscriptionFilter?: Record<string, any> | null;
2315
- /**
2316
- * Filter to specify which subscription items are updated. Make sure to use
2317
- * the catalog item ID and not the item's unique ID. All subscription items
2318
- * with matching `items.catalogReference.catalogItemId` are updated.
2319
- *
2320
- * Max: `100` reference catalog item IDs
2321
- */
2322
- catalogReferenceIds?: string[] | null;
2323
- /**
2324
- * Information about the update timing and update type.
2325
- *
2326
- * + `"IMMEDIATELY"`: The updates become effective immediately.
2327
- * + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
2328
- * + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
2329
- * + `"RESET_PENDING_UPDATES"`: All currently scheduled updates for the specified supcriptions are canceled. Use only the `subscriptionId` field inside `subscriptionFilter`, all other filters result in failed validation errors.
2330
- */
2331
- updateAction?: UpdateAction;
2332
- /**
2333
- * Additional information for updates. Currently, only supported for
2334
- * `{"updateAction": "SPECIFIC_DATE"}`.
2335
- */
2336
- scheduleAdditionalInfo?: ScheduleAdditionalInfo;
2337
- /**
2338
- * Update details for the susbcription items that match the filtering.
2339
- * Currently, you can update only the item price, quantity, and tax. Note
2340
- * that all item properties are updated to the same values. In case you want set
2341
- * different values for individual items, you must call
2342
- * _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
2343
- */
2344
- bulkItemUpdateData?: BulkItemChange;
2345
- /** __Not implemented yet__. Items to add to the subscriptions matching the filtering. */
2346
- itemsToAdd?: Item[];
2011
+ interface UpdatePaymentStatusRequest {
2012
+ subscriptionId?: string;
2013
+ tenantId?: string;
2014
+ paymentStatus?: PaymentStatus;
2347
2015
  }
2348
- interface BulkItemChange {
2349
- /** Information about the new item price. */
2350
- pricingModel?: PricingModel;
2351
- /**
2352
- * New item quantity.
2353
- *
2354
- * Min: `1`
2355
- */
2356
- quantity?: number | null;
2357
- /** Information about the new item tax. */
2358
- tax?: Tax;
2016
+ interface UpdatePaymentStatusResponse {
2017
+ subscription?: Subscription;
2359
2018
  }
2360
- interface BulkUpdateSubscriptionItemsByFilterResponse {
2361
- /**
2362
- * ID of your bulk job. You can use
2363
- * [this Async Infra call](https://pbo.wix.com/fire-console/?artifact=com.wixpress.asyncinfra.async-job-service&service=wix.infra.asyncjobs.v1.AsyncJobService&method=ListAsyncJobItems&body=eyJqb2JfaWQiOiIifQ%3D%3D)
2364
- * to retrieve information about the job status.
2365
- */
2366
- jobId?: string;
2019
+ interface ReviveSubscriptionRequest {
2020
+ tenantId?: string;
2021
+ subscriptionId?: string;
2022
+ revivePolicy?: RevivePolicy;
2023
+ isTestRun?: boolean;
2367
2024
  }
2368
- interface DeleteSubscriptionRequest {
2369
- _id?: string;
2370
- revision?: string;
2025
+ declare enum RevivePolicy {
2026
+ SIMPLE = "SIMPLE",
2027
+ RESUME = "RESUME"
2371
2028
  }
2372
- interface DeleteSubscriptionResponse {
2029
+ interface ReviveSubscriptionResponse {
2030
+ subscription?: Subscription;
2373
2031
  }
2374
- interface CancelSubscriptionRequest {
2375
- _id: string;
2376
- actionContext: ActionContext;
2032
+ interface ConvertSapiRequest {
2033
+ subscriptionId?: string;
2377
2034
  }
2378
- interface ActionContext {
2379
- initiator?: ActionInitiator;
2380
- /** Optional action reason message */
2381
- reason?: string | null;
2035
+ interface ConvertSapiResponse {
2036
+ subscription?: Subscription;
2382
2037
  }
2383
- declare enum ActionInitiator {
2384
- UNDEFINED = "UNDEFINED",
2385
- BUSINESS = "BUSINESS",
2386
- CUSTOMER = "CUSTOMER",
2387
- SYSTEM = "SYSTEM"
2038
+ interface GetSubscriptionInvoicesRequest {
2039
+ _id?: string;
2388
2040
  }
2389
- interface CancelSubscriptionResponse {
2390
- subscription?: Subscription;
2041
+ interface GetSubscriptionInvoicesResponse {
2042
+ invoices?: SubscriptionInvoice[];
2391
2043
  }
2392
- interface PauseSubscriptionRequest {
2393
- _id: string;
2394
- pausePolicy?: PausePolicy;
2395
- pauseAt?: PauseAt;
2396
- /** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
2397
- pauseAtSchedule?: ScheduleAdditionalInfo;
2398
- /** contains additional scheduling information for certain auto_resume_at either specific date */
2399
- autoResumeAtSchedule?: ScheduleAdditionalInfo;
2400
- actionContext: ActionContext;
2044
+ interface SubscriptionInvoice {
2045
+ _id?: string;
2046
+ subscriptionCycle?: number;
2047
+ _createdDate?: Date | null;
2401
2048
  }
2402
- interface PauseSubscriptionResponse {
2049
+ interface FinishFreeTrialNowRequest {
2050
+ subscriptionId?: string;
2051
+ tenantId?: string;
2052
+ }
2053
+ interface FinishFreeTrialNowResponse {
2403
2054
  subscription?: Subscription;
2404
2055
  }
2405
- interface ResumeSubscriptionRequest {
2406
- _id: string;
2407
- resumeAt?: ResumeAt;
2408
- /** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
2409
- resumeAtSchedule?: ScheduleAdditionalInfo;
2410
- actionContext: ActionContext;
2056
+ interface SendTimeCapsuleTaskCanceledBIRequest {
2057
+ tenantId?: string;
2058
+ subscriptionId?: string;
2059
+ taskType?: string;
2411
2060
  }
2412
- interface ResumeSubscriptionResponse {
2413
- subscription?: Subscription;
2061
+ interface Empty {
2414
2062
  }
2415
- interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
2416
- /** Limit number of results and enable to skip rows. The default limit is 25. */
2417
- paging?: Paging;
2418
- /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
2419
- cursor?: CursorPaging;
2420
- /** A filter object */
2421
- filter?: any;
2422
- /** A Sorting option by field name and order. */
2423
- sorting?: SortingClauses;
2063
+ interface ScheduleTimeCapsuleTaskRequest {
2064
+ subscriptionId?: string;
2065
+ taskType?: string;
2066
+ executionTime?: Date | null;
2067
+ tenantId?: string;
2424
2068
  }
2425
- /** @oneof */
2426
- interface SearchSubscriptionsRequestPagingMethodOneOf {
2427
- /** Limit number of results and enable to skip rows. The default limit is 25. */
2428
- paging?: Paging;
2429
- /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
2430
- cursor?: CursorPaging;
2069
+ interface CancelTimeCapsuleTaskRequest {
2070
+ tenantId?: string;
2071
+ subscriptionId?: string;
2072
+ taskType?: string;
2431
2073
  }
2432
- interface SortingClauses {
2433
- sorting?: Sorting[];
2074
+ interface UpdateFullSubscriptionRequest {
2075
+ tenantId?: string;
2076
+ subscription?: Subscription;
2434
2077
  }
2435
- interface SearchSubscriptionsResponse {
2436
- subscriptions?: Subscription[];
2437
- cursor?: CursorPaging;
2078
+ interface UpdateFullSubscriptionResponse {
2079
+ subscription?: Subscription;
2438
2080
  }
2439
- interface TurnOnSubscriptionAutoRenewalRequest {
2440
- _id: string;
2441
- actionContext: ActionContext;
2081
+ interface UpdateSubscriptionInvoiceCycleRequest {
2082
+ subscriptionId?: string;
2083
+ tenantId?: string;
2084
+ invoiceId?: string;
2085
+ subscriptionCycle?: number;
2442
2086
  }
2443
- interface TurnOnSubscriptionAutoRenewalResponse {
2444
- subscription?: Subscription;
2087
+ interface UpdateSubscriptionInvoiceCycleResponse {
2088
+ subscriptionInvoice?: SubscriptionInvoice;
2445
2089
  }
2446
- interface TurnOffSubscriptionAutoRenewalRequest {
2447
- _id: string;
2448
- actionContext: ActionContext;
2090
+ interface AddPausePeriodRequest {
2091
+ tenantId?: string;
2092
+ subscriptionId?: string;
2093
+ pauseStartDate?: Date | null;
2094
+ pauseEndDate?: Date | null;
2449
2095
  }
2450
- interface TurnOffSubscriptionAutoRenewalResponse {
2096
+ interface AddPausePeriodResponse {
2451
2097
  subscription?: Subscription;
2452
2098
  }
2453
- interface MarkLatestInvoiceAsPaidRequest {
2454
- /** The ID of the offline subscription to mark as paid its latest invoice */
2455
- subscriptionId: string;
2099
+ interface RunTimeCapsuleTaskNowRequest {
2100
+ tenantId?: string;
2101
+ subscriptionId?: string;
2102
+ taskType?: string;
2456
2103
  }
2457
- interface MarkLatestInvoiceAsPaidResponse {
2458
- subscription?: Subscription;
2104
+ interface CreateRecurringInvoiceBORequest {
2105
+ subscriptionId?: string;
2106
+ tenantId?: string;
2107
+ cycleNumber?: number;
2459
2108
  }
2460
- interface GetSubscriptionsStatsRequest {
2109
+ interface CreateRecurringInvoiceBOResponse {
2110
+ invoiceId?: string;
2461
2111
  }
2462
- interface GetSubscriptionsStatsResponse {
2463
- amountByStatuses?: AmountByStatus[];
2464
- total?: number;
2112
+ interface SetShiftingDataRequest {
2113
+ subscriptionId?: string;
2114
+ tenantId?: string;
2115
+ isBassManaged?: boolean;
2116
+ shiftManagementDate?: Date | null;
2465
2117
  }
2466
- interface AmountByStatus {
2467
- status?: SubscriptionStatusEnumSubscriptionStatus;
2468
- amount?: number;
2118
+ interface SetShiftingDataResponse {
2119
+ subscription?: Subscription;
2469
2120
  }
2470
- interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
2471
- /** User won't be charged for additional period added on top of subscription end date. */
2472
- extensionPeriod?: Duration;
2473
- /** user will be charged for billing cycles added */
2474
- extensionBillingCycles?: number;
2475
- /** The ID of the subscription to be extended */
2476
- _id: string;
2477
- actionContext: ActionContext;
2121
+ interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
2122
+ attachInvoice?: AttachInvoice;
2123
+ detachInvoice?: DetachInvoice;
2124
+ tenantId?: string;
2125
+ subscriptionId?: string;
2478
2126
  }
2479
2127
  /** @oneof */
2480
- interface ExtendSubscriptionRequestExtendPolicyOneOf {
2481
- /** User won't be charged for additional period added on top of subscription end date. */
2482
- extensionPeriod?: Duration;
2483
- /** user will be charged for billing cycles added */
2484
- extensionBillingCycles?: number;
2128
+ interface FixSubscriptionInvoicesRequestModeOneOf {
2129
+ attachInvoice?: AttachInvoice;
2130
+ detachInvoice?: DetachInvoice;
2485
2131
  }
2486
- interface ExtendSubscriptionResponse {
2487
- /** The now extended subscription */
2132
+ interface AttachInvoice {
2133
+ invoiceId?: string;
2134
+ }
2135
+ interface DetachInvoice {
2136
+ invoiceId?: string;
2137
+ }
2138
+ interface FixSubscriptionInvoicesResponse {
2139
+ invoices?: SubscriptionInvoice[];
2140
+ }
2141
+ interface RestoreDraftSubscriptionRequest {
2142
+ tenantId?: string;
2143
+ subscriptionId?: string;
2144
+ }
2145
+ interface RestoreDraftSubscriptionResponse {
2488
2146
  subscription?: Subscription;
2489
2147
  }
2490
- interface AllowedActionsRequest {
2491
- _id: string;
2492
- /** List of additional fields to be included in the response. */
2493
- fields?: RequestedFields[];
2148
+ interface DeleteDraftSubscriptionRequest {
2149
+ tenantId?: string;
2150
+ subscriptionId?: string;
2494
2151
  }
2495
- declare enum RequestedFields {
2496
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
2497
- /** Include unsupported action list, including the reasons for the lack of support */
2498
- UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
2152
+ interface DeleteDraftSubscriptionResponse {
2153
+ subscription?: Subscription;
2499
2154
  }
2500
- interface AllowedActionsResponse {
2501
- /** List of actions that are allowed. */
2502
- actions?: Action[];
2503
- /** List of actions that are not supported, included only if requested. Provides reasons for each unsupported action. */
2504
- unsupportedActions?: UnsupportedAction[];
2155
+ interface DeleteSubscriptionBORequest {
2156
+ tenantId?: string;
2157
+ subscriptionId?: string;
2505
2158
  }
2506
- interface UnsupportedAction {
2507
- actionType?: ActionType;
2508
- /** Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed. */
2509
- reasons?: UnsupportedReason[];
2159
+ interface DeleteSubscriptionBOResponse {
2160
+ subscription?: Subscription;
2510
2161
  }
2511
- interface UnsupportedReason {
2512
- code?: string;
2513
- description?: string | null;
2162
+ interface CancelSubscriptionBORequest {
2163
+ tenantId?: string;
2164
+ subscriptionId?: string;
2165
+ initiator?: ActionInitiator;
2166
+ reason?: string | null;
2514
2167
  }
2515
- interface ListUpcomingChargesRequest {
2516
- /** Subscription id charges to be previewed for */
2517
- subscriptionId: string;
2518
- /** Period of time to provide charged for. If not provided,then only next charge will be returned. */
2519
- customDuration?: Duration;
2520
- /**
2521
- * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
2522
- * If not provided, the upcoming charges will be calculated according to the existing next billing date.
2523
- */
2524
- nextBillingDate?: Date | null;
2168
+ declare enum ActionInitiator {
2169
+ UNDEFINED = "UNDEFINED",
2170
+ BUSINESS = "BUSINESS",
2171
+ CUSTOMER = "CUSTOMER",
2172
+ SYSTEM = "SYSTEM"
2525
2173
  }
2526
- interface ListUpcomingChargesResponse {
2527
- upcomingCharges?: SubscriptionCharge[];
2174
+ interface CancelSubscriptionBOResponse {
2175
+ subscription?: Subscription;
2528
2176
  }
2529
- interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
2530
- /** Information about a non-existing subscription. */
2531
- subscriptionInfo?: SubscriptionInfo;
2177
+ interface UpdatePaymentMethodBORequest {
2178
+ tenantId?: string;
2179
+ subscriptionId?: string;
2180
+ paymentMethodId?: string;
2181
+ }
2182
+ interface UpdatePaymentMethodBOResponse {
2183
+ subscription?: Subscription;
2184
+ }
2185
+ interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
2186
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
2187
+ tenantId?: string;
2188
+ subscriptionId?: string;
2532
2189
  }
2533
2190
  /** @oneof */
2534
- interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
2535
- /** Information about a non-existing subscription. */
2536
- subscriptionInfo?: SubscriptionInfo;
2191
+ interface SendSubscriptionActionEventBORequestEventOneOf {
2192
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
2537
2193
  }
2538
- /** Subscription information to use for calculating the preview of charges for a subscription. */
2539
- interface SubscriptionInfo {
2540
- billingSettings?: BillingSettings;
2541
- items?: Item[];
2542
- startDate?: Date | null;
2194
+ interface SubscriptionBillingCycleStarted {
2195
+ subscription?: Subscription;
2196
+ /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
2197
+ paymentTransactionId?: string | null;
2543
2198
  }
2544
- interface PreviewSubscriptionChargesResponse {
2545
- /** Charges for subscription. */
2546
- charges?: Charge[];
2199
+ interface SendSubscriptionActionEventResponse {
2547
2200
  }
2548
- /** Represents a charge applicable to a subscription. */
2549
- interface Charge {
2550
- /** The cycle number from which the charge starts. */
2551
- cycleFrom?: number;
2552
- /** The number of cycles for which the charge is applicable. */
2553
- cycleCount?: number | null;
2554
- /** The breakdown of the charge */
2555
- totals?: Totals;
2556
- /** The billing date from which the charge starts */
2557
- cycleBillingDate?: Date | null;
2201
+ interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
2202
+ tenantId?: string;
2203
+ subscriptionId?: string;
2204
+ transactionId?: string;
2558
2205
  }
2559
- interface PreviewSubscriptionsChargesRequest {
2560
- /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
2561
- subscriptionsBillingDetails?: SubscriptionBillingDetails[];
2206
+ interface SetIsMigratedEvent {
2207
+ subscriptionId?: string;
2562
2208
  }
2563
- interface SubscriptionBillingDetails {
2564
- /** External identifier of the subscription */
2565
- externalId?: string | null;
2566
- /** Billing details parameters including schedule, currency, etc. */
2567
- billingSettings?: BillingSettings;
2568
- /** Items, minSize is 1, maxSize is 100 */
2569
- items?: Item[];
2570
- /** Subscription start date, now if not set */
2571
- startDate?: Date | null;
2572
- /** Shipping address associated with subscription. At the moment used only for payments. Optional. */
2573
- shippingAddress?: FullAddressDetails;
2209
+ interface SubscriptionDelayedSyncEvent {
2210
+ subscriptionId?: string;
2574
2211
  }
2575
- interface PreviewSubscriptionsChargesResponse {
2576
- /** Charges for the subscriptions, including an identifier. */
2577
- subscriptionsCharges?: SubscriptionCharges[];
2212
+ interface InvoiceAction extends InvoiceActionActionTypeOneOf {
2213
+ payRecurring?: PayRecurringInvoice;
2578
2214
  }
2579
- interface SubscriptionCharges {
2580
- /** External identifier of the subscription */
2581
- externalId?: string | null;
2582
- /** Charges for subscription. */
2583
- charges?: Charge[];
2215
+ /** @oneof */
2216
+ interface InvoiceActionActionTypeOneOf {
2217
+ payRecurring?: PayRecurringInvoice;
2584
2218
  }
2585
- interface CreateSubscriptionForOrderRequest {
2586
- /** Subscription needs to be created */
2587
- subscription?: Subscription;
2588
- /** Optional unique identifier for this request in order to prevent subscription duplications */
2589
- idempotencyKey?: string | null;
2219
+ interface PayRecurringInvoice {
2220
+ invoiceId?: string;
2590
2221
  }
2591
- interface CreateSubscriptionForOrderResponse {
2592
- /** Created subscription */
2222
+ /**
2223
+ * Sent each time a subscription status has been set to Active
2224
+ * Active shows that a subscription is live and operational.
2225
+ * For example:
2226
+ * * For subscription with free trial, free trial start date is also the activation date.
2227
+ * * For a subscription with future start date, the start date is also the activation date.
2228
+ * * When a subscription is resumed from a pause status, the resume date is also the activation date.
2229
+ */
2230
+ interface SubscriptionActivated {
2231
+ subscription?: Subscription;
2232
+ }
2233
+ /**
2234
+ * Sent each time a subscription status has been set to Ended
2235
+ * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
2236
+ * This is different from a Canceled subscription which ends the subscription before a designated end date.
2237
+ * Therefore, Ended and Canceled are mutually exclusive.
2238
+ */
2239
+ interface SubscriptionEnded {
2240
+ subscription?: Subscription;
2241
+ }
2242
+ interface SubscriptionInitialPurchaseCompleted {
2243
+ subscription?: Subscription;
2244
+ actionDetails?: ActionDetails;
2245
+ paymentTransactionId?: string | null;
2246
+ }
2247
+ interface SubscriptionCycleReadyToPay {
2248
+ subscription?: Subscription;
2249
+ }
2250
+ interface SubscriptionRevived {
2251
+ subscription?: Subscription;
2252
+ }
2253
+ interface CreateSubscriptionResponse {
2254
+ subscription?: Subscription;
2255
+ /** Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions. */
2256
+ paymentOrderId?: string | null;
2257
+ }
2258
+ interface UpdateSubscriptionRequest {
2259
+ /** Revision is validated if Subscription.revision is set */
2260
+ subscription?: Subscription;
2261
+ }
2262
+ interface UpdateSubscriptionResponse {
2263
+ subscription?: Subscription;
2264
+ }
2265
+ interface UpdateSubscriptionStartDateRequest {
2266
+ /** Subscription ID */
2267
+ _id?: string;
2268
+ /**
2269
+ * Can be updated only if Subscription is in Draft state
2270
+ * By setting start_date in the future, end_date will be recalculated for termed Subscriptions
2271
+ * cycles_to_pay_on_creation will be set to 1 if no free trial is set
2272
+ */
2273
+ startDate?: Date | null;
2274
+ }
2275
+ interface UpdateSubscriptionStartDateResponse {
2276
+ subscription?: Subscription;
2277
+ }
2278
+ interface UpdateSubscriptionPoliciesRequest {
2279
+ /** Subscription ID */
2280
+ _id?: string;
2281
+ cancellableByCustomer?: boolean | null;
2282
+ }
2283
+ interface UpdateSubscriptionPoliciesResponse {
2284
+ /** Updated policies of the subscription */
2285
+ policies?: SubscriptionPolicies;
2286
+ }
2287
+ interface UpdateSubscriptionBillingDateRequest {
2288
+ /** ID of the subscription to update the billing date for. */
2289
+ _id: string;
2290
+ /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
2291
+ billingDate: Date | null;
2292
+ /**
2293
+ * Information about how BASS adjusts the total of the next invoice. Extending
2294
+ * the current billing cycle results in a higher payment, while shortening it
2295
+ * leads to a lower payment. BASS offers automatic calculation of the proration
2296
+ * amount based on the number of days added to or removed from the current billing
2297
+ * cycle. Alternatively, you can use your own custom method to calculate the
2298
+ * proration amount. The custom proration amount can't exceed the total of the
2299
+ * current billing cycle.
2300
+ */
2301
+ proration?: Proration;
2302
+ }
2303
+ interface UpdateSubscriptionBillingDateResponse {
2304
+ /** Updated subscription. */
2305
+ subscription?: Subscription;
2306
+ }
2307
+ interface SubscriptionBillingDateUpdated {
2308
+ subscription?: Subscription;
2309
+ billingDate?: Date | null;
2310
+ proration?: Proration;
2311
+ }
2312
+ interface UpdateSubscriptionOriginRequest {
2313
+ /** ID of the subscription to update origin. */
2314
+ _id?: string;
2315
+ /** Origin entity ID of the subscription to update. */
2316
+ entityId?: string;
2317
+ }
2318
+ interface UpdateSubscriptionOriginResponse {
2319
+ /** Updated subscription. */
2320
+ subscription?: Subscription;
2321
+ }
2322
+ interface ReviseSubscriptionRequest {
2323
+ /** Subscription ID */
2324
+ _id?: string;
2325
+ /** 0 for no revision, maxSize is 100 */
2326
+ items?: Item[];
2327
+ }
2328
+ interface ReviseSubscriptionResponse {
2329
+ subscription?: Subscription;
2330
+ }
2331
+ interface UpdateSubscriptionItemsRequest {
2332
+ /** Subscription ID */
2333
+ _id?: string;
2334
+ /** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
2335
+ updateAction?: UpdateAction;
2336
+ /** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
2337
+ scheduleAdditionalInfo?: ScheduleAdditionalInfo;
2338
+ /** Existing items to update */
2339
+ itemsToUpdate?: ItemChange[];
2340
+ /** Items to add */
2341
+ itemsToAdd?: Item[];
2342
+ /** Existing items to delete */
2343
+ itemsToDelete?: string[] | null;
2344
+ }
2345
+ declare enum UpdateAction {
2346
+ NONE = "NONE",
2347
+ /** Update subscription immediately, please note proration for updates changing price are not yet supported */
2348
+ IMMEDIATELY = "IMMEDIATELY",
2349
+ /** Request updates that will take affect only at the start of the next billing cycle. */
2350
+ NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
2351
+ /** Reset all pending updates */
2352
+ RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
2353
+ /** Request updates that will take affect only at a specific date. */
2354
+ SPECIFIC_DATE = "SPECIFIC_DATE"
2355
+ }
2356
+ interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
2357
+ /**
2358
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2359
+ * format. The use of this field may be restricted in various BASS endpoints.
2360
+ * For example, in _Bulk Update Subscription Items_ it's only available in
2361
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2362
+ * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2363
+ * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2364
+ */
2365
+ specificDate?: Date | null;
2366
+ /**
2367
+ * When the update becomes effective, as number of billing cycles from now.
2368
+ * The use of this field may be restricted in various BASS endpoints.
2369
+ * For example, in _Pause Subscription_ it's only available in
2370
+ * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2371
+ * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2372
+ */
2373
+ numberOfCycles?: number;
2374
+ }
2375
+ /** @oneof */
2376
+ interface ScheduleAdditionalInfoParamOneOf {
2377
+ /**
2378
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2379
+ * format. The use of this field may be restricted in various BASS endpoints.
2380
+ * For example, in _Bulk Update Subscription Items_ it's only available in
2381
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2382
+ * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2383
+ * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2384
+ */
2385
+ specificDate?: Date | null;
2386
+ /**
2387
+ * When the update becomes effective, as number of billing cycles from now.
2388
+ * The use of this field may be restricted in various BASS endpoints.
2389
+ * For example, in _Pause Subscription_ it's only available in
2390
+ * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2391
+ * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2392
+ */
2393
+ numberOfCycles?: number;
2394
+ }
2395
+ interface UpdateSubscriptionItemsResponse {
2396
+ subscription?: Subscription;
2397
+ }
2398
+ interface BulkUpdateSubscriptionItemsByFilterRequest {
2399
+ /**
2400
+ * Filter to identify the subscriptions for which items are updated. For
2401
+ * supported fields see
2402
+ * [Search and Query: Bulk Update Subscription Items By Filter](https://bo.wix.com/wix-docs/rest/drafts/subscriptions-by-billing-by-wix/search-and-query#drafts_subscriptions-by-billing-by-wix_search-and-query_bulk-update-subscription-items-by-filter).
2403
+ * Sending an empty subscription filter results in a validation error.
2404
+ * In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
2405
+ * `subscriptionId` field inside this filter. Passing any other filter results
2406
+ * in a failed validation error.
2407
+ */
2408
+ subscriptionFilter?: Record<string, any> | null;
2409
+ /**
2410
+ * Filter to specify which subscription items are updated. Make sure to use
2411
+ * the catalog item ID and not the item's unique ID. All subscription items
2412
+ * with matching `items.catalogReference.catalogItemId` are updated.
2413
+ *
2414
+ * Max: `100` reference catalog item IDs
2415
+ */
2416
+ catalogReferenceIds?: string[] | null;
2417
+ /**
2418
+ * Information about the update timing and update type.
2419
+ *
2420
+ * + `"IMMEDIATELY"`: The updates become effective immediately.
2421
+ * + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
2422
+ * + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
2423
+ * + `"RESET_PENDING_UPDATES"`: All currently scheduled updates for the specified supcriptions are canceled. Use only the `subscriptionId` field inside `subscriptionFilter`, all other filters result in failed validation errors.
2424
+ */
2425
+ updateAction?: UpdateAction;
2426
+ /**
2427
+ * Additional information for updates. Currently, only supported for
2428
+ * `{"updateAction": "SPECIFIC_DATE"}`.
2429
+ */
2430
+ scheduleAdditionalInfo?: ScheduleAdditionalInfo;
2431
+ /**
2432
+ * Update details for the susbcription items that match the filtering.
2433
+ * Currently, you can update only the item price, quantity, and tax. Note
2434
+ * that all item properties are updated to the same values. In case you want set
2435
+ * different values for individual items, you must call
2436
+ * _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
2437
+ */
2438
+ bulkItemUpdateData?: BulkItemChange;
2439
+ /** __Not implemented yet__. Items to add to the subscriptions matching the filtering. */
2440
+ itemsToAdd?: Item[];
2441
+ }
2442
+ interface BulkItemChange {
2443
+ /** Information about the new item price. */
2444
+ pricingModel?: PricingModel;
2445
+ /**
2446
+ * New item quantity.
2447
+ *
2448
+ * Min: `1`
2449
+ */
2450
+ quantity?: number | null;
2451
+ /** Information about the new item tax. */
2452
+ tax?: Tax;
2453
+ }
2454
+ interface BulkUpdateSubscriptionItemsByFilterResponse {
2455
+ /**
2456
+ * ID of your bulk job. You can use
2457
+ * [this Async Infra call](https://pbo.wix.com/fire-console/?artifact=com.wixpress.asyncinfra.async-job-service&service=wix.infra.asyncjobs.v1.AsyncJobService&method=ListAsyncJobItems&body=eyJqb2JfaWQiOiIifQ%3D%3D)
2458
+ * to retrieve information about the job status.
2459
+ */
2460
+ jobId?: string;
2461
+ }
2462
+ interface DeleteSubscriptionRequest {
2463
+ _id?: string;
2464
+ revision?: string;
2465
+ }
2466
+ interface DeleteSubscriptionResponse {
2467
+ }
2468
+ interface CancelSubscriptionRequest {
2469
+ _id: string;
2470
+ actionContext: ActionContext;
2471
+ }
2472
+ interface ActionContext {
2473
+ initiator?: ActionInitiator;
2474
+ /** Optional action reason message */
2475
+ reason?: string | null;
2476
+ }
2477
+ interface CancelSubscriptionResponse {
2478
+ subscription?: Subscription;
2479
+ }
2480
+ interface PauseSubscriptionRequest {
2481
+ _id: string;
2482
+ pausePolicy?: PausePolicy;
2483
+ pauseAt?: PauseAt;
2484
+ /** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
2485
+ pauseAtSchedule?: ScheduleAdditionalInfo;
2486
+ /** contains additional scheduling information for certain auto_resume_at either specific date */
2487
+ autoResumeAtSchedule?: ScheduleAdditionalInfo;
2488
+ actionContext: ActionContext;
2489
+ }
2490
+ interface PauseSubscriptionResponse {
2491
+ subscription?: Subscription;
2492
+ }
2493
+ interface SubscriptionPaused {
2494
+ subscription?: Subscription;
2495
+ pausePolicy?: PausePolicy;
2496
+ actionDetails?: ActionDetails;
2497
+ }
2498
+ interface PauseSubscriptionRequested {
2499
+ subscription?: Subscription;
2500
+ pauseAt?: PauseAt;
2501
+ pausePolicy?: PausePolicy;
2502
+ actionDetails?: ActionDetails;
2503
+ }
2504
+ interface ScheduledPauseCanceled {
2505
+ subscription?: Subscription;
2506
+ actionDetails?: ActionDetails;
2507
+ }
2508
+ interface ResumeSubscriptionRequest {
2509
+ _id: string;
2510
+ resumeAt?: ResumeAt;
2511
+ /** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
2512
+ resumeAtSchedule?: ScheduleAdditionalInfo;
2513
+ actionContext: ActionContext;
2514
+ }
2515
+ interface ResumeSubscriptionResponse {
2516
+ subscription?: Subscription;
2517
+ }
2518
+ interface SubscriptionResumed {
2519
+ subscription?: Subscription;
2520
+ actionDetails?: ActionDetails;
2521
+ }
2522
+ interface ResumeSubscriptionRequested {
2523
+ subscription?: Subscription;
2524
+ resumeAt?: ResumeAt;
2525
+ actionDetails?: ActionDetails;
2526
+ }
2527
+ interface ScheduledResumeCanceled {
2528
+ subscription?: Subscription;
2529
+ actionDetails?: ActionDetails;
2530
+ }
2531
+ interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
2532
+ /** Limit number of results and enable to skip rows. The default limit is 25. */
2533
+ paging?: Paging;
2534
+ /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
2535
+ cursor?: CursorPaging;
2536
+ /** A filter object */
2537
+ filter?: any;
2538
+ /** A Sorting option by field name and order. */
2539
+ sorting?: SortingClauses;
2540
+ }
2541
+ /** @oneof */
2542
+ interface SearchSubscriptionsRequestPagingMethodOneOf {
2543
+ /** Limit number of results and enable to skip rows. The default limit is 25. */
2544
+ paging?: Paging;
2545
+ /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
2546
+ cursor?: CursorPaging;
2547
+ }
2548
+ interface SortingClauses {
2549
+ sorting?: Sorting[];
2550
+ }
2551
+ interface SearchSubscriptionsResponse {
2552
+ subscriptions?: Subscription[];
2553
+ cursor?: CursorPaging;
2554
+ }
2555
+ interface TurnOnSubscriptionAutoRenewalRequest {
2556
+ _id: string;
2557
+ actionContext: ActionContext;
2558
+ }
2559
+ interface TurnOnSubscriptionAutoRenewalResponse {
2560
+ subscription?: Subscription;
2561
+ }
2562
+ interface SubscriptionAutoRenewalTurnedOn {
2563
+ subscription?: Subscription;
2564
+ actionDetails?: ActionDetails;
2565
+ }
2566
+ interface TurnOffSubscriptionAutoRenewalRequest {
2567
+ _id: string;
2568
+ actionContext: ActionContext;
2569
+ }
2570
+ interface TurnOffSubscriptionAutoRenewalResponse {
2571
+ subscription?: Subscription;
2572
+ }
2573
+ interface SubscriptionAutoRenewalTurnedOff {
2574
+ subscription?: Subscription;
2575
+ actionDetails?: ActionDetails;
2576
+ }
2577
+ interface MarkLatestInvoiceAsPaidRequest {
2578
+ /** The ID of the offline subscription to mark as paid its latest invoice */
2579
+ subscriptionId: string;
2580
+ }
2581
+ interface MarkLatestInvoiceAsPaidResponse {
2582
+ subscription?: Subscription;
2583
+ }
2584
+ interface LatestInvoiceMarkedAsPaid {
2585
+ subscription?: Subscription;
2586
+ }
2587
+ interface GetSubscriptionsStatsRequest {
2588
+ }
2589
+ interface GetSubscriptionsStatsResponse {
2590
+ amountByStatuses?: AmountByStatus[];
2591
+ total?: number;
2592
+ }
2593
+ interface AmountByStatus {
2594
+ status?: SubscriptionStatusEnumSubscriptionStatus;
2595
+ amount?: number;
2596
+ }
2597
+ interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
2598
+ /** User won't be charged for additional period added on top of subscription end date. */
2599
+ extensionPeriod?: Duration;
2600
+ /** user will be charged for billing cycles added */
2601
+ extensionBillingCycles?: number;
2602
+ /** The ID of the subscription to be extended */
2603
+ _id: string;
2604
+ actionContext: ActionContext;
2605
+ }
2606
+ /** @oneof */
2607
+ interface ExtendSubscriptionRequestExtendPolicyOneOf {
2608
+ /** User won't be charged for additional period added on top of subscription end date. */
2609
+ extensionPeriod?: Duration;
2610
+ /** user will be charged for billing cycles added */
2611
+ extensionBillingCycles?: number;
2612
+ }
2613
+ interface ExtendSubscriptionResponse {
2614
+ /** The now extended subscription */
2615
+ subscription?: Subscription;
2616
+ }
2617
+ interface AllowedActionsRequest {
2618
+ _id: string;
2619
+ /** List of additional fields to be included in the response. */
2620
+ fields?: RequestedFields[];
2621
+ }
2622
+ declare enum RequestedFields {
2623
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
2624
+ /** Include unsupported action list, including the reasons for the lack of support */
2625
+ UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
2626
+ }
2627
+ interface AllowedActionsResponse {
2628
+ /** List of actions that are allowed. */
2629
+ actions?: Action[];
2630
+ /** List of actions that are not supported, included only if requested. Provides reasons for each unsupported action. */
2631
+ unsupportedActions?: UnsupportedAction[];
2632
+ }
2633
+ interface UnsupportedAction {
2634
+ actionType?: ActionType;
2635
+ /** Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed. */
2636
+ reasons?: UnsupportedReason[];
2637
+ }
2638
+ interface UnsupportedReason {
2639
+ code?: string;
2640
+ description?: string | null;
2641
+ }
2642
+ interface ListUpcomingChargesRequest {
2643
+ /** Subscription id charges to be previewed for */
2644
+ subscriptionId: string;
2645
+ /** Period of time to provide charged for. If not provided,then only next charge will be returned. */
2646
+ customDuration?: Duration;
2647
+ /**
2648
+ * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
2649
+ * If not provided, the upcoming charges will be calculated according to the existing next billing date.
2650
+ */
2651
+ nextBillingDate?: Date | null;
2652
+ }
2653
+ interface ListUpcomingChargesResponse {
2654
+ upcomingCharges?: SubscriptionCharge[];
2655
+ }
2656
+ interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
2657
+ /** Information about a non-existing subscription. */
2658
+ subscriptionInfo?: SubscriptionInfo;
2659
+ }
2660
+ /** @oneof */
2661
+ interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
2662
+ /** Information about a non-existing subscription. */
2663
+ subscriptionInfo?: SubscriptionInfo;
2664
+ }
2665
+ /** Subscription information to use for calculating the preview of charges for a subscription. */
2666
+ interface SubscriptionInfo {
2667
+ billingSettings?: BillingSettings;
2668
+ items?: Item[];
2669
+ startDate?: Date | null;
2670
+ }
2671
+ interface PreviewSubscriptionChargesResponse {
2672
+ /** Charges for subscription. */
2673
+ charges?: Charge[];
2674
+ }
2675
+ /** Represents a charge applicable to a subscription. */
2676
+ interface Charge {
2677
+ /** The cycle number from which the charge starts. */
2678
+ cycleFrom?: number;
2679
+ /** The number of cycles for which the charge is applicable. */
2680
+ cycleCount?: number | null;
2681
+ /** The breakdown of the charge */
2682
+ totals?: Totals;
2683
+ /** The billing date from which the charge starts */
2684
+ cycleBillingDate?: Date | null;
2685
+ }
2686
+ interface PreviewSubscriptionsChargesRequest {
2687
+ /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
2688
+ subscriptionsBillingDetails?: SubscriptionBillingDetails[];
2689
+ /**
2690
+ * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
2691
+ * For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
2692
+ * $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
2693
+ * - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
2694
+ * - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
2695
+ * - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
2696
+ * If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
2697
+ * in this case, charges for cycle 1 through 3.
2698
+ * If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
2699
+ * then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
2700
+ */
2701
+ numberOfNextRecurringCharges?: number | null;
2702
+ }
2703
+ interface SubscriptionBillingDetails {
2704
+ /** External identifier of the subscription */
2705
+ externalId?: string | null;
2706
+ /** Billing details parameters including schedule, currency, etc. */
2707
+ billingSettings?: BillingSettings;
2708
+ /** Items, minSize is 1, maxSize is 100 */
2709
+ items?: Item[];
2710
+ /** Subscription start date, now if not set */
2711
+ startDate?: Date | null;
2712
+ /** Shipping address associated with subscription. At the moment used only for payments. Optional. */
2713
+ shippingAddress?: FullAddressDetails;
2714
+ }
2715
+ interface PreviewSubscriptionsChargesResponse {
2716
+ /** Charges for the subscriptions, including an identifier. */
2717
+ subscriptionsCharges?: SubscriptionCharges[];
2718
+ }
2719
+ interface SubscriptionCharges {
2720
+ /** External identifier of the subscription */
2721
+ externalId?: string | null;
2722
+ /** Charges for subscription. */
2723
+ charges?: Charge[];
2724
+ }
2725
+ interface CreateSubscriptionForOrderRequest {
2726
+ /** Subscription needs to be created */
2727
+ subscription?: Subscription;
2728
+ /** Optional unique identifier for this request in order to prevent subscription duplications */
2729
+ idempotencyKey?: string | null;
2730
+ }
2731
+ interface CreateSubscriptionForOrderResponse {
2732
+ /** Created subscription */
2593
2733
  subscription?: Subscription;
2594
2734
  /** Non-persistent invoice */
2595
2735
  invoice?: Invoice;
@@ -2906,8 +3046,6 @@ interface Reschedule {
2906
3046
  executeAt?: Date | null;
2907
3047
  payload?: string | null;
2908
3048
  }
2909
- interface Empty {
2910
- }
2911
3049
  interface V1SubscriptionEvent extends V1SubscriptionEventEventOneOf {
2912
3050
  /** A subscriptions was created */
2913
3051
  created?: V1SubscriptionCreated;
@@ -3089,384 +3227,287 @@ declare enum PaymentStatusEnumPaymentStatus {
3089
3227
  /**
3090
3228
  * Recurring payment is described by `frequency` (day, week, month) and `interval`.
3091
3229
  *
3092
- * For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.
3093
- *
3094
- * In some cases there should be a trial period for the order, after which payments start to occur.
3095
- * Trial period is also defined as `frequency` and `interval` pair.
3096
- *
3097
- * So one can define a monthly 'subscription' with a 14 days trial period.
3098
- */
3099
- interface V2Subscription {
3100
- /** frequency of recurring payment (required) */
3101
- frequency?: SubscriptionFrequency;
3102
- /** interval of recurring payment (required) */
3103
- interval?: number;
3104
- /** trial period for recurring payment (optional) */
3105
- trial?: SubscriptionTrialPeriod;
3106
- /**
3107
- * how many billing cycles should be done before subscription finishes
3108
- * (optional, 0 by default means endless subscription)
3109
- */
3110
- billingCycles?: number;
3111
- /**
3112
- * date in the future or in the past when the first billing cycle begins
3113
- * (the first off-session payment is performed when it ends)
3114
- */
3115
- firstCycleStartDate?: Date | null;
3116
- }
3117
- /** Frequency unit of recurring payment */
3118
- declare enum SubscriptionFrequency {
3119
- UNDEFINED = "UNDEFINED",
3120
- DAY = "DAY",
3121
- WEEK = "WEEK",
3122
- MONTH = "MONTH",
3123
- YEAR = "YEAR"
3124
- }
3125
- /** Trial period of subscription */
3126
- interface SubscriptionTrialPeriod {
3127
- /** trial period in units (required) */
3128
- period?: number;
3129
- /** units in which trial period is described (optional, default DAY) */
3130
- unit?: SubscriptionFrequency;
3131
- }
3132
- declare enum CancellationInitiator {
3133
- /** Cancellation initiator undefined */
3134
- UNDEFINED = "UNDEFINED",
3135
- /** Subscription was canceled by site owner (default if canceled by user or service identity) */
3136
- OWNER = "OWNER",
3137
- /** Subscription was canceled by member (default if canceled by member identity) */
3138
- MEMBER = "MEMBER",
3139
- /** Subscription was canceled because of payment failure */
3140
- PAYMENT_FAILURE = "PAYMENT_FAILURE",
3141
- /** Subscription was canceled because of payment setup failure */
3142
- SETUP_FAILURE = "SETUP_FAILURE"
3143
- }
3144
- interface SubscriptionPolicy {
3145
- /** Subscription expiration date can be updated */
3146
- expiryDateChangeable?: boolean;
3147
- /** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
3148
- cancellableByMember?: boolean;
3149
- /** Subscription expiration date on cancellation can be set to next payment date */
3150
- cancellableAtNextPaymentCycle?: boolean;
3151
- }
3152
- interface Suspension {
3153
- status?: Status;
3154
- /** Beginning of the suspended period */
3155
- startsAt?: Date | null;
3156
- /** End of the suspended period */
3157
- endsAt?: Date | null;
3158
- }
3159
- declare enum Status {
3160
- UNDEFINED = "UNDEFINED",
3161
- ACTIVE = "ACTIVE",
3162
- ENDED = "ENDED"
3163
- }
3164
- /** A duration expressed in amount of time units. */
3165
- interface V1Duration {
3166
- /** Amount of the unit */
3167
- amount?: number;
3168
- /** Day, Week, Month, Year. */
3169
- unit?: SubscriptionFrequency;
3170
- }
3171
- interface V1SubscriptionActivated {
3172
- subscription?: V1Subscription;
3173
- }
3174
- interface V1SubscriptionCanceled {
3175
- subscription?: V1Subscription;
3176
- }
3177
- interface V1SubscriptionUpdated {
3178
- subscription?: V1Subscription;
3179
- }
3180
- interface SubscriptionCycleTriggered {
3181
- subscription?: V1Subscription;
3182
- billingCycle?: number;
3183
- /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
3184
- transactionId?: string | null;
3185
- }
3186
- interface SubscriptionMarkedAsPaid {
3187
- subscription?: V1Subscription;
3188
- /** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
3189
- billingCycle?: number | null;
3190
- }
3191
- interface SubscriptionCancellationRequested {
3192
- subscription?: V1Subscription;
3193
- }
3194
- interface SubscriptionSuspended {
3195
- subscription?: V1Subscription;
3196
- }
3197
- interface V1SubscriptionResumed {
3198
- subscription?: V1Subscription;
3199
- }
3200
- interface SubscriptionExpired {
3201
- subscription?: V1Subscription;
3202
- }
3203
- interface V1SubscriptionInitialPurchaseCompleted {
3204
- subscription?: V1Subscription;
3205
- }
3206
- interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
3207
- activeSubscription?: CreateSubscriptionRequest;
3208
- }
3209
- /** @oneof */
3210
- interface CreateSubscriptionInStateRequestModeOneOf {
3211
- activeSubscription?: CreateSubscriptionRequest;
3212
- }
3213
- interface CreateSubscriptionInStateResponse {
3214
- subscriptionId?: string;
3215
- }
3216
- interface PayCycleRequest {
3217
- subscriptionId: string;
3218
- paymentTestMode?: PaymentTestMode;
3219
- tenantId: string;
3220
- }
3221
- declare enum PaymentTestMode {
3222
- REGULAR = "REGULAR",
3223
- FAIL_TECHNICAL = "FAIL_TECHNICAL",
3224
- FAIL_DECLINE = "FAIL_DECLINE",
3225
- FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
3226
- }
3227
- interface PayCycleResponse {
3228
- invoiceId?: string;
3229
- paymentOrderId?: string | null;
3230
- subscription?: Subscription;
3231
- }
3232
- interface GetFullSubscriptionDataRequest {
3233
- _id?: string;
3234
- }
3235
- interface GetFullSubscriptionDataResponse {
3236
- subscription?: Subscription;
3237
- internalSubscriptionData?: InternalSubscriptionData;
3238
- }
3239
- interface InternalSubscriptionData {
3240
- originInstanceId?: string;
3241
- source?: string | null;
3242
- billingType?: string;
3243
- isOneTime?: boolean;
3244
- migrationDetails?: MigrationDetails;
3245
- pausePaidDuration?: string | null;
3246
- authorizationPaymentData?: PaymentData;
3247
- currentCyclePausePeriods?: PausePeriod[];
3248
- }
3249
- interface MigrationDetails {
3250
- /** system (application) where the Subscription has been created */
3251
- originSystem?: string;
3252
- /** date when the Subscription started to be managed in BASS */
3253
- shiftManagementDate?: Date | null;
3254
- }
3255
- interface PausePeriod {
3256
- startDate?: Date | null;
3257
- endDate?: Date | null;
3258
- }
3259
- interface GetSubscriptionAndInternalDataRequest {
3260
- subscriptionId?: string;
3261
- tenantId?: string;
3262
- }
3263
- interface GetSubscriptionAndInternalDataResponse {
3264
- subscription?: Subscription;
3265
- internalSubscriptionData?: InternalSubscriptionData;
3266
- }
3267
- interface SearchSubscriptionRequest {
3268
- _id?: string;
3269
- tenantId?: string;
3270
- }
3271
- interface SearchSubscriptionResponse {
3272
- subscription?: Subscription;
3273
- }
3274
- interface UpdatePausePaidDurationRequest {
3275
- subscriptionId?: string;
3276
- pausePaidDurationSeconds?: string;
3277
- tenantId?: string;
3278
- }
3279
- interface UpdatePausePaidDurationResponse {
3280
- }
3281
- interface UpdateStatusRequest {
3282
- subscriptionId?: string;
3283
- tenantId?: string;
3284
- status?: SubscriptionStatusEnumSubscriptionStatus;
3285
- }
3286
- interface UpdateStatusResponse {
3287
- subscription?: Subscription;
3288
- }
3289
- interface UpdatePaymentStatusRequest {
3290
- subscriptionId?: string;
3291
- tenantId?: string;
3292
- paymentStatus?: PaymentStatus;
3293
- }
3294
- interface UpdatePaymentStatusResponse {
3295
- subscription?: Subscription;
3296
- }
3297
- interface ReviveSubscriptionRequest {
3298
- tenantId?: string;
3299
- subscriptionId?: string;
3300
- revivePolicy?: RevivePolicy;
3301
- isTestRun?: boolean;
3302
- }
3303
- declare enum RevivePolicy {
3304
- SIMPLE = "SIMPLE",
3305
- RESUME = "RESUME"
3306
- }
3307
- interface ReviveSubscriptionResponse {
3308
- subscription?: Subscription;
3230
+ * For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.
3231
+ *
3232
+ * In some cases there should be a trial period for the order, after which payments start to occur.
3233
+ * Trial period is also defined as `frequency` and `interval` pair.
3234
+ *
3235
+ * So one can define a monthly 'subscription' with a 14 days trial period.
3236
+ */
3237
+ interface V2Subscription {
3238
+ /** frequency of recurring payment (required) */
3239
+ frequency?: SubscriptionFrequency;
3240
+ /** interval of recurring payment (required) */
3241
+ interval?: number;
3242
+ /** trial period for recurring payment (optional) */
3243
+ trial?: SubscriptionTrialPeriod;
3244
+ /**
3245
+ * how many billing cycles should be done before subscription finishes
3246
+ * (optional, 0 by default means endless subscription)
3247
+ */
3248
+ billingCycles?: number;
3249
+ /**
3250
+ * date in the future or in the past when the first billing cycle begins
3251
+ * (the first off-session payment is performed when it ends)
3252
+ */
3253
+ firstCycleStartDate?: Date | null;
3309
3254
  }
3310
- interface ConvertSapiRequest {
3311
- subscriptionId?: string;
3255
+ /** Frequency unit of recurring payment */
3256
+ declare enum SubscriptionFrequency {
3257
+ UNDEFINED = "UNDEFINED",
3258
+ DAY = "DAY",
3259
+ WEEK = "WEEK",
3260
+ MONTH = "MONTH",
3261
+ YEAR = "YEAR"
3312
3262
  }
3313
- interface ConvertSapiResponse {
3314
- subscription?: Subscription;
3263
+ /** Trial period of subscription */
3264
+ interface SubscriptionTrialPeriod {
3265
+ /** trial period in units (required) */
3266
+ period?: number;
3267
+ /** units in which trial period is described (optional, default DAY) */
3268
+ unit?: SubscriptionFrequency;
3315
3269
  }
3316
- interface GetSubscriptionInvoicesRequest {
3317
- _id?: string;
3270
+ declare enum CancellationInitiator {
3271
+ /** Cancellation initiator undefined */
3272
+ UNDEFINED = "UNDEFINED",
3273
+ /** Subscription was canceled by site owner (default if canceled by user or service identity) */
3274
+ OWNER = "OWNER",
3275
+ /** Subscription was canceled by member (default if canceled by member identity) */
3276
+ MEMBER = "MEMBER",
3277
+ /** Subscription was canceled because of payment failure */
3278
+ PAYMENT_FAILURE = "PAYMENT_FAILURE",
3279
+ /** Subscription was canceled because of payment setup failure */
3280
+ SETUP_FAILURE = "SETUP_FAILURE"
3318
3281
  }
3319
- interface GetSubscriptionInvoicesResponse {
3320
- invoices?: SubscriptionInvoice[];
3282
+ interface SubscriptionPolicy {
3283
+ /** Subscription expiration date can be updated */
3284
+ expiryDateChangeable?: boolean;
3285
+ /** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
3286
+ cancellableByMember?: boolean;
3287
+ /** Subscription expiration date on cancellation can be set to next payment date */
3288
+ cancellableAtNextPaymentCycle?: boolean;
3321
3289
  }
3322
- interface SubscriptionInvoice {
3323
- _id?: string;
3324
- subscriptionCycle?: number;
3325
- _createdDate?: Date | null;
3290
+ interface Suspension {
3291
+ status?: Status;
3292
+ /** Beginning of the suspended period */
3293
+ startsAt?: Date | null;
3294
+ /** End of the suspended period */
3295
+ endsAt?: Date | null;
3326
3296
  }
3327
- interface FinishFreeTrialNowRequest {
3328
- subscriptionId?: string;
3329
- tenantId?: string;
3297
+ declare enum Status {
3298
+ UNDEFINED = "UNDEFINED",
3299
+ ACTIVE = "ACTIVE",
3300
+ ENDED = "ENDED"
3330
3301
  }
3331
- interface FinishFreeTrialNowResponse {
3332
- subscription?: Subscription;
3302
+ /** A duration expressed in amount of time units. */
3303
+ interface V1Duration {
3304
+ /** Amount of the unit */
3305
+ amount?: number;
3306
+ /** Day, Week, Month, Year. */
3307
+ unit?: SubscriptionFrequency;
3333
3308
  }
3334
- interface SendTimeCapsuleTaskCanceledBIRequest {
3335
- tenantId?: string;
3336
- subscriptionId?: string;
3337
- taskType?: string;
3309
+ interface V1SubscriptionActivated {
3310
+ subscription?: V1Subscription;
3338
3311
  }
3339
- interface ScheduleTimeCapsuleTaskRequest {
3340
- subscriptionId?: string;
3341
- taskType?: string;
3342
- executionTime?: Date | null;
3343
- tenantId?: string;
3312
+ interface V1SubscriptionCanceled {
3313
+ subscription?: V1Subscription;
3344
3314
  }
3345
- interface CancelTimeCapsuleTaskRequest {
3346
- tenantId?: string;
3347
- subscriptionId?: string;
3348
- taskType?: string;
3315
+ interface V1SubscriptionUpdated {
3316
+ subscription?: V1Subscription;
3349
3317
  }
3350
- interface UpdateFullSubscriptionRequest {
3351
- tenantId?: string;
3352
- subscription?: Subscription;
3318
+ interface SubscriptionCycleTriggered {
3319
+ subscription?: V1Subscription;
3320
+ billingCycle?: number;
3321
+ /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
3322
+ transactionId?: string | null;
3353
3323
  }
3354
- interface UpdateFullSubscriptionResponse {
3355
- subscription?: Subscription;
3324
+ interface SubscriptionMarkedAsPaid {
3325
+ subscription?: V1Subscription;
3326
+ /** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
3327
+ billingCycle?: number | null;
3356
3328
  }
3357
- interface UpdateSubscriptionInvoiceCycleRequest {
3358
- subscriptionId?: string;
3359
- tenantId?: string;
3360
- invoiceId?: string;
3361
- subscriptionCycle?: number;
3329
+ interface SubscriptionCancellationRequested {
3330
+ subscription?: V1Subscription;
3362
3331
  }
3363
- interface UpdateSubscriptionInvoiceCycleResponse {
3364
- subscriptionInvoice?: SubscriptionInvoice;
3332
+ interface SubscriptionSuspended {
3333
+ subscription?: V1Subscription;
3365
3334
  }
3366
- interface AddPausePeriodRequest {
3367
- tenantId?: string;
3368
- subscriptionId?: string;
3369
- pauseStartDate?: Date | null;
3370
- pauseEndDate?: Date | null;
3335
+ interface V1SubscriptionResumed {
3336
+ subscription?: V1Subscription;
3371
3337
  }
3372
- interface AddPausePeriodResponse {
3373
- subscription?: Subscription;
3338
+ interface SubscriptionExpired {
3339
+ subscription?: V1Subscription;
3374
3340
  }
3375
- interface RunTimeCapsuleTaskNowRequest {
3376
- tenantId?: string;
3377
- subscriptionId?: string;
3378
- taskType?: string;
3341
+ interface V1SubscriptionInitialPurchaseCompleted {
3342
+ subscription?: V1Subscription;
3379
3343
  }
3380
- interface CreateRecurringInvoiceBORequest {
3381
- subscriptionId?: string;
3382
- tenantId?: string;
3383
- cycleNumber?: number;
3344
+ interface ListSubscriptionHistoryRequest {
3345
+ subscriptionId: string;
3346
+ /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
3347
+ mode?: HistoryViewMode;
3348
+ /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
3349
+ cursor?: CursorPaging;
3384
3350
  }
3385
- interface CreateRecurringInvoiceBOResponse {
3386
- invoiceId?: string;
3351
+ declare enum HistoryViewMode {
3352
+ UNKNOWN = "UNKNOWN",
3353
+ /** Comprehensive view including all history events. */
3354
+ BACKOFFICE = "BACKOFFICE",
3355
+ /** User-centric view of the history. */
3356
+ USER = "USER"
3387
3357
  }
3388
- interface SetShiftingDataRequest {
3389
- subscriptionId?: string;
3390
- tenantId?: string;
3391
- isBassManaged?: boolean;
3392
- shiftManagementDate?: Date | null;
3358
+ interface ListSubscriptionHistoryResponse {
3359
+ /** List of history entries for the subscription. */
3360
+ historyEntries?: SubscriptionHistoryEntry[];
3361
+ /** Paging metadata. A `next` cursor is returned if there are more results. */
3362
+ pagingMetadata?: PagingMetadataV2;
3393
3363
  }
3394
- interface SetShiftingDataResponse {
3395
- subscription?: Subscription;
3364
+ interface SubscriptionHistoryEntry {
3365
+ entryId?: string;
3366
+ /** TODO: add max length? it is not defined in domainevents, so should we? */
3367
+ slug?: string;
3368
+ entryTime?: Date | null;
3369
+ event?: SubscriptionEvent;
3396
3370
  }
3397
- interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
3398
- attachInvoice?: AttachInvoice;
3399
- detachInvoice?: DetachInvoice;
3400
- tenantId?: string;
3401
- subscriptionId?: string;
3371
+ interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
3372
+ created?: SubscriptionCreated;
3373
+ updated?: SubscriptionUpdated;
3374
+ deleted?: SubscriptionDeleted;
3375
+ activated?: SubscriptionActivated;
3376
+ ended?: SubscriptionEnded;
3377
+ canceled?: SubscriptionCanceled;
3378
+ paused?: SubscriptionPaused;
3379
+ resumed?: SubscriptionResumed;
3380
+ pauseRequested?: PauseSubscriptionRequested;
3381
+ resumeRequested?: ResumeSubscriptionRequested;
3382
+ scheduledPauseCanceled?: ScheduledPauseCanceled;
3383
+ scheduledResumeCanceled?: ScheduledResumeCanceled;
3384
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
3385
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
3386
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
3387
+ cycleReadyToPay?: SubscriptionCycleReadyToPay;
3388
+ extended?: SubscriptionExtended;
3389
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
3390
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
3391
+ revived?: SubscriptionRevived;
3392
+ billingDateUpdated?: SubscriptionBillingDateUpdated;
3393
+ futureUpdatesRequested?: FutureUpdatesRequested;
3394
+ updatesApplied?: UpdatesApplied;
3395
+ resetPendingUpdates?: ResetPendingUpdates;
3396
+ gracePeriodStarted?: GracePeriodStarted;
3397
+ gracePeriodEnded?: GracePeriodEnded;
3398
+ paymentMethodUpdated?: PaymentMethodUpdated;
3399
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
3400
+ freeTrailStarted?: FreeTrailStarted;
3401
+ freeTrailEnded?: FreeTrailEnded;
3402
+ subscriptionBoAction?: SubscriptionBackOfficeAction;
3403
+ unknown?: UnknownSubscriptionEvent;
3402
3404
  }
3403
3405
  /** @oneof */
3404
- interface FixSubscriptionInvoicesRequestModeOneOf {
3405
- attachInvoice?: AttachInvoice;
3406
- detachInvoice?: DetachInvoice;
3406
+ interface SubscriptionEventPayloadOneOf {
3407
+ created?: SubscriptionCreated;
3408
+ updated?: SubscriptionUpdated;
3409
+ deleted?: SubscriptionDeleted;
3410
+ activated?: SubscriptionActivated;
3411
+ ended?: SubscriptionEnded;
3412
+ canceled?: SubscriptionCanceled;
3413
+ paused?: SubscriptionPaused;
3414
+ resumed?: SubscriptionResumed;
3415
+ pauseRequested?: PauseSubscriptionRequested;
3416
+ resumeRequested?: ResumeSubscriptionRequested;
3417
+ scheduledPauseCanceled?: ScheduledPauseCanceled;
3418
+ scheduledResumeCanceled?: ScheduledResumeCanceled;
3419
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
3420
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
3421
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
3422
+ cycleReadyToPay?: SubscriptionCycleReadyToPay;
3423
+ extended?: SubscriptionExtended;
3424
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
3425
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
3426
+ revived?: SubscriptionRevived;
3427
+ billingDateUpdated?: SubscriptionBillingDateUpdated;
3428
+ futureUpdatesRequested?: FutureUpdatesRequested;
3429
+ updatesApplied?: UpdatesApplied;
3430
+ resetPendingUpdates?: ResetPendingUpdates;
3431
+ gracePeriodStarted?: GracePeriodStarted;
3432
+ gracePeriodEnded?: GracePeriodEnded;
3433
+ paymentMethodUpdated?: PaymentMethodUpdated;
3434
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
3435
+ freeTrailStarted?: FreeTrailStarted;
3436
+ freeTrailEnded?: FreeTrailEnded;
3437
+ subscriptionBoAction?: SubscriptionBackOfficeAction;
3438
+ unknown?: UnknownSubscriptionEvent;
3407
3439
  }
3408
- interface AttachInvoice {
3409
- invoiceId?: string;
3440
+ interface SubscriptionCreated {
3441
+ subscription?: Subscription;
3410
3442
  }
3411
- interface DetachInvoice {
3412
- invoiceId?: string;
3443
+ interface SubscriptionUpdated {
3444
+ current?: Subscription;
3445
+ previous?: Subscription;
3446
+ diff?: SubscriptionDiff;
3413
3447
  }
3414
- interface FixSubscriptionInvoicesResponse {
3415
- invoices?: SubscriptionInvoice[];
3448
+ interface SubscriptionDiff {
3449
+ added?: string | null;
3450
+ changed?: string | null;
3451
+ deleted?: string | null;
3416
3452
  }
3417
- interface RestoreDraftSubscriptionRequest {
3418
- tenantId?: string;
3453
+ interface SubscriptionDeleted {
3419
3454
  subscriptionId?: string;
3420
3455
  }
3421
- interface RestoreDraftSubscriptionResponse {
3456
+ interface FutureUpdatesRequested {
3422
3457
  subscription?: Subscription;
3458
+ requestedUpdateData?: SubscriptionUpdateData;
3423
3459
  }
3424
- interface DeleteDraftSubscriptionRequest {
3425
- tenantId?: string;
3426
- subscriptionId?: string;
3460
+ interface UpdatesApplied {
3461
+ subscription?: Subscription;
3462
+ updateAction?: UpdateAction;
3463
+ appliedUpdateData?: SubscriptionUpdateData;
3427
3464
  }
3428
- interface DeleteDraftSubscriptionResponse {
3465
+ interface ResetPendingUpdates {
3429
3466
  subscription?: Subscription;
3430
3467
  }
3431
- interface DeleteSubscriptionBORequest {
3432
- tenantId?: string;
3433
- subscriptionId?: string;
3468
+ interface GracePeriodStarted {
3469
+ subscription?: Subscription;
3434
3470
  }
3435
- interface DeleteSubscriptionBOResponse {
3471
+ interface GracePeriodEnded {
3436
3472
  subscription?: Subscription;
3473
+ /** Indication for the payment settlement method. */
3474
+ paymentSettlementMethod?: PaymentSettlementMethod;
3437
3475
  }
3438
- interface CancelSubscriptionBORequest {
3439
- tenantId?: string;
3440
- subscriptionId?: string;
3441
- initiator?: ActionInitiator;
3442
- reason?: string | null;
3476
+ declare enum PaymentSettlementMethod {
3477
+ UNKNOWN = "UNKNOWN",
3478
+ /** System-defined payment settlement. */
3479
+ SYSTEM = "SYSTEM",
3480
+ /** Manually mark the payment as paid. */
3481
+ MARK_AS_PAID = "MARK_AS_PAID",
3482
+ /** Require the customer to pay immediately, by insert a new payment method. */
3483
+ CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
3443
3484
  }
3444
- interface CancelSubscriptionBOResponse {
3485
+ interface PaymentMethodUpdated {
3445
3486
  subscription?: Subscription;
3487
+ initiator?: HistoryActionInitiator;
3488
+ paymentMode?: PaymentMode;
3446
3489
  }
3447
- interface UpdatePaymentMethodBORequest {
3448
- tenantId?: string;
3449
- subscriptionId?: string;
3450
- paymentMethodId?: string;
3451
- }
3452
- interface UpdatePaymentMethodBOResponse {
3490
+ interface SubscriptionCollectionMethodUpdated {
3453
3491
  subscription?: Subscription;
3492
+ newCollectionMethod?: CollectionMethodEnumCollectionMethod;
3493
+ previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
3454
3494
  }
3455
- interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
3456
- billingCycleStarted?: SubscriptionBillingCycleStarted;
3457
- tenantId?: string;
3458
- subscriptionId?: string;
3495
+ interface FreeTrailStarted {
3496
+ subscription?: Subscription;
3459
3497
  }
3460
- /** @oneof */
3461
- interface SendSubscriptionActionEventBORequestEventOneOf {
3462
- billingCycleStarted?: SubscriptionBillingCycleStarted;
3498
+ interface FreeTrailEnded {
3499
+ subscription?: Subscription;
3463
3500
  }
3464
- interface SendSubscriptionActionEventResponse {
3501
+ interface SubscriptionBackOfficeAction {
3502
+ subscription?: Subscription;
3503
+ /** The backoffice method name */
3504
+ name?: string;
3505
+ /** json as string format, to store the flatted request object */
3506
+ params?: string;
3465
3507
  }
3466
- interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
3467
- tenantId?: string;
3468
- subscriptionId?: string;
3469
- transactionId?: string;
3508
+ /** Defines unknown events restored from the logs */
3509
+ interface UnknownSubscriptionEvent {
3510
+ subscriptionAsString?: string | null;
3470
3511
  }
3471
3512
  interface CustomerNonNullableFields {
3472
3513
  visitorId: string;
@@ -3501,11 +3542,15 @@ interface TaxNonNullableFields {
3501
3542
  percentage: string;
3502
3543
  dynamic?: DynamicTaxNonNullableFields;
3503
3544
  }
3545
+ interface CyclesNonNullableFields {
3546
+ cycleFrom: number;
3547
+ }
3504
3548
  interface AdditionalFeeNonNullableFields {
3505
3549
  name: string;
3506
3550
  amount: string;
3507
3551
  trigger: AdditionalFeeTrigger;
3508
3552
  tax?: TaxNonNullableFields;
3553
+ cycles?: CyclesNonNullableFields;
3509
3554
  }
3510
3555
  interface DiscountCyclesNonNullableFields {
3511
3556
  cycleFrom: number;
@@ -3558,250 +3603,84 @@ interface CustomProrationNonNullableFields {
3558
3603
  interface ProrationNonNullableFields {
3559
3604
  custom?: CustomProrationNonNullableFields;
3560
3605
  }
3561
- interface UpdateBillingDateDataNonNullableFields {
3562
- proration?: ProrationNonNullableFields;
3563
- }
3564
- interface AutomaticRetryDataNonNullableFields {
3565
- enabled: boolean;
3566
- }
3567
- interface GracePeriodDataNonNullableFields {
3568
- automaticRetryData?: AutomaticRetryDataNonNullableFields;
3569
- }
3570
- interface BillingStatusNonNullableFields {
3571
- currentCycle: number;
3572
- latestPaymentData?: PaymentDataNonNullableFields;
3573
- updateBillingDateData?: UpdateBillingDateDataNonNullableFields;
3574
- gracePeriodData?: GracePeriodDataNonNullableFields;
3575
- }
3576
- interface SubscriptionPoliciesNonNullableFields {
3577
- customerCanCancel: boolean;
3578
- businessCanExtend: boolean;
3579
- allowEndOfCycleCancellation: boolean;
3580
- }
3581
- interface PauseInfoNonNullableFields {
3582
- pausePolicy: PausePolicy;
3583
- pauseAt: PauseAt;
3584
- resumeAt: ResumeAt;
3585
- }
3586
- interface CancellationInfoNonNullableFields {
3587
- initiator: HistoryActionInitiator;
3588
- }
3589
- interface FixedPriceNonNullableFields {
3590
- itemPrice: string;
3591
- }
3592
- interface PricingModelNonNullableFields {
3593
- fixedPrice?: FixedPriceNonNullableFields;
3594
- }
3595
- interface ItemChangeNonNullableFields {
3596
- _id: string;
3597
- pricingModel?: PricingModelNonNullableFields;
3598
- tax?: TaxNonNullableFields;
3599
- }
3600
- interface CatalogReferenceNonNullableFields {
3601
- catalogItemId: string;
3602
- }
3603
- interface ApplicationFeeNonNullableFields {
3604
- amount: string;
3605
- discounts: DiscountNonNullableFields[];
3606
- }
3607
- interface ItemNonNullableFields {
3608
- name: string;
3609
- catalogReference?: CatalogReferenceNonNullableFields;
3610
- category: ItemCategory;
3611
- quantity: number;
3612
- pricingModel?: PricingModelNonNullableFields;
3613
- tax?: TaxNonNullableFields;
3614
- discounts: DiscountNonNullableFields[];
3615
- applicationFee?: ApplicationFeeNonNullableFields;
3616
- }
3617
- interface SubscriptionUpdateDataNonNullableFields {
3618
- itemsToUpdate: ItemChangeNonNullableFields[];
3619
- itemsToAdd: ItemNonNullableFields[];
3620
- numberOfRequests: number;
3621
- }
3622
- interface SpecificDateSubscriptionUpdateDataNonNullableFields {
3623
- updateData?: SubscriptionUpdateDataNonNullableFields;
3624
- }
3625
- interface SubscriptionNonNullableFields {
3626
- name: string;
3627
- customer?: CustomerNonNullableFields;
3628
- status: SubscriptionStatusEnumSubscriptionStatus;
3629
- billingSettings?: BillingSettingsNonNullableFields;
3630
- billingStatus?: BillingStatusNonNullableFields;
3631
- shippingAddress?: FullAddressDetailsNonNullableFields;
3632
- policies?: SubscriptionPoliciesNonNullableFields;
3633
- pauseInfo?: PauseInfoNonNullableFields;
3634
- cancellationInfo?: CancellationInfoNonNullableFields;
3635
- pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
3636
- bassManaged: boolean;
3637
- specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
3638
- items: ItemNonNullableFields[];
3639
- }
3640
- interface SubscriptionCreatedNonNullableFields {
3641
- subscription?: SubscriptionNonNullableFields;
3642
- }
3643
- interface SubscriptionUpdatedNonNullableFields {
3644
- current?: SubscriptionNonNullableFields;
3645
- previous?: SubscriptionNonNullableFields;
3646
- }
3647
- interface SubscriptionDeletedNonNullableFields {
3648
- subscriptionId: string;
3649
- }
3650
- interface SubscriptionActivatedNonNullableFields {
3651
- subscription?: SubscriptionNonNullableFields;
3652
- }
3653
- interface SubscriptionEndedNonNullableFields {
3654
- subscription?: SubscriptionNonNullableFields;
3655
- }
3656
- interface ActionDetailsNonNullableFields {
3657
- initiator: HistoryActionInitiator;
3658
- }
3659
- interface SubscriptionCanceledNonNullableFields {
3660
- subscription?: SubscriptionNonNullableFields;
3661
- actionDetails?: ActionDetailsNonNullableFields;
3662
- }
3663
- interface SubscriptionPausedNonNullableFields {
3664
- subscription?: SubscriptionNonNullableFields;
3665
- pausePolicy: PausePolicy;
3666
- actionDetails?: ActionDetailsNonNullableFields;
3667
- }
3668
- interface SubscriptionResumedNonNullableFields {
3669
- subscription?: SubscriptionNonNullableFields;
3670
- actionDetails?: ActionDetailsNonNullableFields;
3671
- }
3672
- interface PauseSubscriptionRequestedNonNullableFields {
3673
- subscription?: SubscriptionNonNullableFields;
3674
- pauseAt: PauseAt;
3675
- pausePolicy: PausePolicy;
3676
- actionDetails?: ActionDetailsNonNullableFields;
3677
- }
3678
- interface ResumeSubscriptionRequestedNonNullableFields {
3679
- subscription?: SubscriptionNonNullableFields;
3680
- resumeAt: ResumeAt;
3681
- actionDetails?: ActionDetailsNonNullableFields;
3682
- }
3683
- interface ScheduledPauseCanceledNonNullableFields {
3684
- subscription?: SubscriptionNonNullableFields;
3685
- actionDetails?: ActionDetailsNonNullableFields;
3686
- }
3687
- interface ScheduledResumeCanceledNonNullableFields {
3688
- subscription?: SubscriptionNonNullableFields;
3689
- actionDetails?: ActionDetailsNonNullableFields;
3690
- }
3691
- interface SubscriptionBillingCycleStartedNonNullableFields {
3692
- subscription?: SubscriptionNonNullableFields;
3693
- }
3694
- interface SubscriptionAutoRenewalTurnedOnNonNullableFields {
3695
- subscription?: SubscriptionNonNullableFields;
3696
- actionDetails?: ActionDetailsNonNullableFields;
3697
- }
3698
- interface SubscriptionAutoRenewalTurnedOffNonNullableFields {
3699
- subscription?: SubscriptionNonNullableFields;
3700
- actionDetails?: ActionDetailsNonNullableFields;
3701
- }
3702
- interface SubscriptionCycleReadyToPayNonNullableFields {
3703
- subscription?: SubscriptionNonNullableFields;
3704
- }
3705
- interface SubscriptionExtendedNonNullableFields {
3706
- extensionPeriod?: DurationNonNullableFields;
3707
- extensionBillingCycles: number;
3708
- subscription?: SubscriptionNonNullableFields;
3709
- actionDetails?: ActionDetailsNonNullableFields;
3710
- }
3711
- interface SubscriptionInitialPurchaseCompletedNonNullableFields {
3712
- subscription?: SubscriptionNonNullableFields;
3713
- actionDetails?: ActionDetailsNonNullableFields;
3714
- }
3715
- interface LatestInvoiceMarkedAsPaidNonNullableFields {
3716
- subscription?: SubscriptionNonNullableFields;
3717
- }
3718
- interface SubscriptionRevivedNonNullableFields {
3719
- subscription?: SubscriptionNonNullableFields;
3720
- }
3721
- interface SubscriptionBillingDateUpdatedNonNullableFields {
3722
- subscription?: SubscriptionNonNullableFields;
3606
+ interface UpdateBillingDateDataNonNullableFields {
3723
3607
  proration?: ProrationNonNullableFields;
3724
3608
  }
3725
- interface FutureUpdatesRequestedNonNullableFields {
3726
- subscription?: SubscriptionNonNullableFields;
3727
- requestedUpdateData?: SubscriptionUpdateDataNonNullableFields;
3609
+ interface AutomaticRetryDataNonNullableFields {
3610
+ enabled: boolean;
3728
3611
  }
3729
- interface UpdatesAppliedNonNullableFields {
3730
- subscription?: SubscriptionNonNullableFields;
3731
- updateAction: UpdateAction;
3732
- appliedUpdateData?: SubscriptionUpdateDataNonNullableFields;
3612
+ interface GracePeriodDataNonNullableFields {
3613
+ automaticRetryData?: AutomaticRetryDataNonNullableFields;
3733
3614
  }
3734
- interface ResetPendingUpdatesNonNullableFields {
3735
- subscription?: SubscriptionNonNullableFields;
3615
+ interface BillingStatusNonNullableFields {
3616
+ currentCycle: number;
3617
+ latestPaymentData?: PaymentDataNonNullableFields;
3618
+ updateBillingDateData?: UpdateBillingDateDataNonNullableFields;
3619
+ gracePeriodData?: GracePeriodDataNonNullableFields;
3736
3620
  }
3737
- interface GracePeriodStartedNonNullableFields {
3738
- subscription?: SubscriptionNonNullableFields;
3621
+ interface SubscriptionPoliciesNonNullableFields {
3622
+ customerCanCancel: boolean;
3623
+ businessCanExtend: boolean;
3624
+ allowEndOfCycleCancellation: boolean;
3739
3625
  }
3740
- interface GracePeriodEndedNonNullableFields {
3741
- subscription?: SubscriptionNonNullableFields;
3742
- paymentSettlementMethod: PaymentSettlementMethod;
3626
+ interface PauseInfoNonNullableFields {
3627
+ pausePolicy: PausePolicy;
3628
+ pauseAt: PauseAt;
3629
+ resumeAt: ResumeAt;
3743
3630
  }
3744
- interface PaymentMethodUpdatedNonNullableFields {
3745
- subscription?: SubscriptionNonNullableFields;
3631
+ interface CancellationInfoNonNullableFields {
3746
3632
  initiator: HistoryActionInitiator;
3747
- paymentMode: PaymentMode;
3748
3633
  }
3749
- interface SubscriptionCollectionMethodUpdatedNonNullableFields {
3750
- subscription?: SubscriptionNonNullableFields;
3751
- newCollectionMethod: CollectionMethodEnumCollectionMethod;
3752
- previousCollectionMethod: CollectionMethodEnumCollectionMethod;
3634
+ interface FixedPriceNonNullableFields {
3635
+ itemPrice: string;
3753
3636
  }
3754
- interface FreeTrailStartedNonNullableFields {
3755
- subscription?: SubscriptionNonNullableFields;
3637
+ interface PricingModelNonNullableFields {
3638
+ fixedPrice?: FixedPriceNonNullableFields;
3756
3639
  }
3757
- interface FreeTrailEndedNonNullableFields {
3758
- subscription?: SubscriptionNonNullableFields;
3640
+ interface ItemChangeNonNullableFields {
3641
+ _id: string;
3642
+ pricingModel?: PricingModelNonNullableFields;
3643
+ tax?: TaxNonNullableFields;
3759
3644
  }
3760
- interface SubscriptionBackOfficeActionNonNullableFields {
3761
- subscription?: SubscriptionNonNullableFields;
3645
+ interface CatalogReferenceNonNullableFields {
3646
+ catalogItemId: string;
3647
+ }
3648
+ interface ApplicationFeeNonNullableFields {
3649
+ amount: string;
3650
+ discounts: DiscountNonNullableFields[];
3651
+ }
3652
+ interface ItemNonNullableFields {
3762
3653
  name: string;
3763
- params: string;
3654
+ catalogReference?: CatalogReferenceNonNullableFields;
3655
+ category: ItemCategory;
3656
+ quantity: number;
3657
+ pricingModel?: PricingModelNonNullableFields;
3658
+ tax?: TaxNonNullableFields;
3659
+ discounts: DiscountNonNullableFields[];
3660
+ applicationFee?: ApplicationFeeNonNullableFields;
3764
3661
  }
3765
- interface SubscriptionEventNonNullableFields {
3766
- created?: SubscriptionCreatedNonNullableFields;
3767
- updated?: SubscriptionUpdatedNonNullableFields;
3768
- deleted?: SubscriptionDeletedNonNullableFields;
3769
- activated?: SubscriptionActivatedNonNullableFields;
3770
- ended?: SubscriptionEndedNonNullableFields;
3771
- canceled?: SubscriptionCanceledNonNullableFields;
3772
- paused?: SubscriptionPausedNonNullableFields;
3773
- resumed?: SubscriptionResumedNonNullableFields;
3774
- pauseRequested?: PauseSubscriptionRequestedNonNullableFields;
3775
- resumeRequested?: ResumeSubscriptionRequestedNonNullableFields;
3776
- scheduledPauseCanceled?: ScheduledPauseCanceledNonNullableFields;
3777
- scheduledResumeCanceled?: ScheduledResumeCanceledNonNullableFields;
3778
- billingCycleStarted?: SubscriptionBillingCycleStartedNonNullableFields;
3779
- autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOnNonNullableFields;
3780
- autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOffNonNullableFields;
3781
- cycleReadyToPay?: SubscriptionCycleReadyToPayNonNullableFields;
3782
- extended?: SubscriptionExtendedNonNullableFields;
3783
- initialPurchaseCompleted?: SubscriptionInitialPurchaseCompletedNonNullableFields;
3784
- latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaidNonNullableFields;
3785
- revived?: SubscriptionRevivedNonNullableFields;
3786
- billingDateUpdated?: SubscriptionBillingDateUpdatedNonNullableFields;
3787
- futureUpdatesRequested?: FutureUpdatesRequestedNonNullableFields;
3788
- updatesApplied?: UpdatesAppliedNonNullableFields;
3789
- resetPendingUpdates?: ResetPendingUpdatesNonNullableFields;
3790
- gracePeriodStarted?: GracePeriodStartedNonNullableFields;
3791
- gracePeriodEnded?: GracePeriodEndedNonNullableFields;
3792
- paymentMethodUpdated?: PaymentMethodUpdatedNonNullableFields;
3793
- collectionMethodUpdated?: SubscriptionCollectionMethodUpdatedNonNullableFields;
3794
- freeTrailStarted?: FreeTrailStartedNonNullableFields;
3795
- freeTrailEnded?: FreeTrailEndedNonNullableFields;
3796
- subscriptionBoAction?: SubscriptionBackOfficeActionNonNullableFields;
3662
+ interface SubscriptionUpdateDataNonNullableFields {
3663
+ itemsToUpdate: ItemChangeNonNullableFields[];
3664
+ itemsToAdd: ItemNonNullableFields[];
3665
+ numberOfRequests: number;
3797
3666
  }
3798
- interface SubscriptionHistoryEntryNonNullableFields {
3799
- entryId: string;
3800
- slug: string;
3801
- event?: SubscriptionEventNonNullableFields;
3667
+ interface SpecificDateSubscriptionUpdateDataNonNullableFields {
3668
+ updateData?: SubscriptionUpdateDataNonNullableFields;
3802
3669
  }
3803
- interface ListSubscriptionHistoryResponseNonNullableFields {
3804
- historyEntries: SubscriptionHistoryEntryNonNullableFields[];
3670
+ interface SubscriptionNonNullableFields {
3671
+ name: string;
3672
+ customer?: CustomerNonNullableFields;
3673
+ status: SubscriptionStatusEnumSubscriptionStatus;
3674
+ billingSettings?: BillingSettingsNonNullableFields;
3675
+ billingStatus?: BillingStatusNonNullableFields;
3676
+ shippingAddress?: FullAddressDetailsNonNullableFields;
3677
+ policies?: SubscriptionPoliciesNonNullableFields;
3678
+ pauseInfo?: PauseInfoNonNullableFields;
3679
+ cancellationInfo?: CancellationInfoNonNullableFields;
3680
+ pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
3681
+ bassManaged: boolean;
3682
+ specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
3683
+ items: ItemNonNullableFields[];
3805
3684
  }
3806
3685
  interface GetSubscriptionResponseNonNullableFields {
3807
3686
  subscription?: SubscriptionNonNullableFields;
@@ -3889,6 +3768,10 @@ interface CustomerListUpcomingChargesResponseNonNullableFields {
3889
3768
  interface InitiatePaymentMethodSetupResponseNonNullableFields {
3890
3769
  paymentOrderId: string;
3891
3770
  }
3771
+ interface PayCycleResponseNonNullableFields {
3772
+ invoiceId: string;
3773
+ subscription?: SubscriptionNonNullableFields;
3774
+ }
3892
3775
  interface UpdateSubscriptionBillingDateResponseNonNullableFields {
3893
3776
  subscription?: SubscriptionNonNullableFields;
3894
3777
  }
@@ -3908,60 +3791,222 @@ interface CountByStatusNonNullableFields {
3908
3791
  status: SubscriptionStatusEnumSubscriptionStatus;
3909
3792
  count: number;
3910
3793
  }
3911
- interface CountSubscriptionsResponseNonNullableFields {
3912
- countByStatus: CountByStatusNonNullableFields[];
3913
- total: number;
3794
+ interface CountSubscriptionsResponseNonNullableFields {
3795
+ countByStatus: CountByStatusNonNullableFields[];
3796
+ total: number;
3797
+ }
3798
+ interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
3799
+ subscription?: SubscriptionNonNullableFields;
3800
+ }
3801
+ interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
3802
+ subscription?: SubscriptionNonNullableFields;
3803
+ }
3804
+ interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
3805
+ subscription?: SubscriptionNonNullableFields;
3806
+ }
3807
+ interface AmountByStatusNonNullableFields {
3808
+ status: SubscriptionStatusEnumSubscriptionStatus;
3809
+ amount: number;
3810
+ }
3811
+ interface GetSubscriptionsStatsResponseNonNullableFields {
3812
+ amountByStatuses: AmountByStatusNonNullableFields[];
3813
+ total: number;
3814
+ }
3815
+ interface ExtendSubscriptionResponseNonNullableFields {
3816
+ subscription?: SubscriptionNonNullableFields;
3817
+ }
3818
+ interface UnsupportedReasonNonNullableFields {
3819
+ code: string;
3820
+ }
3821
+ interface UnsupportedActionNonNullableFields {
3822
+ actionType: ActionType;
3823
+ reasons: UnsupportedReasonNonNullableFields[];
3824
+ }
3825
+ interface AllowedActionsResponseNonNullableFields {
3826
+ actions: ActionNonNullableFields[];
3827
+ unsupportedActions: UnsupportedActionNonNullableFields[];
3828
+ }
3829
+ interface ListUpcomingChargesResponseNonNullableFields {
3830
+ upcomingCharges: SubscriptionChargeNonNullableFields[];
3831
+ }
3832
+ interface ChargeNonNullableFields {
3833
+ cycleFrom: number;
3834
+ totals?: TotalsNonNullableFields;
3835
+ }
3836
+ interface PreviewSubscriptionChargesResponseNonNullableFields {
3837
+ charges: ChargeNonNullableFields[];
3838
+ }
3839
+ interface SubscriptionChargesNonNullableFields {
3840
+ charges: ChargeNonNullableFields[];
3841
+ }
3842
+ interface PreviewSubscriptionsChargesResponseNonNullableFields {
3843
+ subscriptionsCharges: SubscriptionChargesNonNullableFields[];
3844
+ }
3845
+ interface SubscriptionCreatedNonNullableFields {
3846
+ subscription?: SubscriptionNonNullableFields;
3847
+ }
3848
+ interface SubscriptionUpdatedNonNullableFields {
3849
+ current?: SubscriptionNonNullableFields;
3850
+ previous?: SubscriptionNonNullableFields;
3851
+ }
3852
+ interface SubscriptionDeletedNonNullableFields {
3853
+ subscriptionId: string;
3854
+ }
3855
+ interface SubscriptionActivatedNonNullableFields {
3856
+ subscription?: SubscriptionNonNullableFields;
3857
+ }
3858
+ interface SubscriptionEndedNonNullableFields {
3859
+ subscription?: SubscriptionNonNullableFields;
3860
+ }
3861
+ interface ActionDetailsNonNullableFields {
3862
+ initiator: HistoryActionInitiator;
3863
+ }
3864
+ interface SubscriptionCanceledNonNullableFields {
3865
+ subscription?: SubscriptionNonNullableFields;
3866
+ actionDetails?: ActionDetailsNonNullableFields;
3867
+ }
3868
+ interface SubscriptionPausedNonNullableFields {
3869
+ subscription?: SubscriptionNonNullableFields;
3870
+ pausePolicy: PausePolicy;
3871
+ actionDetails?: ActionDetailsNonNullableFields;
3872
+ }
3873
+ interface SubscriptionResumedNonNullableFields {
3874
+ subscription?: SubscriptionNonNullableFields;
3875
+ actionDetails?: ActionDetailsNonNullableFields;
3876
+ }
3877
+ interface PauseSubscriptionRequestedNonNullableFields {
3878
+ subscription?: SubscriptionNonNullableFields;
3879
+ pauseAt: PauseAt;
3880
+ pausePolicy: PausePolicy;
3881
+ actionDetails?: ActionDetailsNonNullableFields;
3882
+ }
3883
+ interface ResumeSubscriptionRequestedNonNullableFields {
3884
+ subscription?: SubscriptionNonNullableFields;
3885
+ resumeAt: ResumeAt;
3886
+ actionDetails?: ActionDetailsNonNullableFields;
3887
+ }
3888
+ interface ScheduledPauseCanceledNonNullableFields {
3889
+ subscription?: SubscriptionNonNullableFields;
3890
+ actionDetails?: ActionDetailsNonNullableFields;
3891
+ }
3892
+ interface ScheduledResumeCanceledNonNullableFields {
3893
+ subscription?: SubscriptionNonNullableFields;
3894
+ actionDetails?: ActionDetailsNonNullableFields;
3895
+ }
3896
+ interface SubscriptionBillingCycleStartedNonNullableFields {
3897
+ subscription?: SubscriptionNonNullableFields;
3898
+ }
3899
+ interface SubscriptionAutoRenewalTurnedOnNonNullableFields {
3900
+ subscription?: SubscriptionNonNullableFields;
3901
+ actionDetails?: ActionDetailsNonNullableFields;
3902
+ }
3903
+ interface SubscriptionAutoRenewalTurnedOffNonNullableFields {
3904
+ subscription?: SubscriptionNonNullableFields;
3905
+ actionDetails?: ActionDetailsNonNullableFields;
3906
+ }
3907
+ interface SubscriptionCycleReadyToPayNonNullableFields {
3908
+ subscription?: SubscriptionNonNullableFields;
3909
+ }
3910
+ interface SubscriptionExtendedNonNullableFields {
3911
+ extensionPeriod?: DurationNonNullableFields;
3912
+ extensionBillingCycles: number;
3913
+ subscription?: SubscriptionNonNullableFields;
3914
+ actionDetails?: ActionDetailsNonNullableFields;
3915
+ }
3916
+ interface SubscriptionInitialPurchaseCompletedNonNullableFields {
3917
+ subscription?: SubscriptionNonNullableFields;
3918
+ actionDetails?: ActionDetailsNonNullableFields;
3914
3919
  }
3915
- interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
3920
+ interface LatestInvoiceMarkedAsPaidNonNullableFields {
3916
3921
  subscription?: SubscriptionNonNullableFields;
3917
3922
  }
3918
- interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
3923
+ interface SubscriptionRevivedNonNullableFields {
3919
3924
  subscription?: SubscriptionNonNullableFields;
3920
3925
  }
3921
- interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
3926
+ interface SubscriptionBillingDateUpdatedNonNullableFields {
3922
3927
  subscription?: SubscriptionNonNullableFields;
3928
+ proration?: ProrationNonNullableFields;
3923
3929
  }
3924
- interface AmountByStatusNonNullableFields {
3925
- status: SubscriptionStatusEnumSubscriptionStatus;
3926
- amount: number;
3930
+ interface FutureUpdatesRequestedNonNullableFields {
3931
+ subscription?: SubscriptionNonNullableFields;
3932
+ requestedUpdateData?: SubscriptionUpdateDataNonNullableFields;
3927
3933
  }
3928
- interface GetSubscriptionsStatsResponseNonNullableFields {
3929
- amountByStatuses: AmountByStatusNonNullableFields[];
3930
- total: number;
3934
+ interface UpdatesAppliedNonNullableFields {
3935
+ subscription?: SubscriptionNonNullableFields;
3936
+ updateAction: UpdateAction;
3937
+ appliedUpdateData?: SubscriptionUpdateDataNonNullableFields;
3931
3938
  }
3932
- interface ExtendSubscriptionResponseNonNullableFields {
3939
+ interface ResetPendingUpdatesNonNullableFields {
3933
3940
  subscription?: SubscriptionNonNullableFields;
3934
3941
  }
3935
- interface UnsupportedReasonNonNullableFields {
3936
- code: string;
3942
+ interface GracePeriodStartedNonNullableFields {
3943
+ subscription?: SubscriptionNonNullableFields;
3937
3944
  }
3938
- interface UnsupportedActionNonNullableFields {
3939
- actionType: ActionType;
3940
- reasons: UnsupportedReasonNonNullableFields[];
3945
+ interface GracePeriodEndedNonNullableFields {
3946
+ subscription?: SubscriptionNonNullableFields;
3947
+ paymentSettlementMethod: PaymentSettlementMethod;
3941
3948
  }
3942
- interface AllowedActionsResponseNonNullableFields {
3943
- actions: ActionNonNullableFields[];
3944
- unsupportedActions: UnsupportedActionNonNullableFields[];
3949
+ interface PaymentMethodUpdatedNonNullableFields {
3950
+ subscription?: SubscriptionNonNullableFields;
3951
+ initiator: HistoryActionInitiator;
3952
+ paymentMode: PaymentMode;
3945
3953
  }
3946
- interface ListUpcomingChargesResponseNonNullableFields {
3947
- upcomingCharges: SubscriptionChargeNonNullableFields[];
3954
+ interface SubscriptionCollectionMethodUpdatedNonNullableFields {
3955
+ subscription?: SubscriptionNonNullableFields;
3956
+ newCollectionMethod: CollectionMethodEnumCollectionMethod;
3957
+ previousCollectionMethod: CollectionMethodEnumCollectionMethod;
3948
3958
  }
3949
- interface ChargeNonNullableFields {
3950
- cycleFrom: number;
3951
- totals?: TotalsNonNullableFields;
3959
+ interface FreeTrailStartedNonNullableFields {
3960
+ subscription?: SubscriptionNonNullableFields;
3952
3961
  }
3953
- interface PreviewSubscriptionChargesResponseNonNullableFields {
3954
- charges: ChargeNonNullableFields[];
3962
+ interface FreeTrailEndedNonNullableFields {
3963
+ subscription?: SubscriptionNonNullableFields;
3955
3964
  }
3956
- interface SubscriptionChargesNonNullableFields {
3957
- charges: ChargeNonNullableFields[];
3965
+ interface SubscriptionBackOfficeActionNonNullableFields {
3966
+ subscription?: SubscriptionNonNullableFields;
3967
+ name: string;
3968
+ params: string;
3958
3969
  }
3959
- interface PreviewSubscriptionsChargesResponseNonNullableFields {
3960
- subscriptionsCharges: SubscriptionChargesNonNullableFields[];
3970
+ interface SubscriptionEventNonNullableFields {
3971
+ created?: SubscriptionCreatedNonNullableFields;
3972
+ updated?: SubscriptionUpdatedNonNullableFields;
3973
+ deleted?: SubscriptionDeletedNonNullableFields;
3974
+ activated?: SubscriptionActivatedNonNullableFields;
3975
+ ended?: SubscriptionEndedNonNullableFields;
3976
+ canceled?: SubscriptionCanceledNonNullableFields;
3977
+ paused?: SubscriptionPausedNonNullableFields;
3978
+ resumed?: SubscriptionResumedNonNullableFields;
3979
+ pauseRequested?: PauseSubscriptionRequestedNonNullableFields;
3980
+ resumeRequested?: ResumeSubscriptionRequestedNonNullableFields;
3981
+ scheduledPauseCanceled?: ScheduledPauseCanceledNonNullableFields;
3982
+ scheduledResumeCanceled?: ScheduledResumeCanceledNonNullableFields;
3983
+ billingCycleStarted?: SubscriptionBillingCycleStartedNonNullableFields;
3984
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOnNonNullableFields;
3985
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOffNonNullableFields;
3986
+ cycleReadyToPay?: SubscriptionCycleReadyToPayNonNullableFields;
3987
+ extended?: SubscriptionExtendedNonNullableFields;
3988
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompletedNonNullableFields;
3989
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaidNonNullableFields;
3990
+ revived?: SubscriptionRevivedNonNullableFields;
3991
+ billingDateUpdated?: SubscriptionBillingDateUpdatedNonNullableFields;
3992
+ futureUpdatesRequested?: FutureUpdatesRequestedNonNullableFields;
3993
+ updatesApplied?: UpdatesAppliedNonNullableFields;
3994
+ resetPendingUpdates?: ResetPendingUpdatesNonNullableFields;
3995
+ gracePeriodStarted?: GracePeriodStartedNonNullableFields;
3996
+ gracePeriodEnded?: GracePeriodEndedNonNullableFields;
3997
+ paymentMethodUpdated?: PaymentMethodUpdatedNonNullableFields;
3998
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdatedNonNullableFields;
3999
+ freeTrailStarted?: FreeTrailStartedNonNullableFields;
4000
+ freeTrailEnded?: FreeTrailEndedNonNullableFields;
4001
+ subscriptionBoAction?: SubscriptionBackOfficeActionNonNullableFields;
3961
4002
  }
3962
- interface PayCycleResponseNonNullableFields {
3963
- invoiceId: string;
3964
- subscription?: SubscriptionNonNullableFields;
4003
+ interface SubscriptionHistoryEntryNonNullableFields {
4004
+ entryId: string;
4005
+ slug: string;
4006
+ event?: SubscriptionEventNonNullableFields;
4007
+ }
4008
+ interface ListSubscriptionHistoryResponseNonNullableFields {
4009
+ historyEntries: SubscriptionHistoryEntryNonNullableFields[];
3965
4010
  }
3966
4011
  interface BaseEventMetadata {
3967
4012
  /** App instance ID. */
@@ -4021,52 +4066,46 @@ interface SubscriptionUpdatedEnvelope {
4021
4066
  entity: Subscription;
4022
4067
  metadata: EventMetadata;
4023
4068
  }
4024
- interface SubscriptionBillingDateUpdatedEnvelope {
4025
- data: SubscriptionBillingDateUpdated;
4069
+ interface SubscriptionAutoRenewalTurnedOffEnvelope {
4070
+ data: SubscriptionAutoRenewalTurnedOff;
4026
4071
  metadata: EventMetadata;
4027
4072
  }
4028
- interface SubscriptionPausedEnvelope {
4029
- data: SubscriptionPaused;
4073
+ interface SubscriptionAutoRenewalTurnedOnEnvelope {
4074
+ data: SubscriptionAutoRenewalTurnedOn;
4030
4075
  metadata: EventMetadata;
4031
4076
  }
4032
- interface SubscriptionPauseScheduledEnvelope {
4033
- data: PauseSubscriptionRequested;
4077
+ interface SubscriptionBillingDateUpdatedEnvelope {
4078
+ data: SubscriptionBillingDateUpdated;
4079
+ metadata: EventMetadata;
4080
+ }
4081
+ interface SubscriptionLatestInvoiceMarkedAsPaidEnvelope {
4082
+ data: LatestInvoiceMarkedAsPaid;
4034
4083
  metadata: EventMetadata;
4035
4084
  }
4036
4085
  interface SubscriptionPauseScheduleCanceledEnvelope {
4037
4086
  data: ScheduledPauseCanceled;
4038
4087
  metadata: EventMetadata;
4039
4088
  }
4040
- interface SubscriptionResumedEnvelope {
4041
- data: SubscriptionResumed;
4089
+ interface SubscriptionPauseScheduledEnvelope {
4090
+ data: PauseSubscriptionRequested;
4042
4091
  metadata: EventMetadata;
4043
4092
  }
4044
- interface SubscriptionResumeScheduledEnvelope {
4045
- data: ResumeSubscriptionRequested;
4093
+ interface SubscriptionPausedEnvelope {
4094
+ data: SubscriptionPaused;
4046
4095
  metadata: EventMetadata;
4047
4096
  }
4048
4097
  interface SubscriptionResumeScheduleCanceledEnvelope {
4049
4098
  data: ScheduledResumeCanceled;
4050
4099
  metadata: EventMetadata;
4051
4100
  }
4052
- interface SubscriptionAutoRenewalTurnedOnEnvelope {
4053
- data: SubscriptionAutoRenewalTurnedOn;
4054
- metadata: EventMetadata;
4055
- }
4056
- interface SubscriptionAutoRenewalTurnedOffEnvelope {
4057
- data: SubscriptionAutoRenewalTurnedOff;
4101
+ interface SubscriptionResumeScheduledEnvelope {
4102
+ data: ResumeSubscriptionRequested;
4058
4103
  metadata: EventMetadata;
4059
4104
  }
4060
- interface SubscriptionLatestInvoiceMarkedAsPaidEnvelope {
4061
- data: LatestInvoiceMarkedAsPaid;
4105
+ interface SubscriptionResumedEnvelope {
4106
+ data: SubscriptionResumed;
4062
4107
  metadata: EventMetadata;
4063
4108
  }
4064
- interface ListSubscriptionHistoryOptions {
4065
- /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
4066
- mode?: HistoryViewMode;
4067
- /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
4068
- cursor?: CursorPaging;
4069
- }
4070
4109
  interface CustomerCancelSubscriptionOptions {
4071
4110
  /** Optional action reason message */
4072
4111
  reason?: string | null;
@@ -4092,6 +4131,10 @@ interface CustomerInitiatePaymentMethodSetupOptions {
4092
4131
  paymentMode?: PaymentMode;
4093
4132
  paymentSettings?: PaymentSettings;
4094
4133
  }
4134
+ interface PayCycleOptions {
4135
+ paymentTestMode?: PaymentTestMode;
4136
+ tenantId: string;
4137
+ }
4095
4138
  interface UpdateSubscriptionBillingDateOptions {
4096
4139
  /**
4097
4140
  * Information about how BASS adjusts the total of the next invoice. Extending
@@ -4159,21 +4202,31 @@ interface PreviewSubscriptionChargesOptions extends PreviewSubscriptionChargesRe
4159
4202
  interface PreviewSubscriptionsChargesOptions {
4160
4203
  /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
4161
4204
  subscriptionsBillingDetails?: SubscriptionBillingDetails[];
4205
+ /**
4206
+ * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
4207
+ * For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
4208
+ * $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
4209
+ * - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
4210
+ * - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
4211
+ * - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
4212
+ * If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
4213
+ * in this case, charges for cycle 1 through 3.
4214
+ * If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
4215
+ * then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
4216
+ */
4217
+ numberOfNextRecurringCharges?: number | null;
4162
4218
  }
4163
4219
  interface InitiatePaymentMethodSetupOptions {
4164
4220
  paymentMode?: PaymentMode;
4165
4221
  paymentSettings?: PaymentSettings;
4166
4222
  }
4167
- interface PayCycleOptions {
4168
- paymentTestMode?: PaymentTestMode;
4169
- tenantId: string;
4223
+ interface ListSubscriptionHistoryOptions {
4224
+ /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
4225
+ mode?: HistoryViewMode;
4226
+ /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
4227
+ cursor?: CursorPaging;
4170
4228
  }
4171
4229
 
4172
- declare function listSubscriptionHistory$1(httpClient: HttpClient): ListSubscriptionHistorySignature;
4173
- interface ListSubscriptionHistorySignature {
4174
- /** */
4175
- (subscriptionId: string, options?: ListSubscriptionHistoryOptions | undefined): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
4176
- }
4177
4230
  declare function customerGetSubscription$1(httpClient: HttpClient): CustomerGetSubscriptionSignature;
4178
4231
  interface CustomerGetSubscriptionSignature {
4179
4232
  /**
@@ -4243,6 +4296,13 @@ interface CustomerInitiatePaymentMethodSetupSignature {
4243
4296
  */
4244
4297
  (_id: string, options?: CustomerInitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
4245
4298
  }
4299
+ declare function payCycle$1(httpClient: HttpClient): PayCycleSignature;
4300
+ interface PayCycleSignature {
4301
+ /**
4302
+ * This used only for automation and permitted tenants (QA & testing)
4303
+ */
4304
+ (subscriptionId: string, options?: PayCycleOptions | undefined): Promise<PayCycleResponse & PayCycleResponseNonNullableFields>;
4305
+ }
4246
4306
  declare function getSubscription$1(httpClient: HttpClient): GetSubscriptionSignature;
4247
4307
  interface GetSubscriptionSignature {
4248
4308
  /**
@@ -4415,30 +4475,27 @@ interface InitiatePaymentMethodSetupSignature {
4415
4475
  */
4416
4476
  (_id: string, options?: InitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
4417
4477
  }
4418
- declare function payCycle$1(httpClient: HttpClient): PayCycleSignature;
4419
- interface PayCycleSignature {
4420
- /**
4421
- * This used only for automation and permitted tenants (QA & testing)
4422
- */
4423
- (subscriptionId: string, options?: PayCycleOptions | undefined): Promise<PayCycleResponse & PayCycleResponseNonNullableFields>;
4478
+ declare function listSubscriptionHistory$1(httpClient: HttpClient): ListSubscriptionHistorySignature;
4479
+ interface ListSubscriptionHistorySignature {
4480
+ /** */
4481
+ (subscriptionId: string, options?: ListSubscriptionHistoryOptions | undefined): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
4424
4482
  }
4425
4483
  declare const onSubscriptionCanceled$1: EventDefinition<SubscriptionCanceledEnvelope, "wix.billing.v1.subscription_canceled">;
4426
4484
  declare const onSubscriptionExtended$1: EventDefinition<SubscriptionExtendedEnvelope, "wix.billing.v1.subscription_extended">;
4427
4485
  declare const onSubscriptionUpdated$1: EventDefinition<SubscriptionUpdatedEnvelope, "wix.billing.v1.subscription_updated">;
4486
+ declare const onSubscriptionAutoRenewalTurnedOff$1: EventDefinition<SubscriptionAutoRenewalTurnedOffEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_off">;
4487
+ declare const onSubscriptionAutoRenewalTurnedOn$1: EventDefinition<SubscriptionAutoRenewalTurnedOnEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_on">;
4428
4488
  declare const onSubscriptionBillingDateUpdated$1: EventDefinition<SubscriptionBillingDateUpdatedEnvelope, "wix.billing.v1.subscription_billing_date_updated">;
4429
- declare const onSubscriptionPaused$1: EventDefinition<SubscriptionPausedEnvelope, "wix.billing.v1.subscription_paused">;
4430
- declare const onSubscriptionPauseScheduled$1: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
4489
+ declare const onSubscriptionLatestInvoiceMarkedAsPaid$1: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
4431
4490
  declare const onSubscriptionPauseScheduleCanceled$1: EventDefinition<SubscriptionPauseScheduleCanceledEnvelope, "wix.billing.v1.subscription_pause_schedule_canceled">;
4432
- declare const onSubscriptionResumed$1: EventDefinition<SubscriptionResumedEnvelope, "wix.billing.v1.subscription_resumed">;
4433
- declare const onSubscriptionResumeScheduled$1: EventDefinition<SubscriptionResumeScheduledEnvelope, "wix.billing.v1.subscription_resume_scheduled">;
4491
+ declare const onSubscriptionPauseScheduled$1: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
4492
+ declare const onSubscriptionPaused$1: EventDefinition<SubscriptionPausedEnvelope, "wix.billing.v1.subscription_paused">;
4434
4493
  declare const onSubscriptionResumeScheduleCanceled$1: EventDefinition<SubscriptionResumeScheduleCanceledEnvelope, "wix.billing.v1.subscription_resume_schedule_canceled">;
4435
- declare const onSubscriptionAutoRenewalTurnedOn$1: EventDefinition<SubscriptionAutoRenewalTurnedOnEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_on">;
4436
- declare const onSubscriptionAutoRenewalTurnedOff$1: EventDefinition<SubscriptionAutoRenewalTurnedOffEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_off">;
4437
- declare const onSubscriptionLatestInvoiceMarkedAsPaid$1: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
4494
+ declare const onSubscriptionResumeScheduled$1: EventDefinition<SubscriptionResumeScheduledEnvelope, "wix.billing.v1.subscription_resume_scheduled">;
4495
+ declare const onSubscriptionResumed$1: EventDefinition<SubscriptionResumedEnvelope, "wix.billing.v1.subscription_resumed">;
4438
4496
 
4439
4497
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
4440
4498
 
4441
- declare const listSubscriptionHistory: MaybeContext<BuildRESTFunction<typeof listSubscriptionHistory$1> & typeof listSubscriptionHistory$1>;
4442
4499
  declare const customerGetSubscription: MaybeContext<BuildRESTFunction<typeof customerGetSubscription$1> & typeof customerGetSubscription$1>;
4443
4500
  declare const customerCancelSubscription: MaybeContext<BuildRESTFunction<typeof customerCancelSubscription$1> & typeof customerCancelSubscription$1>;
4444
4501
  declare const customerTurnOnSubscriptionAutoRenewal: MaybeContext<BuildRESTFunction<typeof customerTurnOnSubscriptionAutoRenewal$1> & typeof customerTurnOnSubscriptionAutoRenewal$1>;
@@ -4449,6 +4506,7 @@ declare const customerUpdateSubscriptionPaymentMethod: MaybeContext<BuildRESTFun
4449
4506
  declare const customerAllowedActions: MaybeContext<BuildRESTFunction<typeof customerAllowedActions$1> & typeof customerAllowedActions$1>;
4450
4507
  declare const customerListUpcomingCharges: MaybeContext<BuildRESTFunction<typeof customerListUpcomingCharges$1> & typeof customerListUpcomingCharges$1>;
4451
4508
  declare const customerInitiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof customerInitiatePaymentMethodSetup$1> & typeof customerInitiatePaymentMethodSetup$1>;
4509
+ declare const payCycle: MaybeContext<BuildRESTFunction<typeof payCycle$1> & typeof payCycle$1>;
4452
4510
  declare const getSubscription: MaybeContext<BuildRESTFunction<typeof getSubscription$1> & typeof getSubscription$1>;
4453
4511
  declare const updateSubscriptionPaymentMethod: MaybeContext<BuildRESTFunction<typeof updateSubscriptionPaymentMethod$1> & typeof updateSubscriptionPaymentMethod$1>;
4454
4512
  declare const updateSubscriptionBillingDate: MaybeContext<BuildRESTFunction<typeof updateSubscriptionBillingDate$1> & typeof updateSubscriptionBillingDate$1>;
@@ -4468,7 +4526,7 @@ declare const listUpcomingCharges: MaybeContext<BuildRESTFunction<typeof listUpc
4468
4526
  declare const previewSubscriptionCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionCharges$1> & typeof previewSubscriptionCharges$1>;
4469
4527
  declare const previewSubscriptionsCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionsCharges$1> & typeof previewSubscriptionsCharges$1>;
4470
4528
  declare const initiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof initiatePaymentMethodSetup$1> & typeof initiatePaymentMethodSetup$1>;
4471
- declare const payCycle: MaybeContext<BuildRESTFunction<typeof payCycle$1> & typeof payCycle$1>;
4529
+ declare const listSubscriptionHistory: MaybeContext<BuildRESTFunction<typeof listSubscriptionHistory$1> & typeof listSubscriptionHistory$1>;
4472
4530
 
4473
4531
  type _publicOnSubscriptionCanceledType = typeof onSubscriptionCanceled$1;
4474
4532
  /**
@@ -4488,23 +4546,27 @@ type _publicOnSubscriptionUpdatedType = typeof onSubscriptionUpdated$1;
4488
4546
  */
4489
4547
  declare const onSubscriptionUpdated: ReturnType<typeof createEventModule<_publicOnSubscriptionUpdatedType>>;
4490
4548
 
4491
- type _publicOnSubscriptionBillingDateUpdatedType = typeof onSubscriptionBillingDateUpdated$1;
4549
+ type _publicOnSubscriptionAutoRenewalTurnedOffType = typeof onSubscriptionAutoRenewalTurnedOff$1;
4492
4550
  /**
4493
- * Triggered when subscription has been extended
4551
+ * Triggered when a subscription cycleAutoRenew was turned off.
4494
4552
  */
4495
- declare const onSubscriptionBillingDateUpdated: ReturnType<typeof createEventModule<_publicOnSubscriptionBillingDateUpdatedType>>;
4553
+ declare const onSubscriptionAutoRenewalTurnedOff: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOffType>>;
4496
4554
 
4497
- type _publicOnSubscriptionPausedType = typeof onSubscriptionPaused$1;
4555
+ type _publicOnSubscriptionAutoRenewalTurnedOnType = typeof onSubscriptionAutoRenewalTurnedOn$1;
4498
4556
  /**
4499
- * Triggered when a subscription is paused.
4557
+ * Triggered when a subscription cycleAutoRenew was turned on.
4500
4558
  */
4501
- declare const onSubscriptionPaused: ReturnType<typeof createEventModule<_publicOnSubscriptionPausedType>>;
4559
+ declare const onSubscriptionAutoRenewalTurnedOn: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOnType>>;
4502
4560
 
4503
- type _publicOnSubscriptionPauseScheduledType = typeof onSubscriptionPauseScheduled$1;
4561
+ type _publicOnSubscriptionBillingDateUpdatedType = typeof onSubscriptionBillingDateUpdated$1;
4504
4562
  /**
4505
- * Triggered when pause subscription requested
4563
+ * Triggered when subscription has been extended
4506
4564
  */
4507
- declare const onSubscriptionPauseScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionPauseScheduledType>>;
4565
+ declare const onSubscriptionBillingDateUpdated: ReturnType<typeof createEventModule<_publicOnSubscriptionBillingDateUpdatedType>>;
4566
+
4567
+ type _publicOnSubscriptionLatestInvoiceMarkedAsPaidType = typeof onSubscriptionLatestInvoiceMarkedAsPaid$1;
4568
+ /** */
4569
+ declare const onSubscriptionLatestInvoiceMarkedAsPaid: ReturnType<typeof createEventModule<_publicOnSubscriptionLatestInvoiceMarkedAsPaidType>>;
4508
4570
 
4509
4571
  type _publicOnSubscriptionPauseScheduleCanceledType = typeof onSubscriptionPauseScheduleCanceled$1;
4510
4572
  /**
@@ -4512,17 +4574,17 @@ type _publicOnSubscriptionPauseScheduleCanceledType = typeof onSubscriptionPause
4512
4574
  */
4513
4575
  declare const onSubscriptionPauseScheduleCanceled: ReturnType<typeof createEventModule<_publicOnSubscriptionPauseScheduleCanceledType>>;
4514
4576
 
4515
- type _publicOnSubscriptionResumedType = typeof onSubscriptionResumed$1;
4577
+ type _publicOnSubscriptionPauseScheduledType = typeof onSubscriptionPauseScheduled$1;
4516
4578
  /**
4517
- * Triggered when a subscription is resumed.
4579
+ * Triggered when pause subscription requested
4518
4580
  */
4519
- declare const onSubscriptionResumed: ReturnType<typeof createEventModule<_publicOnSubscriptionResumedType>>;
4581
+ declare const onSubscriptionPauseScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionPauseScheduledType>>;
4520
4582
 
4521
- type _publicOnSubscriptionResumeScheduledType = typeof onSubscriptionResumeScheduled$1;
4583
+ type _publicOnSubscriptionPausedType = typeof onSubscriptionPaused$1;
4522
4584
  /**
4523
- * Triggered when resume subscription requested
4585
+ * Triggered when a subscription is paused.
4524
4586
  */
4525
- declare const onSubscriptionResumeScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionResumeScheduledType>>;
4587
+ declare const onSubscriptionPaused: ReturnType<typeof createEventModule<_publicOnSubscriptionPausedType>>;
4526
4588
 
4527
4589
  type _publicOnSubscriptionResumeScheduleCanceledType = typeof onSubscriptionResumeScheduleCanceled$1;
4528
4590
  /**
@@ -4530,21 +4592,17 @@ type _publicOnSubscriptionResumeScheduleCanceledType = typeof onSubscriptionResu
4530
4592
  */
4531
4593
  declare const onSubscriptionResumeScheduleCanceled: ReturnType<typeof createEventModule<_publicOnSubscriptionResumeScheduleCanceledType>>;
4532
4594
 
4533
- type _publicOnSubscriptionAutoRenewalTurnedOnType = typeof onSubscriptionAutoRenewalTurnedOn$1;
4595
+ type _publicOnSubscriptionResumeScheduledType = typeof onSubscriptionResumeScheduled$1;
4534
4596
  /**
4535
- * Triggered when a subscription cycleAutoRenew was turned on.
4597
+ * Triggered when resume subscription requested
4536
4598
  */
4537
- declare const onSubscriptionAutoRenewalTurnedOn: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOnType>>;
4599
+ declare const onSubscriptionResumeScheduled: ReturnType<typeof createEventModule<_publicOnSubscriptionResumeScheduledType>>;
4538
4600
 
4539
- type _publicOnSubscriptionAutoRenewalTurnedOffType = typeof onSubscriptionAutoRenewalTurnedOff$1;
4601
+ type _publicOnSubscriptionResumedType = typeof onSubscriptionResumed$1;
4540
4602
  /**
4541
- * Triggered when a subscription cycleAutoRenew was turned off.
4603
+ * Triggered when a subscription is resumed.
4542
4604
  */
4543
- declare const onSubscriptionAutoRenewalTurnedOff: ReturnType<typeof createEventModule<_publicOnSubscriptionAutoRenewalTurnedOffType>>;
4544
-
4545
- type _publicOnSubscriptionLatestInvoiceMarkedAsPaidType = typeof onSubscriptionLatestInvoiceMarkedAsPaid$1;
4546
- /** */
4547
- declare const onSubscriptionLatestInvoiceMarkedAsPaid: ReturnType<typeof createEventModule<_publicOnSubscriptionLatestInvoiceMarkedAsPaidType>>;
4605
+ declare const onSubscriptionResumed: ReturnType<typeof createEventModule<_publicOnSubscriptionResumedType>>;
4548
4606
 
4549
4607
  type index_d_Action = Action;
4550
4608
  type index_d_ActionContext = ActionContext;
@@ -4647,6 +4705,7 @@ type index_d_CustomerTurnOnAutoRenewalRequest = CustomerTurnOnAutoRenewalRequest
4647
4705
  type index_d_CustomerTurnOnAutoRenewalResponse = CustomerTurnOnAutoRenewalResponse;
4648
4706
  type index_d_CustomerTurnOnAutoRenewalResponseNonNullableFields = CustomerTurnOnAutoRenewalResponseNonNullableFields;
4649
4707
  type index_d_CustomerTurnOnSubscriptionAutoRenewalOptions = CustomerTurnOnSubscriptionAutoRenewalOptions;
4708
+ type index_d_Cycles = Cycles;
4650
4709
  type index_d_DeleteDraftSubscriptionRequest = DeleteDraftSubscriptionRequest;
4651
4710
  type index_d_DeleteDraftSubscriptionResponse = DeleteDraftSubscriptionResponse;
4652
4711
  type index_d_DeleteSubscriptionBORequest = DeleteSubscriptionBORequest;
@@ -5057,7 +5116,7 @@ declare const index_d_turnOnSubscriptionAutoRenewal: typeof turnOnSubscriptionAu
5057
5116
  declare const index_d_updateSubscriptionBillingDate: typeof updateSubscriptionBillingDate;
5058
5117
  declare const index_d_updateSubscriptionPaymentMethod: typeof updateSubscriptionPaymentMethod;
5059
5118
  declare namespace index_d {
5060
- export { type index_d_Action as Action, type index_d_ActionContext as ActionContext, type index_d_ActionDetails as ActionDetails, type index_d_ActionEvent as ActionEvent, index_d_ActionInitiator as ActionInitiator, index_d_ActionType as ActionType, type index_d_AddPausePeriodRequest as AddPausePeriodRequest, type index_d_AddPausePeriodResponse as AddPausePeriodResponse, type index_d_AdditionalFee as AdditionalFee, index_d_AdditionalFeeTrigger as AdditionalFeeTrigger, type index_d_Address as Address, type index_d_AddressStreetOneOf as AddressStreetOneOf, type index_d_AggregatedTaxBreakdown as AggregatedTaxBreakdown, type index_d_AllowedActionsOptions as AllowedActionsOptions, type index_d_AllowedActionsRequest as AllowedActionsRequest, type index_d_AllowedActionsResponse as AllowedActionsResponse, type index_d_AllowedActionsResponseNonNullableFields as AllowedActionsResponseNonNullableFields, type index_d_AmountByStatus as AmountByStatus, type index_d_ApplicationFee as ApplicationFee, type index_d_ApplicationFeeValueOneOf as ApplicationFeeValueOneOf, type index_d_AttachInvoice as AttachInvoice, type index_d_AutomaticRetryData as AutomaticRetryData, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BillingSettings as BillingSettings, type index_d_BillingStatus as BillingStatus, type index_d_BulkItemChange as BulkItemChange, type index_d_BulkUpdateSubscriptionItemsByFilterRequest as BulkUpdateSubscriptionItemsByFilterRequest, type index_d_BulkUpdateSubscriptionItemsByFilterResponse as BulkUpdateSubscriptionItemsByFilterResponse, type index_d_BusinessOrigin as BusinessOrigin, type index_d_BusinessOriginData as BusinessOriginData, type index_d_Cancel as Cancel, type index_d_CancelSubscriptionBORequest as CancelSubscriptionBORequest, type index_d_CancelSubscriptionBOResponse as CancelSubscriptionBOResponse, type index_d_CancelSubscriptionRequest as CancelSubscriptionRequest, type index_d_CancelSubscriptionResponse as CancelSubscriptionResponse, type index_d_CancelSubscriptionResponseNonNullableFields as CancelSubscriptionResponseNonNullableFields, type index_d_CancelTimeCapsuleTaskRequest as CancelTimeCapsuleTaskRequest, type index_d_CancellationInfo as CancellationInfo, index_d_CancellationInitiator as CancellationInitiator, type index_d_CatalogReference as CatalogReference, type index_d_Charge as Charge, index_d_CollectionMethod as CollectionMethod, index_d_CollectionMethodEnumCollectionMethod as CollectionMethodEnumCollectionMethod, type index_d_Complete as Complete, type index_d_ConvertSapiRequest as ConvertSapiRequest, type index_d_ConvertSapiResponse as ConvertSapiResponse, type index_d_CountByStatus as CountByStatus, type index_d_CountSubscriptionFilter as CountSubscriptionFilter, type index_d_CountSubscriptionFilterStatusOneOf as CountSubscriptionFilterStatusOneOf, type index_d_CountSubscriptionsOptions as CountSubscriptionsOptions, type index_d_CountSubscriptionsRequest as CountSubscriptionsRequest, type index_d_CountSubscriptionsResponse as CountSubscriptionsResponse, type index_d_CountSubscriptionsResponseNonNullableFields as CountSubscriptionsResponseNonNullableFields, type index_d_CreateRecurringInvoiceBORequest as CreateRecurringInvoiceBORequest, type index_d_CreateRecurringInvoiceBOResponse as CreateRecurringInvoiceBOResponse, type index_d_CreateSubscriptionForOrderRequest as CreateSubscriptionForOrderRequest, type index_d_CreateSubscriptionForOrderResponse as CreateSubscriptionForOrderResponse, type index_d_CreateSubscriptionInStateRequest as CreateSubscriptionInStateRequest, type index_d_CreateSubscriptionInStateRequestModeOneOf as CreateSubscriptionInStateRequestModeOneOf, type index_d_CreateSubscriptionInStateResponse as CreateSubscriptionInStateResponse, type index_d_CreateSubscriptionRequest as CreateSubscriptionRequest, type index_d_CreateSubscriptionResponse as CreateSubscriptionResponse, index_d_CreationMode as CreationMode, type index_d_CursorPaging as CursorPaging, type index_d_Cursors as Cursors, type index_d_CustomBillingSchedule as CustomBillingSchedule, type index_d_CustomProration as CustomProration, type index_d_CustomProrationAmountOneOf as CustomProrationAmountOneOf, type index_d_Customer as Customer, type index_d_CustomerAllowedActionsRequest as CustomerAllowedActionsRequest, type index_d_CustomerAllowedActionsResponse as CustomerAllowedActionsResponse, type index_d_CustomerAllowedActionsResponseNonNullableFields as CustomerAllowedActionsResponseNonNullableFields, type index_d_CustomerCancelSubscriptionOptions as CustomerCancelSubscriptionOptions, type index_d_CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequest, type index_d_CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponse, type index_d_CustomerCancelSubscriptionResponseNonNullableFields as CustomerCancelSubscriptionResponseNonNullableFields, type index_d_CustomerExtendSubscriptionOptions as CustomerExtendSubscriptionOptions, type index_d_CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequest, type index_d_CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponse, type index_d_CustomerExtendSubscriptionResponseNonNullableFields as CustomerExtendSubscriptionResponseNonNullableFields, type index_d_CustomerIdOneOf as CustomerIdOneOf, type index_d_CustomerInitiatePaymentMethodSetupOptions as CustomerInitiatePaymentMethodSetupOptions, type index_d_CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequest, type index_d_CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponse, type index_d_CustomerListUpcomingChargesResponseNonNullableFields as CustomerListUpcomingChargesResponseNonNullableFields, type index_d_CustomerQuerySubscriptionsOptions as CustomerQuerySubscriptionsOptions, type index_d_CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequest, type index_d_CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponse, type index_d_CustomerTurnOffAutoRenewalResponseNonNullableFields as CustomerTurnOffAutoRenewalResponseNonNullableFields, type index_d_CustomerTurnOffSubscriptionAutoRenewalOptions as CustomerTurnOffSubscriptionAutoRenewalOptions, type index_d_CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequest, type index_d_CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponse, type index_d_CustomerTurnOnAutoRenewalResponseNonNullableFields as CustomerTurnOnAutoRenewalResponseNonNullableFields, type index_d_CustomerTurnOnSubscriptionAutoRenewalOptions as CustomerTurnOnSubscriptionAutoRenewalOptions, type index_d_DeleteDraftSubscriptionRequest as DeleteDraftSubscriptionRequest, type index_d_DeleteDraftSubscriptionResponse as DeleteDraftSubscriptionResponse, type index_d_DeleteSubscriptionBORequest as DeleteSubscriptionBORequest, type index_d_DeleteSubscriptionBOResponse as DeleteSubscriptionBOResponse, type index_d_DeleteSubscriptionRequest as DeleteSubscriptionRequest, type index_d_DeleteSubscriptionResponse as DeleteSubscriptionResponse, type index_d_DetachInvoice as DetachInvoice, type index_d_Discount as Discount, type index_d_DiscountCycles as DiscountCycles, type index_d_DiscountOrigin as DiscountOrigin, type index_d_DiscountValueOneOf as DiscountValueOneOf, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Duration as Duration, index_d_DurationUnit as DurationUnit, type index_d_DynamicTax as DynamicTax, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, index_d_ExtendPolicyType as ExtendPolicyType, type index_d_ExtendSubscriptionOptions as ExtendSubscriptionOptions, type index_d_ExtendSubscriptionRequest as ExtendSubscriptionRequest, type index_d_ExtendSubscriptionRequestExtendPolicyOneOf as ExtendSubscriptionRequestExtendPolicyOneOf, type index_d_ExtendSubscriptionResponse as ExtendSubscriptionResponse, type index_d_ExtendSubscriptionResponseNonNullableFields as ExtendSubscriptionResponseNonNullableFields, type index_d_ExternalCollectionDetails as ExternalCollectionDetails, type index_d_FinishFreeTrialNowRequest as FinishFreeTrialNowRequest, type index_d_FinishFreeTrialNowResponse as FinishFreeTrialNowResponse, type index_d_FixSubscriptionInvoicesRequest as FixSubscriptionInvoicesRequest, type index_d_FixSubscriptionInvoicesRequestModeOneOf as FixSubscriptionInvoicesRequestModeOneOf, type index_d_FixSubscriptionInvoicesResponse as FixSubscriptionInvoicesResponse, type index_d_FixedPrice as FixedPrice, type index_d_FreeTrailEnded as FreeTrailEnded, type index_d_FreeTrailStarted as FreeTrailStarted, type index_d_FreeTrialData as FreeTrialData, type index_d_FullAddressContactDetails as FullAddressContactDetails, type index_d_FullAddressDetails as FullAddressDetails, type index_d_FutureUpdatesRequested as FutureUpdatesRequested, type index_d_GetFullSubscriptionDataRequest as GetFullSubscriptionDataRequest, type index_d_GetFullSubscriptionDataResponse as GetFullSubscriptionDataResponse, type index_d_GetSubscriptionAndInternalDataRequest as GetSubscriptionAndInternalDataRequest, type index_d_GetSubscriptionAndInternalDataResponse as GetSubscriptionAndInternalDataResponse, type index_d_GetSubscriptionInvoicesRequest as GetSubscriptionInvoicesRequest, type index_d_GetSubscriptionInvoicesResponse as GetSubscriptionInvoicesResponse, type index_d_GetSubscriptionRequest as GetSubscriptionRequest, type index_d_GetSubscriptionResponse as GetSubscriptionResponse, type index_d_GetSubscriptionResponseNonNullableFields as GetSubscriptionResponseNonNullableFields, type index_d_GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequest, type index_d_GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponse, type index_d_GetSubscriptionsStatsResponseNonNullableFields as GetSubscriptionsStatsResponseNonNullableFields, type index_d_GracePeriodData as GracePeriodData, type index_d_GracePeriodEnded as GracePeriodEnded, type index_d_GracePeriodStarted as GracePeriodStarted, type index_d_HandleSubscriptionAfterInvoiceMarkedAsPaidRequest as HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, index_d_HistoryActionInitiator as HistoryActionInitiator, index_d_HistoryViewMode as HistoryViewMode, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, type index_d_InitiatePaymentMethodSetupOptions as InitiatePaymentMethodSetupOptions, type index_d_InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequest, type index_d_InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponse, type index_d_InitiatePaymentMethodSetupResponseNonNullableFields as InitiatePaymentMethodSetupResponseNonNullableFields, type index_d_InternalSubscriptionData as InternalSubscriptionData, type index_d_Invoice as Invoice, type index_d_InvoiceAction as InvoiceAction, type index_d_InvoiceActionActionTypeOneOf as InvoiceActionActionTypeOneOf, type index_d_InvoiceApplicationFee as InvoiceApplicationFee, type index_d_InvoiceApplicationFeeValueOneOf as InvoiceApplicationFeeValueOneOf, type index_d_InvoiceDiscount as InvoiceDiscount, type index_d_InvoiceDiscountValueOneOf as InvoiceDiscountValueOneOf, type index_d_InvoiceItem as InvoiceItem, type index_d_InvoiceItemPaymentTypeOneOf as InvoiceItemPaymentTypeOneOf, type index_d_InvoiceShippingCharges as InvoiceShippingCharges, index_d_InvoiceStatus as InvoiceStatus, type index_d_Item as Item, index_d_ItemCategory as ItemCategory, type index_d_ItemChange as ItemChange, type index_d_ItemTaxData as ItemTaxData, type index_d_LatestInvoiceMarkedAsPaid as LatestInvoiceMarkedAsPaid, type index_d_LatestPaymentAttempt as LatestPaymentAttempt, type index_d_LineItemTaxSummary as LineItemTaxSummary, type index_d_ListSubscriptionHistoryOptions as ListSubscriptionHistoryOptions, type index_d_ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequest, type index_d_ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponse, type index_d_ListSubscriptionHistoryResponseNonNullableFields as ListSubscriptionHistoryResponseNonNullableFields, type index_d_ListUpcomingChargesOptions as ListUpcomingChargesOptions, type index_d_ListUpcomingChargesRequest as ListUpcomingChargesRequest, type index_d_ListUpcomingChargesResponse as ListUpcomingChargesResponse, type index_d_ListUpcomingChargesResponseNonNullableFields as ListUpcomingChargesResponseNonNullableFields, type index_d_MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequest, type index_d_MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponse, type index_d_MarkLatestInvoiceAsPaidResponseNonNullableFields as MarkLatestInvoiceAsPaidResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MigrationDetails as MigrationDetails, type index_d_Money as Money, type index_d_OneTime as OneTime, index_d_OrderMethod as OrderMethod, type index_d_OriginOverride as OriginOverride, type index_d_Paging as Paging, type index_d_PagingMetadataV2 as PagingMetadataV2, index_d_PauseAt as PauseAt, type index_d_PauseInfo as PauseInfo, type index_d_PausePeriod as PausePeriod, index_d_PausePolicy as PausePolicy, type index_d_PauseSubscriptionOptions as PauseSubscriptionOptions, type index_d_PauseSubscriptionRequest as PauseSubscriptionRequest, type index_d_PauseSubscriptionRequested as PauseSubscriptionRequested, type index_d_PauseSubscriptionResponse as PauseSubscriptionResponse, type index_d_PauseSubscriptionResponseNonNullableFields as PauseSubscriptionResponseNonNullableFields, type index_d_PayCycleOptions as PayCycleOptions, type index_d_PayCycleRequest as PayCycleRequest, type index_d_PayCycleResponse as PayCycleResponse, type index_d_PayCycleResponseNonNullableFields as PayCycleResponseNonNullableFields, type index_d_PayRecurringInvoice as PayRecurringInvoice, index_d_PaymentAttemptStatus as PaymentAttemptStatus, type index_d_PaymentData as PaymentData, type index_d_PaymentMethod as PaymentMethod, type index_d_PaymentMethodUpdated as PaymentMethodUpdated, index_d_PaymentMode as PaymentMode, type index_d_PaymentOrigin as PaymentOrigin, type index_d_PaymentSettings as PaymentSettings, index_d_PaymentSettlementMethod as PaymentSettlementMethod, index_d_PaymentStatus as PaymentStatus, index_d_PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatus, index_d_PaymentTestMode as PaymentTestMode, type index_d_PreviewSubscriptionChargesOptions as PreviewSubscriptionChargesOptions, type index_d_PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequest, type index_d_PreviewSubscriptionChargesRequestSubscriptionOneOf as PreviewSubscriptionChargesRequestSubscriptionOneOf, type index_d_PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponse, type index_d_PreviewSubscriptionChargesResponseNonNullableFields as PreviewSubscriptionChargesResponseNonNullableFields, type index_d_PreviewSubscriptionsChargesOptions as PreviewSubscriptionsChargesOptions, type index_d_PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequest, type index_d_PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponse, type index_d_PreviewSubscriptionsChargesResponseNonNullableFields as PreviewSubscriptionsChargesResponseNonNullableFields, type index_d_PriceAdjustment as PriceAdjustment, type index_d_PriceAdjustmentAdjustmentTypeOneOf as PriceAdjustmentAdjustmentTypeOneOf, type index_d_PriceAdjustmentValue as PriceAdjustmentValue, type index_d_PriceAdjustmentValueAdjustmentValueTypeOneOf as PriceAdjustmentValueAdjustmentValueTypeOneOf, type index_d_PriceDetails as PriceDetails, type index_d_PricingModel as PricingModel, type index_d_PricingModelModelOneOf as PricingModelModelOneOf, type index_d_Proration as Proration, type index_d_ProrationTypeOneOf as ProrationTypeOneOf, type index_d_QuerySubscriptionsRequest as QuerySubscriptionsRequest, type index_d_QuerySubscriptionsResponse as QuerySubscriptionsResponse, type index_d_QuerySubscriptionsResponseNonNullableFields as QuerySubscriptionsResponseNonNullableFields, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type index_d_Recurring as Recurring, type index_d_RedirectUrls as RedirectUrls, index_d_RequestedFields as RequestedFields, type index_d_Reschedule as Reschedule, type index_d_ResetPendingUpdates as ResetPendingUpdates, type index_d_RestoreDraftSubscriptionRequest as RestoreDraftSubscriptionRequest, type index_d_RestoreDraftSubscriptionResponse as RestoreDraftSubscriptionResponse, type index_d_RestoreInfo as RestoreInfo, index_d_ResumeAt as ResumeAt, type index_d_ResumeSubscriptionOptions as ResumeSubscriptionOptions, type index_d_ResumeSubscriptionRequest as ResumeSubscriptionRequest, type index_d_ResumeSubscriptionRequested as ResumeSubscriptionRequested, type index_d_ResumeSubscriptionResponse as ResumeSubscriptionResponse, type index_d_ResumeSubscriptionResponseNonNullableFields as ResumeSubscriptionResponseNonNullableFields, type index_d_ReviseSubscriptionRequest as ReviseSubscriptionRequest, type index_d_ReviseSubscriptionResponse as ReviseSubscriptionResponse, index_d_RevivePolicy as RevivePolicy, type index_d_ReviveSubscriptionRequest as ReviveSubscriptionRequest, type index_d_ReviveSubscriptionResponse as ReviveSubscriptionResponse, type index_d_RunTimeCapsuleTaskNowRequest as RunTimeCapsuleTaskNowRequest, type index_d_ScheduleAdditionalInfo as ScheduleAdditionalInfo, type index_d_ScheduleAdditionalInfoParamOneOf as ScheduleAdditionalInfoParamOneOf, type index_d_ScheduleTimeCapsuleTaskRequest as ScheduleTimeCapsuleTaskRequest, type index_d_ScheduledPauseCanceled as ScheduledPauseCanceled, type index_d_ScheduledResumeCanceled as ScheduledResumeCanceled, type index_d_SearchSubscriptionRequest as SearchSubscriptionRequest, type index_d_SearchSubscriptionResponse as SearchSubscriptionResponse, type index_d_SearchSubscriptionsOptions as SearchSubscriptionsOptions, type index_d_SearchSubscriptionsRequest as SearchSubscriptionsRequest, type index_d_SearchSubscriptionsRequestPagingMethodOneOf as SearchSubscriptionsRequestPagingMethodOneOf, type index_d_SearchSubscriptionsResponse as SearchSubscriptionsResponse, type index_d_SearchSubscriptionsResponseNonNullableFields as SearchSubscriptionsResponseNonNullableFields, type index_d_SendSubscriptionActionEventBORequest as SendSubscriptionActionEventBORequest, type index_d_SendSubscriptionActionEventBORequestEventOneOf as SendSubscriptionActionEventBORequestEventOneOf, type index_d_SendSubscriptionActionEventResponse as SendSubscriptionActionEventResponse, type index_d_SendTimeCapsuleTaskCanceledBIRequest as SendTimeCapsuleTaskCanceledBIRequest, type index_d_SetIsMigratedEvent as SetIsMigratedEvent, type index_d_SetShiftingDataRequest as SetShiftingDataRequest, type index_d_SetShiftingDataResponse as SetShiftingDataResponse, type index_d_ShippingCharges as ShippingCharges, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_SortingClauses as SortingClauses, type index_d_SpecificDateSubscriptionUpdateData as SpecificDateSubscriptionUpdateData, index_d_Status as Status, type index_d_StreetAddress as StreetAddress, type index_d_Subscriber as Subscriber, type index_d_Subscription as Subscription, type index_d_SubscriptionActivated as SubscriptionActivated, type index_d_SubscriptionAutoRenewalTurnedOff as SubscriptionAutoRenewalTurnedOff, type index_d_SubscriptionAutoRenewalTurnedOffEnvelope as SubscriptionAutoRenewalTurnedOffEnvelope, type index_d_SubscriptionAutoRenewalTurnedOn as SubscriptionAutoRenewalTurnedOn, type index_d_SubscriptionAutoRenewalTurnedOnEnvelope as SubscriptionAutoRenewalTurnedOnEnvelope, type index_d_SubscriptionBackOfficeAction as SubscriptionBackOfficeAction, type index_d_SubscriptionBillingCycleStarted as SubscriptionBillingCycleStarted, type index_d_SubscriptionBillingDateUpdated as SubscriptionBillingDateUpdated, type index_d_SubscriptionBillingDateUpdatedEnvelope as SubscriptionBillingDateUpdatedEnvelope, type index_d_SubscriptionBillingDetails as SubscriptionBillingDetails, type index_d_SubscriptionCanceled as SubscriptionCanceled, type index_d_SubscriptionCanceledEnvelope as SubscriptionCanceledEnvelope, type index_d_SubscriptionCancellationRequested as SubscriptionCancellationRequested, type index_d_SubscriptionCharge as SubscriptionCharge, type index_d_SubscriptionCharges as SubscriptionCharges, type index_d_SubscriptionCollectionMethodUpdated as SubscriptionCollectionMethodUpdated, type index_d_SubscriptionCreated as SubscriptionCreated, type index_d_SubscriptionCycleReadyToPay as SubscriptionCycleReadyToPay, type index_d_SubscriptionCycleTriggered as SubscriptionCycleTriggered, type index_d_SubscriptionDelayedSyncEvent as SubscriptionDelayedSyncEvent, type index_d_SubscriptionDeleted as SubscriptionDeleted, type index_d_SubscriptionDiff as SubscriptionDiff, type index_d_SubscriptionEnded as SubscriptionEnded, type index_d_SubscriptionEvent as SubscriptionEvent, type index_d_SubscriptionEventPayloadOneOf as SubscriptionEventPayloadOneOf, type index_d_SubscriptionExpired as SubscriptionExpired, type index_d_SubscriptionExtended as SubscriptionExtended, type index_d_SubscriptionExtendedEnvelope as SubscriptionExtendedEnvelope, type index_d_SubscriptionExtendedExtendPolicyOneOf as SubscriptionExtendedExtendPolicyOneOf, index_d_SubscriptionFrequency as SubscriptionFrequency, type index_d_SubscriptionHistoryEntry as SubscriptionHistoryEntry, type index_d_SubscriptionInfo as SubscriptionInfo, type index_d_SubscriptionInitialPurchaseCompleted as SubscriptionInitialPurchaseCompleted, type index_d_SubscriptionInvoice as SubscriptionInvoice, type index_d_SubscriptionLatestInvoiceMarkedAsPaidEnvelope as SubscriptionLatestInvoiceMarkedAsPaidEnvelope, type index_d_SubscriptionMarkedAsPaid as SubscriptionMarkedAsPaid, type index_d_SubscriptionPauseScheduleCanceledEnvelope as SubscriptionPauseScheduleCanceledEnvelope, type index_d_SubscriptionPauseScheduledEnvelope as SubscriptionPauseScheduledEnvelope, type index_d_SubscriptionPaused as SubscriptionPaused, type index_d_SubscriptionPausedEnvelope as SubscriptionPausedEnvelope, type index_d_SubscriptionPolicies as SubscriptionPolicies, type index_d_SubscriptionPolicy as SubscriptionPolicy, type index_d_SubscriptionResumeScheduleCanceledEnvelope as SubscriptionResumeScheduleCanceledEnvelope, type index_d_SubscriptionResumeScheduledEnvelope as SubscriptionResumeScheduledEnvelope, type index_d_SubscriptionResumed as SubscriptionResumed, type index_d_SubscriptionResumedEnvelope as SubscriptionResumedEnvelope, type index_d_SubscriptionRevived as SubscriptionRevived, type index_d_SubscriptionStatus as SubscriptionStatus, index_d_SubscriptionStatusEnumSubscriptionStatus as SubscriptionStatusEnumSubscriptionStatus, index_d_SubscriptionStatusGroup as SubscriptionStatusGroup, type index_d_SubscriptionSuspended as SubscriptionSuspended, type index_d_SubscriptionTrialPeriod as SubscriptionTrialPeriod, index_d_SubscriptionType as SubscriptionType, type index_d_SubscriptionUpdateData as SubscriptionUpdateData, type index_d_SubscriptionUpdated as SubscriptionUpdated, type index_d_SubscriptionUpdatedEnvelope as SubscriptionUpdatedEnvelope, type index_d_Suspension as Suspension, type index_d_Task as Task, type index_d_TaskAction as TaskAction, type index_d_TaskActionActionOneOf as TaskActionActionOneOf, type index_d_TaskKey as TaskKey, type index_d_Tax as Tax, type index_d_TaxBreakdown as TaxBreakdown, type index_d_TaxData as TaxData, type index_d_TaxSettings as TaxSettings, type index_d_TaxSummary as TaxSummary, type index_d_TaxValueOneOf as TaxValueOneOf, index_d_TaxableAddressType as TaxableAddressType, type index_d_TimeBasedProration as TimeBasedProration, type index_d_Totals as Totals, type index_d_TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequest, type index_d_TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponse, type index_d_TurnOffSubscriptionAutoRenewalResponseNonNullableFields as TurnOffSubscriptionAutoRenewalResponseNonNullableFields, type index_d_TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequest, type index_d_TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponse, type index_d_TurnOnSubscriptionAutoRenewalResponseNonNullableFields as TurnOnSubscriptionAutoRenewalResponseNonNullableFields, type index_d_UnknownSubscriptionEvent as UnknownSubscriptionEvent, type index_d_UnsupportedAction as UnsupportedAction, type index_d_UnsupportedReason as UnsupportedReason, index_d_UpdateAction as UpdateAction, type index_d_UpdateBillingDateData as UpdateBillingDateData, type index_d_UpdateFullSubscriptionRequest as UpdateFullSubscriptionRequest, type index_d_UpdateFullSubscriptionResponse as UpdateFullSubscriptionResponse, type index_d_UpdatePausePaidDurationRequest as UpdatePausePaidDurationRequest, type index_d_UpdatePausePaidDurationResponse as UpdatePausePaidDurationResponse, type index_d_UpdatePaymentMethodBORequest as UpdatePaymentMethodBORequest, type index_d_UpdatePaymentMethodBOResponse as UpdatePaymentMethodBOResponse, type index_d_UpdatePaymentStatusRequest as UpdatePaymentStatusRequest, type index_d_UpdatePaymentStatusResponse as UpdatePaymentStatusResponse, type index_d_UpdateStatusRequest as UpdateStatusRequest, type index_d_UpdateStatusResponse as UpdateStatusResponse, type index_d_UpdateSubscriptionBillingDateOptions as UpdateSubscriptionBillingDateOptions, type index_d_UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequest, type index_d_UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponse, type index_d_UpdateSubscriptionBillingDateResponseNonNullableFields as UpdateSubscriptionBillingDateResponseNonNullableFields, type index_d_UpdateSubscriptionInvoiceCycleRequest as UpdateSubscriptionInvoiceCycleRequest, type index_d_UpdateSubscriptionInvoiceCycleResponse as UpdateSubscriptionInvoiceCycleResponse, type index_d_UpdateSubscriptionItemsRequest as UpdateSubscriptionItemsRequest, type index_d_UpdateSubscriptionItemsResponse as UpdateSubscriptionItemsResponse, type index_d_UpdateSubscriptionOriginRequest as UpdateSubscriptionOriginRequest, type index_d_UpdateSubscriptionOriginResponse as UpdateSubscriptionOriginResponse, type index_d_UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequest, type index_d_UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponse, type index_d_UpdateSubscriptionPaymentMethodResponseNonNullableFields as UpdateSubscriptionPaymentMethodResponseNonNullableFields, type index_d_UpdateSubscriptionPoliciesRequest as UpdateSubscriptionPoliciesRequest, type index_d_UpdateSubscriptionPoliciesResponse as UpdateSubscriptionPoliciesResponse, type index_d_UpdateSubscriptionRequest as UpdateSubscriptionRequest, type index_d_UpdateSubscriptionResponse as UpdateSubscriptionResponse, type index_d_UpdateSubscriptionStartDateRequest as UpdateSubscriptionStartDateRequest, type index_d_UpdateSubscriptionStartDateResponse as UpdateSubscriptionStartDateResponse, type index_d_UpdatesApplied as UpdatesApplied, type index_d_V1Duration as V1Duration, type index_d_V1Subscription as V1Subscription, type index_d_V1SubscriptionActivated as V1SubscriptionActivated, type index_d_V1SubscriptionCanceled as V1SubscriptionCanceled, type index_d_V1SubscriptionCreated as V1SubscriptionCreated, type index_d_V1SubscriptionEvent as V1SubscriptionEvent, type index_d_V1SubscriptionEventEventOneOf as V1SubscriptionEventEventOneOf, type index_d_V1SubscriptionInitialPurchaseCompleted as V1SubscriptionInitialPurchaseCompleted, type index_d_V1SubscriptionResumed as V1SubscriptionResumed, index_d_V1SubscriptionStatusEnumSubscriptionStatus as V1SubscriptionStatusEnumSubscriptionStatus, type index_d_V1SubscriptionUpdated as V1SubscriptionUpdated, type index_d_V2Subscription as V2Subscription, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnSubscriptionAutoRenewalTurnedOffType as _publicOnSubscriptionAutoRenewalTurnedOffType, type index_d__publicOnSubscriptionAutoRenewalTurnedOnType as _publicOnSubscriptionAutoRenewalTurnedOnType, type index_d__publicOnSubscriptionBillingDateUpdatedType as _publicOnSubscriptionBillingDateUpdatedType, type index_d__publicOnSubscriptionCanceledType as _publicOnSubscriptionCanceledType, type index_d__publicOnSubscriptionExtendedType as _publicOnSubscriptionExtendedType, type index_d__publicOnSubscriptionLatestInvoiceMarkedAsPaidType as _publicOnSubscriptionLatestInvoiceMarkedAsPaidType, type index_d__publicOnSubscriptionPauseScheduleCanceledType as _publicOnSubscriptionPauseScheduleCanceledType, type index_d__publicOnSubscriptionPauseScheduledType as _publicOnSubscriptionPauseScheduledType, type index_d__publicOnSubscriptionPausedType as _publicOnSubscriptionPausedType, type index_d__publicOnSubscriptionResumeScheduleCanceledType as _publicOnSubscriptionResumeScheduleCanceledType, type index_d__publicOnSubscriptionResumeScheduledType as _publicOnSubscriptionResumeScheduledType, type index_d__publicOnSubscriptionResumedType as _publicOnSubscriptionResumedType, type index_d__publicOnSubscriptionUpdatedType as _publicOnSubscriptionUpdatedType, index_d_allowedActions as allowedActions, index_d_cancelSubscription as cancelSubscription, index_d_countSubscriptions as countSubscriptions, index_d_customerAllowedActions as customerAllowedActions, index_d_customerCancelSubscription as customerCancelSubscription, index_d_customerExtendSubscription as customerExtendSubscription, index_d_customerGetSubscription as customerGetSubscription, index_d_customerInitiatePaymentMethodSetup as customerInitiatePaymentMethodSetup, index_d_customerListUpcomingCharges as customerListUpcomingCharges, index_d_customerQuerySubscriptions as customerQuerySubscriptions, index_d_customerTurnOffSubscriptionAutoRenewal as customerTurnOffSubscriptionAutoRenewal, index_d_customerTurnOnSubscriptionAutoRenewal as customerTurnOnSubscriptionAutoRenewal, index_d_customerUpdateSubscriptionPaymentMethod as customerUpdateSubscriptionPaymentMethod, index_d_extendSubscription as extendSubscription, index_d_getSubscription as getSubscription, index_d_getSubscriptionsStats as getSubscriptionsStats, index_d_initiatePaymentMethodSetup as initiatePaymentMethodSetup, index_d_listSubscriptionHistory as listSubscriptionHistory, index_d_listUpcomingCharges as listUpcomingCharges, index_d_markLatestInvoiceAsPaid as markLatestInvoiceAsPaid, index_d_onSubscriptionAutoRenewalTurnedOff as onSubscriptionAutoRenewalTurnedOff, index_d_onSubscriptionAutoRenewalTurnedOn as onSubscriptionAutoRenewalTurnedOn, index_d_onSubscriptionBillingDateUpdated as onSubscriptionBillingDateUpdated, index_d_onSubscriptionCanceled as onSubscriptionCanceled, index_d_onSubscriptionExtended as onSubscriptionExtended, index_d_onSubscriptionLatestInvoiceMarkedAsPaid as onSubscriptionLatestInvoiceMarkedAsPaid, index_d_onSubscriptionPauseScheduleCanceled as onSubscriptionPauseScheduleCanceled, index_d_onSubscriptionPauseScheduled as onSubscriptionPauseScheduled, index_d_onSubscriptionPaused as onSubscriptionPaused, index_d_onSubscriptionResumeScheduleCanceled as onSubscriptionResumeScheduleCanceled, index_d_onSubscriptionResumeScheduled as onSubscriptionResumeScheduled, index_d_onSubscriptionResumed as onSubscriptionResumed, index_d_onSubscriptionUpdated as onSubscriptionUpdated, index_d_pauseSubscription as pauseSubscription, index_d_payCycle as payCycle, index_d_previewSubscriptionCharges as previewSubscriptionCharges, index_d_previewSubscriptionsCharges as previewSubscriptionsCharges, onSubscriptionAutoRenewalTurnedOff$1 as publicOnSubscriptionAutoRenewalTurnedOff, onSubscriptionAutoRenewalTurnedOn$1 as publicOnSubscriptionAutoRenewalTurnedOn, onSubscriptionBillingDateUpdated$1 as publicOnSubscriptionBillingDateUpdated, onSubscriptionCanceled$1 as publicOnSubscriptionCanceled, onSubscriptionExtended$1 as publicOnSubscriptionExtended, onSubscriptionLatestInvoiceMarkedAsPaid$1 as publicOnSubscriptionLatestInvoiceMarkedAsPaid, onSubscriptionPauseScheduleCanceled$1 as publicOnSubscriptionPauseScheduleCanceled, onSubscriptionPauseScheduled$1 as publicOnSubscriptionPauseScheduled, onSubscriptionPaused$1 as publicOnSubscriptionPaused, onSubscriptionResumeScheduleCanceled$1 as publicOnSubscriptionResumeScheduleCanceled, onSubscriptionResumeScheduled$1 as publicOnSubscriptionResumeScheduled, onSubscriptionResumed$1 as publicOnSubscriptionResumed, onSubscriptionUpdated$1 as publicOnSubscriptionUpdated, index_d_querySubscriptions as querySubscriptions, index_d_resumeSubscription as resumeSubscription, index_d_searchSubscriptions as searchSubscriptions, index_d_turnOffSubscriptionAutoRenewal as turnOffSubscriptionAutoRenewal, index_d_turnOnSubscriptionAutoRenewal as turnOnSubscriptionAutoRenewal, index_d_updateSubscriptionBillingDate as updateSubscriptionBillingDate, index_d_updateSubscriptionPaymentMethod as updateSubscriptionPaymentMethod };
5119
+ export { type index_d_Action as Action, type index_d_ActionContext as ActionContext, type index_d_ActionDetails as ActionDetails, type index_d_ActionEvent as ActionEvent, index_d_ActionInitiator as ActionInitiator, index_d_ActionType as ActionType, type index_d_AddPausePeriodRequest as AddPausePeriodRequest, type index_d_AddPausePeriodResponse as AddPausePeriodResponse, type index_d_AdditionalFee as AdditionalFee, index_d_AdditionalFeeTrigger as AdditionalFeeTrigger, type index_d_Address as Address, type index_d_AddressStreetOneOf as AddressStreetOneOf, type index_d_AggregatedTaxBreakdown as AggregatedTaxBreakdown, type index_d_AllowedActionsOptions as AllowedActionsOptions, type index_d_AllowedActionsRequest as AllowedActionsRequest, type index_d_AllowedActionsResponse as AllowedActionsResponse, type index_d_AllowedActionsResponseNonNullableFields as AllowedActionsResponseNonNullableFields, type index_d_AmountByStatus as AmountByStatus, type index_d_ApplicationFee as ApplicationFee, type index_d_ApplicationFeeValueOneOf as ApplicationFeeValueOneOf, type index_d_AttachInvoice as AttachInvoice, type index_d_AutomaticRetryData as AutomaticRetryData, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BillingSettings as BillingSettings, type index_d_BillingStatus as BillingStatus, type index_d_BulkItemChange as BulkItemChange, type index_d_BulkUpdateSubscriptionItemsByFilterRequest as BulkUpdateSubscriptionItemsByFilterRequest, type index_d_BulkUpdateSubscriptionItemsByFilterResponse as BulkUpdateSubscriptionItemsByFilterResponse, type index_d_BusinessOrigin as BusinessOrigin, type index_d_BusinessOriginData as BusinessOriginData, type index_d_Cancel as Cancel, type index_d_CancelSubscriptionBORequest as CancelSubscriptionBORequest, type index_d_CancelSubscriptionBOResponse as CancelSubscriptionBOResponse, type index_d_CancelSubscriptionRequest as CancelSubscriptionRequest, type index_d_CancelSubscriptionResponse as CancelSubscriptionResponse, type index_d_CancelSubscriptionResponseNonNullableFields as CancelSubscriptionResponseNonNullableFields, type index_d_CancelTimeCapsuleTaskRequest as CancelTimeCapsuleTaskRequest, type index_d_CancellationInfo as CancellationInfo, index_d_CancellationInitiator as CancellationInitiator, type index_d_CatalogReference as CatalogReference, type index_d_Charge as Charge, index_d_CollectionMethod as CollectionMethod, index_d_CollectionMethodEnumCollectionMethod as CollectionMethodEnumCollectionMethod, type index_d_Complete as Complete, type index_d_ConvertSapiRequest as ConvertSapiRequest, type index_d_ConvertSapiResponse as ConvertSapiResponse, type index_d_CountByStatus as CountByStatus, type index_d_CountSubscriptionFilter as CountSubscriptionFilter, type index_d_CountSubscriptionFilterStatusOneOf as CountSubscriptionFilterStatusOneOf, type index_d_CountSubscriptionsOptions as CountSubscriptionsOptions, type index_d_CountSubscriptionsRequest as CountSubscriptionsRequest, type index_d_CountSubscriptionsResponse as CountSubscriptionsResponse, type index_d_CountSubscriptionsResponseNonNullableFields as CountSubscriptionsResponseNonNullableFields, type index_d_CreateRecurringInvoiceBORequest as CreateRecurringInvoiceBORequest, type index_d_CreateRecurringInvoiceBOResponse as CreateRecurringInvoiceBOResponse, type index_d_CreateSubscriptionForOrderRequest as CreateSubscriptionForOrderRequest, type index_d_CreateSubscriptionForOrderResponse as CreateSubscriptionForOrderResponse, type index_d_CreateSubscriptionInStateRequest as CreateSubscriptionInStateRequest, type index_d_CreateSubscriptionInStateRequestModeOneOf as CreateSubscriptionInStateRequestModeOneOf, type index_d_CreateSubscriptionInStateResponse as CreateSubscriptionInStateResponse, type index_d_CreateSubscriptionRequest as CreateSubscriptionRequest, type index_d_CreateSubscriptionResponse as CreateSubscriptionResponse, index_d_CreationMode as CreationMode, type index_d_CursorPaging as CursorPaging, type index_d_Cursors as Cursors, type index_d_CustomBillingSchedule as CustomBillingSchedule, type index_d_CustomProration as CustomProration, type index_d_CustomProrationAmountOneOf as CustomProrationAmountOneOf, type index_d_Customer as Customer, type index_d_CustomerAllowedActionsRequest as CustomerAllowedActionsRequest, type index_d_CustomerAllowedActionsResponse as CustomerAllowedActionsResponse, type index_d_CustomerAllowedActionsResponseNonNullableFields as CustomerAllowedActionsResponseNonNullableFields, type index_d_CustomerCancelSubscriptionOptions as CustomerCancelSubscriptionOptions, type index_d_CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequest, type index_d_CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponse, type index_d_CustomerCancelSubscriptionResponseNonNullableFields as CustomerCancelSubscriptionResponseNonNullableFields, type index_d_CustomerExtendSubscriptionOptions as CustomerExtendSubscriptionOptions, type index_d_CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequest, type index_d_CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponse, type index_d_CustomerExtendSubscriptionResponseNonNullableFields as CustomerExtendSubscriptionResponseNonNullableFields, type index_d_CustomerIdOneOf as CustomerIdOneOf, type index_d_CustomerInitiatePaymentMethodSetupOptions as CustomerInitiatePaymentMethodSetupOptions, type index_d_CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequest, type index_d_CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponse, type index_d_CustomerListUpcomingChargesResponseNonNullableFields as CustomerListUpcomingChargesResponseNonNullableFields, type index_d_CustomerQuerySubscriptionsOptions as CustomerQuerySubscriptionsOptions, type index_d_CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequest, type index_d_CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponse, type index_d_CustomerTurnOffAutoRenewalResponseNonNullableFields as CustomerTurnOffAutoRenewalResponseNonNullableFields, type index_d_CustomerTurnOffSubscriptionAutoRenewalOptions as CustomerTurnOffSubscriptionAutoRenewalOptions, type index_d_CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequest, type index_d_CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponse, type index_d_CustomerTurnOnAutoRenewalResponseNonNullableFields as CustomerTurnOnAutoRenewalResponseNonNullableFields, type index_d_CustomerTurnOnSubscriptionAutoRenewalOptions as CustomerTurnOnSubscriptionAutoRenewalOptions, type index_d_Cycles as Cycles, type index_d_DeleteDraftSubscriptionRequest as DeleteDraftSubscriptionRequest, type index_d_DeleteDraftSubscriptionResponse as DeleteDraftSubscriptionResponse, type index_d_DeleteSubscriptionBORequest as DeleteSubscriptionBORequest, type index_d_DeleteSubscriptionBOResponse as DeleteSubscriptionBOResponse, type index_d_DeleteSubscriptionRequest as DeleteSubscriptionRequest, type index_d_DeleteSubscriptionResponse as DeleteSubscriptionResponse, type index_d_DetachInvoice as DetachInvoice, type index_d_Discount as Discount, type index_d_DiscountCycles as DiscountCycles, type index_d_DiscountOrigin as DiscountOrigin, type index_d_DiscountValueOneOf as DiscountValueOneOf, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Duration as Duration, index_d_DurationUnit as DurationUnit, type index_d_DynamicTax as DynamicTax, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, index_d_ExtendPolicyType as ExtendPolicyType, type index_d_ExtendSubscriptionOptions as ExtendSubscriptionOptions, type index_d_ExtendSubscriptionRequest as ExtendSubscriptionRequest, type index_d_ExtendSubscriptionRequestExtendPolicyOneOf as ExtendSubscriptionRequestExtendPolicyOneOf, type index_d_ExtendSubscriptionResponse as ExtendSubscriptionResponse, type index_d_ExtendSubscriptionResponseNonNullableFields as ExtendSubscriptionResponseNonNullableFields, type index_d_ExternalCollectionDetails as ExternalCollectionDetails, type index_d_FinishFreeTrialNowRequest as FinishFreeTrialNowRequest, type index_d_FinishFreeTrialNowResponse as FinishFreeTrialNowResponse, type index_d_FixSubscriptionInvoicesRequest as FixSubscriptionInvoicesRequest, type index_d_FixSubscriptionInvoicesRequestModeOneOf as FixSubscriptionInvoicesRequestModeOneOf, type index_d_FixSubscriptionInvoicesResponse as FixSubscriptionInvoicesResponse, type index_d_FixedPrice as FixedPrice, type index_d_FreeTrailEnded as FreeTrailEnded, type index_d_FreeTrailStarted as FreeTrailStarted, type index_d_FreeTrialData as FreeTrialData, type index_d_FullAddressContactDetails as FullAddressContactDetails, type index_d_FullAddressDetails as FullAddressDetails, type index_d_FutureUpdatesRequested as FutureUpdatesRequested, type index_d_GetFullSubscriptionDataRequest as GetFullSubscriptionDataRequest, type index_d_GetFullSubscriptionDataResponse as GetFullSubscriptionDataResponse, type index_d_GetSubscriptionAndInternalDataRequest as GetSubscriptionAndInternalDataRequest, type index_d_GetSubscriptionAndInternalDataResponse as GetSubscriptionAndInternalDataResponse, type index_d_GetSubscriptionInvoicesRequest as GetSubscriptionInvoicesRequest, type index_d_GetSubscriptionInvoicesResponse as GetSubscriptionInvoicesResponse, type index_d_GetSubscriptionRequest as GetSubscriptionRequest, type index_d_GetSubscriptionResponse as GetSubscriptionResponse, type index_d_GetSubscriptionResponseNonNullableFields as GetSubscriptionResponseNonNullableFields, type index_d_GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequest, type index_d_GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponse, type index_d_GetSubscriptionsStatsResponseNonNullableFields as GetSubscriptionsStatsResponseNonNullableFields, type index_d_GracePeriodData as GracePeriodData, type index_d_GracePeriodEnded as GracePeriodEnded, type index_d_GracePeriodStarted as GracePeriodStarted, type index_d_HandleSubscriptionAfterInvoiceMarkedAsPaidRequest as HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, index_d_HistoryActionInitiator as HistoryActionInitiator, index_d_HistoryViewMode as HistoryViewMode, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, type index_d_InitiatePaymentMethodSetupOptions as InitiatePaymentMethodSetupOptions, type index_d_InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequest, type index_d_InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponse, type index_d_InitiatePaymentMethodSetupResponseNonNullableFields as InitiatePaymentMethodSetupResponseNonNullableFields, type index_d_InternalSubscriptionData as InternalSubscriptionData, type index_d_Invoice as Invoice, type index_d_InvoiceAction as InvoiceAction, type index_d_InvoiceActionActionTypeOneOf as InvoiceActionActionTypeOneOf, type index_d_InvoiceApplicationFee as InvoiceApplicationFee, type index_d_InvoiceApplicationFeeValueOneOf as InvoiceApplicationFeeValueOneOf, type index_d_InvoiceDiscount as InvoiceDiscount, type index_d_InvoiceDiscountValueOneOf as InvoiceDiscountValueOneOf, type index_d_InvoiceItem as InvoiceItem, type index_d_InvoiceItemPaymentTypeOneOf as InvoiceItemPaymentTypeOneOf, type index_d_InvoiceShippingCharges as InvoiceShippingCharges, index_d_InvoiceStatus as InvoiceStatus, type index_d_Item as Item, index_d_ItemCategory as ItemCategory, type index_d_ItemChange as ItemChange, type index_d_ItemTaxData as ItemTaxData, type index_d_LatestInvoiceMarkedAsPaid as LatestInvoiceMarkedAsPaid, type index_d_LatestPaymentAttempt as LatestPaymentAttempt, type index_d_LineItemTaxSummary as LineItemTaxSummary, type index_d_ListSubscriptionHistoryOptions as ListSubscriptionHistoryOptions, type index_d_ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequest, type index_d_ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponse, type index_d_ListSubscriptionHistoryResponseNonNullableFields as ListSubscriptionHistoryResponseNonNullableFields, type index_d_ListUpcomingChargesOptions as ListUpcomingChargesOptions, type index_d_ListUpcomingChargesRequest as ListUpcomingChargesRequest, type index_d_ListUpcomingChargesResponse as ListUpcomingChargesResponse, type index_d_ListUpcomingChargesResponseNonNullableFields as ListUpcomingChargesResponseNonNullableFields, type index_d_MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequest, type index_d_MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponse, type index_d_MarkLatestInvoiceAsPaidResponseNonNullableFields as MarkLatestInvoiceAsPaidResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MigrationDetails as MigrationDetails, type index_d_Money as Money, type index_d_OneTime as OneTime, index_d_OrderMethod as OrderMethod, type index_d_OriginOverride as OriginOverride, type index_d_Paging as Paging, type index_d_PagingMetadataV2 as PagingMetadataV2, index_d_PauseAt as PauseAt, type index_d_PauseInfo as PauseInfo, type index_d_PausePeriod as PausePeriod, index_d_PausePolicy as PausePolicy, type index_d_PauseSubscriptionOptions as PauseSubscriptionOptions, type index_d_PauseSubscriptionRequest as PauseSubscriptionRequest, type index_d_PauseSubscriptionRequested as PauseSubscriptionRequested, type index_d_PauseSubscriptionResponse as PauseSubscriptionResponse, type index_d_PauseSubscriptionResponseNonNullableFields as PauseSubscriptionResponseNonNullableFields, type index_d_PayCycleOptions as PayCycleOptions, type index_d_PayCycleRequest as PayCycleRequest, type index_d_PayCycleResponse as PayCycleResponse, type index_d_PayCycleResponseNonNullableFields as PayCycleResponseNonNullableFields, type index_d_PayRecurringInvoice as PayRecurringInvoice, index_d_PaymentAttemptStatus as PaymentAttemptStatus, type index_d_PaymentData as PaymentData, type index_d_PaymentMethod as PaymentMethod, type index_d_PaymentMethodUpdated as PaymentMethodUpdated, index_d_PaymentMode as PaymentMode, type index_d_PaymentOrigin as PaymentOrigin, type index_d_PaymentSettings as PaymentSettings, index_d_PaymentSettlementMethod as PaymentSettlementMethod, index_d_PaymentStatus as PaymentStatus, index_d_PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatus, index_d_PaymentTestMode as PaymentTestMode, type index_d_PreviewSubscriptionChargesOptions as PreviewSubscriptionChargesOptions, type index_d_PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequest, type index_d_PreviewSubscriptionChargesRequestSubscriptionOneOf as PreviewSubscriptionChargesRequestSubscriptionOneOf, type index_d_PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponse, type index_d_PreviewSubscriptionChargesResponseNonNullableFields as PreviewSubscriptionChargesResponseNonNullableFields, type index_d_PreviewSubscriptionsChargesOptions as PreviewSubscriptionsChargesOptions, type index_d_PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequest, type index_d_PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponse, type index_d_PreviewSubscriptionsChargesResponseNonNullableFields as PreviewSubscriptionsChargesResponseNonNullableFields, type index_d_PriceAdjustment as PriceAdjustment, type index_d_PriceAdjustmentAdjustmentTypeOneOf as PriceAdjustmentAdjustmentTypeOneOf, type index_d_PriceAdjustmentValue as PriceAdjustmentValue, type index_d_PriceAdjustmentValueAdjustmentValueTypeOneOf as PriceAdjustmentValueAdjustmentValueTypeOneOf, type index_d_PriceDetails as PriceDetails, type index_d_PricingModel as PricingModel, type index_d_PricingModelModelOneOf as PricingModelModelOneOf, type index_d_Proration as Proration, type index_d_ProrationTypeOneOf as ProrationTypeOneOf, type index_d_QuerySubscriptionsRequest as QuerySubscriptionsRequest, type index_d_QuerySubscriptionsResponse as QuerySubscriptionsResponse, type index_d_QuerySubscriptionsResponseNonNullableFields as QuerySubscriptionsResponseNonNullableFields, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type index_d_Recurring as Recurring, type index_d_RedirectUrls as RedirectUrls, index_d_RequestedFields as RequestedFields, type index_d_Reschedule as Reschedule, type index_d_ResetPendingUpdates as ResetPendingUpdates, type index_d_RestoreDraftSubscriptionRequest as RestoreDraftSubscriptionRequest, type index_d_RestoreDraftSubscriptionResponse as RestoreDraftSubscriptionResponse, type index_d_RestoreInfo as RestoreInfo, index_d_ResumeAt as ResumeAt, type index_d_ResumeSubscriptionOptions as ResumeSubscriptionOptions, type index_d_ResumeSubscriptionRequest as ResumeSubscriptionRequest, type index_d_ResumeSubscriptionRequested as ResumeSubscriptionRequested, type index_d_ResumeSubscriptionResponse as ResumeSubscriptionResponse, type index_d_ResumeSubscriptionResponseNonNullableFields as ResumeSubscriptionResponseNonNullableFields, type index_d_ReviseSubscriptionRequest as ReviseSubscriptionRequest, type index_d_ReviseSubscriptionResponse as ReviseSubscriptionResponse, index_d_RevivePolicy as RevivePolicy, type index_d_ReviveSubscriptionRequest as ReviveSubscriptionRequest, type index_d_ReviveSubscriptionResponse as ReviveSubscriptionResponse, type index_d_RunTimeCapsuleTaskNowRequest as RunTimeCapsuleTaskNowRequest, type index_d_ScheduleAdditionalInfo as ScheduleAdditionalInfo, type index_d_ScheduleAdditionalInfoParamOneOf as ScheduleAdditionalInfoParamOneOf, type index_d_ScheduleTimeCapsuleTaskRequest as ScheduleTimeCapsuleTaskRequest, type index_d_ScheduledPauseCanceled as ScheduledPauseCanceled, type index_d_ScheduledResumeCanceled as ScheduledResumeCanceled, type index_d_SearchSubscriptionRequest as SearchSubscriptionRequest, type index_d_SearchSubscriptionResponse as SearchSubscriptionResponse, type index_d_SearchSubscriptionsOptions as SearchSubscriptionsOptions, type index_d_SearchSubscriptionsRequest as SearchSubscriptionsRequest, type index_d_SearchSubscriptionsRequestPagingMethodOneOf as SearchSubscriptionsRequestPagingMethodOneOf, type index_d_SearchSubscriptionsResponse as SearchSubscriptionsResponse, type index_d_SearchSubscriptionsResponseNonNullableFields as SearchSubscriptionsResponseNonNullableFields, type index_d_SendSubscriptionActionEventBORequest as SendSubscriptionActionEventBORequest, type index_d_SendSubscriptionActionEventBORequestEventOneOf as SendSubscriptionActionEventBORequestEventOneOf, type index_d_SendSubscriptionActionEventResponse as SendSubscriptionActionEventResponse, type index_d_SendTimeCapsuleTaskCanceledBIRequest as SendTimeCapsuleTaskCanceledBIRequest, type index_d_SetIsMigratedEvent as SetIsMigratedEvent, type index_d_SetShiftingDataRequest as SetShiftingDataRequest, type index_d_SetShiftingDataResponse as SetShiftingDataResponse, type index_d_ShippingCharges as ShippingCharges, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_SortingClauses as SortingClauses, type index_d_SpecificDateSubscriptionUpdateData as SpecificDateSubscriptionUpdateData, index_d_Status as Status, type index_d_StreetAddress as StreetAddress, type index_d_Subscriber as Subscriber, type index_d_Subscription as Subscription, type index_d_SubscriptionActivated as SubscriptionActivated, type index_d_SubscriptionAutoRenewalTurnedOff as SubscriptionAutoRenewalTurnedOff, type index_d_SubscriptionAutoRenewalTurnedOffEnvelope as SubscriptionAutoRenewalTurnedOffEnvelope, type index_d_SubscriptionAutoRenewalTurnedOn as SubscriptionAutoRenewalTurnedOn, type index_d_SubscriptionAutoRenewalTurnedOnEnvelope as SubscriptionAutoRenewalTurnedOnEnvelope, type index_d_SubscriptionBackOfficeAction as SubscriptionBackOfficeAction, type index_d_SubscriptionBillingCycleStarted as SubscriptionBillingCycleStarted, type index_d_SubscriptionBillingDateUpdated as SubscriptionBillingDateUpdated, type index_d_SubscriptionBillingDateUpdatedEnvelope as SubscriptionBillingDateUpdatedEnvelope, type index_d_SubscriptionBillingDetails as SubscriptionBillingDetails, type index_d_SubscriptionCanceled as SubscriptionCanceled, type index_d_SubscriptionCanceledEnvelope as SubscriptionCanceledEnvelope, type index_d_SubscriptionCancellationRequested as SubscriptionCancellationRequested, type index_d_SubscriptionCharge as SubscriptionCharge, type index_d_SubscriptionCharges as SubscriptionCharges, type index_d_SubscriptionCollectionMethodUpdated as SubscriptionCollectionMethodUpdated, type index_d_SubscriptionCreated as SubscriptionCreated, type index_d_SubscriptionCycleReadyToPay as SubscriptionCycleReadyToPay, type index_d_SubscriptionCycleTriggered as SubscriptionCycleTriggered, type index_d_SubscriptionDelayedSyncEvent as SubscriptionDelayedSyncEvent, type index_d_SubscriptionDeleted as SubscriptionDeleted, type index_d_SubscriptionDiff as SubscriptionDiff, type index_d_SubscriptionEnded as SubscriptionEnded, type index_d_SubscriptionEvent as SubscriptionEvent, type index_d_SubscriptionEventPayloadOneOf as SubscriptionEventPayloadOneOf, type index_d_SubscriptionExpired as SubscriptionExpired, type index_d_SubscriptionExtended as SubscriptionExtended, type index_d_SubscriptionExtendedEnvelope as SubscriptionExtendedEnvelope, type index_d_SubscriptionExtendedExtendPolicyOneOf as SubscriptionExtendedExtendPolicyOneOf, index_d_SubscriptionFrequency as SubscriptionFrequency, type index_d_SubscriptionHistoryEntry as SubscriptionHistoryEntry, type index_d_SubscriptionInfo as SubscriptionInfo, type index_d_SubscriptionInitialPurchaseCompleted as SubscriptionInitialPurchaseCompleted, type index_d_SubscriptionInvoice as SubscriptionInvoice, type index_d_SubscriptionLatestInvoiceMarkedAsPaidEnvelope as SubscriptionLatestInvoiceMarkedAsPaidEnvelope, type index_d_SubscriptionMarkedAsPaid as SubscriptionMarkedAsPaid, type index_d_SubscriptionPauseScheduleCanceledEnvelope as SubscriptionPauseScheduleCanceledEnvelope, type index_d_SubscriptionPauseScheduledEnvelope as SubscriptionPauseScheduledEnvelope, type index_d_SubscriptionPaused as SubscriptionPaused, type index_d_SubscriptionPausedEnvelope as SubscriptionPausedEnvelope, type index_d_SubscriptionPolicies as SubscriptionPolicies, type index_d_SubscriptionPolicy as SubscriptionPolicy, type index_d_SubscriptionResumeScheduleCanceledEnvelope as SubscriptionResumeScheduleCanceledEnvelope, type index_d_SubscriptionResumeScheduledEnvelope as SubscriptionResumeScheduledEnvelope, type index_d_SubscriptionResumed as SubscriptionResumed, type index_d_SubscriptionResumedEnvelope as SubscriptionResumedEnvelope, type index_d_SubscriptionRevived as SubscriptionRevived, type index_d_SubscriptionStatus as SubscriptionStatus, index_d_SubscriptionStatusEnumSubscriptionStatus as SubscriptionStatusEnumSubscriptionStatus, index_d_SubscriptionStatusGroup as SubscriptionStatusGroup, type index_d_SubscriptionSuspended as SubscriptionSuspended, type index_d_SubscriptionTrialPeriod as SubscriptionTrialPeriod, index_d_SubscriptionType as SubscriptionType, type index_d_SubscriptionUpdateData as SubscriptionUpdateData, type index_d_SubscriptionUpdated as SubscriptionUpdated, type index_d_SubscriptionUpdatedEnvelope as SubscriptionUpdatedEnvelope, type index_d_Suspension as Suspension, type index_d_Task as Task, type index_d_TaskAction as TaskAction, type index_d_TaskActionActionOneOf as TaskActionActionOneOf, type index_d_TaskKey as TaskKey, type index_d_Tax as Tax, type index_d_TaxBreakdown as TaxBreakdown, type index_d_TaxData as TaxData, type index_d_TaxSettings as TaxSettings, type index_d_TaxSummary as TaxSummary, type index_d_TaxValueOneOf as TaxValueOneOf, index_d_TaxableAddressType as TaxableAddressType, type index_d_TimeBasedProration as TimeBasedProration, type index_d_Totals as Totals, type index_d_TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequest, type index_d_TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponse, type index_d_TurnOffSubscriptionAutoRenewalResponseNonNullableFields as TurnOffSubscriptionAutoRenewalResponseNonNullableFields, type index_d_TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequest, type index_d_TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponse, type index_d_TurnOnSubscriptionAutoRenewalResponseNonNullableFields as TurnOnSubscriptionAutoRenewalResponseNonNullableFields, type index_d_UnknownSubscriptionEvent as UnknownSubscriptionEvent, type index_d_UnsupportedAction as UnsupportedAction, type index_d_UnsupportedReason as UnsupportedReason, index_d_UpdateAction as UpdateAction, type index_d_UpdateBillingDateData as UpdateBillingDateData, type index_d_UpdateFullSubscriptionRequest as UpdateFullSubscriptionRequest, type index_d_UpdateFullSubscriptionResponse as UpdateFullSubscriptionResponse, type index_d_UpdatePausePaidDurationRequest as UpdatePausePaidDurationRequest, type index_d_UpdatePausePaidDurationResponse as UpdatePausePaidDurationResponse, type index_d_UpdatePaymentMethodBORequest as UpdatePaymentMethodBORequest, type index_d_UpdatePaymentMethodBOResponse as UpdatePaymentMethodBOResponse, type index_d_UpdatePaymentStatusRequest as UpdatePaymentStatusRequest, type index_d_UpdatePaymentStatusResponse as UpdatePaymentStatusResponse, type index_d_UpdateStatusRequest as UpdateStatusRequest, type index_d_UpdateStatusResponse as UpdateStatusResponse, type index_d_UpdateSubscriptionBillingDateOptions as UpdateSubscriptionBillingDateOptions, type index_d_UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequest, type index_d_UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponse, type index_d_UpdateSubscriptionBillingDateResponseNonNullableFields as UpdateSubscriptionBillingDateResponseNonNullableFields, type index_d_UpdateSubscriptionInvoiceCycleRequest as UpdateSubscriptionInvoiceCycleRequest, type index_d_UpdateSubscriptionInvoiceCycleResponse as UpdateSubscriptionInvoiceCycleResponse, type index_d_UpdateSubscriptionItemsRequest as UpdateSubscriptionItemsRequest, type index_d_UpdateSubscriptionItemsResponse as UpdateSubscriptionItemsResponse, type index_d_UpdateSubscriptionOriginRequest as UpdateSubscriptionOriginRequest, type index_d_UpdateSubscriptionOriginResponse as UpdateSubscriptionOriginResponse, type index_d_UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequest, type index_d_UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponse, type index_d_UpdateSubscriptionPaymentMethodResponseNonNullableFields as UpdateSubscriptionPaymentMethodResponseNonNullableFields, type index_d_UpdateSubscriptionPoliciesRequest as UpdateSubscriptionPoliciesRequest, type index_d_UpdateSubscriptionPoliciesResponse as UpdateSubscriptionPoliciesResponse, type index_d_UpdateSubscriptionRequest as UpdateSubscriptionRequest, type index_d_UpdateSubscriptionResponse as UpdateSubscriptionResponse, type index_d_UpdateSubscriptionStartDateRequest as UpdateSubscriptionStartDateRequest, type index_d_UpdateSubscriptionStartDateResponse as UpdateSubscriptionStartDateResponse, type index_d_UpdatesApplied as UpdatesApplied, type index_d_V1Duration as V1Duration, type index_d_V1Subscription as V1Subscription, type index_d_V1SubscriptionActivated as V1SubscriptionActivated, type index_d_V1SubscriptionCanceled as V1SubscriptionCanceled, type index_d_V1SubscriptionCreated as V1SubscriptionCreated, type index_d_V1SubscriptionEvent as V1SubscriptionEvent, type index_d_V1SubscriptionEventEventOneOf as V1SubscriptionEventEventOneOf, type index_d_V1SubscriptionInitialPurchaseCompleted as V1SubscriptionInitialPurchaseCompleted, type index_d_V1SubscriptionResumed as V1SubscriptionResumed, index_d_V1SubscriptionStatusEnumSubscriptionStatus as V1SubscriptionStatusEnumSubscriptionStatus, type index_d_V1SubscriptionUpdated as V1SubscriptionUpdated, type index_d_V2Subscription as V2Subscription, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnSubscriptionAutoRenewalTurnedOffType as _publicOnSubscriptionAutoRenewalTurnedOffType, type index_d__publicOnSubscriptionAutoRenewalTurnedOnType as _publicOnSubscriptionAutoRenewalTurnedOnType, type index_d__publicOnSubscriptionBillingDateUpdatedType as _publicOnSubscriptionBillingDateUpdatedType, type index_d__publicOnSubscriptionCanceledType as _publicOnSubscriptionCanceledType, type index_d__publicOnSubscriptionExtendedType as _publicOnSubscriptionExtendedType, type index_d__publicOnSubscriptionLatestInvoiceMarkedAsPaidType as _publicOnSubscriptionLatestInvoiceMarkedAsPaidType, type index_d__publicOnSubscriptionPauseScheduleCanceledType as _publicOnSubscriptionPauseScheduleCanceledType, type index_d__publicOnSubscriptionPauseScheduledType as _publicOnSubscriptionPauseScheduledType, type index_d__publicOnSubscriptionPausedType as _publicOnSubscriptionPausedType, type index_d__publicOnSubscriptionResumeScheduleCanceledType as _publicOnSubscriptionResumeScheduleCanceledType, type index_d__publicOnSubscriptionResumeScheduledType as _publicOnSubscriptionResumeScheduledType, type index_d__publicOnSubscriptionResumedType as _publicOnSubscriptionResumedType, type index_d__publicOnSubscriptionUpdatedType as _publicOnSubscriptionUpdatedType, index_d_allowedActions as allowedActions, index_d_cancelSubscription as cancelSubscription, index_d_countSubscriptions as countSubscriptions, index_d_customerAllowedActions as customerAllowedActions, index_d_customerCancelSubscription as customerCancelSubscription, index_d_customerExtendSubscription as customerExtendSubscription, index_d_customerGetSubscription as customerGetSubscription, index_d_customerInitiatePaymentMethodSetup as customerInitiatePaymentMethodSetup, index_d_customerListUpcomingCharges as customerListUpcomingCharges, index_d_customerQuerySubscriptions as customerQuerySubscriptions, index_d_customerTurnOffSubscriptionAutoRenewal as customerTurnOffSubscriptionAutoRenewal, index_d_customerTurnOnSubscriptionAutoRenewal as customerTurnOnSubscriptionAutoRenewal, index_d_customerUpdateSubscriptionPaymentMethod as customerUpdateSubscriptionPaymentMethod, index_d_extendSubscription as extendSubscription, index_d_getSubscription as getSubscription, index_d_getSubscriptionsStats as getSubscriptionsStats, index_d_initiatePaymentMethodSetup as initiatePaymentMethodSetup, index_d_listSubscriptionHistory as listSubscriptionHistory, index_d_listUpcomingCharges as listUpcomingCharges, index_d_markLatestInvoiceAsPaid as markLatestInvoiceAsPaid, index_d_onSubscriptionAutoRenewalTurnedOff as onSubscriptionAutoRenewalTurnedOff, index_d_onSubscriptionAutoRenewalTurnedOn as onSubscriptionAutoRenewalTurnedOn, index_d_onSubscriptionBillingDateUpdated as onSubscriptionBillingDateUpdated, index_d_onSubscriptionCanceled as onSubscriptionCanceled, index_d_onSubscriptionExtended as onSubscriptionExtended, index_d_onSubscriptionLatestInvoiceMarkedAsPaid as onSubscriptionLatestInvoiceMarkedAsPaid, index_d_onSubscriptionPauseScheduleCanceled as onSubscriptionPauseScheduleCanceled, index_d_onSubscriptionPauseScheduled as onSubscriptionPauseScheduled, index_d_onSubscriptionPaused as onSubscriptionPaused, index_d_onSubscriptionResumeScheduleCanceled as onSubscriptionResumeScheduleCanceled, index_d_onSubscriptionResumeScheduled as onSubscriptionResumeScheduled, index_d_onSubscriptionResumed as onSubscriptionResumed, index_d_onSubscriptionUpdated as onSubscriptionUpdated, index_d_pauseSubscription as pauseSubscription, index_d_payCycle as payCycle, index_d_previewSubscriptionCharges as previewSubscriptionCharges, index_d_previewSubscriptionsCharges as previewSubscriptionsCharges, onSubscriptionAutoRenewalTurnedOff$1 as publicOnSubscriptionAutoRenewalTurnedOff, onSubscriptionAutoRenewalTurnedOn$1 as publicOnSubscriptionAutoRenewalTurnedOn, onSubscriptionBillingDateUpdated$1 as publicOnSubscriptionBillingDateUpdated, onSubscriptionCanceled$1 as publicOnSubscriptionCanceled, onSubscriptionExtended$1 as publicOnSubscriptionExtended, onSubscriptionLatestInvoiceMarkedAsPaid$1 as publicOnSubscriptionLatestInvoiceMarkedAsPaid, onSubscriptionPauseScheduleCanceled$1 as publicOnSubscriptionPauseScheduleCanceled, onSubscriptionPauseScheduled$1 as publicOnSubscriptionPauseScheduled, onSubscriptionPaused$1 as publicOnSubscriptionPaused, onSubscriptionResumeScheduleCanceled$1 as publicOnSubscriptionResumeScheduleCanceled, onSubscriptionResumeScheduled$1 as publicOnSubscriptionResumeScheduled, onSubscriptionResumed$1 as publicOnSubscriptionResumed, onSubscriptionUpdated$1 as publicOnSubscriptionUpdated, index_d_querySubscriptions as querySubscriptions, index_d_resumeSubscription as resumeSubscription, index_d_searchSubscriptions as searchSubscriptions, index_d_turnOffSubscriptionAutoRenewal as turnOffSubscriptionAutoRenewal, index_d_turnOnSubscriptionAutoRenewal as turnOnSubscriptionAutoRenewal, index_d_updateSubscriptionBillingDate as updateSubscriptionBillingDate, index_d_updateSubscriptionPaymentMethod as updateSubscriptionPaymentMethod };
5061
5120
  }
5062
5121
 
5063
5122
  export { index_d as subscriptions };