@wix/subscription 1.0.33 → 1.0.34

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.
@@ -567,6 +567,8 @@ interface Subscription {
567
567
  changesCounter?: string | null;
568
568
  /** Billing order id. Optional. */
569
569
  orderId?: string | null;
570
+ /** Platform origin subscription is coming from. */
571
+ platformOrigin?: PlatformOrigin;
570
572
  /** items, minSize is 1, maxSize is 100 */
571
573
  items?: Item[];
572
574
  }
@@ -689,7 +691,9 @@ declare enum CollectionMethodEnumCollectionMethod {
689
691
  /** Payment will be collected somehow. Billing only issues invoice per cycle. */
690
692
  SEND_INVOICE = "SEND_INVOICE",
691
693
  /** Payment will be collected externally */
692
- EXTERNAL = "EXTERNAL"
694
+ EXTERNAL = "EXTERNAL",
695
+ /** Indicates the product has a zero amount, meaning its free with no payment required. */
696
+ FREE = "FREE"
693
697
  }
694
698
  interface Duration {
695
699
  /** Duration unit: DAY, WEEK, MONTH, YEAR */
@@ -1301,18 +1305,151 @@ interface SpecificDateSubscriptionUpdateData {
1301
1305
  updateData?: SubscriptionUpdateData;
1302
1306
  executionDate?: Date | null;
1303
1307
  }
1304
- interface GetSubscriptionRequest {
1305
- _id: string;
1308
+ interface PlatformOrigin {
1309
+ appId?: string | null;
1310
+ entityId?: string | null;
1306
1311
  }
1307
- interface GetSubscriptionResponse {
1312
+ interface ListSubscriptionHistoryRequest {
1313
+ subscriptionId: string;
1314
+ /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
1315
+ mode?: HistoryViewMode;
1316
+ /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
1317
+ cursor?: CursorPaging;
1318
+ }
1319
+ declare enum HistoryViewMode {
1320
+ UNKNOWN = "UNKNOWN",
1321
+ /** Comprehensive view including all history events. */
1322
+ BACKOFFICE = "BACKOFFICE",
1323
+ /** User-centric view of the history. */
1324
+ USER = "USER"
1325
+ }
1326
+ interface CursorPaging {
1327
+ /** Maximum number of items to return in the results. */
1328
+ limit?: number | null;
1329
+ /**
1330
+ * Pointer to the next or previous page in the list of results.
1331
+ *
1332
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1333
+ * Not relevant for the first request.
1334
+ */
1335
+ cursor?: string | null;
1336
+ }
1337
+ interface ListSubscriptionHistoryResponse {
1338
+ /** List of history entries for the subscription. */
1339
+ historyEntries?: SubscriptionHistoryEntry[];
1340
+ /** Paging metadata. A `next` cursor is returned if there are more results. */
1341
+ pagingMetadata?: PagingMetadataV2;
1342
+ }
1343
+ interface SubscriptionHistoryEntry {
1344
+ entryId?: string;
1345
+ /** TODO: add max length? it is not defined in domainevents, so should we? */
1346
+ slug?: string;
1347
+ entryTime?: Date | null;
1348
+ event?: SubscriptionEvent;
1349
+ }
1350
+ interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
1351
+ created?: SubscriptionCreated;
1352
+ updated?: SubscriptionUpdated;
1353
+ deleted?: SubscriptionDeleted;
1354
+ activated?: SubscriptionActivated;
1355
+ ended?: SubscriptionEnded;
1356
+ canceled?: SubscriptionCanceled;
1357
+ paused?: SubscriptionPaused;
1358
+ resumed?: SubscriptionResumed;
1359
+ pauseRequested?: PauseSubscriptionRequested;
1360
+ resumeRequested?: ResumeSubscriptionRequested;
1361
+ scheduledPauseCanceled?: ScheduledPauseCanceled;
1362
+ scheduledResumeCanceled?: ScheduledResumeCanceled;
1363
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
1364
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
1365
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
1366
+ cycleReadyToPay?: SubscriptionCycleReadyToPay;
1367
+ extended?: SubscriptionExtended;
1368
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
1369
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
1370
+ revived?: SubscriptionRevived;
1371
+ billingDateUpdated?: SubscriptionBillingDateUpdated;
1372
+ futureUpdatesRequested?: FutureUpdatesRequested;
1373
+ updatesApplied?: UpdatesApplied;
1374
+ resetPendingUpdates?: ResetPendingUpdates;
1375
+ gracePeriodStarted?: GracePeriodStarted;
1376
+ gracePeriodEnded?: GracePeriodEnded;
1377
+ paymentMethodUpdated?: PaymentMethodUpdated;
1378
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
1379
+ freeTrailStarted?: FreeTrailStarted;
1380
+ freeTrailEnded?: FreeTrailEnded;
1381
+ subscriptionBoAction?: SubscriptionBackOfficeAction;
1382
+ unknown?: UnknownSubscriptionEvent;
1383
+ }
1384
+ /** @oneof */
1385
+ interface SubscriptionEventPayloadOneOf {
1386
+ created?: SubscriptionCreated;
1387
+ updated?: SubscriptionUpdated;
1388
+ deleted?: SubscriptionDeleted;
1389
+ activated?: SubscriptionActivated;
1390
+ ended?: SubscriptionEnded;
1391
+ canceled?: SubscriptionCanceled;
1392
+ paused?: SubscriptionPaused;
1393
+ resumed?: SubscriptionResumed;
1394
+ pauseRequested?: PauseSubscriptionRequested;
1395
+ resumeRequested?: ResumeSubscriptionRequested;
1396
+ scheduledPauseCanceled?: ScheduledPauseCanceled;
1397
+ scheduledResumeCanceled?: ScheduledResumeCanceled;
1398
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
1399
+ autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
1400
+ autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
1401
+ cycleReadyToPay?: SubscriptionCycleReadyToPay;
1402
+ extended?: SubscriptionExtended;
1403
+ initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
1404
+ latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
1405
+ revived?: SubscriptionRevived;
1406
+ billingDateUpdated?: SubscriptionBillingDateUpdated;
1407
+ futureUpdatesRequested?: FutureUpdatesRequested;
1408
+ updatesApplied?: UpdatesApplied;
1409
+ resetPendingUpdates?: ResetPendingUpdates;
1410
+ gracePeriodStarted?: GracePeriodStarted;
1411
+ gracePeriodEnded?: GracePeriodEnded;
1412
+ paymentMethodUpdated?: PaymentMethodUpdated;
1413
+ collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
1414
+ freeTrailStarted?: FreeTrailStarted;
1415
+ freeTrailEnded?: FreeTrailEnded;
1416
+ subscriptionBoAction?: SubscriptionBackOfficeAction;
1417
+ unknown?: UnknownSubscriptionEvent;
1418
+ }
1419
+ interface SubscriptionCreated {
1308
1420
  subscription?: Subscription;
1309
1421
  }
1310
- interface CustomerCancelSubscriptionRequest {
1311
- _id: string;
1312
- /** Optional action reason message */
1313
- reason?: string | null;
1422
+ interface SubscriptionUpdated {
1423
+ current?: Subscription;
1424
+ previous?: Subscription;
1425
+ diff?: SubscriptionDiff;
1314
1426
  }
1315
- interface CustomerCancelSubscriptionResponse {
1427
+ interface SubscriptionDiff {
1428
+ added?: string | null;
1429
+ changed?: string | null;
1430
+ deleted?: string | null;
1431
+ }
1432
+ interface SubscriptionDeleted {
1433
+ subscriptionId?: string;
1434
+ }
1435
+ /**
1436
+ * Sent each time a subscription status has been set to Active
1437
+ * Active shows that a subscription is live and operational.
1438
+ * For example:
1439
+ * * For subscription with free trial, free trial start date is also the activation date.
1440
+ * * For a subscription with future start date, the start date is also the activation date.
1441
+ * * When a subscription is resumed from a pause status, the resume date is also the activation date.
1442
+ */
1443
+ interface SubscriptionActivated {
1444
+ subscription?: Subscription;
1445
+ }
1446
+ /**
1447
+ * Sent each time a subscription status has been set to Ended
1448
+ * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
1449
+ * This is different from a Canceled subscription which ends the subscription before a designated end date.
1450
+ * Therefore, Ended and Canceled are mutually exclusive.
1451
+ */
1452
+ interface SubscriptionEnded {
1316
1453
  subscription?: Subscription;
1317
1454
  }
1318
1455
  /**
@@ -1330,32 +1467,48 @@ interface ActionDetails {
1330
1467
  initiator?: HistoryActionInitiator;
1331
1468
  reason?: string | null;
1332
1469
  }
1333
- interface CustomerTurnOnAutoRenewalRequest {
1334
- _id: string;
1335
- /** Optional action reason message */
1336
- reason?: string | null;
1470
+ interface SubscriptionPaused {
1471
+ subscription?: Subscription;
1472
+ pausePolicy?: PausePolicy;
1473
+ actionDetails?: ActionDetails;
1337
1474
  }
1338
- interface CustomerTurnOnAutoRenewalResponse {
1475
+ interface SubscriptionResumed {
1339
1476
  subscription?: Subscription;
1477
+ actionDetails?: ActionDetails;
1340
1478
  }
1341
- interface CustomerTurnOffAutoRenewalRequest {
1342
- _id: string;
1343
- /** Optional action reason message */
1344
- reason?: string | null;
1479
+ interface PauseSubscriptionRequested {
1480
+ subscription?: Subscription;
1481
+ pauseAt?: PauseAt;
1482
+ pausePolicy?: PausePolicy;
1483
+ actionDetails?: ActionDetails;
1345
1484
  }
1346
- interface CustomerTurnOffAutoRenewalResponse {
1485
+ interface ResumeSubscriptionRequested {
1347
1486
  subscription?: Subscription;
1487
+ resumeAt?: ResumeAt;
1488
+ actionDetails?: ActionDetails;
1348
1489
  }
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;
1490
+ interface ScheduledPauseCanceled {
1491
+ subscription?: Subscription;
1492
+ actionDetails?: ActionDetails;
1356
1493
  }
1357
- interface CustomerExtendSubscriptionResponse {
1358
- /** The now extended subscription */
1494
+ interface ScheduledResumeCanceled {
1495
+ subscription?: Subscription;
1496
+ actionDetails?: ActionDetails;
1497
+ }
1498
+ interface SubscriptionBillingCycleStarted {
1499
+ subscription?: Subscription;
1500
+ /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
1501
+ paymentTransactionId?: string | null;
1502
+ }
1503
+ interface SubscriptionAutoRenewalTurnedOn {
1504
+ subscription?: Subscription;
1505
+ actionDetails?: ActionDetails;
1506
+ }
1507
+ interface SubscriptionAutoRenewalTurnedOff {
1508
+ subscription?: Subscription;
1509
+ actionDetails?: ActionDetails;
1510
+ }
1511
+ interface SubscriptionCycleReadyToPay {
1359
1512
  subscription?: Subscription;
1360
1513
  }
1361
1514
  interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
@@ -1369,68 +1522,95 @@ interface SubscriptionExtendedExtendPolicyOneOf {
1369
1522
  extensionPeriod?: Duration;
1370
1523
  extensionBillingCycles?: number;
1371
1524
  }
1372
- interface QuerySubscriptionsRequest {
1373
- query?: QueryV2;
1525
+ interface SubscriptionInitialPurchaseCompleted {
1526
+ subscription?: Subscription;
1527
+ actionDetails?: ActionDetails;
1528
+ paymentTransactionId?: string | null;
1374
1529
  }
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[];
1530
+ interface LatestInvoiceMarkedAsPaid {
1531
+ subscription?: Subscription;
1396
1532
  }
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;
1533
+ interface SubscriptionRevived {
1534
+ subscription?: Subscription;
1403
1535
  }
1404
- interface Sorting {
1405
- /** Name of the field to sort by. */
1406
- fieldName?: string;
1407
- /** Sort order. */
1408
- order?: SortOrder;
1536
+ interface SubscriptionBillingDateUpdated {
1537
+ subscription?: Subscription;
1538
+ billingDate?: Date | null;
1539
+ proration?: Proration;
1409
1540
  }
1410
- declare enum SortOrder {
1411
- ASC = "ASC",
1412
- DESC = "DESC"
1541
+ interface FutureUpdatesRequested {
1542
+ subscription?: Subscription;
1543
+ requestedUpdateData?: SubscriptionUpdateData;
1413
1544
  }
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;
1545
+ interface UpdatesApplied {
1546
+ subscription?: Subscription;
1547
+ updateAction?: UpdateAction;
1548
+ appliedUpdateData?: SubscriptionUpdateData;
1419
1549
  }
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;
1550
+ declare enum UpdateAction {
1551
+ NONE = "NONE",
1552
+ /** Update subscription immediately, please note proration for updates changing price are not yet supported */
1553
+ IMMEDIATELY = "IMMEDIATELY",
1554
+ /** Request updates that will take affect only at the start of the next billing cycle. */
1555
+ NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
1556
+ /** Reset all pending updates */
1557
+ RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
1558
+ /** Request updates that will take affect only at a specific date. */
1559
+ SPECIFIC_DATE = "SPECIFIC_DATE"
1430
1560
  }
1431
- interface QuerySubscriptionsResponse {
1432
- subscriptions?: Subscription[];
1433
- metadata?: PagingMetadataV2;
1561
+ interface ResetPendingUpdates {
1562
+ subscription?: Subscription;
1563
+ }
1564
+ interface GracePeriodStarted {
1565
+ subscription?: Subscription;
1566
+ }
1567
+ interface GracePeriodEnded {
1568
+ subscription?: Subscription;
1569
+ /** Indication for the payment settlement method. */
1570
+ paymentSettlementMethod?: PaymentSettlementMethod;
1571
+ }
1572
+ declare enum PaymentSettlementMethod {
1573
+ UNKNOWN = "UNKNOWN",
1574
+ /** System-defined payment settlement. */
1575
+ SYSTEM = "SYSTEM",
1576
+ /** Manually mark the payment as paid. */
1577
+ MARK_AS_PAID = "MARK_AS_PAID",
1578
+ /** Require the customer to pay immediately, by insert a new payment method. */
1579
+ CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
1580
+ }
1581
+ interface PaymentMethodUpdated {
1582
+ subscription?: Subscription;
1583
+ initiator?: HistoryActionInitiator;
1584
+ paymentMode?: PaymentMode;
1585
+ }
1586
+ declare enum PaymentMode {
1587
+ NONE = "NONE",
1588
+ /** The latest invoice of the subscription will be charged. */
1589
+ CHARGE = "CHARGE",
1590
+ /** An authorization invoice with zero amount will be created. */
1591
+ AUTHORIZATION = "AUTHORIZATION"
1592
+ }
1593
+ interface SubscriptionCollectionMethodUpdated {
1594
+ subscription?: Subscription;
1595
+ newCollectionMethod?: CollectionMethodEnumCollectionMethod;
1596
+ previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
1597
+ }
1598
+ interface FreeTrailStarted {
1599
+ subscription?: Subscription;
1600
+ }
1601
+ interface FreeTrailEnded {
1602
+ subscription?: Subscription;
1603
+ }
1604
+ interface SubscriptionBackOfficeAction {
1605
+ subscription?: Subscription;
1606
+ /** The backoffice method name */
1607
+ name?: string;
1608
+ /** json as string format, to store the flatted request object */
1609
+ params?: string;
1610
+ }
1611
+ /** Defines unknown events restored from the logs */
1612
+ interface UnknownSubscriptionEvent {
1613
+ subscriptionAsString?: string | null;
1434
1614
  }
1435
1615
  interface PagingMetadataV2 {
1436
1616
  /** Number of items returned in the response. */
@@ -1450,6 +1630,100 @@ interface Cursors {
1450
1630
  /** Cursor pointing to the previous page in the list of results. */
1451
1631
  prev?: string | null;
1452
1632
  }
1633
+ interface GetSubscriptionRequest {
1634
+ _id: string;
1635
+ }
1636
+ interface GetSubscriptionResponse {
1637
+ subscription?: Subscription;
1638
+ }
1639
+ interface CustomerCancelSubscriptionRequest {
1640
+ _id: string;
1641
+ /** Optional action reason message */
1642
+ reason?: string | null;
1643
+ }
1644
+ interface CustomerCancelSubscriptionResponse {
1645
+ subscription?: Subscription;
1646
+ }
1647
+ interface CustomerTurnOnAutoRenewalRequest {
1648
+ _id: string;
1649
+ /** Optional action reason message */
1650
+ reason?: string | null;
1651
+ }
1652
+ interface CustomerTurnOnAutoRenewalResponse {
1653
+ subscription?: Subscription;
1654
+ }
1655
+ interface CustomerTurnOffAutoRenewalRequest {
1656
+ _id: string;
1657
+ /** Optional action reason message */
1658
+ reason?: string | null;
1659
+ }
1660
+ interface CustomerTurnOffAutoRenewalResponse {
1661
+ subscription?: Subscription;
1662
+ }
1663
+ interface CustomerExtendSubscriptionRequest {
1664
+ /** The ID of the subscription to be extended */
1665
+ _id: string;
1666
+ /** Optional action reason message */
1667
+ reason?: string | null;
1668
+ /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
1669
+ billingCyclesToAdd: number | null;
1670
+ }
1671
+ interface CustomerExtendSubscriptionResponse {
1672
+ /** The now extended subscription */
1673
+ subscription?: Subscription;
1674
+ }
1675
+ interface QuerySubscriptionsRequest {
1676
+ query?: QueryV2;
1677
+ }
1678
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
1679
+ /** Paging options to limit and skip the number of items. */
1680
+ paging?: Paging;
1681
+ /** 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`. */
1682
+ cursorPaging?: CursorPaging;
1683
+ /**
1684
+ * Filter object.
1685
+ *
1686
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1687
+ */
1688
+ filter?: Record<string, any> | null;
1689
+ /**
1690
+ * Sort object.
1691
+ *
1692
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1693
+ */
1694
+ sort?: Sorting[];
1695
+ /** 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. */
1696
+ fields?: string[];
1697
+ /** 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. */
1698
+ fieldsets?: string[];
1699
+ }
1700
+ /** @oneof */
1701
+ interface QueryV2PagingMethodOneOf {
1702
+ /** Paging options to limit and skip the number of items. */
1703
+ paging?: Paging;
1704
+ /** 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`. */
1705
+ cursorPaging?: CursorPaging;
1706
+ }
1707
+ interface Sorting {
1708
+ /** Name of the field to sort by. */
1709
+ fieldName?: string;
1710
+ /** Sort order. */
1711
+ order?: SortOrder;
1712
+ }
1713
+ declare enum SortOrder {
1714
+ ASC = "ASC",
1715
+ DESC = "DESC"
1716
+ }
1717
+ interface Paging {
1718
+ /** Number of items to load. */
1719
+ limit?: number | null;
1720
+ /** Number of items to skip in the current sort order. */
1721
+ offset?: number | null;
1722
+ }
1723
+ interface QuerySubscriptionsResponse {
1724
+ subscriptions?: Subscription[];
1725
+ metadata?: PagingMetadataV2;
1726
+ }
1453
1727
  interface CountSubscriptionsRequest {
1454
1728
  /** Filters to specify which subscriptions are counted. */
1455
1729
  filter?: CountSubscriptionFilter;
@@ -1753,13 +2027,6 @@ interface InitiatePaymentMethodSetupRequest {
1753
2027
  paymentMode?: PaymentMode;
1754
2028
  paymentSettings?: PaymentSettings;
1755
2029
  }
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
- }
1763
2030
  interface PaymentSettings {
1764
2031
  /** Allowed payment providers for Subscriptions, for example to limit subscriptions to be created only with "Wix Payments" provider. */
1765
2032
  allowedProviderIds?: string[];
@@ -1912,12 +2179,21 @@ declare enum WebhookIdentityType {
1912
2179
  WIX_USER = "WIX_USER",
1913
2180
  APP = "APP"
1914
2181
  }
1915
- interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
1916
- activeSubscription?: CreateSubscriptionRequest;
2182
+ interface SetIsMigratedEvent {
2183
+ subscriptionId?: string;
2184
+ }
2185
+ interface SubscriptionDelayedSyncEvent {
2186
+ subscriptionId?: string;
2187
+ }
2188
+ interface InvoiceAction extends InvoiceActionActionTypeOneOf {
2189
+ payRecurring?: PayRecurringInvoice;
1917
2190
  }
1918
2191
  /** @oneof */
1919
- interface CreateSubscriptionInStateRequestModeOneOf {
1920
- activeSubscription?: CreateSubscriptionRequest;
2192
+ interface InvoiceActionActionTypeOneOf {
2193
+ payRecurring?: PayRecurringInvoice;
2194
+ }
2195
+ interface PayRecurringInvoice {
2196
+ invoiceId?: string;
1921
2197
  }
1922
2198
  interface CreateSubscriptionRequest {
1923
2199
  subscription?: Subscription;
@@ -1932,801 +2208,434 @@ interface OriginOverride {
1932
2208
  appId?: string;
1933
2209
  instanceId?: string;
1934
2210
  }
1935
- interface CreateSubscriptionInStateResponse {
1936
- subscriptionId?: string;
1937
- }
1938
- interface PayCycleRequest {
1939
- subscriptionId: string;
1940
- paymentTestMode?: PaymentTestMode;
1941
- tenantId: string;
2211
+ interface CreateSubscriptionResponse {
2212
+ subscription?: Subscription;
2213
+ /** Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions. */
2214
+ paymentOrderId?: string | null;
1942
2215
  }
1943
- declare enum PaymentTestMode {
1944
- REGULAR = "REGULAR",
1945
- FAIL_TECHNICAL = "FAIL_TECHNICAL",
1946
- FAIL_DECLINE = "FAIL_DECLINE",
1947
- FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
2216
+ interface UpdateSubscriptionRequest {
2217
+ /** Revision is validated if Subscription.revision is set */
2218
+ subscription?: Subscription;
1948
2219
  }
1949
- interface PayCycleResponse {
1950
- invoiceId?: string;
1951
- paymentOrderId?: string | null;
2220
+ interface UpdateSubscriptionResponse {
1952
2221
  subscription?: Subscription;
1953
2222
  }
1954
- interface GetFullSubscriptionDataRequest {
2223
+ interface UpdateSubscriptionStartDateRequest {
2224
+ /** Subscription ID */
1955
2225
  _id?: string;
2226
+ /**
2227
+ * Can be updated only if Subscription is in Draft state
2228
+ * By setting start_date in the future, end_date will be recalculated for termed Subscriptions
2229
+ * cycles_to_pay_on_creation will be set to 1 if no free trial is set
2230
+ */
2231
+ startDate?: Date | null;
1956
2232
  }
1957
- interface GetFullSubscriptionDataResponse {
2233
+ interface UpdateSubscriptionStartDateResponse {
1958
2234
  subscription?: Subscription;
1959
- internalSubscriptionData?: InternalSubscriptionData;
1960
- }
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[];
1970
2235
  }
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;
2236
+ interface UpdateSubscriptionPoliciesRequest {
2237
+ /** Subscription ID */
2238
+ _id?: string;
2239
+ cancellableByCustomer?: boolean | null;
1976
2240
  }
1977
- interface PausePeriod {
1978
- startDate?: Date | null;
1979
- endDate?: Date | null;
2241
+ interface UpdateSubscriptionPoliciesResponse {
2242
+ /** Updated policies of the subscription */
2243
+ policies?: SubscriptionPolicies;
1980
2244
  }
1981
- interface GetSubscriptionAndInternalDataRequest {
1982
- subscriptionId?: string;
1983
- tenantId?: string;
2245
+ interface UpdateSubscriptionBillingDateRequest {
2246
+ /** ID of the subscription to update the billing date for. */
2247
+ _id: string;
2248
+ /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
2249
+ billingDate: Date | null;
2250
+ /**
2251
+ * Information about how BASS adjusts the total of the next invoice. Extending
2252
+ * the current billing cycle results in a higher payment, while shortening it
2253
+ * leads to a lower payment. BASS offers automatic calculation of the proration
2254
+ * amount based on the number of days added to or removed from the current billing
2255
+ * cycle. Alternatively, you can use your own custom method to calculate the
2256
+ * proration amount. The custom proration amount can't exceed the total of the
2257
+ * current billing cycle.
2258
+ */
2259
+ proration?: Proration;
1984
2260
  }
1985
- interface GetSubscriptionAndInternalDataResponse {
2261
+ interface UpdateSubscriptionBillingDateResponse {
2262
+ /** Updated subscription. */
1986
2263
  subscription?: Subscription;
1987
- internalSubscriptionData?: InternalSubscriptionData;
1988
2264
  }
1989
- interface SearchSubscriptionRequest {
2265
+ interface UpdateSubscriptionOriginRequest {
2266
+ /** ID of the subscription to update origin. */
1990
2267
  _id?: string;
1991
- tenantId?: string;
2268
+ /** Origin entity ID of the subscription to update. */
2269
+ entityId?: string;
1992
2270
  }
1993
- interface SearchSubscriptionResponse {
2271
+ interface UpdateSubscriptionOriginResponse {
2272
+ /** Updated subscription. */
1994
2273
  subscription?: Subscription;
1995
2274
  }
1996
- interface UpdatePausePaidDurationRequest {
1997
- subscriptionId?: string;
1998
- pausePaidDurationSeconds?: string;
1999
- tenantId?: string;
2000
- }
2001
- interface UpdatePausePaidDurationResponse {
2002
- }
2003
- interface UpdateStatusRequest {
2004
- subscriptionId?: string;
2005
- tenantId?: string;
2006
- status?: SubscriptionStatusEnumSubscriptionStatus;
2275
+ interface ReviseSubscriptionRequest {
2276
+ /** Subscription ID */
2277
+ _id?: string;
2278
+ /** 0 for no revision, maxSize is 100 */
2279
+ items?: Item[];
2007
2280
  }
2008
- interface UpdateStatusResponse {
2281
+ interface ReviseSubscriptionResponse {
2009
2282
  subscription?: Subscription;
2010
2283
  }
2011
- interface UpdatePaymentStatusRequest {
2012
- subscriptionId?: string;
2013
- tenantId?: string;
2014
- paymentStatus?: PaymentStatus;
2015
- }
2016
- interface UpdatePaymentStatusResponse {
2017
- subscription?: Subscription;
2284
+ interface UpdateSubscriptionItemsRequest {
2285
+ /** Subscription ID */
2286
+ _id?: string;
2287
+ /** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
2288
+ updateAction?: UpdateAction;
2289
+ /** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
2290
+ scheduleAdditionalInfo?: ScheduleAdditionalInfo;
2291
+ /** Existing items to update */
2292
+ itemsToUpdate?: ItemChange[];
2293
+ /** Items to add */
2294
+ itemsToAdd?: Item[];
2295
+ /** Existing items to delete */
2296
+ itemsToDelete?: string[] | null;
2018
2297
  }
2019
- interface ReviveSubscriptionRequest {
2020
- tenantId?: string;
2021
- subscriptionId?: string;
2022
- revivePolicy?: RevivePolicy;
2023
- isTestRun?: boolean;
2298
+ interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
2299
+ /**
2300
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2301
+ * format. The use of this field may be restricted in various BASS endpoints.
2302
+ * For example, in _Bulk Update Subscription Items_ it's only available in
2303
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2304
+ * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2305
+ * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2306
+ */
2307
+ specificDate?: Date | null;
2308
+ /**
2309
+ * When the update becomes effective, as number of billing cycles from now.
2310
+ * The use of this field may be restricted in various BASS endpoints.
2311
+ * For example, in _Pause Subscription_ it's only available in
2312
+ * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2313
+ * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2314
+ */
2315
+ numberOfCycles?: number;
2024
2316
  }
2025
- declare enum RevivePolicy {
2026
- SIMPLE = "SIMPLE",
2027
- RESUME = "RESUME"
2317
+ /** @oneof */
2318
+ interface ScheduleAdditionalInfoParamOneOf {
2319
+ /**
2320
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2321
+ * format. The use of this field may be restricted in various BASS endpoints.
2322
+ * For example, in _Bulk Update Subscription Items_ it's only available in
2323
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2324
+ * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2325
+ * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2326
+ */
2327
+ specificDate?: Date | null;
2328
+ /**
2329
+ * When the update becomes effective, as number of billing cycles from now.
2330
+ * The use of this field may be restricted in various BASS endpoints.
2331
+ * For example, in _Pause Subscription_ it's only available in
2332
+ * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2333
+ * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2334
+ */
2335
+ numberOfCycles?: number;
2028
2336
  }
2029
- interface ReviveSubscriptionResponse {
2337
+ interface UpdateSubscriptionItemsResponse {
2030
2338
  subscription?: Subscription;
2031
2339
  }
2032
- interface ConvertSapiRequest {
2033
- subscriptionId?: string;
2034
- }
2035
- interface ConvertSapiResponse {
2036
- subscription?: Subscription;
2340
+ interface BulkUpdateSubscriptionItemsByFilterRequest {
2341
+ /**
2342
+ * Filter to identify the subscriptions for which items are updated. For
2343
+ * supported fields see
2344
+ * [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).
2345
+ * Sending an empty subscription filter results in a validation error.
2346
+ * In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
2347
+ * `subscriptionId` field inside this filter. Passing any other filter results
2348
+ * in a failed validation error.
2349
+ */
2350
+ subscriptionFilter?: Record<string, any> | null;
2351
+ /**
2352
+ * Filter to specify which subscription items are updated. Make sure to use
2353
+ * the catalog item ID and not the item's unique ID. All subscription items
2354
+ * with matching `items.catalogReference.catalogItemId` are updated.
2355
+ *
2356
+ * Max: `100` reference catalog item IDs
2357
+ */
2358
+ catalogReferenceIds?: string[] | null;
2359
+ /**
2360
+ * Information about the update timing and update type.
2361
+ *
2362
+ * + `"IMMEDIATELY"`: The updates become effective immediately.
2363
+ * + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
2364
+ * + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
2365
+ * + `"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.
2366
+ */
2367
+ updateAction?: UpdateAction;
2368
+ /**
2369
+ * Additional information for updates. Currently, only supported for
2370
+ * `{"updateAction": "SPECIFIC_DATE"}`.
2371
+ */
2372
+ scheduleAdditionalInfo?: ScheduleAdditionalInfo;
2373
+ /**
2374
+ * Update details for the susbcription items that match the filtering.
2375
+ * Currently, you can update only the item price, quantity, and tax. Note
2376
+ * that all item properties are updated to the same values. In case you want set
2377
+ * different values for individual items, you must call
2378
+ * _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
2379
+ */
2380
+ bulkItemUpdateData?: BulkItemChange;
2381
+ /** __Not implemented yet__. Items to add to the subscriptions matching the filtering. */
2382
+ itemsToAdd?: Item[];
2037
2383
  }
2038
- interface GetSubscriptionInvoicesRequest {
2039
- _id?: string;
2384
+ interface BulkItemChange {
2385
+ /** Information about the new item price. */
2386
+ pricingModel?: PricingModel;
2387
+ /**
2388
+ * New item quantity.
2389
+ *
2390
+ * Min: `1`
2391
+ */
2392
+ quantity?: number | null;
2393
+ /** Information about the new item tax. */
2394
+ tax?: Tax;
2040
2395
  }
2041
- interface GetSubscriptionInvoicesResponse {
2042
- invoices?: SubscriptionInvoice[];
2396
+ interface BulkUpdateSubscriptionItemsByFilterResponse {
2397
+ /**
2398
+ * ID of your bulk job. You can use
2399
+ * [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)
2400
+ * to retrieve information about the job status.
2401
+ */
2402
+ jobId?: string;
2043
2403
  }
2044
- interface SubscriptionInvoice {
2404
+ interface DeleteSubscriptionRequest {
2045
2405
  _id?: string;
2046
- subscriptionCycle?: number;
2047
- _createdDate?: Date | null;
2406
+ revision?: string;
2048
2407
  }
2049
- interface FinishFreeTrialNowRequest {
2050
- subscriptionId?: string;
2051
- tenantId?: string;
2408
+ interface DeleteSubscriptionResponse {
2052
2409
  }
2053
- interface FinishFreeTrialNowResponse {
2054
- subscription?: Subscription;
2410
+ interface CancelSubscriptionRequest {
2411
+ _id: string;
2412
+ actionContext: ActionContext;
2055
2413
  }
2056
- interface SendTimeCapsuleTaskCanceledBIRequest {
2057
- tenantId?: string;
2058
- subscriptionId?: string;
2059
- taskType?: string;
2414
+ interface ActionContext {
2415
+ initiator?: ActionInitiator;
2416
+ /** Optional action reason message */
2417
+ reason?: string | null;
2060
2418
  }
2061
- interface Empty {
2419
+ declare enum ActionInitiator {
2420
+ UNDEFINED = "UNDEFINED",
2421
+ BUSINESS = "BUSINESS",
2422
+ CUSTOMER = "CUSTOMER",
2423
+ SYSTEM = "SYSTEM"
2062
2424
  }
2063
- interface ScheduleTimeCapsuleTaskRequest {
2064
- subscriptionId?: string;
2065
- taskType?: string;
2066
- executionTime?: Date | null;
2067
- tenantId?: string;
2425
+ interface CancelSubscriptionResponse {
2426
+ subscription?: Subscription;
2068
2427
  }
2069
- interface CancelTimeCapsuleTaskRequest {
2070
- tenantId?: string;
2071
- subscriptionId?: string;
2072
- taskType?: string;
2428
+ interface PauseSubscriptionRequest {
2429
+ _id: string;
2430
+ pausePolicy?: PausePolicy;
2431
+ pauseAt?: PauseAt;
2432
+ /** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
2433
+ pauseAtSchedule?: ScheduleAdditionalInfo;
2434
+ /** contains additional scheduling information for certain auto_resume_at either specific date */
2435
+ autoResumeAtSchedule?: ScheduleAdditionalInfo;
2436
+ actionContext: ActionContext;
2073
2437
  }
2074
- interface UpdateFullSubscriptionRequest {
2075
- tenantId?: string;
2438
+ interface PauseSubscriptionResponse {
2076
2439
  subscription?: Subscription;
2077
2440
  }
2078
- interface UpdateFullSubscriptionResponse {
2441
+ interface ResumeSubscriptionRequest {
2442
+ _id: string;
2443
+ resumeAt?: ResumeAt;
2444
+ /** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
2445
+ resumeAtSchedule?: ScheduleAdditionalInfo;
2446
+ actionContext: ActionContext;
2447
+ }
2448
+ interface ResumeSubscriptionResponse {
2079
2449
  subscription?: Subscription;
2080
2450
  }
2081
- interface UpdateSubscriptionInvoiceCycleRequest {
2082
- subscriptionId?: string;
2083
- tenantId?: string;
2084
- invoiceId?: string;
2085
- subscriptionCycle?: number;
2086
- }
2087
- interface UpdateSubscriptionInvoiceCycleResponse {
2088
- subscriptionInvoice?: SubscriptionInvoice;
2451
+ interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
2452
+ /** Limit number of results and enable to skip rows. The default limit is 25. */
2453
+ paging?: Paging;
2454
+ /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
2455
+ cursor?: CursorPaging;
2456
+ /** A filter object */
2457
+ filter?: any;
2458
+ /** A Sorting option by field name and order. */
2459
+ sorting?: SortingClauses;
2089
2460
  }
2090
- interface AddPausePeriodRequest {
2091
- tenantId?: string;
2092
- subscriptionId?: string;
2093
- pauseStartDate?: Date | null;
2094
- pauseEndDate?: Date | null;
2461
+ /** @oneof */
2462
+ interface SearchSubscriptionsRequestPagingMethodOneOf {
2463
+ /** Limit number of results and enable to skip rows. The default limit is 25. */
2464
+ paging?: Paging;
2465
+ /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
2466
+ cursor?: CursorPaging;
2095
2467
  }
2096
- interface AddPausePeriodResponse {
2097
- subscription?: Subscription;
2468
+ interface SortingClauses {
2469
+ sorting?: Sorting[];
2098
2470
  }
2099
- interface RunTimeCapsuleTaskNowRequest {
2100
- tenantId?: string;
2101
- subscriptionId?: string;
2102
- taskType?: string;
2471
+ interface SearchSubscriptionsResponse {
2472
+ subscriptions?: Subscription[];
2473
+ cursor?: CursorPaging;
2103
2474
  }
2104
- interface CreateRecurringInvoiceBORequest {
2105
- subscriptionId?: string;
2106
- tenantId?: string;
2107
- cycleNumber?: number;
2475
+ interface TurnOnSubscriptionAutoRenewalRequest {
2476
+ _id: string;
2477
+ actionContext: ActionContext;
2108
2478
  }
2109
- interface CreateRecurringInvoiceBOResponse {
2110
- invoiceId?: string;
2479
+ interface TurnOnSubscriptionAutoRenewalResponse {
2480
+ subscription?: Subscription;
2111
2481
  }
2112
- interface SetShiftingDataRequest {
2113
- subscriptionId?: string;
2114
- tenantId?: string;
2115
- isBassManaged?: boolean;
2116
- shiftManagementDate?: Date | null;
2482
+ interface TurnOffSubscriptionAutoRenewalRequest {
2483
+ _id: string;
2484
+ actionContext: ActionContext;
2117
2485
  }
2118
- interface SetShiftingDataResponse {
2486
+ interface TurnOffSubscriptionAutoRenewalResponse {
2119
2487
  subscription?: Subscription;
2120
2488
  }
2121
- interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
2122
- attachInvoice?: AttachInvoice;
2123
- detachInvoice?: DetachInvoice;
2124
- tenantId?: string;
2125
- subscriptionId?: string;
2126
- }
2127
- /** @oneof */
2128
- interface FixSubscriptionInvoicesRequestModeOneOf {
2129
- attachInvoice?: AttachInvoice;
2130
- detachInvoice?: DetachInvoice;
2489
+ interface MarkLatestInvoiceAsPaidRequest {
2490
+ /** The ID of the offline subscription to mark as paid its latest invoice */
2491
+ subscriptionId: string;
2131
2492
  }
2132
- interface AttachInvoice {
2133
- invoiceId?: string;
2493
+ interface MarkLatestInvoiceAsPaidResponse {
2494
+ subscription?: Subscription;
2134
2495
  }
2135
- interface DetachInvoice {
2136
- invoiceId?: string;
2496
+ interface GetSubscriptionsStatsRequest {
2137
2497
  }
2138
- interface FixSubscriptionInvoicesResponse {
2139
- invoices?: SubscriptionInvoice[];
2498
+ interface GetSubscriptionsStatsResponse {
2499
+ amountByStatuses?: AmountByStatus[];
2500
+ total?: number;
2140
2501
  }
2141
- interface RestoreDraftSubscriptionRequest {
2142
- tenantId?: string;
2143
- subscriptionId?: string;
2502
+ interface AmountByStatus {
2503
+ status?: SubscriptionStatusEnumSubscriptionStatus;
2504
+ amount?: number;
2144
2505
  }
2145
- interface RestoreDraftSubscriptionResponse {
2146
- subscription?: Subscription;
2506
+ interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
2507
+ /** User won't be charged for additional period added on top of subscription end date. */
2508
+ extensionPeriod?: Duration;
2509
+ /** user will be charged for billing cycles added */
2510
+ extensionBillingCycles?: number;
2511
+ /** The ID of the subscription to be extended */
2512
+ _id: string;
2513
+ actionContext: ActionContext;
2147
2514
  }
2148
- interface DeleteDraftSubscriptionRequest {
2149
- tenantId?: string;
2150
- subscriptionId?: string;
2515
+ /** @oneof */
2516
+ interface ExtendSubscriptionRequestExtendPolicyOneOf {
2517
+ /** User won't be charged for additional period added on top of subscription end date. */
2518
+ extensionPeriod?: Duration;
2519
+ /** user will be charged for billing cycles added */
2520
+ extensionBillingCycles?: number;
2151
2521
  }
2152
- interface DeleteDraftSubscriptionResponse {
2522
+ interface ExtendSubscriptionResponse {
2523
+ /** The now extended subscription */
2153
2524
  subscription?: Subscription;
2154
2525
  }
2155
- interface DeleteSubscriptionBORequest {
2156
- tenantId?: string;
2157
- subscriptionId?: string;
2526
+ interface AllowedActionsRequest {
2527
+ _id: string;
2528
+ /** List of additional fields to be included in the response. */
2529
+ fields?: RequestedFields[];
2158
2530
  }
2159
- interface DeleteSubscriptionBOResponse {
2160
- subscription?: Subscription;
2531
+ declare enum RequestedFields {
2532
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
2533
+ /** Include unsupported action list, including the reasons for the lack of support */
2534
+ UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
2161
2535
  }
2162
- interface CancelSubscriptionBORequest {
2163
- tenantId?: string;
2164
- subscriptionId?: string;
2165
- initiator?: ActionInitiator;
2166
- reason?: string | null;
2536
+ interface AllowedActionsResponse {
2537
+ /** List of actions that are allowed. */
2538
+ actions?: Action[];
2539
+ /** List of actions that are not supported, included only if requested. Provides reasons for each unsupported action. */
2540
+ unsupportedActions?: UnsupportedAction[];
2167
2541
  }
2168
- declare enum ActionInitiator {
2169
- UNDEFINED = "UNDEFINED",
2170
- BUSINESS = "BUSINESS",
2171
- CUSTOMER = "CUSTOMER",
2172
- SYSTEM = "SYSTEM"
2542
+ interface UnsupportedAction {
2543
+ actionType?: ActionType;
2544
+ /** Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed. */
2545
+ reasons?: UnsupportedReason[];
2173
2546
  }
2174
- interface CancelSubscriptionBOResponse {
2175
- subscription?: Subscription;
2547
+ interface UnsupportedReason {
2548
+ code?: string;
2549
+ description?: string | null;
2176
2550
  }
2177
- interface UpdatePaymentMethodBORequest {
2178
- tenantId?: string;
2179
- subscriptionId?: string;
2180
- paymentMethodId?: string;
2551
+ interface ListUpcomingChargesRequest {
2552
+ /** Subscription id charges to be previewed for */
2553
+ subscriptionId: string;
2554
+ /** Period of time to provide charged for. If not provided,then only next charge will be returned. */
2555
+ customDuration?: Duration;
2556
+ /**
2557
+ * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
2558
+ * If not provided, the upcoming charges will be calculated according to the existing next billing date.
2559
+ */
2560
+ nextBillingDate?: Date | null;
2181
2561
  }
2182
- interface UpdatePaymentMethodBOResponse {
2183
- subscription?: Subscription;
2562
+ interface ListUpcomingChargesResponse {
2563
+ upcomingCharges?: SubscriptionCharge[];
2184
2564
  }
2185
- interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
2186
- billingCycleStarted?: SubscriptionBillingCycleStarted;
2187
- tenantId?: string;
2188
- subscriptionId?: string;
2565
+ interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
2566
+ /** Information about a non-existing subscription. */
2567
+ subscriptionInfo?: SubscriptionInfo;
2189
2568
  }
2190
2569
  /** @oneof */
2191
- interface SendSubscriptionActionEventBORequestEventOneOf {
2192
- billingCycleStarted?: SubscriptionBillingCycleStarted;
2570
+ interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
2571
+ /** Information about a non-existing subscription. */
2572
+ subscriptionInfo?: SubscriptionInfo;
2193
2573
  }
2194
- interface SubscriptionBillingCycleStarted {
2195
- subscription?: Subscription;
2196
- /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
2197
- paymentTransactionId?: string | null;
2574
+ /** Subscription information to use for calculating the preview of charges for a subscription. */
2575
+ interface SubscriptionInfo {
2576
+ billingSettings?: BillingSettings;
2577
+ items?: Item[];
2578
+ startDate?: Date | null;
2198
2579
  }
2199
- interface SendSubscriptionActionEventResponse {
2580
+ interface PreviewSubscriptionChargesResponse {
2581
+ /** Charges for subscription. */
2582
+ charges?: Charge[];
2200
2583
  }
2201
- interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
2202
- tenantId?: string;
2203
- subscriptionId?: string;
2204
- transactionId?: string;
2584
+ /** Represents a charge applicable to a subscription. */
2585
+ interface Charge {
2586
+ /** The cycle number from which the charge starts. */
2587
+ cycleFrom?: number;
2588
+ /** The number of cycles for which the charge is applicable. */
2589
+ cycleCount?: number | null;
2590
+ /** The breakdown of the charge */
2591
+ totals?: Totals;
2592
+ /** The billing date from which the charge starts */
2593
+ cycleBillingDate?: Date | null;
2205
2594
  }
2206
- interface SetIsMigratedEvent {
2207
- subscriptionId?: string;
2595
+ interface PreviewSubscriptionsChargesRequest {
2596
+ /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
2597
+ subscriptionsBillingDetails?: SubscriptionBillingDetails[];
2598
+ /**
2599
+ * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
2600
+ * For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
2601
+ * $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
2602
+ * - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
2603
+ * - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
2604
+ * - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
2605
+ * If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
2606
+ * in this case, charges for cycle 1 through 3.
2607
+ * If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
2608
+ * then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
2609
+ */
2610
+ numberOfNextRecurringCharges?: number | null;
2208
2611
  }
2209
- interface SubscriptionDelayedSyncEvent {
2210
- subscriptionId?: string;
2612
+ interface SubscriptionBillingDetails {
2613
+ /** External identifier of the subscription */
2614
+ externalId?: string | null;
2615
+ /** Billing details parameters including schedule, currency, etc. */
2616
+ billingSettings?: BillingSettings;
2617
+ /** Items, minSize is 1, maxSize is 100 */
2618
+ items?: Item[];
2619
+ /** Subscription start date, now if not set */
2620
+ startDate?: Date | null;
2621
+ /** Shipping address associated with subscription. At the moment used only for payments. Optional. */
2622
+ shippingAddress?: FullAddressDetails;
2211
2623
  }
2212
- interface InvoiceAction extends InvoiceActionActionTypeOneOf {
2213
- payRecurring?: PayRecurringInvoice;
2624
+ interface PreviewSubscriptionsChargesResponse {
2625
+ /** Charges for the subscriptions, including an identifier. */
2626
+ subscriptionsCharges?: SubscriptionCharges[];
2214
2627
  }
2215
- /** @oneof */
2216
- interface InvoiceActionActionTypeOneOf {
2217
- payRecurring?: PayRecurringInvoice;
2628
+ interface SubscriptionCharges {
2629
+ /** External identifier of the subscription */
2630
+ externalId?: string | null;
2631
+ /** Charges for subscription. */
2632
+ charges?: Charge[];
2218
2633
  }
2219
- interface PayRecurringInvoice {
2220
- invoiceId?: string;
2221
- }
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;
2634
+ interface CreateSubscriptionForOrderRequest {
2635
+ /** Subscription needs to be created */
2636
+ subscription?: Subscription;
2637
+ /** Optional unique identifier for this request in order to prevent subscription duplications */
2638
+ idempotencyKey?: string | null;
2730
2639
  }
2731
2640
  interface CreateSubscriptionForOrderResponse {
2732
2641
  /** Created subscription */
@@ -3046,6 +2955,8 @@ interface Reschedule {
3046
2955
  executeAt?: Date | null;
3047
2956
  payload?: string | null;
3048
2957
  }
2958
+ interface Empty {
2959
+ }
3049
2960
  interface V1SubscriptionEvent extends V1SubscriptionEventEventOneOf {
3050
2961
  /** A subscriptions was created */
3051
2962
  created?: V1SubscriptionCreated;
@@ -3260,254 +3171,362 @@ declare enum SubscriptionFrequency {
3260
3171
  MONTH = "MONTH",
3261
3172
  YEAR = "YEAR"
3262
3173
  }
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;
3174
+ /** Trial period of subscription */
3175
+ interface SubscriptionTrialPeriod {
3176
+ /** trial period in units (required) */
3177
+ period?: number;
3178
+ /** units in which trial period is described (optional, default DAY) */
3179
+ unit?: SubscriptionFrequency;
3180
+ }
3181
+ declare enum CancellationInitiator {
3182
+ /** Cancellation initiator undefined */
3183
+ UNDEFINED = "UNDEFINED",
3184
+ /** Subscription was canceled by site owner (default if canceled by user or service identity) */
3185
+ OWNER = "OWNER",
3186
+ /** Subscription was canceled by member (default if canceled by member identity) */
3187
+ MEMBER = "MEMBER",
3188
+ /** Subscription was canceled because of payment failure */
3189
+ PAYMENT_FAILURE = "PAYMENT_FAILURE",
3190
+ /** Subscription was canceled because of payment setup failure */
3191
+ SETUP_FAILURE = "SETUP_FAILURE"
3192
+ }
3193
+ interface SubscriptionPolicy {
3194
+ /** Subscription expiration date can be updated */
3195
+ expiryDateChangeable?: boolean;
3196
+ /** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
3197
+ cancellableByMember?: boolean;
3198
+ /** Subscription expiration date on cancellation can be set to next payment date */
3199
+ cancellableAtNextPaymentCycle?: boolean;
3200
+ }
3201
+ interface Suspension {
3202
+ status?: Status;
3203
+ /** Beginning of the suspended period */
3204
+ startsAt?: Date | null;
3205
+ /** End of the suspended period */
3206
+ endsAt?: Date | null;
3207
+ }
3208
+ declare enum Status {
3209
+ UNDEFINED = "UNDEFINED",
3210
+ ACTIVE = "ACTIVE",
3211
+ ENDED = "ENDED"
3212
+ }
3213
+ /** A duration expressed in amount of time units. */
3214
+ interface V1Duration {
3215
+ /** Amount of the unit */
3216
+ amount?: number;
3217
+ /** Day, Week, Month, Year. */
3218
+ unit?: SubscriptionFrequency;
3219
+ }
3220
+ interface V1SubscriptionActivated {
3221
+ subscription?: V1Subscription;
3222
+ }
3223
+ interface V1SubscriptionCanceled {
3224
+ subscription?: V1Subscription;
3225
+ }
3226
+ interface V1SubscriptionUpdated {
3227
+ subscription?: V1Subscription;
3228
+ }
3229
+ interface SubscriptionCycleTriggered {
3230
+ subscription?: V1Subscription;
3231
+ billingCycle?: number;
3232
+ /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
3233
+ transactionId?: string | null;
3234
+ }
3235
+ interface SubscriptionMarkedAsPaid {
3236
+ subscription?: V1Subscription;
3237
+ /** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
3238
+ billingCycle?: number | null;
3239
+ }
3240
+ interface SubscriptionCancellationRequested {
3241
+ subscription?: V1Subscription;
3242
+ }
3243
+ interface SubscriptionSuspended {
3244
+ subscription?: V1Subscription;
3245
+ }
3246
+ interface V1SubscriptionResumed {
3247
+ subscription?: V1Subscription;
3248
+ }
3249
+ interface SubscriptionExpired {
3250
+ subscription?: V1Subscription;
3251
+ }
3252
+ interface V1SubscriptionInitialPurchaseCompleted {
3253
+ subscription?: V1Subscription;
3254
+ }
3255
+ interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
3256
+ activeSubscription?: CreateSubscriptionRequest;
3257
+ }
3258
+ /** @oneof */
3259
+ interface CreateSubscriptionInStateRequestModeOneOf {
3260
+ activeSubscription?: CreateSubscriptionRequest;
3261
+ }
3262
+ interface CreateSubscriptionInStateResponse {
3263
+ subscriptionId?: string;
3264
+ }
3265
+ interface PayCycleRequest {
3266
+ subscriptionId: string;
3267
+ paymentTestMode?: PaymentTestMode;
3268
+ tenantId: string;
3269
+ }
3270
+ declare enum PaymentTestMode {
3271
+ REGULAR = "REGULAR",
3272
+ FAIL_TECHNICAL = "FAIL_TECHNICAL",
3273
+ FAIL_DECLINE = "FAIL_DECLINE",
3274
+ FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
3275
+ }
3276
+ interface PayCycleResponse {
3277
+ invoiceId?: string;
3278
+ paymentOrderId?: string | null;
3279
+ subscription?: Subscription;
3280
+ }
3281
+ interface GetFullSubscriptionDataRequest {
3282
+ _id?: string;
3283
+ }
3284
+ interface GetFullSubscriptionDataResponse {
3285
+ subscription?: Subscription;
3286
+ internalSubscriptionData?: InternalSubscriptionData;
3287
+ }
3288
+ interface InternalSubscriptionData {
3289
+ originInstanceId?: string;
3290
+ source?: string | null;
3291
+ billingType?: string;
3292
+ isOneTime?: boolean;
3293
+ migrationDetails?: MigrationDetails;
3294
+ pausePaidDuration?: string | null;
3295
+ authorizationPaymentData?: PaymentData;
3296
+ currentCyclePausePeriods?: PausePeriod[];
3297
+ }
3298
+ interface MigrationDetails {
3299
+ /** system (application) where the Subscription has been created */
3300
+ originSystem?: string;
3301
+ /** date when the Subscription started to be managed in BASS */
3302
+ shiftManagementDate?: Date | null;
3303
+ }
3304
+ interface PausePeriod {
3305
+ startDate?: Date | null;
3306
+ endDate?: Date | null;
3307
+ }
3308
+ interface GetSubscriptionAndInternalDataRequest {
3309
+ subscriptionId?: string;
3310
+ tenantId?: string;
3311
+ }
3312
+ interface GetSubscriptionAndInternalDataResponse {
3313
+ subscription?: Subscription;
3314
+ internalSubscriptionData?: InternalSubscriptionData;
3315
+ }
3316
+ interface SearchSubscriptionRequest {
3317
+ _id?: string;
3318
+ tenantId?: string;
3319
+ }
3320
+ interface SearchSubscriptionResponse {
3321
+ subscription?: Subscription;
3322
+ }
3323
+ interface UpdatePausePaidDurationRequest {
3324
+ subscriptionId?: string;
3325
+ pausePaidDurationSeconds?: string;
3326
+ tenantId?: string;
3327
+ }
3328
+ interface UpdatePausePaidDurationResponse {
3329
+ }
3330
+ interface UpdateStatusRequest {
3331
+ subscriptionId?: string;
3332
+ tenantId?: string;
3333
+ status?: SubscriptionStatusEnumSubscriptionStatus;
3334
+ }
3335
+ interface UpdateStatusResponse {
3336
+ subscription?: Subscription;
3337
+ }
3338
+ interface UpdatePaymentStatusRequest {
3339
+ subscriptionId?: string;
3340
+ tenantId?: string;
3341
+ paymentStatus?: PaymentStatus;
3342
+ }
3343
+ interface UpdatePaymentStatusResponse {
3344
+ subscription?: Subscription;
3345
+ }
3346
+ interface ReviveSubscriptionRequest {
3347
+ tenantId?: string;
3348
+ subscriptionId?: string;
3349
+ revivePolicy?: RevivePolicy;
3350
+ isTestRun?: boolean;
3351
+ }
3352
+ declare enum RevivePolicy {
3353
+ SIMPLE = "SIMPLE",
3354
+ RESUME = "RESUME"
3355
+ }
3356
+ interface ReviveSubscriptionResponse {
3357
+ subscription?: Subscription;
3358
+ }
3359
+ interface ConvertSapiRequest {
3360
+ subscriptionId?: string;
3361
+ }
3362
+ interface ConvertSapiResponse {
3363
+ subscription?: Subscription;
3269
3364
  }
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"
3365
+ interface GetSubscriptionInvoicesRequest {
3366
+ _id?: string;
3281
3367
  }
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;
3368
+ interface GetSubscriptionInvoicesResponse {
3369
+ invoices?: SubscriptionInvoice[];
3289
3370
  }
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;
3371
+ interface SubscriptionInvoice {
3372
+ _id?: string;
3373
+ subscriptionCycle?: number;
3374
+ _createdDate?: Date | null;
3296
3375
  }
3297
- declare enum Status {
3298
- UNDEFINED = "UNDEFINED",
3299
- ACTIVE = "ACTIVE",
3300
- ENDED = "ENDED"
3376
+ interface FinishFreeTrialNowRequest {
3377
+ subscriptionId?: string;
3378
+ tenantId?: string;
3301
3379
  }
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;
3380
+ interface FinishFreeTrialNowResponse {
3381
+ subscription?: Subscription;
3308
3382
  }
3309
- interface V1SubscriptionActivated {
3310
- subscription?: V1Subscription;
3383
+ interface SendTimeCapsuleTaskCanceledBIRequest {
3384
+ tenantId?: string;
3385
+ subscriptionId?: string;
3386
+ taskType?: string;
3311
3387
  }
3312
- interface V1SubscriptionCanceled {
3313
- subscription?: V1Subscription;
3388
+ interface ScheduleTimeCapsuleTaskRequest {
3389
+ subscriptionId?: string;
3390
+ taskType?: string;
3391
+ executionTime?: Date | null;
3392
+ tenantId?: string;
3314
3393
  }
3315
- interface V1SubscriptionUpdated {
3316
- subscription?: V1Subscription;
3394
+ interface CancelTimeCapsuleTaskRequest {
3395
+ tenantId?: string;
3396
+ subscriptionId?: string;
3397
+ taskType?: string;
3317
3398
  }
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;
3399
+ interface UpdateFullSubscriptionRequest {
3400
+ tenantId?: string;
3401
+ subscription?: Subscription;
3323
3402
  }
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;
3403
+ interface UpdateFullSubscriptionResponse {
3404
+ subscription?: Subscription;
3328
3405
  }
3329
- interface SubscriptionCancellationRequested {
3330
- subscription?: V1Subscription;
3406
+ interface UpdateSubscriptionInvoiceCycleRequest {
3407
+ subscriptionId?: string;
3408
+ tenantId?: string;
3409
+ invoiceId?: string;
3410
+ subscriptionCycle?: number;
3331
3411
  }
3332
- interface SubscriptionSuspended {
3333
- subscription?: V1Subscription;
3412
+ interface UpdateSubscriptionInvoiceCycleResponse {
3413
+ subscriptionInvoice?: SubscriptionInvoice;
3334
3414
  }
3335
- interface V1SubscriptionResumed {
3336
- subscription?: V1Subscription;
3415
+ interface AddPausePeriodRequest {
3416
+ tenantId?: string;
3417
+ subscriptionId?: string;
3418
+ pauseStartDate?: Date | null;
3419
+ pauseEndDate?: Date | null;
3337
3420
  }
3338
- interface SubscriptionExpired {
3339
- subscription?: V1Subscription;
3421
+ interface AddPausePeriodResponse {
3422
+ subscription?: Subscription;
3340
3423
  }
3341
- interface V1SubscriptionInitialPurchaseCompleted {
3342
- subscription?: V1Subscription;
3424
+ interface RunTimeCapsuleTaskNowRequest {
3425
+ tenantId?: string;
3426
+ subscriptionId?: string;
3427
+ taskType?: string;
3343
3428
  }
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;
3429
+ interface CreateRecurringInvoiceBORequest {
3430
+ subscriptionId?: string;
3431
+ tenantId?: string;
3432
+ cycleNumber?: number;
3350
3433
  }
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"
3434
+ interface CreateRecurringInvoiceBOResponse {
3435
+ invoiceId?: string;
3357
3436
  }
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;
3437
+ interface SetShiftingDataRequest {
3438
+ subscriptionId?: string;
3439
+ tenantId?: string;
3440
+ isBassManaged?: boolean;
3441
+ shiftManagementDate?: Date | null;
3363
3442
  }
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;
3443
+ interface SetShiftingDataResponse {
3444
+ subscription?: Subscription;
3370
3445
  }
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;
3446
+ interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
3447
+ attachInvoice?: AttachInvoice;
3448
+ detachInvoice?: DetachInvoice;
3449
+ tenantId?: string;
3450
+ subscriptionId?: string;
3404
3451
  }
3405
3452
  /** @oneof */
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;
3453
+ interface FixSubscriptionInvoicesRequestModeOneOf {
3454
+ attachInvoice?: AttachInvoice;
3455
+ detachInvoice?: DetachInvoice;
3439
3456
  }
3440
- interface SubscriptionCreated {
3457
+ interface AttachInvoice {
3458
+ invoiceId?: string;
3459
+ }
3460
+ interface DetachInvoice {
3461
+ invoiceId?: string;
3462
+ }
3463
+ interface FixSubscriptionInvoicesResponse {
3464
+ invoices?: SubscriptionInvoice[];
3465
+ }
3466
+ interface RestoreDraftSubscriptionRequest {
3467
+ tenantId?: string;
3468
+ subscriptionId?: string;
3469
+ }
3470
+ interface RestoreDraftSubscriptionResponse {
3441
3471
  subscription?: Subscription;
3442
3472
  }
3443
- interface SubscriptionUpdated {
3444
- current?: Subscription;
3445
- previous?: Subscription;
3446
- diff?: SubscriptionDiff;
3473
+ interface DeleteDraftSubscriptionRequest {
3474
+ tenantId?: string;
3475
+ subscriptionId?: string;
3447
3476
  }
3448
- interface SubscriptionDiff {
3449
- added?: string | null;
3450
- changed?: string | null;
3451
- deleted?: string | null;
3477
+ interface DeleteDraftSubscriptionResponse {
3478
+ subscription?: Subscription;
3452
3479
  }
3453
- interface SubscriptionDeleted {
3480
+ interface DeleteSubscriptionBORequest {
3481
+ tenantId?: string;
3454
3482
  subscriptionId?: string;
3455
3483
  }
3456
- interface FutureUpdatesRequested {
3484
+ interface DeleteSubscriptionBOResponse {
3457
3485
  subscription?: Subscription;
3458
- requestedUpdateData?: SubscriptionUpdateData;
3459
3486
  }
3460
- interface UpdatesApplied {
3461
- subscription?: Subscription;
3462
- updateAction?: UpdateAction;
3463
- appliedUpdateData?: SubscriptionUpdateData;
3487
+ interface CancelSubscriptionBORequest {
3488
+ tenantId?: string;
3489
+ subscriptionId?: string;
3490
+ initiator?: ActionInitiator;
3491
+ reason?: string | null;
3464
3492
  }
3465
- interface ResetPendingUpdates {
3493
+ interface CancelSubscriptionBOResponse {
3466
3494
  subscription?: Subscription;
3467
3495
  }
3468
- interface GracePeriodStarted {
3469
- subscription?: Subscription;
3496
+ interface UpdatePaymentMethodBORequest {
3497
+ tenantId?: string;
3498
+ subscriptionId?: string;
3499
+ paymentMethodId?: string;
3470
3500
  }
3471
- interface GracePeriodEnded {
3501
+ interface UpdatePaymentMethodBOResponse {
3472
3502
  subscription?: Subscription;
3473
- /** Indication for the payment settlement method. */
3474
- paymentSettlementMethod?: PaymentSettlementMethod;
3475
3503
  }
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"
3504
+ interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
3505
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
3506
+ tenantId?: string;
3507
+ subscriptionId?: string;
3484
3508
  }
3485
- interface PaymentMethodUpdated {
3486
- subscription?: Subscription;
3487
- initiator?: HistoryActionInitiator;
3488
- paymentMode?: PaymentMode;
3509
+ /** @oneof */
3510
+ interface SendSubscriptionActionEventBORequestEventOneOf {
3511
+ billingCycleStarted?: SubscriptionBillingCycleStarted;
3489
3512
  }
3490
- interface SubscriptionCollectionMethodUpdated {
3491
- subscription?: Subscription;
3492
- newCollectionMethod?: CollectionMethodEnumCollectionMethod;
3493
- previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
3513
+ interface SendSubscriptionActionEventResponse {
3494
3514
  }
3495
- interface FreeTrailStarted {
3496
- subscription?: Subscription;
3515
+ interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
3516
+ tenantId?: string;
3517
+ subscriptionId?: string;
3518
+ transactionId?: string;
3497
3519
  }
3498
- interface FreeTrailEnded {
3499
- subscription?: Subscription;
3520
+ interface PauseSubscriptionBORequest {
3521
+ tenantId?: string;
3522
+ subscriptionId?: string;
3523
+ pausePolicy?: PausePolicy;
3524
+ pauseAt?: PauseAt;
3525
+ initiator?: ActionInitiator;
3526
+ reason?: string | null;
3500
3527
  }
3501
- interface SubscriptionBackOfficeAction {
3528
+ interface PauseSubscriptionBOResponse {
3502
3529
  subscription?: Subscription;
3503
- /** The backoffice method name */
3504
- name?: string;
3505
- /** json as string format, to store the flatted request object */
3506
- params?: string;
3507
- }
3508
- /** Defines unknown events restored from the logs */
3509
- interface UnknownSubscriptionEvent {
3510
- subscriptionAsString?: string | null;
3511
3530
  }
3512
3531
  interface CustomerNonNullableFields {
3513
3532
  visitorId: string;
@@ -3637,210 +3656,50 @@ interface FixedPriceNonNullableFields {
3637
3656
  interface PricingModelNonNullableFields {
3638
3657
  fixedPrice?: FixedPriceNonNullableFields;
3639
3658
  }
3640
- interface ItemChangeNonNullableFields {
3641
- _id: string;
3642
- pricingModel?: PricingModelNonNullableFields;
3643
- tax?: TaxNonNullableFields;
3644
- }
3645
- interface CatalogReferenceNonNullableFields {
3646
- catalogItemId: string;
3647
- }
3648
- interface ApplicationFeeNonNullableFields {
3649
- amount: string;
3650
- discounts: DiscountNonNullableFields[];
3651
- }
3652
- interface ItemNonNullableFields {
3653
- name: string;
3654
- catalogReference?: CatalogReferenceNonNullableFields;
3655
- category: ItemCategory;
3656
- quantity: number;
3657
- pricingModel?: PricingModelNonNullableFields;
3658
- tax?: TaxNonNullableFields;
3659
- discounts: DiscountNonNullableFields[];
3660
- applicationFee?: ApplicationFeeNonNullableFields;
3661
- }
3662
- interface SubscriptionUpdateDataNonNullableFields {
3663
- itemsToUpdate: ItemChangeNonNullableFields[];
3664
- itemsToAdd: ItemNonNullableFields[];
3665
- numberOfRequests: number;
3666
- }
3667
- interface SpecificDateSubscriptionUpdateDataNonNullableFields {
3668
- updateData?: SubscriptionUpdateDataNonNullableFields;
3669
- }
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[];
3684
- }
3685
- interface GetSubscriptionResponseNonNullableFields {
3686
- subscription?: SubscriptionNonNullableFields;
3687
- }
3688
- interface CustomerCancelSubscriptionResponseNonNullableFields {
3689
- subscription?: SubscriptionNonNullableFields;
3690
- }
3691
- interface CustomerTurnOnAutoRenewalResponseNonNullableFields {
3692
- subscription?: SubscriptionNonNullableFields;
3693
- }
3694
- interface CustomerTurnOffAutoRenewalResponseNonNullableFields {
3695
- subscription?: SubscriptionNonNullableFields;
3696
- }
3697
- interface CustomerExtendSubscriptionResponseNonNullableFields {
3698
- subscription?: SubscriptionNonNullableFields;
3699
- }
3700
- interface QuerySubscriptionsResponseNonNullableFields {
3701
- subscriptions: SubscriptionNonNullableFields[];
3702
- }
3703
- interface UpdateSubscriptionPaymentMethodResponseNonNullableFields {
3704
- subscription?: SubscriptionNonNullableFields;
3705
- }
3706
- interface ActionNonNullableFields {
3707
- actionType: ActionType;
3708
- pausePolicies: PausePolicy[];
3709
- pauseAt: PauseAt[];
3710
- resumeAt: ResumeAt[];
3711
- extendPolicies: ExtendPolicyType[];
3712
- }
3713
- interface CustomerAllowedActionsResponseNonNullableFields {
3714
- actions: ActionNonNullableFields[];
3715
- }
3716
- interface RecurringNonNullableFields {
3717
- cycleNumber: number;
3718
- }
3719
- interface InvoiceDiscountNonNullableFields {
3720
- amount: string;
3721
- percentage: string;
3722
- origin?: DiscountOriginNonNullableFields;
3723
- }
3724
- interface InvoiceApplicationFeeNonNullableFields {
3725
- amount: string;
3726
- discount?: InvoiceDiscountNonNullableFields;
3727
- }
3728
- interface PriceDetailsNonNullableFields {
3729
- price: string;
3730
- tax?: TaxNonNullableFields;
3731
- discount?: InvoiceDiscountNonNullableFields;
3732
- applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
3733
- }
3734
- interface LineItemTaxSummaryNonNullableFields {
3735
- aggregatedTaxAmount: string;
3736
- aggregatedTaxRate: string;
3737
- taxableAmount: string;
3738
- }
3739
- interface TaxBreakdownNonNullableFields {
3740
- taxType: string;
3741
- taxRate: string;
3742
- jurisdictionType: string;
3743
- }
3744
- interface ItemTaxDataNonNullableFields {
3745
- lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields;
3746
- taxBreakdowns: TaxBreakdownNonNullableFields[];
3747
- }
3748
- interface InvoiceItemNonNullableFields {
3749
- recurring?: RecurringNonNullableFields;
3750
- _id: string;
3751
- name: string;
3752
- catalogReference?: CatalogReferenceNonNullableFields;
3753
- category: ItemCategory;
3754
- quantity: number;
3755
- priceDetails?: PriceDetailsNonNullableFields;
3756
- totals?: TotalsNonNullableFields;
3757
- taxData?: ItemTaxDataNonNullableFields;
3758
- }
3759
- interface SubscriptionChargeNonNullableFields {
3760
- cycle: number;
3761
- totals?: TotalsNonNullableFields;
3762
- invoiceItems: InvoiceItemNonNullableFields[];
3763
- discount?: InvoiceDiscountNonNullableFields;
3764
- }
3765
- interface CustomerListUpcomingChargesResponseNonNullableFields {
3766
- upcomingCharge?: SubscriptionChargeNonNullableFields;
3767
- }
3768
- interface InitiatePaymentMethodSetupResponseNonNullableFields {
3769
- paymentOrderId: string;
3770
- }
3771
- interface PayCycleResponseNonNullableFields {
3772
- invoiceId: string;
3773
- subscription?: SubscriptionNonNullableFields;
3774
- }
3775
- interface UpdateSubscriptionBillingDateResponseNonNullableFields {
3776
- subscription?: SubscriptionNonNullableFields;
3777
- }
3778
- interface CancelSubscriptionResponseNonNullableFields {
3779
- subscription?: SubscriptionNonNullableFields;
3780
- }
3781
- interface PauseSubscriptionResponseNonNullableFields {
3782
- subscription?: SubscriptionNonNullableFields;
3783
- }
3784
- interface ResumeSubscriptionResponseNonNullableFields {
3785
- subscription?: SubscriptionNonNullableFields;
3786
- }
3787
- interface SearchSubscriptionsResponseNonNullableFields {
3788
- subscriptions: SubscriptionNonNullableFields[];
3789
- }
3790
- interface CountByStatusNonNullableFields {
3791
- status: SubscriptionStatusEnumSubscriptionStatus;
3792
- count: number;
3793
- }
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[];
3659
+ interface ItemChangeNonNullableFields {
3660
+ _id: string;
3661
+ pricingModel?: PricingModelNonNullableFields;
3662
+ tax?: TaxNonNullableFields;
3824
3663
  }
3825
- interface AllowedActionsResponseNonNullableFields {
3826
- actions: ActionNonNullableFields[];
3827
- unsupportedActions: UnsupportedActionNonNullableFields[];
3664
+ interface CatalogReferenceNonNullableFields {
3665
+ catalogItemId: string;
3828
3666
  }
3829
- interface ListUpcomingChargesResponseNonNullableFields {
3830
- upcomingCharges: SubscriptionChargeNonNullableFields[];
3667
+ interface ApplicationFeeNonNullableFields {
3668
+ amount: string;
3669
+ discounts: DiscountNonNullableFields[];
3831
3670
  }
3832
- interface ChargeNonNullableFields {
3833
- cycleFrom: number;
3834
- totals?: TotalsNonNullableFields;
3671
+ interface ItemNonNullableFields {
3672
+ name: string;
3673
+ catalogReference?: CatalogReferenceNonNullableFields;
3674
+ category: ItemCategory;
3675
+ quantity: number;
3676
+ pricingModel?: PricingModelNonNullableFields;
3677
+ tax?: TaxNonNullableFields;
3678
+ discounts: DiscountNonNullableFields[];
3679
+ applicationFee?: ApplicationFeeNonNullableFields;
3835
3680
  }
3836
- interface PreviewSubscriptionChargesResponseNonNullableFields {
3837
- charges: ChargeNonNullableFields[];
3681
+ interface SubscriptionUpdateDataNonNullableFields {
3682
+ itemsToUpdate: ItemChangeNonNullableFields[];
3683
+ itemsToAdd: ItemNonNullableFields[];
3684
+ numberOfRequests: number;
3838
3685
  }
3839
- interface SubscriptionChargesNonNullableFields {
3840
- charges: ChargeNonNullableFields[];
3686
+ interface SpecificDateSubscriptionUpdateDataNonNullableFields {
3687
+ updateData?: SubscriptionUpdateDataNonNullableFields;
3841
3688
  }
3842
- interface PreviewSubscriptionsChargesResponseNonNullableFields {
3843
- subscriptionsCharges: SubscriptionChargesNonNullableFields[];
3689
+ interface SubscriptionNonNullableFields {
3690
+ name: string;
3691
+ customer?: CustomerNonNullableFields;
3692
+ status: SubscriptionStatusEnumSubscriptionStatus;
3693
+ billingSettings?: BillingSettingsNonNullableFields;
3694
+ billingStatus?: BillingStatusNonNullableFields;
3695
+ shippingAddress?: FullAddressDetailsNonNullableFields;
3696
+ policies?: SubscriptionPoliciesNonNullableFields;
3697
+ pauseInfo?: PauseInfoNonNullableFields;
3698
+ cancellationInfo?: CancellationInfoNonNullableFields;
3699
+ pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
3700
+ bassManaged: boolean;
3701
+ specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
3702
+ items: ItemNonNullableFields[];
3844
3703
  }
3845
3704
  interface SubscriptionCreatedNonNullableFields {
3846
3705
  subscription?: SubscriptionNonNullableFields;
@@ -4008,6 +3867,166 @@ interface SubscriptionHistoryEntryNonNullableFields {
4008
3867
  interface ListSubscriptionHistoryResponseNonNullableFields {
4009
3868
  historyEntries: SubscriptionHistoryEntryNonNullableFields[];
4010
3869
  }
3870
+ interface GetSubscriptionResponseNonNullableFields {
3871
+ subscription?: SubscriptionNonNullableFields;
3872
+ }
3873
+ interface CustomerCancelSubscriptionResponseNonNullableFields {
3874
+ subscription?: SubscriptionNonNullableFields;
3875
+ }
3876
+ interface CustomerTurnOnAutoRenewalResponseNonNullableFields {
3877
+ subscription?: SubscriptionNonNullableFields;
3878
+ }
3879
+ interface CustomerTurnOffAutoRenewalResponseNonNullableFields {
3880
+ subscription?: SubscriptionNonNullableFields;
3881
+ }
3882
+ interface CustomerExtendSubscriptionResponseNonNullableFields {
3883
+ subscription?: SubscriptionNonNullableFields;
3884
+ }
3885
+ interface QuerySubscriptionsResponseNonNullableFields {
3886
+ subscriptions: SubscriptionNonNullableFields[];
3887
+ }
3888
+ interface UpdateSubscriptionPaymentMethodResponseNonNullableFields {
3889
+ subscription?: SubscriptionNonNullableFields;
3890
+ }
3891
+ interface ActionNonNullableFields {
3892
+ actionType: ActionType;
3893
+ pausePolicies: PausePolicy[];
3894
+ pauseAt: PauseAt[];
3895
+ resumeAt: ResumeAt[];
3896
+ extendPolicies: ExtendPolicyType[];
3897
+ }
3898
+ interface CustomerAllowedActionsResponseNonNullableFields {
3899
+ actions: ActionNonNullableFields[];
3900
+ }
3901
+ interface RecurringNonNullableFields {
3902
+ cycleNumber: number;
3903
+ }
3904
+ interface InvoiceDiscountNonNullableFields {
3905
+ amount: string;
3906
+ percentage: string;
3907
+ origin?: DiscountOriginNonNullableFields;
3908
+ }
3909
+ interface InvoiceApplicationFeeNonNullableFields {
3910
+ amount: string;
3911
+ discount?: InvoiceDiscountNonNullableFields;
3912
+ }
3913
+ interface PriceDetailsNonNullableFields {
3914
+ price: string;
3915
+ tax?: TaxNonNullableFields;
3916
+ discount?: InvoiceDiscountNonNullableFields;
3917
+ applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
3918
+ }
3919
+ interface LineItemTaxSummaryNonNullableFields {
3920
+ aggregatedTaxAmount: string;
3921
+ aggregatedTaxRate: string;
3922
+ taxableAmount: string;
3923
+ }
3924
+ interface TaxBreakdownNonNullableFields {
3925
+ taxType: string;
3926
+ taxRate: string;
3927
+ jurisdictionType: string;
3928
+ }
3929
+ interface ItemTaxDataNonNullableFields {
3930
+ lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields;
3931
+ taxBreakdowns: TaxBreakdownNonNullableFields[];
3932
+ }
3933
+ interface InvoiceItemNonNullableFields {
3934
+ recurring?: RecurringNonNullableFields;
3935
+ _id: string;
3936
+ name: string;
3937
+ catalogReference?: CatalogReferenceNonNullableFields;
3938
+ category: ItemCategory;
3939
+ quantity: number;
3940
+ priceDetails?: PriceDetailsNonNullableFields;
3941
+ totals?: TotalsNonNullableFields;
3942
+ taxData?: ItemTaxDataNonNullableFields;
3943
+ }
3944
+ interface SubscriptionChargeNonNullableFields {
3945
+ cycle: number;
3946
+ totals?: TotalsNonNullableFields;
3947
+ invoiceItems: InvoiceItemNonNullableFields[];
3948
+ discount?: InvoiceDiscountNonNullableFields;
3949
+ }
3950
+ interface CustomerListUpcomingChargesResponseNonNullableFields {
3951
+ upcomingCharge?: SubscriptionChargeNonNullableFields;
3952
+ }
3953
+ interface InitiatePaymentMethodSetupResponseNonNullableFields {
3954
+ paymentOrderId: string;
3955
+ }
3956
+ interface UpdateSubscriptionBillingDateResponseNonNullableFields {
3957
+ subscription?: SubscriptionNonNullableFields;
3958
+ }
3959
+ interface CancelSubscriptionResponseNonNullableFields {
3960
+ subscription?: SubscriptionNonNullableFields;
3961
+ }
3962
+ interface PauseSubscriptionResponseNonNullableFields {
3963
+ subscription?: SubscriptionNonNullableFields;
3964
+ }
3965
+ interface ResumeSubscriptionResponseNonNullableFields {
3966
+ subscription?: SubscriptionNonNullableFields;
3967
+ }
3968
+ interface SearchSubscriptionsResponseNonNullableFields {
3969
+ subscriptions: SubscriptionNonNullableFields[];
3970
+ }
3971
+ interface CountByStatusNonNullableFields {
3972
+ status: SubscriptionStatusEnumSubscriptionStatus;
3973
+ count: number;
3974
+ }
3975
+ interface CountSubscriptionsResponseNonNullableFields {
3976
+ countByStatus: CountByStatusNonNullableFields[];
3977
+ total: number;
3978
+ }
3979
+ interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
3980
+ subscription?: SubscriptionNonNullableFields;
3981
+ }
3982
+ interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
3983
+ subscription?: SubscriptionNonNullableFields;
3984
+ }
3985
+ interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
3986
+ subscription?: SubscriptionNonNullableFields;
3987
+ }
3988
+ interface AmountByStatusNonNullableFields {
3989
+ status: SubscriptionStatusEnumSubscriptionStatus;
3990
+ amount: number;
3991
+ }
3992
+ interface GetSubscriptionsStatsResponseNonNullableFields {
3993
+ amountByStatuses: AmountByStatusNonNullableFields[];
3994
+ total: number;
3995
+ }
3996
+ interface ExtendSubscriptionResponseNonNullableFields {
3997
+ subscription?: SubscriptionNonNullableFields;
3998
+ }
3999
+ interface UnsupportedReasonNonNullableFields {
4000
+ code: string;
4001
+ }
4002
+ interface UnsupportedActionNonNullableFields {
4003
+ actionType: ActionType;
4004
+ reasons: UnsupportedReasonNonNullableFields[];
4005
+ }
4006
+ interface AllowedActionsResponseNonNullableFields {
4007
+ actions: ActionNonNullableFields[];
4008
+ unsupportedActions: UnsupportedActionNonNullableFields[];
4009
+ }
4010
+ interface ListUpcomingChargesResponseNonNullableFields {
4011
+ upcomingCharges: SubscriptionChargeNonNullableFields[];
4012
+ }
4013
+ interface ChargeNonNullableFields {
4014
+ cycleFrom: number;
4015
+ totals?: TotalsNonNullableFields;
4016
+ }
4017
+ interface PreviewSubscriptionChargesResponseNonNullableFields {
4018
+ charges: ChargeNonNullableFields[];
4019
+ }
4020
+ interface SubscriptionChargesNonNullableFields {
4021
+ charges: ChargeNonNullableFields[];
4022
+ }
4023
+ interface PreviewSubscriptionsChargesResponseNonNullableFields {
4024
+ subscriptionsCharges: SubscriptionChargesNonNullableFields[];
4025
+ }
4026
+ interface PayCycleResponseNonNullableFields {
4027
+ invoiceId: string;
4028
+ subscription?: SubscriptionNonNullableFields;
4029
+ }
4011
4030
  interface BaseEventMetadata {
4012
4031
  /** App instance ID. */
4013
4032
  instanceId?: string | null;
@@ -4106,6 +4125,12 @@ interface SubscriptionResumedEnvelope {
4106
4125
  data: SubscriptionResumed;
4107
4126
  metadata: EventMetadata;
4108
4127
  }
4128
+ interface ListSubscriptionHistoryOptions {
4129
+ /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
4130
+ mode?: HistoryViewMode;
4131
+ /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
4132
+ cursor?: CursorPaging;
4133
+ }
4109
4134
  interface CustomerCancelSubscriptionOptions {
4110
4135
  /** Optional action reason message */
4111
4136
  reason?: string | null;
@@ -4131,10 +4156,6 @@ interface CustomerInitiatePaymentMethodSetupOptions {
4131
4156
  paymentMode?: PaymentMode;
4132
4157
  paymentSettings?: PaymentSettings;
4133
4158
  }
4134
- interface PayCycleOptions {
4135
- paymentTestMode?: PaymentTestMode;
4136
- tenantId: string;
4137
- }
4138
4159
  interface UpdateSubscriptionBillingDateOptions {
4139
4160
  /**
4140
4161
  * Information about how BASS adjusts the total of the next invoice. Extending
@@ -4220,13 +4241,16 @@ interface InitiatePaymentMethodSetupOptions {
4220
4241
  paymentMode?: PaymentMode;
4221
4242
  paymentSettings?: PaymentSettings;
4222
4243
  }
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;
4244
+ interface PayCycleOptions {
4245
+ paymentTestMode?: PaymentTestMode;
4246
+ tenantId: string;
4228
4247
  }
4229
4248
 
4249
+ declare function listSubscriptionHistory$1(httpClient: HttpClient): ListSubscriptionHistorySignature;
4250
+ interface ListSubscriptionHistorySignature {
4251
+ /** */
4252
+ (subscriptionId: string, options?: ListSubscriptionHistoryOptions | undefined): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
4253
+ }
4230
4254
  declare function customerGetSubscription$1(httpClient: HttpClient): CustomerGetSubscriptionSignature;
4231
4255
  interface CustomerGetSubscriptionSignature {
4232
4256
  /**
@@ -4296,13 +4320,6 @@ interface CustomerInitiatePaymentMethodSetupSignature {
4296
4320
  */
4297
4321
  (_id: string, options?: CustomerInitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
4298
4322
  }
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
- }
4306
4323
  declare function getSubscription$1(httpClient: HttpClient): GetSubscriptionSignature;
4307
4324
  interface GetSubscriptionSignature {
4308
4325
  /**
@@ -4475,10 +4492,12 @@ interface InitiatePaymentMethodSetupSignature {
4475
4492
  */
4476
4493
  (_id: string, options?: InitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
4477
4494
  }
4478
- declare function listSubscriptionHistory$1(httpClient: HttpClient): ListSubscriptionHistorySignature;
4479
- interface ListSubscriptionHistorySignature {
4480
- /** */
4481
- (subscriptionId: string, options?: ListSubscriptionHistoryOptions | undefined): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
4495
+ declare function payCycle$1(httpClient: HttpClient): PayCycleSignature;
4496
+ interface PayCycleSignature {
4497
+ /**
4498
+ * This used only for automation and permitted tenants (QA & testing)
4499
+ */
4500
+ (subscriptionId: string, options?: PayCycleOptions | undefined): Promise<PayCycleResponse & PayCycleResponseNonNullableFields>;
4482
4501
  }
4483
4502
  declare const onSubscriptionCanceled$1: EventDefinition<SubscriptionCanceledEnvelope, "wix.billing.v1.subscription_canceled">;
4484
4503
  declare const onSubscriptionExtended$1: EventDefinition<SubscriptionExtendedEnvelope, "wix.billing.v1.subscription_extended">;
@@ -4496,6 +4515,7 @@ declare const onSubscriptionResumed$1: EventDefinition<SubscriptionResumedEnvelo
4496
4515
 
4497
4516
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
4498
4517
 
4518
+ declare const listSubscriptionHistory: MaybeContext<BuildRESTFunction<typeof listSubscriptionHistory$1> & typeof listSubscriptionHistory$1>;
4499
4519
  declare const customerGetSubscription: MaybeContext<BuildRESTFunction<typeof customerGetSubscription$1> & typeof customerGetSubscription$1>;
4500
4520
  declare const customerCancelSubscription: MaybeContext<BuildRESTFunction<typeof customerCancelSubscription$1> & typeof customerCancelSubscription$1>;
4501
4521
  declare const customerTurnOnSubscriptionAutoRenewal: MaybeContext<BuildRESTFunction<typeof customerTurnOnSubscriptionAutoRenewal$1> & typeof customerTurnOnSubscriptionAutoRenewal$1>;
@@ -4506,7 +4526,6 @@ declare const customerUpdateSubscriptionPaymentMethod: MaybeContext<BuildRESTFun
4506
4526
  declare const customerAllowedActions: MaybeContext<BuildRESTFunction<typeof customerAllowedActions$1> & typeof customerAllowedActions$1>;
4507
4527
  declare const customerListUpcomingCharges: MaybeContext<BuildRESTFunction<typeof customerListUpcomingCharges$1> & typeof customerListUpcomingCharges$1>;
4508
4528
  declare const customerInitiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof customerInitiatePaymentMethodSetup$1> & typeof customerInitiatePaymentMethodSetup$1>;
4509
- declare const payCycle: MaybeContext<BuildRESTFunction<typeof payCycle$1> & typeof payCycle$1>;
4510
4529
  declare const getSubscription: MaybeContext<BuildRESTFunction<typeof getSubscription$1> & typeof getSubscription$1>;
4511
4530
  declare const updateSubscriptionPaymentMethod: MaybeContext<BuildRESTFunction<typeof updateSubscriptionPaymentMethod$1> & typeof updateSubscriptionPaymentMethod$1>;
4512
4531
  declare const updateSubscriptionBillingDate: MaybeContext<BuildRESTFunction<typeof updateSubscriptionBillingDate$1> & typeof updateSubscriptionBillingDate$1>;
@@ -4526,7 +4545,7 @@ declare const listUpcomingCharges: MaybeContext<BuildRESTFunction<typeof listUpc
4526
4545
  declare const previewSubscriptionCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionCharges$1> & typeof previewSubscriptionCharges$1>;
4527
4546
  declare const previewSubscriptionsCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionsCharges$1> & typeof previewSubscriptionsCharges$1>;
4528
4547
  declare const initiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof initiatePaymentMethodSetup$1> & typeof initiatePaymentMethodSetup$1>;
4529
- declare const listSubscriptionHistory: MaybeContext<BuildRESTFunction<typeof listSubscriptionHistory$1> & typeof listSubscriptionHistory$1>;
4548
+ declare const payCycle: MaybeContext<BuildRESTFunction<typeof payCycle$1> & typeof payCycle$1>;
4530
4549
 
4531
4550
  type _publicOnSubscriptionCanceledType = typeof onSubscriptionCanceled$1;
4532
4551
  /**
@@ -4823,6 +4842,8 @@ type context_PauseInfo = PauseInfo;
4823
4842
  type context_PausePeriod = PausePeriod;
4824
4843
  type context_PausePolicy = PausePolicy;
4825
4844
  declare const context_PausePolicy: typeof PausePolicy;
4845
+ type context_PauseSubscriptionBORequest = PauseSubscriptionBORequest;
4846
+ type context_PauseSubscriptionBOResponse = PauseSubscriptionBOResponse;
4826
4847
  type context_PauseSubscriptionOptions = PauseSubscriptionOptions;
4827
4848
  type context_PauseSubscriptionRequest = PauseSubscriptionRequest;
4828
4849
  type context_PauseSubscriptionRequested = PauseSubscriptionRequested;
@@ -4850,6 +4871,7 @@ type context_PaymentStatusEnumPaymentStatus = PaymentStatusEnumPaymentStatus;
4850
4871
  declare const context_PaymentStatusEnumPaymentStatus: typeof PaymentStatusEnumPaymentStatus;
4851
4872
  type context_PaymentTestMode = PaymentTestMode;
4852
4873
  declare const context_PaymentTestMode: typeof PaymentTestMode;
4874
+ type context_PlatformOrigin = PlatformOrigin;
4853
4875
  type context_PreviewSubscriptionChargesOptions = PreviewSubscriptionChargesOptions;
4854
4876
  type context_PreviewSubscriptionChargesRequest = PreviewSubscriptionChargesRequest;
4855
4877
  type context_PreviewSubscriptionChargesRequestSubscriptionOneOf = PreviewSubscriptionChargesRequestSubscriptionOneOf;
@@ -5116,7 +5138,7 @@ declare const context_turnOnSubscriptionAutoRenewal: typeof turnOnSubscriptionAu
5116
5138
  declare const context_updateSubscriptionBillingDate: typeof updateSubscriptionBillingDate;
5117
5139
  declare const context_updateSubscriptionPaymentMethod: typeof updateSubscriptionPaymentMethod;
5118
5140
  declare namespace context {
5119
- export { type context_Action as Action, type context_ActionContext as ActionContext, type context_ActionDetails as ActionDetails, type context_ActionEvent as ActionEvent, context_ActionInitiator as ActionInitiator, context_ActionType as ActionType, type context_AddPausePeriodRequest as AddPausePeriodRequest, type context_AddPausePeriodResponse as AddPausePeriodResponse, type context_AdditionalFee as AdditionalFee, context_AdditionalFeeTrigger as AdditionalFeeTrigger, type context_Address as Address, type context_AddressStreetOneOf as AddressStreetOneOf, type context_AggregatedTaxBreakdown as AggregatedTaxBreakdown, type context_AllowedActionsOptions as AllowedActionsOptions, type context_AllowedActionsRequest as AllowedActionsRequest, type context_AllowedActionsResponse as AllowedActionsResponse, type context_AllowedActionsResponseNonNullableFields as AllowedActionsResponseNonNullableFields, type context_AmountByStatus as AmountByStatus, type context_ApplicationFee as ApplicationFee, type context_ApplicationFeeValueOneOf as ApplicationFeeValueOneOf, type context_AttachInvoice as AttachInvoice, type context_AutomaticRetryData as AutomaticRetryData, type context_BaseEventMetadata as BaseEventMetadata, type context_BillingSettings as BillingSettings, type context_BillingStatus as BillingStatus, type context_BulkItemChange as BulkItemChange, type context_BulkUpdateSubscriptionItemsByFilterRequest as BulkUpdateSubscriptionItemsByFilterRequest, type context_BulkUpdateSubscriptionItemsByFilterResponse as BulkUpdateSubscriptionItemsByFilterResponse, type context_BusinessOrigin as BusinessOrigin, type context_BusinessOriginData as BusinessOriginData, type context_Cancel as Cancel, type context_CancelSubscriptionBORequest as CancelSubscriptionBORequest, type context_CancelSubscriptionBOResponse as CancelSubscriptionBOResponse, type context_CancelSubscriptionRequest as CancelSubscriptionRequest, type context_CancelSubscriptionResponse as CancelSubscriptionResponse, type context_CancelSubscriptionResponseNonNullableFields as CancelSubscriptionResponseNonNullableFields, type context_CancelTimeCapsuleTaskRequest as CancelTimeCapsuleTaskRequest, type context_CancellationInfo as CancellationInfo, context_CancellationInitiator as CancellationInitiator, type context_CatalogReference as CatalogReference, type context_Charge as Charge, context_CollectionMethod as CollectionMethod, context_CollectionMethodEnumCollectionMethod as CollectionMethodEnumCollectionMethod, type context_Complete as Complete, type context_ConvertSapiRequest as ConvertSapiRequest, type context_ConvertSapiResponse as ConvertSapiResponse, type context_CountByStatus as CountByStatus, type context_CountSubscriptionFilter as CountSubscriptionFilter, type context_CountSubscriptionFilterStatusOneOf as CountSubscriptionFilterStatusOneOf, type context_CountSubscriptionsOptions as CountSubscriptionsOptions, type context_CountSubscriptionsRequest as CountSubscriptionsRequest, type context_CountSubscriptionsResponse as CountSubscriptionsResponse, type context_CountSubscriptionsResponseNonNullableFields as CountSubscriptionsResponseNonNullableFields, type context_CreateRecurringInvoiceBORequest as CreateRecurringInvoiceBORequest, type context_CreateRecurringInvoiceBOResponse as CreateRecurringInvoiceBOResponse, type context_CreateSubscriptionForOrderRequest as CreateSubscriptionForOrderRequest, type context_CreateSubscriptionForOrderResponse as CreateSubscriptionForOrderResponse, type context_CreateSubscriptionInStateRequest as CreateSubscriptionInStateRequest, type context_CreateSubscriptionInStateRequestModeOneOf as CreateSubscriptionInStateRequestModeOneOf, type context_CreateSubscriptionInStateResponse as CreateSubscriptionInStateResponse, type context_CreateSubscriptionRequest as CreateSubscriptionRequest, type context_CreateSubscriptionResponse as CreateSubscriptionResponse, context_CreationMode as CreationMode, type context_CursorPaging as CursorPaging, type context_Cursors as Cursors, type context_CustomBillingSchedule as CustomBillingSchedule, type context_CustomProration as CustomProration, type context_CustomProrationAmountOneOf as CustomProrationAmountOneOf, type context_Customer as Customer, type context_CustomerAllowedActionsRequest as CustomerAllowedActionsRequest, type context_CustomerAllowedActionsResponse as CustomerAllowedActionsResponse, type context_CustomerAllowedActionsResponseNonNullableFields as CustomerAllowedActionsResponseNonNullableFields, type context_CustomerCancelSubscriptionOptions as CustomerCancelSubscriptionOptions, type context_CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequest, type context_CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponse, type context_CustomerCancelSubscriptionResponseNonNullableFields as CustomerCancelSubscriptionResponseNonNullableFields, type context_CustomerExtendSubscriptionOptions as CustomerExtendSubscriptionOptions, type context_CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequest, type context_CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponse, type context_CustomerExtendSubscriptionResponseNonNullableFields as CustomerExtendSubscriptionResponseNonNullableFields, type context_CustomerIdOneOf as CustomerIdOneOf, type context_CustomerInitiatePaymentMethodSetupOptions as CustomerInitiatePaymentMethodSetupOptions, type context_CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequest, type context_CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponse, type context_CustomerListUpcomingChargesResponseNonNullableFields as CustomerListUpcomingChargesResponseNonNullableFields, type context_CustomerQuerySubscriptionsOptions as CustomerQuerySubscriptionsOptions, type context_CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequest, type context_CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponse, type context_CustomerTurnOffAutoRenewalResponseNonNullableFields as CustomerTurnOffAutoRenewalResponseNonNullableFields, type context_CustomerTurnOffSubscriptionAutoRenewalOptions as CustomerTurnOffSubscriptionAutoRenewalOptions, type context_CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequest, type context_CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponse, type context_CustomerTurnOnAutoRenewalResponseNonNullableFields as CustomerTurnOnAutoRenewalResponseNonNullableFields, type context_CustomerTurnOnSubscriptionAutoRenewalOptions as CustomerTurnOnSubscriptionAutoRenewalOptions, type context_Cycles as Cycles, type context_DeleteDraftSubscriptionRequest as DeleteDraftSubscriptionRequest, type context_DeleteDraftSubscriptionResponse as DeleteDraftSubscriptionResponse, type context_DeleteSubscriptionBORequest as DeleteSubscriptionBORequest, type context_DeleteSubscriptionBOResponse as DeleteSubscriptionBOResponse, type context_DeleteSubscriptionRequest as DeleteSubscriptionRequest, type context_DeleteSubscriptionResponse as DeleteSubscriptionResponse, type context_DetachInvoice as DetachInvoice, type context_Discount as Discount, type context_DiscountCycles as DiscountCycles, type context_DiscountOrigin as DiscountOrigin, type context_DiscountValueOneOf as DiscountValueOneOf, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Duration as Duration, context_DurationUnit as DurationUnit, type context_DynamicTax as DynamicTax, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, context_ExtendPolicyType as ExtendPolicyType, type context_ExtendSubscriptionOptions as ExtendSubscriptionOptions, type context_ExtendSubscriptionRequest as ExtendSubscriptionRequest, type context_ExtendSubscriptionRequestExtendPolicyOneOf as ExtendSubscriptionRequestExtendPolicyOneOf, type context_ExtendSubscriptionResponse as ExtendSubscriptionResponse, type context_ExtendSubscriptionResponseNonNullableFields as ExtendSubscriptionResponseNonNullableFields, type context_ExternalCollectionDetails as ExternalCollectionDetails, type context_FinishFreeTrialNowRequest as FinishFreeTrialNowRequest, type context_FinishFreeTrialNowResponse as FinishFreeTrialNowResponse, type context_FixSubscriptionInvoicesRequest as FixSubscriptionInvoicesRequest, type context_FixSubscriptionInvoicesRequestModeOneOf as FixSubscriptionInvoicesRequestModeOneOf, type context_FixSubscriptionInvoicesResponse as FixSubscriptionInvoicesResponse, type context_FixedPrice as FixedPrice, type context_FreeTrailEnded as FreeTrailEnded, type context_FreeTrailStarted as FreeTrailStarted, type context_FreeTrialData as FreeTrialData, type context_FullAddressContactDetails as FullAddressContactDetails, type context_FullAddressDetails as FullAddressDetails, type context_FutureUpdatesRequested as FutureUpdatesRequested, type context_GetFullSubscriptionDataRequest as GetFullSubscriptionDataRequest, type context_GetFullSubscriptionDataResponse as GetFullSubscriptionDataResponse, type context_GetSubscriptionAndInternalDataRequest as GetSubscriptionAndInternalDataRequest, type context_GetSubscriptionAndInternalDataResponse as GetSubscriptionAndInternalDataResponse, type context_GetSubscriptionInvoicesRequest as GetSubscriptionInvoicesRequest, type context_GetSubscriptionInvoicesResponse as GetSubscriptionInvoicesResponse, type context_GetSubscriptionRequest as GetSubscriptionRequest, type context_GetSubscriptionResponse as GetSubscriptionResponse, type context_GetSubscriptionResponseNonNullableFields as GetSubscriptionResponseNonNullableFields, type context_GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequest, type context_GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponse, type context_GetSubscriptionsStatsResponseNonNullableFields as GetSubscriptionsStatsResponseNonNullableFields, type context_GracePeriodData as GracePeriodData, type context_GracePeriodEnded as GracePeriodEnded, type context_GracePeriodStarted as GracePeriodStarted, type context_HandleSubscriptionAfterInvoiceMarkedAsPaidRequest as HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, context_HistoryActionInitiator as HistoryActionInitiator, context_HistoryViewMode as HistoryViewMode, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_InitiatePaymentMethodSetupOptions as InitiatePaymentMethodSetupOptions, type context_InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequest, type context_InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponse, type context_InitiatePaymentMethodSetupResponseNonNullableFields as InitiatePaymentMethodSetupResponseNonNullableFields, type context_InternalSubscriptionData as InternalSubscriptionData, type context_Invoice as Invoice, type context_InvoiceAction as InvoiceAction, type context_InvoiceActionActionTypeOneOf as InvoiceActionActionTypeOneOf, type context_InvoiceApplicationFee as InvoiceApplicationFee, type context_InvoiceApplicationFeeValueOneOf as InvoiceApplicationFeeValueOneOf, type context_InvoiceDiscount as InvoiceDiscount, type context_InvoiceDiscountValueOneOf as InvoiceDiscountValueOneOf, type context_InvoiceItem as InvoiceItem, type context_InvoiceItemPaymentTypeOneOf as InvoiceItemPaymentTypeOneOf, type context_InvoiceShippingCharges as InvoiceShippingCharges, context_InvoiceStatus as InvoiceStatus, type context_Item as Item, context_ItemCategory as ItemCategory, type context_ItemChange as ItemChange, type context_ItemTaxData as ItemTaxData, type context_LatestInvoiceMarkedAsPaid as LatestInvoiceMarkedAsPaid, type context_LatestPaymentAttempt as LatestPaymentAttempt, type context_LineItemTaxSummary as LineItemTaxSummary, type context_ListSubscriptionHistoryOptions as ListSubscriptionHistoryOptions, type context_ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequest, type context_ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponse, type context_ListSubscriptionHistoryResponseNonNullableFields as ListSubscriptionHistoryResponseNonNullableFields, type context_ListUpcomingChargesOptions as ListUpcomingChargesOptions, type context_ListUpcomingChargesRequest as ListUpcomingChargesRequest, type context_ListUpcomingChargesResponse as ListUpcomingChargesResponse, type context_ListUpcomingChargesResponseNonNullableFields as ListUpcomingChargesResponseNonNullableFields, type context_MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequest, type context_MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponse, type context_MarkLatestInvoiceAsPaidResponseNonNullableFields as MarkLatestInvoiceAsPaidResponseNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_MigrationDetails as MigrationDetails, type context_Money as Money, type context_OneTime as OneTime, context_OrderMethod as OrderMethod, type context_OriginOverride as OriginOverride, type context_Paging as Paging, type context_PagingMetadataV2 as PagingMetadataV2, context_PauseAt as PauseAt, type context_PauseInfo as PauseInfo, type context_PausePeriod as PausePeriod, context_PausePolicy as PausePolicy, type context_PauseSubscriptionOptions as PauseSubscriptionOptions, type context_PauseSubscriptionRequest as PauseSubscriptionRequest, type context_PauseSubscriptionRequested as PauseSubscriptionRequested, type context_PauseSubscriptionResponse as PauseSubscriptionResponse, type context_PauseSubscriptionResponseNonNullableFields as PauseSubscriptionResponseNonNullableFields, type context_PayCycleOptions as PayCycleOptions, type context_PayCycleRequest as PayCycleRequest, type context_PayCycleResponse as PayCycleResponse, type context_PayCycleResponseNonNullableFields as PayCycleResponseNonNullableFields, type context_PayRecurringInvoice as PayRecurringInvoice, context_PaymentAttemptStatus as PaymentAttemptStatus, type context_PaymentData as PaymentData, type context_PaymentMethod as PaymentMethod, type context_PaymentMethodUpdated as PaymentMethodUpdated, context_PaymentMode as PaymentMode, type context_PaymentOrigin as PaymentOrigin, type context_PaymentSettings as PaymentSettings, context_PaymentSettlementMethod as PaymentSettlementMethod, context_PaymentStatus as PaymentStatus, context_PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatus, context_PaymentTestMode as PaymentTestMode, type context_PreviewSubscriptionChargesOptions as PreviewSubscriptionChargesOptions, type context_PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequest, type context_PreviewSubscriptionChargesRequestSubscriptionOneOf as PreviewSubscriptionChargesRequestSubscriptionOneOf, type context_PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponse, type context_PreviewSubscriptionChargesResponseNonNullableFields as PreviewSubscriptionChargesResponseNonNullableFields, type context_PreviewSubscriptionsChargesOptions as PreviewSubscriptionsChargesOptions, type context_PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequest, type context_PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponse, type context_PreviewSubscriptionsChargesResponseNonNullableFields as PreviewSubscriptionsChargesResponseNonNullableFields, type context_PriceAdjustment as PriceAdjustment, type context_PriceAdjustmentAdjustmentTypeOneOf as PriceAdjustmentAdjustmentTypeOneOf, type context_PriceAdjustmentValue as PriceAdjustmentValue, type context_PriceAdjustmentValueAdjustmentValueTypeOneOf as PriceAdjustmentValueAdjustmentValueTypeOneOf, type context_PriceDetails as PriceDetails, type context_PricingModel as PricingModel, type context_PricingModelModelOneOf as PricingModelModelOneOf, type context_Proration as Proration, type context_ProrationTypeOneOf as ProrationTypeOneOf, type context_QuerySubscriptionsRequest as QuerySubscriptionsRequest, type context_QuerySubscriptionsResponse as QuerySubscriptionsResponse, type context_QuerySubscriptionsResponseNonNullableFields as QuerySubscriptionsResponseNonNullableFields, type context_QueryV2 as QueryV2, type context_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context_Recurring as Recurring, type context_RedirectUrls as RedirectUrls, context_RequestedFields as RequestedFields, type context_Reschedule as Reschedule, type context_ResetPendingUpdates as ResetPendingUpdates, type context_RestoreDraftSubscriptionRequest as RestoreDraftSubscriptionRequest, type context_RestoreDraftSubscriptionResponse as RestoreDraftSubscriptionResponse, type context_RestoreInfo as RestoreInfo, context_ResumeAt as ResumeAt, type context_ResumeSubscriptionOptions as ResumeSubscriptionOptions, type context_ResumeSubscriptionRequest as ResumeSubscriptionRequest, type context_ResumeSubscriptionRequested as ResumeSubscriptionRequested, type context_ResumeSubscriptionResponse as ResumeSubscriptionResponse, type context_ResumeSubscriptionResponseNonNullableFields as ResumeSubscriptionResponseNonNullableFields, type context_ReviseSubscriptionRequest as ReviseSubscriptionRequest, type context_ReviseSubscriptionResponse as ReviseSubscriptionResponse, context_RevivePolicy as RevivePolicy, type context_ReviveSubscriptionRequest as ReviveSubscriptionRequest, type context_ReviveSubscriptionResponse as ReviveSubscriptionResponse, type context_RunTimeCapsuleTaskNowRequest as RunTimeCapsuleTaskNowRequest, type context_ScheduleAdditionalInfo as ScheduleAdditionalInfo, type context_ScheduleAdditionalInfoParamOneOf as ScheduleAdditionalInfoParamOneOf, type context_ScheduleTimeCapsuleTaskRequest as ScheduleTimeCapsuleTaskRequest, type context_ScheduledPauseCanceled as ScheduledPauseCanceled, type context_ScheduledResumeCanceled as ScheduledResumeCanceled, type context_SearchSubscriptionRequest as SearchSubscriptionRequest, type context_SearchSubscriptionResponse as SearchSubscriptionResponse, type context_SearchSubscriptionsOptions as SearchSubscriptionsOptions, type context_SearchSubscriptionsRequest as SearchSubscriptionsRequest, type context_SearchSubscriptionsRequestPagingMethodOneOf as SearchSubscriptionsRequestPagingMethodOneOf, type context_SearchSubscriptionsResponse as SearchSubscriptionsResponse, type context_SearchSubscriptionsResponseNonNullableFields as SearchSubscriptionsResponseNonNullableFields, type context_SendSubscriptionActionEventBORequest as SendSubscriptionActionEventBORequest, type context_SendSubscriptionActionEventBORequestEventOneOf as SendSubscriptionActionEventBORequestEventOneOf, type context_SendSubscriptionActionEventResponse as SendSubscriptionActionEventResponse, type context_SendTimeCapsuleTaskCanceledBIRequest as SendTimeCapsuleTaskCanceledBIRequest, type context_SetIsMigratedEvent as SetIsMigratedEvent, type context_SetShiftingDataRequest as SetShiftingDataRequest, type context_SetShiftingDataResponse as SetShiftingDataResponse, type context_ShippingCharges as ShippingCharges, context_SortOrder as SortOrder, type context_Sorting as Sorting, type context_SortingClauses as SortingClauses, type context_SpecificDateSubscriptionUpdateData as SpecificDateSubscriptionUpdateData, context_Status as Status, type context_StreetAddress as StreetAddress, type context_Subscriber as Subscriber, type context_Subscription as Subscription, type context_SubscriptionActivated as SubscriptionActivated, type context_SubscriptionAutoRenewalTurnedOff as SubscriptionAutoRenewalTurnedOff, type context_SubscriptionAutoRenewalTurnedOffEnvelope as SubscriptionAutoRenewalTurnedOffEnvelope, type context_SubscriptionAutoRenewalTurnedOn as SubscriptionAutoRenewalTurnedOn, type context_SubscriptionAutoRenewalTurnedOnEnvelope as SubscriptionAutoRenewalTurnedOnEnvelope, type context_SubscriptionBackOfficeAction as SubscriptionBackOfficeAction, type context_SubscriptionBillingCycleStarted as SubscriptionBillingCycleStarted, type context_SubscriptionBillingDateUpdated as SubscriptionBillingDateUpdated, type context_SubscriptionBillingDateUpdatedEnvelope as SubscriptionBillingDateUpdatedEnvelope, type context_SubscriptionBillingDetails as SubscriptionBillingDetails, type context_SubscriptionCanceled as SubscriptionCanceled, type context_SubscriptionCanceledEnvelope as SubscriptionCanceledEnvelope, type context_SubscriptionCancellationRequested as SubscriptionCancellationRequested, type context_SubscriptionCharge as SubscriptionCharge, type context_SubscriptionCharges as SubscriptionCharges, type context_SubscriptionCollectionMethodUpdated as SubscriptionCollectionMethodUpdated, type context_SubscriptionCreated as SubscriptionCreated, type context_SubscriptionCycleReadyToPay as SubscriptionCycleReadyToPay, type context_SubscriptionCycleTriggered as SubscriptionCycleTriggered, type context_SubscriptionDelayedSyncEvent as SubscriptionDelayedSyncEvent, type context_SubscriptionDeleted as SubscriptionDeleted, type context_SubscriptionDiff as SubscriptionDiff, type context_SubscriptionEnded as SubscriptionEnded, type context_SubscriptionEvent as SubscriptionEvent, type context_SubscriptionEventPayloadOneOf as SubscriptionEventPayloadOneOf, type context_SubscriptionExpired as SubscriptionExpired, type context_SubscriptionExtended as SubscriptionExtended, type context_SubscriptionExtendedEnvelope as SubscriptionExtendedEnvelope, type context_SubscriptionExtendedExtendPolicyOneOf as SubscriptionExtendedExtendPolicyOneOf, context_SubscriptionFrequency as SubscriptionFrequency, type context_SubscriptionHistoryEntry as SubscriptionHistoryEntry, type context_SubscriptionInfo as SubscriptionInfo, type context_SubscriptionInitialPurchaseCompleted as SubscriptionInitialPurchaseCompleted, type context_SubscriptionInvoice as SubscriptionInvoice, type context_SubscriptionLatestInvoiceMarkedAsPaidEnvelope as SubscriptionLatestInvoiceMarkedAsPaidEnvelope, type context_SubscriptionMarkedAsPaid as SubscriptionMarkedAsPaid, type context_SubscriptionPauseScheduleCanceledEnvelope as SubscriptionPauseScheduleCanceledEnvelope, type context_SubscriptionPauseScheduledEnvelope as SubscriptionPauseScheduledEnvelope, type context_SubscriptionPaused as SubscriptionPaused, type context_SubscriptionPausedEnvelope as SubscriptionPausedEnvelope, type context_SubscriptionPolicies as SubscriptionPolicies, type context_SubscriptionPolicy as SubscriptionPolicy, type context_SubscriptionResumeScheduleCanceledEnvelope as SubscriptionResumeScheduleCanceledEnvelope, type context_SubscriptionResumeScheduledEnvelope as SubscriptionResumeScheduledEnvelope, type context_SubscriptionResumed as SubscriptionResumed, type context_SubscriptionResumedEnvelope as SubscriptionResumedEnvelope, type context_SubscriptionRevived as SubscriptionRevived, type context_SubscriptionStatus as SubscriptionStatus, context_SubscriptionStatusEnumSubscriptionStatus as SubscriptionStatusEnumSubscriptionStatus, context_SubscriptionStatusGroup as SubscriptionStatusGroup, type context_SubscriptionSuspended as SubscriptionSuspended, type context_SubscriptionTrialPeriod as SubscriptionTrialPeriod, context_SubscriptionType as SubscriptionType, type context_SubscriptionUpdateData as SubscriptionUpdateData, type context_SubscriptionUpdated as SubscriptionUpdated, type context_SubscriptionUpdatedEnvelope as SubscriptionUpdatedEnvelope, type context_Suspension as Suspension, type context_Task as Task, type context_TaskAction as TaskAction, type context_TaskActionActionOneOf as TaskActionActionOneOf, type context_TaskKey as TaskKey, type context_Tax as Tax, type context_TaxBreakdown as TaxBreakdown, type context_TaxData as TaxData, type context_TaxSettings as TaxSettings, type context_TaxSummary as TaxSummary, type context_TaxValueOneOf as TaxValueOneOf, context_TaxableAddressType as TaxableAddressType, type context_TimeBasedProration as TimeBasedProration, type context_Totals as Totals, type context_TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequest, type context_TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponse, type context_TurnOffSubscriptionAutoRenewalResponseNonNullableFields as TurnOffSubscriptionAutoRenewalResponseNonNullableFields, type context_TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequest, type context_TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponse, type context_TurnOnSubscriptionAutoRenewalResponseNonNullableFields as TurnOnSubscriptionAutoRenewalResponseNonNullableFields, type context_UnknownSubscriptionEvent as UnknownSubscriptionEvent, type context_UnsupportedAction as UnsupportedAction, type context_UnsupportedReason as UnsupportedReason, context_UpdateAction as UpdateAction, type context_UpdateBillingDateData as UpdateBillingDateData, type context_UpdateFullSubscriptionRequest as UpdateFullSubscriptionRequest, type context_UpdateFullSubscriptionResponse as UpdateFullSubscriptionResponse, type context_UpdatePausePaidDurationRequest as UpdatePausePaidDurationRequest, type context_UpdatePausePaidDurationResponse as UpdatePausePaidDurationResponse, type context_UpdatePaymentMethodBORequest as UpdatePaymentMethodBORequest, type context_UpdatePaymentMethodBOResponse as UpdatePaymentMethodBOResponse, type context_UpdatePaymentStatusRequest as UpdatePaymentStatusRequest, type context_UpdatePaymentStatusResponse as UpdatePaymentStatusResponse, type context_UpdateStatusRequest as UpdateStatusRequest, type context_UpdateStatusResponse as UpdateStatusResponse, type context_UpdateSubscriptionBillingDateOptions as UpdateSubscriptionBillingDateOptions, type context_UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequest, type context_UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponse, type context_UpdateSubscriptionBillingDateResponseNonNullableFields as UpdateSubscriptionBillingDateResponseNonNullableFields, type context_UpdateSubscriptionInvoiceCycleRequest as UpdateSubscriptionInvoiceCycleRequest, type context_UpdateSubscriptionInvoiceCycleResponse as UpdateSubscriptionInvoiceCycleResponse, type context_UpdateSubscriptionItemsRequest as UpdateSubscriptionItemsRequest, type context_UpdateSubscriptionItemsResponse as UpdateSubscriptionItemsResponse, type context_UpdateSubscriptionOriginRequest as UpdateSubscriptionOriginRequest, type context_UpdateSubscriptionOriginResponse as UpdateSubscriptionOriginResponse, type context_UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequest, type context_UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponse, type context_UpdateSubscriptionPaymentMethodResponseNonNullableFields as UpdateSubscriptionPaymentMethodResponseNonNullableFields, type context_UpdateSubscriptionPoliciesRequest as UpdateSubscriptionPoliciesRequest, type context_UpdateSubscriptionPoliciesResponse as UpdateSubscriptionPoliciesResponse, type context_UpdateSubscriptionRequest as UpdateSubscriptionRequest, type context_UpdateSubscriptionResponse as UpdateSubscriptionResponse, type context_UpdateSubscriptionStartDateRequest as UpdateSubscriptionStartDateRequest, type context_UpdateSubscriptionStartDateResponse as UpdateSubscriptionStartDateResponse, type context_UpdatesApplied as UpdatesApplied, type context_V1Duration as V1Duration, type context_V1Subscription as V1Subscription, type context_V1SubscriptionActivated as V1SubscriptionActivated, type context_V1SubscriptionCanceled as V1SubscriptionCanceled, type context_V1SubscriptionCreated as V1SubscriptionCreated, type context_V1SubscriptionEvent as V1SubscriptionEvent, type context_V1SubscriptionEventEventOneOf as V1SubscriptionEventEventOneOf, type context_V1SubscriptionInitialPurchaseCompleted as V1SubscriptionInitialPurchaseCompleted, type context_V1SubscriptionResumed as V1SubscriptionResumed, context_V1SubscriptionStatusEnumSubscriptionStatus as V1SubscriptionStatusEnumSubscriptionStatus, type context_V1SubscriptionUpdated as V1SubscriptionUpdated, type context_V2Subscription as V2Subscription, context_WebhookIdentityType as WebhookIdentityType, type context__publicOnSubscriptionAutoRenewalTurnedOffType as _publicOnSubscriptionAutoRenewalTurnedOffType, type context__publicOnSubscriptionAutoRenewalTurnedOnType as _publicOnSubscriptionAutoRenewalTurnedOnType, type context__publicOnSubscriptionBillingDateUpdatedType as _publicOnSubscriptionBillingDateUpdatedType, type context__publicOnSubscriptionCanceledType as _publicOnSubscriptionCanceledType, type context__publicOnSubscriptionExtendedType as _publicOnSubscriptionExtendedType, type context__publicOnSubscriptionLatestInvoiceMarkedAsPaidType as _publicOnSubscriptionLatestInvoiceMarkedAsPaidType, type context__publicOnSubscriptionPauseScheduleCanceledType as _publicOnSubscriptionPauseScheduleCanceledType, type context__publicOnSubscriptionPauseScheduledType as _publicOnSubscriptionPauseScheduledType, type context__publicOnSubscriptionPausedType as _publicOnSubscriptionPausedType, type context__publicOnSubscriptionResumeScheduleCanceledType as _publicOnSubscriptionResumeScheduleCanceledType, type context__publicOnSubscriptionResumeScheduledType as _publicOnSubscriptionResumeScheduledType, type context__publicOnSubscriptionResumedType as _publicOnSubscriptionResumedType, type context__publicOnSubscriptionUpdatedType as _publicOnSubscriptionUpdatedType, context_allowedActions as allowedActions, context_cancelSubscription as cancelSubscription, context_countSubscriptions as countSubscriptions, context_customerAllowedActions as customerAllowedActions, context_customerCancelSubscription as customerCancelSubscription, context_customerExtendSubscription as customerExtendSubscription, context_customerGetSubscription as customerGetSubscription, context_customerInitiatePaymentMethodSetup as customerInitiatePaymentMethodSetup, context_customerListUpcomingCharges as customerListUpcomingCharges, context_customerQuerySubscriptions as customerQuerySubscriptions, context_customerTurnOffSubscriptionAutoRenewal as customerTurnOffSubscriptionAutoRenewal, context_customerTurnOnSubscriptionAutoRenewal as customerTurnOnSubscriptionAutoRenewal, context_customerUpdateSubscriptionPaymentMethod as customerUpdateSubscriptionPaymentMethod, context_extendSubscription as extendSubscription, context_getSubscription as getSubscription, context_getSubscriptionsStats as getSubscriptionsStats, context_initiatePaymentMethodSetup as initiatePaymentMethodSetup, context_listSubscriptionHistory as listSubscriptionHistory, context_listUpcomingCharges as listUpcomingCharges, context_markLatestInvoiceAsPaid as markLatestInvoiceAsPaid, context_onSubscriptionAutoRenewalTurnedOff as onSubscriptionAutoRenewalTurnedOff, context_onSubscriptionAutoRenewalTurnedOn as onSubscriptionAutoRenewalTurnedOn, context_onSubscriptionBillingDateUpdated as onSubscriptionBillingDateUpdated, context_onSubscriptionCanceled as onSubscriptionCanceled, context_onSubscriptionExtended as onSubscriptionExtended, context_onSubscriptionLatestInvoiceMarkedAsPaid as onSubscriptionLatestInvoiceMarkedAsPaid, context_onSubscriptionPauseScheduleCanceled as onSubscriptionPauseScheduleCanceled, context_onSubscriptionPauseScheduled as onSubscriptionPauseScheduled, context_onSubscriptionPaused as onSubscriptionPaused, context_onSubscriptionResumeScheduleCanceled as onSubscriptionResumeScheduleCanceled, context_onSubscriptionResumeScheduled as onSubscriptionResumeScheduled, context_onSubscriptionResumed as onSubscriptionResumed, context_onSubscriptionUpdated as onSubscriptionUpdated, context_pauseSubscription as pauseSubscription, context_payCycle as payCycle, context_previewSubscriptionCharges as previewSubscriptionCharges, context_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, context_querySubscriptions as querySubscriptions, context_resumeSubscription as resumeSubscription, context_searchSubscriptions as searchSubscriptions, context_turnOffSubscriptionAutoRenewal as turnOffSubscriptionAutoRenewal, context_turnOnSubscriptionAutoRenewal as turnOnSubscriptionAutoRenewal, context_updateSubscriptionBillingDate as updateSubscriptionBillingDate, context_updateSubscriptionPaymentMethod as updateSubscriptionPaymentMethod };
5141
+ export { type context_Action as Action, type context_ActionContext as ActionContext, type context_ActionDetails as ActionDetails, type context_ActionEvent as ActionEvent, context_ActionInitiator as ActionInitiator, context_ActionType as ActionType, type context_AddPausePeriodRequest as AddPausePeriodRequest, type context_AddPausePeriodResponse as AddPausePeriodResponse, type context_AdditionalFee as AdditionalFee, context_AdditionalFeeTrigger as AdditionalFeeTrigger, type context_Address as Address, type context_AddressStreetOneOf as AddressStreetOneOf, type context_AggregatedTaxBreakdown as AggregatedTaxBreakdown, type context_AllowedActionsOptions as AllowedActionsOptions, type context_AllowedActionsRequest as AllowedActionsRequest, type context_AllowedActionsResponse as AllowedActionsResponse, type context_AllowedActionsResponseNonNullableFields as AllowedActionsResponseNonNullableFields, type context_AmountByStatus as AmountByStatus, type context_ApplicationFee as ApplicationFee, type context_ApplicationFeeValueOneOf as ApplicationFeeValueOneOf, type context_AttachInvoice as AttachInvoice, type context_AutomaticRetryData as AutomaticRetryData, type context_BaseEventMetadata as BaseEventMetadata, type context_BillingSettings as BillingSettings, type context_BillingStatus as BillingStatus, type context_BulkItemChange as BulkItemChange, type context_BulkUpdateSubscriptionItemsByFilterRequest as BulkUpdateSubscriptionItemsByFilterRequest, type context_BulkUpdateSubscriptionItemsByFilterResponse as BulkUpdateSubscriptionItemsByFilterResponse, type context_BusinessOrigin as BusinessOrigin, type context_BusinessOriginData as BusinessOriginData, type context_Cancel as Cancel, type context_CancelSubscriptionBORequest as CancelSubscriptionBORequest, type context_CancelSubscriptionBOResponse as CancelSubscriptionBOResponse, type context_CancelSubscriptionRequest as CancelSubscriptionRequest, type context_CancelSubscriptionResponse as CancelSubscriptionResponse, type context_CancelSubscriptionResponseNonNullableFields as CancelSubscriptionResponseNonNullableFields, type context_CancelTimeCapsuleTaskRequest as CancelTimeCapsuleTaskRequest, type context_CancellationInfo as CancellationInfo, context_CancellationInitiator as CancellationInitiator, type context_CatalogReference as CatalogReference, type context_Charge as Charge, context_CollectionMethod as CollectionMethod, context_CollectionMethodEnumCollectionMethod as CollectionMethodEnumCollectionMethod, type context_Complete as Complete, type context_ConvertSapiRequest as ConvertSapiRequest, type context_ConvertSapiResponse as ConvertSapiResponse, type context_CountByStatus as CountByStatus, type context_CountSubscriptionFilter as CountSubscriptionFilter, type context_CountSubscriptionFilterStatusOneOf as CountSubscriptionFilterStatusOneOf, type context_CountSubscriptionsOptions as CountSubscriptionsOptions, type context_CountSubscriptionsRequest as CountSubscriptionsRequest, type context_CountSubscriptionsResponse as CountSubscriptionsResponse, type context_CountSubscriptionsResponseNonNullableFields as CountSubscriptionsResponseNonNullableFields, type context_CreateRecurringInvoiceBORequest as CreateRecurringInvoiceBORequest, type context_CreateRecurringInvoiceBOResponse as CreateRecurringInvoiceBOResponse, type context_CreateSubscriptionForOrderRequest as CreateSubscriptionForOrderRequest, type context_CreateSubscriptionForOrderResponse as CreateSubscriptionForOrderResponse, type context_CreateSubscriptionInStateRequest as CreateSubscriptionInStateRequest, type context_CreateSubscriptionInStateRequestModeOneOf as CreateSubscriptionInStateRequestModeOneOf, type context_CreateSubscriptionInStateResponse as CreateSubscriptionInStateResponse, type context_CreateSubscriptionRequest as CreateSubscriptionRequest, type context_CreateSubscriptionResponse as CreateSubscriptionResponse, context_CreationMode as CreationMode, type context_CursorPaging as CursorPaging, type context_Cursors as Cursors, type context_CustomBillingSchedule as CustomBillingSchedule, type context_CustomProration as CustomProration, type context_CustomProrationAmountOneOf as CustomProrationAmountOneOf, type context_Customer as Customer, type context_CustomerAllowedActionsRequest as CustomerAllowedActionsRequest, type context_CustomerAllowedActionsResponse as CustomerAllowedActionsResponse, type context_CustomerAllowedActionsResponseNonNullableFields as CustomerAllowedActionsResponseNonNullableFields, type context_CustomerCancelSubscriptionOptions as CustomerCancelSubscriptionOptions, type context_CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequest, type context_CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponse, type context_CustomerCancelSubscriptionResponseNonNullableFields as CustomerCancelSubscriptionResponseNonNullableFields, type context_CustomerExtendSubscriptionOptions as CustomerExtendSubscriptionOptions, type context_CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequest, type context_CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponse, type context_CustomerExtendSubscriptionResponseNonNullableFields as CustomerExtendSubscriptionResponseNonNullableFields, type context_CustomerIdOneOf as CustomerIdOneOf, type context_CustomerInitiatePaymentMethodSetupOptions as CustomerInitiatePaymentMethodSetupOptions, type context_CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequest, type context_CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponse, type context_CustomerListUpcomingChargesResponseNonNullableFields as CustomerListUpcomingChargesResponseNonNullableFields, type context_CustomerQuerySubscriptionsOptions as CustomerQuerySubscriptionsOptions, type context_CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequest, type context_CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponse, type context_CustomerTurnOffAutoRenewalResponseNonNullableFields as CustomerTurnOffAutoRenewalResponseNonNullableFields, type context_CustomerTurnOffSubscriptionAutoRenewalOptions as CustomerTurnOffSubscriptionAutoRenewalOptions, type context_CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequest, type context_CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponse, type context_CustomerTurnOnAutoRenewalResponseNonNullableFields as CustomerTurnOnAutoRenewalResponseNonNullableFields, type context_CustomerTurnOnSubscriptionAutoRenewalOptions as CustomerTurnOnSubscriptionAutoRenewalOptions, type context_Cycles as Cycles, type context_DeleteDraftSubscriptionRequest as DeleteDraftSubscriptionRequest, type context_DeleteDraftSubscriptionResponse as DeleteDraftSubscriptionResponse, type context_DeleteSubscriptionBORequest as DeleteSubscriptionBORequest, type context_DeleteSubscriptionBOResponse as DeleteSubscriptionBOResponse, type context_DeleteSubscriptionRequest as DeleteSubscriptionRequest, type context_DeleteSubscriptionResponse as DeleteSubscriptionResponse, type context_DetachInvoice as DetachInvoice, type context_Discount as Discount, type context_DiscountCycles as DiscountCycles, type context_DiscountOrigin as DiscountOrigin, type context_DiscountValueOneOf as DiscountValueOneOf, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Duration as Duration, context_DurationUnit as DurationUnit, type context_DynamicTax as DynamicTax, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, context_ExtendPolicyType as ExtendPolicyType, type context_ExtendSubscriptionOptions as ExtendSubscriptionOptions, type context_ExtendSubscriptionRequest as ExtendSubscriptionRequest, type context_ExtendSubscriptionRequestExtendPolicyOneOf as ExtendSubscriptionRequestExtendPolicyOneOf, type context_ExtendSubscriptionResponse as ExtendSubscriptionResponse, type context_ExtendSubscriptionResponseNonNullableFields as ExtendSubscriptionResponseNonNullableFields, type context_ExternalCollectionDetails as ExternalCollectionDetails, type context_FinishFreeTrialNowRequest as FinishFreeTrialNowRequest, type context_FinishFreeTrialNowResponse as FinishFreeTrialNowResponse, type context_FixSubscriptionInvoicesRequest as FixSubscriptionInvoicesRequest, type context_FixSubscriptionInvoicesRequestModeOneOf as FixSubscriptionInvoicesRequestModeOneOf, type context_FixSubscriptionInvoicesResponse as FixSubscriptionInvoicesResponse, type context_FixedPrice as FixedPrice, type context_FreeTrailEnded as FreeTrailEnded, type context_FreeTrailStarted as FreeTrailStarted, type context_FreeTrialData as FreeTrialData, type context_FullAddressContactDetails as FullAddressContactDetails, type context_FullAddressDetails as FullAddressDetails, type context_FutureUpdatesRequested as FutureUpdatesRequested, type context_GetFullSubscriptionDataRequest as GetFullSubscriptionDataRequest, type context_GetFullSubscriptionDataResponse as GetFullSubscriptionDataResponse, type context_GetSubscriptionAndInternalDataRequest as GetSubscriptionAndInternalDataRequest, type context_GetSubscriptionAndInternalDataResponse as GetSubscriptionAndInternalDataResponse, type context_GetSubscriptionInvoicesRequest as GetSubscriptionInvoicesRequest, type context_GetSubscriptionInvoicesResponse as GetSubscriptionInvoicesResponse, type context_GetSubscriptionRequest as GetSubscriptionRequest, type context_GetSubscriptionResponse as GetSubscriptionResponse, type context_GetSubscriptionResponseNonNullableFields as GetSubscriptionResponseNonNullableFields, type context_GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequest, type context_GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponse, type context_GetSubscriptionsStatsResponseNonNullableFields as GetSubscriptionsStatsResponseNonNullableFields, type context_GracePeriodData as GracePeriodData, type context_GracePeriodEnded as GracePeriodEnded, type context_GracePeriodStarted as GracePeriodStarted, type context_HandleSubscriptionAfterInvoiceMarkedAsPaidRequest as HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, context_HistoryActionInitiator as HistoryActionInitiator, context_HistoryViewMode as HistoryViewMode, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_InitiatePaymentMethodSetupOptions as InitiatePaymentMethodSetupOptions, type context_InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequest, type context_InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponse, type context_InitiatePaymentMethodSetupResponseNonNullableFields as InitiatePaymentMethodSetupResponseNonNullableFields, type context_InternalSubscriptionData as InternalSubscriptionData, type context_Invoice as Invoice, type context_InvoiceAction as InvoiceAction, type context_InvoiceActionActionTypeOneOf as InvoiceActionActionTypeOneOf, type context_InvoiceApplicationFee as InvoiceApplicationFee, type context_InvoiceApplicationFeeValueOneOf as InvoiceApplicationFeeValueOneOf, type context_InvoiceDiscount as InvoiceDiscount, type context_InvoiceDiscountValueOneOf as InvoiceDiscountValueOneOf, type context_InvoiceItem as InvoiceItem, type context_InvoiceItemPaymentTypeOneOf as InvoiceItemPaymentTypeOneOf, type context_InvoiceShippingCharges as InvoiceShippingCharges, context_InvoiceStatus as InvoiceStatus, type context_Item as Item, context_ItemCategory as ItemCategory, type context_ItemChange as ItemChange, type context_ItemTaxData as ItemTaxData, type context_LatestInvoiceMarkedAsPaid as LatestInvoiceMarkedAsPaid, type context_LatestPaymentAttempt as LatestPaymentAttempt, type context_LineItemTaxSummary as LineItemTaxSummary, type context_ListSubscriptionHistoryOptions as ListSubscriptionHistoryOptions, type context_ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequest, type context_ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponse, type context_ListSubscriptionHistoryResponseNonNullableFields as ListSubscriptionHistoryResponseNonNullableFields, type context_ListUpcomingChargesOptions as ListUpcomingChargesOptions, type context_ListUpcomingChargesRequest as ListUpcomingChargesRequest, type context_ListUpcomingChargesResponse as ListUpcomingChargesResponse, type context_ListUpcomingChargesResponseNonNullableFields as ListUpcomingChargesResponseNonNullableFields, type context_MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequest, type context_MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponse, type context_MarkLatestInvoiceAsPaidResponseNonNullableFields as MarkLatestInvoiceAsPaidResponseNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_MigrationDetails as MigrationDetails, type context_Money as Money, type context_OneTime as OneTime, context_OrderMethod as OrderMethod, type context_OriginOverride as OriginOverride, type context_Paging as Paging, type context_PagingMetadataV2 as PagingMetadataV2, context_PauseAt as PauseAt, type context_PauseInfo as PauseInfo, type context_PausePeriod as PausePeriod, context_PausePolicy as PausePolicy, type context_PauseSubscriptionBORequest as PauseSubscriptionBORequest, type context_PauseSubscriptionBOResponse as PauseSubscriptionBOResponse, type context_PauseSubscriptionOptions as PauseSubscriptionOptions, type context_PauseSubscriptionRequest as PauseSubscriptionRequest, type context_PauseSubscriptionRequested as PauseSubscriptionRequested, type context_PauseSubscriptionResponse as PauseSubscriptionResponse, type context_PauseSubscriptionResponseNonNullableFields as PauseSubscriptionResponseNonNullableFields, type context_PayCycleOptions as PayCycleOptions, type context_PayCycleRequest as PayCycleRequest, type context_PayCycleResponse as PayCycleResponse, type context_PayCycleResponseNonNullableFields as PayCycleResponseNonNullableFields, type context_PayRecurringInvoice as PayRecurringInvoice, context_PaymentAttemptStatus as PaymentAttemptStatus, type context_PaymentData as PaymentData, type context_PaymentMethod as PaymentMethod, type context_PaymentMethodUpdated as PaymentMethodUpdated, context_PaymentMode as PaymentMode, type context_PaymentOrigin as PaymentOrigin, type context_PaymentSettings as PaymentSettings, context_PaymentSettlementMethod as PaymentSettlementMethod, context_PaymentStatus as PaymentStatus, context_PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatus, context_PaymentTestMode as PaymentTestMode, type context_PlatformOrigin as PlatformOrigin, type context_PreviewSubscriptionChargesOptions as PreviewSubscriptionChargesOptions, type context_PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequest, type context_PreviewSubscriptionChargesRequestSubscriptionOneOf as PreviewSubscriptionChargesRequestSubscriptionOneOf, type context_PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponse, type context_PreviewSubscriptionChargesResponseNonNullableFields as PreviewSubscriptionChargesResponseNonNullableFields, type context_PreviewSubscriptionsChargesOptions as PreviewSubscriptionsChargesOptions, type context_PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequest, type context_PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponse, type context_PreviewSubscriptionsChargesResponseNonNullableFields as PreviewSubscriptionsChargesResponseNonNullableFields, type context_PriceAdjustment as PriceAdjustment, type context_PriceAdjustmentAdjustmentTypeOneOf as PriceAdjustmentAdjustmentTypeOneOf, type context_PriceAdjustmentValue as PriceAdjustmentValue, type context_PriceAdjustmentValueAdjustmentValueTypeOneOf as PriceAdjustmentValueAdjustmentValueTypeOneOf, type context_PriceDetails as PriceDetails, type context_PricingModel as PricingModel, type context_PricingModelModelOneOf as PricingModelModelOneOf, type context_Proration as Proration, type context_ProrationTypeOneOf as ProrationTypeOneOf, type context_QuerySubscriptionsRequest as QuerySubscriptionsRequest, type context_QuerySubscriptionsResponse as QuerySubscriptionsResponse, type context_QuerySubscriptionsResponseNonNullableFields as QuerySubscriptionsResponseNonNullableFields, type context_QueryV2 as QueryV2, type context_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context_Recurring as Recurring, type context_RedirectUrls as RedirectUrls, context_RequestedFields as RequestedFields, type context_Reschedule as Reschedule, type context_ResetPendingUpdates as ResetPendingUpdates, type context_RestoreDraftSubscriptionRequest as RestoreDraftSubscriptionRequest, type context_RestoreDraftSubscriptionResponse as RestoreDraftSubscriptionResponse, type context_RestoreInfo as RestoreInfo, context_ResumeAt as ResumeAt, type context_ResumeSubscriptionOptions as ResumeSubscriptionOptions, type context_ResumeSubscriptionRequest as ResumeSubscriptionRequest, type context_ResumeSubscriptionRequested as ResumeSubscriptionRequested, type context_ResumeSubscriptionResponse as ResumeSubscriptionResponse, type context_ResumeSubscriptionResponseNonNullableFields as ResumeSubscriptionResponseNonNullableFields, type context_ReviseSubscriptionRequest as ReviseSubscriptionRequest, type context_ReviseSubscriptionResponse as ReviseSubscriptionResponse, context_RevivePolicy as RevivePolicy, type context_ReviveSubscriptionRequest as ReviveSubscriptionRequest, type context_ReviveSubscriptionResponse as ReviveSubscriptionResponse, type context_RunTimeCapsuleTaskNowRequest as RunTimeCapsuleTaskNowRequest, type context_ScheduleAdditionalInfo as ScheduleAdditionalInfo, type context_ScheduleAdditionalInfoParamOneOf as ScheduleAdditionalInfoParamOneOf, type context_ScheduleTimeCapsuleTaskRequest as ScheduleTimeCapsuleTaskRequest, type context_ScheduledPauseCanceled as ScheduledPauseCanceled, type context_ScheduledResumeCanceled as ScheduledResumeCanceled, type context_SearchSubscriptionRequest as SearchSubscriptionRequest, type context_SearchSubscriptionResponse as SearchSubscriptionResponse, type context_SearchSubscriptionsOptions as SearchSubscriptionsOptions, type context_SearchSubscriptionsRequest as SearchSubscriptionsRequest, type context_SearchSubscriptionsRequestPagingMethodOneOf as SearchSubscriptionsRequestPagingMethodOneOf, type context_SearchSubscriptionsResponse as SearchSubscriptionsResponse, type context_SearchSubscriptionsResponseNonNullableFields as SearchSubscriptionsResponseNonNullableFields, type context_SendSubscriptionActionEventBORequest as SendSubscriptionActionEventBORequest, type context_SendSubscriptionActionEventBORequestEventOneOf as SendSubscriptionActionEventBORequestEventOneOf, type context_SendSubscriptionActionEventResponse as SendSubscriptionActionEventResponse, type context_SendTimeCapsuleTaskCanceledBIRequest as SendTimeCapsuleTaskCanceledBIRequest, type context_SetIsMigratedEvent as SetIsMigratedEvent, type context_SetShiftingDataRequest as SetShiftingDataRequest, type context_SetShiftingDataResponse as SetShiftingDataResponse, type context_ShippingCharges as ShippingCharges, context_SortOrder as SortOrder, type context_Sorting as Sorting, type context_SortingClauses as SortingClauses, type context_SpecificDateSubscriptionUpdateData as SpecificDateSubscriptionUpdateData, context_Status as Status, type context_StreetAddress as StreetAddress, type context_Subscriber as Subscriber, type context_Subscription as Subscription, type context_SubscriptionActivated as SubscriptionActivated, type context_SubscriptionAutoRenewalTurnedOff as SubscriptionAutoRenewalTurnedOff, type context_SubscriptionAutoRenewalTurnedOffEnvelope as SubscriptionAutoRenewalTurnedOffEnvelope, type context_SubscriptionAutoRenewalTurnedOn as SubscriptionAutoRenewalTurnedOn, type context_SubscriptionAutoRenewalTurnedOnEnvelope as SubscriptionAutoRenewalTurnedOnEnvelope, type context_SubscriptionBackOfficeAction as SubscriptionBackOfficeAction, type context_SubscriptionBillingCycleStarted as SubscriptionBillingCycleStarted, type context_SubscriptionBillingDateUpdated as SubscriptionBillingDateUpdated, type context_SubscriptionBillingDateUpdatedEnvelope as SubscriptionBillingDateUpdatedEnvelope, type context_SubscriptionBillingDetails as SubscriptionBillingDetails, type context_SubscriptionCanceled as SubscriptionCanceled, type context_SubscriptionCanceledEnvelope as SubscriptionCanceledEnvelope, type context_SubscriptionCancellationRequested as SubscriptionCancellationRequested, type context_SubscriptionCharge as SubscriptionCharge, type context_SubscriptionCharges as SubscriptionCharges, type context_SubscriptionCollectionMethodUpdated as SubscriptionCollectionMethodUpdated, type context_SubscriptionCreated as SubscriptionCreated, type context_SubscriptionCycleReadyToPay as SubscriptionCycleReadyToPay, type context_SubscriptionCycleTriggered as SubscriptionCycleTriggered, type context_SubscriptionDelayedSyncEvent as SubscriptionDelayedSyncEvent, type context_SubscriptionDeleted as SubscriptionDeleted, type context_SubscriptionDiff as SubscriptionDiff, type context_SubscriptionEnded as SubscriptionEnded, type context_SubscriptionEvent as SubscriptionEvent, type context_SubscriptionEventPayloadOneOf as SubscriptionEventPayloadOneOf, type context_SubscriptionExpired as SubscriptionExpired, type context_SubscriptionExtended as SubscriptionExtended, type context_SubscriptionExtendedEnvelope as SubscriptionExtendedEnvelope, type context_SubscriptionExtendedExtendPolicyOneOf as SubscriptionExtendedExtendPolicyOneOf, context_SubscriptionFrequency as SubscriptionFrequency, type context_SubscriptionHistoryEntry as SubscriptionHistoryEntry, type context_SubscriptionInfo as SubscriptionInfo, type context_SubscriptionInitialPurchaseCompleted as SubscriptionInitialPurchaseCompleted, type context_SubscriptionInvoice as SubscriptionInvoice, type context_SubscriptionLatestInvoiceMarkedAsPaidEnvelope as SubscriptionLatestInvoiceMarkedAsPaidEnvelope, type context_SubscriptionMarkedAsPaid as SubscriptionMarkedAsPaid, type context_SubscriptionPauseScheduleCanceledEnvelope as SubscriptionPauseScheduleCanceledEnvelope, type context_SubscriptionPauseScheduledEnvelope as SubscriptionPauseScheduledEnvelope, type context_SubscriptionPaused as SubscriptionPaused, type context_SubscriptionPausedEnvelope as SubscriptionPausedEnvelope, type context_SubscriptionPolicies as SubscriptionPolicies, type context_SubscriptionPolicy as SubscriptionPolicy, type context_SubscriptionResumeScheduleCanceledEnvelope as SubscriptionResumeScheduleCanceledEnvelope, type context_SubscriptionResumeScheduledEnvelope as SubscriptionResumeScheduledEnvelope, type context_SubscriptionResumed as SubscriptionResumed, type context_SubscriptionResumedEnvelope as SubscriptionResumedEnvelope, type context_SubscriptionRevived as SubscriptionRevived, type context_SubscriptionStatus as SubscriptionStatus, context_SubscriptionStatusEnumSubscriptionStatus as SubscriptionStatusEnumSubscriptionStatus, context_SubscriptionStatusGroup as SubscriptionStatusGroup, type context_SubscriptionSuspended as SubscriptionSuspended, type context_SubscriptionTrialPeriod as SubscriptionTrialPeriod, context_SubscriptionType as SubscriptionType, type context_SubscriptionUpdateData as SubscriptionUpdateData, type context_SubscriptionUpdated as SubscriptionUpdated, type context_SubscriptionUpdatedEnvelope as SubscriptionUpdatedEnvelope, type context_Suspension as Suspension, type context_Task as Task, type context_TaskAction as TaskAction, type context_TaskActionActionOneOf as TaskActionActionOneOf, type context_TaskKey as TaskKey, type context_Tax as Tax, type context_TaxBreakdown as TaxBreakdown, type context_TaxData as TaxData, type context_TaxSettings as TaxSettings, type context_TaxSummary as TaxSummary, type context_TaxValueOneOf as TaxValueOneOf, context_TaxableAddressType as TaxableAddressType, type context_TimeBasedProration as TimeBasedProration, type context_Totals as Totals, type context_TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequest, type context_TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponse, type context_TurnOffSubscriptionAutoRenewalResponseNonNullableFields as TurnOffSubscriptionAutoRenewalResponseNonNullableFields, type context_TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequest, type context_TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponse, type context_TurnOnSubscriptionAutoRenewalResponseNonNullableFields as TurnOnSubscriptionAutoRenewalResponseNonNullableFields, type context_UnknownSubscriptionEvent as UnknownSubscriptionEvent, type context_UnsupportedAction as UnsupportedAction, type context_UnsupportedReason as UnsupportedReason, context_UpdateAction as UpdateAction, type context_UpdateBillingDateData as UpdateBillingDateData, type context_UpdateFullSubscriptionRequest as UpdateFullSubscriptionRequest, type context_UpdateFullSubscriptionResponse as UpdateFullSubscriptionResponse, type context_UpdatePausePaidDurationRequest as UpdatePausePaidDurationRequest, type context_UpdatePausePaidDurationResponse as UpdatePausePaidDurationResponse, type context_UpdatePaymentMethodBORequest as UpdatePaymentMethodBORequest, type context_UpdatePaymentMethodBOResponse as UpdatePaymentMethodBOResponse, type context_UpdatePaymentStatusRequest as UpdatePaymentStatusRequest, type context_UpdatePaymentStatusResponse as UpdatePaymentStatusResponse, type context_UpdateStatusRequest as UpdateStatusRequest, type context_UpdateStatusResponse as UpdateStatusResponse, type context_UpdateSubscriptionBillingDateOptions as UpdateSubscriptionBillingDateOptions, type context_UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequest, type context_UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponse, type context_UpdateSubscriptionBillingDateResponseNonNullableFields as UpdateSubscriptionBillingDateResponseNonNullableFields, type context_UpdateSubscriptionInvoiceCycleRequest as UpdateSubscriptionInvoiceCycleRequest, type context_UpdateSubscriptionInvoiceCycleResponse as UpdateSubscriptionInvoiceCycleResponse, type context_UpdateSubscriptionItemsRequest as UpdateSubscriptionItemsRequest, type context_UpdateSubscriptionItemsResponse as UpdateSubscriptionItemsResponse, type context_UpdateSubscriptionOriginRequest as UpdateSubscriptionOriginRequest, type context_UpdateSubscriptionOriginResponse as UpdateSubscriptionOriginResponse, type context_UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequest, type context_UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponse, type context_UpdateSubscriptionPaymentMethodResponseNonNullableFields as UpdateSubscriptionPaymentMethodResponseNonNullableFields, type context_UpdateSubscriptionPoliciesRequest as UpdateSubscriptionPoliciesRequest, type context_UpdateSubscriptionPoliciesResponse as UpdateSubscriptionPoliciesResponse, type context_UpdateSubscriptionRequest as UpdateSubscriptionRequest, type context_UpdateSubscriptionResponse as UpdateSubscriptionResponse, type context_UpdateSubscriptionStartDateRequest as UpdateSubscriptionStartDateRequest, type context_UpdateSubscriptionStartDateResponse as UpdateSubscriptionStartDateResponse, type context_UpdatesApplied as UpdatesApplied, type context_V1Duration as V1Duration, type context_V1Subscription as V1Subscription, type context_V1SubscriptionActivated as V1SubscriptionActivated, type context_V1SubscriptionCanceled as V1SubscriptionCanceled, type context_V1SubscriptionCreated as V1SubscriptionCreated, type context_V1SubscriptionEvent as V1SubscriptionEvent, type context_V1SubscriptionEventEventOneOf as V1SubscriptionEventEventOneOf, type context_V1SubscriptionInitialPurchaseCompleted as V1SubscriptionInitialPurchaseCompleted, type context_V1SubscriptionResumed as V1SubscriptionResumed, context_V1SubscriptionStatusEnumSubscriptionStatus as V1SubscriptionStatusEnumSubscriptionStatus, type context_V1SubscriptionUpdated as V1SubscriptionUpdated, type context_V2Subscription as V2Subscription, context_WebhookIdentityType as WebhookIdentityType, type context__publicOnSubscriptionAutoRenewalTurnedOffType as _publicOnSubscriptionAutoRenewalTurnedOffType, type context__publicOnSubscriptionAutoRenewalTurnedOnType as _publicOnSubscriptionAutoRenewalTurnedOnType, type context__publicOnSubscriptionBillingDateUpdatedType as _publicOnSubscriptionBillingDateUpdatedType, type context__publicOnSubscriptionCanceledType as _publicOnSubscriptionCanceledType, type context__publicOnSubscriptionExtendedType as _publicOnSubscriptionExtendedType, type context__publicOnSubscriptionLatestInvoiceMarkedAsPaidType as _publicOnSubscriptionLatestInvoiceMarkedAsPaidType, type context__publicOnSubscriptionPauseScheduleCanceledType as _publicOnSubscriptionPauseScheduleCanceledType, type context__publicOnSubscriptionPauseScheduledType as _publicOnSubscriptionPauseScheduledType, type context__publicOnSubscriptionPausedType as _publicOnSubscriptionPausedType, type context__publicOnSubscriptionResumeScheduleCanceledType as _publicOnSubscriptionResumeScheduleCanceledType, type context__publicOnSubscriptionResumeScheduledType as _publicOnSubscriptionResumeScheduledType, type context__publicOnSubscriptionResumedType as _publicOnSubscriptionResumedType, type context__publicOnSubscriptionUpdatedType as _publicOnSubscriptionUpdatedType, context_allowedActions as allowedActions, context_cancelSubscription as cancelSubscription, context_countSubscriptions as countSubscriptions, context_customerAllowedActions as customerAllowedActions, context_customerCancelSubscription as customerCancelSubscription, context_customerExtendSubscription as customerExtendSubscription, context_customerGetSubscription as customerGetSubscription, context_customerInitiatePaymentMethodSetup as customerInitiatePaymentMethodSetup, context_customerListUpcomingCharges as customerListUpcomingCharges, context_customerQuerySubscriptions as customerQuerySubscriptions, context_customerTurnOffSubscriptionAutoRenewal as customerTurnOffSubscriptionAutoRenewal, context_customerTurnOnSubscriptionAutoRenewal as customerTurnOnSubscriptionAutoRenewal, context_customerUpdateSubscriptionPaymentMethod as customerUpdateSubscriptionPaymentMethod, context_extendSubscription as extendSubscription, context_getSubscription as getSubscription, context_getSubscriptionsStats as getSubscriptionsStats, context_initiatePaymentMethodSetup as initiatePaymentMethodSetup, context_listSubscriptionHistory as listSubscriptionHistory, context_listUpcomingCharges as listUpcomingCharges, context_markLatestInvoiceAsPaid as markLatestInvoiceAsPaid, context_onSubscriptionAutoRenewalTurnedOff as onSubscriptionAutoRenewalTurnedOff, context_onSubscriptionAutoRenewalTurnedOn as onSubscriptionAutoRenewalTurnedOn, context_onSubscriptionBillingDateUpdated as onSubscriptionBillingDateUpdated, context_onSubscriptionCanceled as onSubscriptionCanceled, context_onSubscriptionExtended as onSubscriptionExtended, context_onSubscriptionLatestInvoiceMarkedAsPaid as onSubscriptionLatestInvoiceMarkedAsPaid, context_onSubscriptionPauseScheduleCanceled as onSubscriptionPauseScheduleCanceled, context_onSubscriptionPauseScheduled as onSubscriptionPauseScheduled, context_onSubscriptionPaused as onSubscriptionPaused, context_onSubscriptionResumeScheduleCanceled as onSubscriptionResumeScheduleCanceled, context_onSubscriptionResumeScheduled as onSubscriptionResumeScheduled, context_onSubscriptionResumed as onSubscriptionResumed, context_onSubscriptionUpdated as onSubscriptionUpdated, context_pauseSubscription as pauseSubscription, context_payCycle as payCycle, context_previewSubscriptionCharges as previewSubscriptionCharges, context_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, context_querySubscriptions as querySubscriptions, context_resumeSubscription as resumeSubscription, context_searchSubscriptions as searchSubscriptions, context_turnOffSubscriptionAutoRenewal as turnOffSubscriptionAutoRenewal, context_turnOnSubscriptionAutoRenewal as turnOnSubscriptionAutoRenewal, context_updateSubscriptionBillingDate as updateSubscriptionBillingDate, context_updateSubscriptionPaymentMethod as updateSubscriptionPaymentMethod };
5120
5142
  }
5121
5143
 
5122
5144
  export { context as subscriptions };