@wix/subscription 1.0.32 → 1.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -3
- package/type-bundles/context.bundle.d.ts +1294 -1261
- package/type-bundles/index.bundle.d.ts +1294 -1261
- package/type-bundles/meta.bundle.d.ts +1193 -1129
|
@@ -785,10 +785,32 @@ interface AdditionalFee {
|
|
|
785
785
|
*
|
|
786
786
|
* + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
|
|
787
787
|
* + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
|
|
788
|
+
* @deprecated When the fee is added to the invoice.
|
|
789
|
+
*
|
|
790
|
+
* + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
|
|
791
|
+
* + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
|
|
792
|
+
* @replacedBy cycles
|
|
793
|
+
* @targetRemovalDate 2025-12-31
|
|
788
794
|
*/
|
|
789
795
|
trigger?: AdditionalFeeTrigger;
|
|
790
796
|
/** Information about the tax of the conditional fee. */
|
|
791
797
|
tax?: Tax;
|
|
798
|
+
/**
|
|
799
|
+
* Specifies the cycles during which the fee will be applied. If this field is provided,
|
|
800
|
+
* it determines the exact range of cycles the fee applies to. The logic is as follows:
|
|
801
|
+
*
|
|
802
|
+
* - `cycle_from`: The first cycle the fee will be added to. Must be greater than 0.
|
|
803
|
+
* - `number_of_cycles`: The number of consecutive cycles the fee will be applied to,
|
|
804
|
+
* starting from `cycle_from`. If not specified, the fee applies to all cycles starting
|
|
805
|
+
* from `cycle_from`.
|
|
806
|
+
*
|
|
807
|
+
* Example:
|
|
808
|
+
* - `cycle_from = 1, number_of_cycles = 3`: Fee applies to cycles 1, 2, and 3.
|
|
809
|
+
* - `cycle_from = 2, number_of_cycles = None`: Fee applies to cycles 2 and onward indefinitely.
|
|
810
|
+
*
|
|
811
|
+
* If `cycles` is not specified (`None`), the fee will only be applied to the first cycle of the subscription.
|
|
812
|
+
*/
|
|
813
|
+
cycles?: Cycles;
|
|
792
814
|
}
|
|
793
815
|
declare enum AdditionalFeeTrigger {
|
|
794
816
|
UNKNOWN = "UNKNOWN",
|
|
@@ -851,6 +873,12 @@ declare enum TaxableAddressType {
|
|
|
851
873
|
/** Tax will be calculated using multiple address (from BUSINESS to SHIPPING) */
|
|
852
874
|
SHIPPING = "SHIPPING"
|
|
853
875
|
}
|
|
876
|
+
interface Cycles {
|
|
877
|
+
/** The cycle will start. Minimum cycle number is 1 */
|
|
878
|
+
cycleFrom?: number;
|
|
879
|
+
/** Number of cycles to be applied on. In order to apply a on all cycles until the end of the subscription, this field should be empty. */
|
|
880
|
+
numberOfCycles?: number | null;
|
|
881
|
+
}
|
|
854
882
|
interface ShippingCharges {
|
|
855
883
|
/**
|
|
856
884
|
* Amount of the shipping fee in `0.00` format.
|
|
@@ -1273,147 +1301,18 @@ interface SpecificDateSubscriptionUpdateData {
|
|
|
1273
1301
|
updateData?: SubscriptionUpdateData;
|
|
1274
1302
|
executionDate?: Date | null;
|
|
1275
1303
|
}
|
|
1276
|
-
interface
|
|
1277
|
-
|
|
1278
|
-
/** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
|
|
1279
|
-
mode?: HistoryViewMode;
|
|
1280
|
-
/** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
|
|
1281
|
-
cursor?: CursorPaging;
|
|
1282
|
-
}
|
|
1283
|
-
declare enum HistoryViewMode {
|
|
1284
|
-
UNKNOWN = "UNKNOWN",
|
|
1285
|
-
/** Comprehensive view including all history events. */
|
|
1286
|
-
BACKOFFICE = "BACKOFFICE",
|
|
1287
|
-
/** User-centric view of the history. */
|
|
1288
|
-
USER = "USER"
|
|
1289
|
-
}
|
|
1290
|
-
interface CursorPaging {
|
|
1291
|
-
/** Maximum number of items to return in the results. */
|
|
1292
|
-
limit?: number | null;
|
|
1293
|
-
/**
|
|
1294
|
-
* Pointer to the next or previous page in the list of results.
|
|
1295
|
-
*
|
|
1296
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
1297
|
-
* Not relevant for the first request.
|
|
1298
|
-
*/
|
|
1299
|
-
cursor?: string | null;
|
|
1300
|
-
}
|
|
1301
|
-
interface ListSubscriptionHistoryResponse {
|
|
1302
|
-
/** List of history entries for the subscription. */
|
|
1303
|
-
historyEntries?: SubscriptionHistoryEntry[];
|
|
1304
|
-
/** Paging metadata. A `next` cursor is returned if there are more results. */
|
|
1305
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1306
|
-
}
|
|
1307
|
-
interface SubscriptionHistoryEntry {
|
|
1308
|
-
entryId?: string;
|
|
1309
|
-
/** TODO: add max length? it is not defined in domainevents, so should we? */
|
|
1310
|
-
slug?: string;
|
|
1311
|
-
entryTime?: Date | null;
|
|
1312
|
-
event?: SubscriptionEvent;
|
|
1313
|
-
}
|
|
1314
|
-
interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
|
|
1315
|
-
created?: SubscriptionCreated;
|
|
1316
|
-
updated?: SubscriptionUpdated;
|
|
1317
|
-
deleted?: SubscriptionDeleted;
|
|
1318
|
-
activated?: SubscriptionActivated;
|
|
1319
|
-
ended?: SubscriptionEnded;
|
|
1320
|
-
canceled?: SubscriptionCanceled;
|
|
1321
|
-
paused?: SubscriptionPaused;
|
|
1322
|
-
resumed?: SubscriptionResumed;
|
|
1323
|
-
pauseRequested?: PauseSubscriptionRequested;
|
|
1324
|
-
resumeRequested?: ResumeSubscriptionRequested;
|
|
1325
|
-
scheduledPauseCanceled?: ScheduledPauseCanceled;
|
|
1326
|
-
scheduledResumeCanceled?: ScheduledResumeCanceled;
|
|
1327
|
-
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
1328
|
-
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
|
|
1329
|
-
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
|
|
1330
|
-
cycleReadyToPay?: SubscriptionCycleReadyToPay;
|
|
1331
|
-
extended?: SubscriptionExtended;
|
|
1332
|
-
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
|
|
1333
|
-
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
|
|
1334
|
-
revived?: SubscriptionRevived;
|
|
1335
|
-
billingDateUpdated?: SubscriptionBillingDateUpdated;
|
|
1336
|
-
futureUpdatesRequested?: FutureUpdatesRequested;
|
|
1337
|
-
updatesApplied?: UpdatesApplied;
|
|
1338
|
-
resetPendingUpdates?: ResetPendingUpdates;
|
|
1339
|
-
gracePeriodStarted?: GracePeriodStarted;
|
|
1340
|
-
gracePeriodEnded?: GracePeriodEnded;
|
|
1341
|
-
paymentMethodUpdated?: PaymentMethodUpdated;
|
|
1342
|
-
collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
|
|
1343
|
-
freeTrailStarted?: FreeTrailStarted;
|
|
1344
|
-
freeTrailEnded?: FreeTrailEnded;
|
|
1345
|
-
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
1346
|
-
unknown?: UnknownSubscriptionEvent;
|
|
1347
|
-
}
|
|
1348
|
-
/** @oneof */
|
|
1349
|
-
interface SubscriptionEventPayloadOneOf {
|
|
1350
|
-
created?: SubscriptionCreated;
|
|
1351
|
-
updated?: SubscriptionUpdated;
|
|
1352
|
-
deleted?: SubscriptionDeleted;
|
|
1353
|
-
activated?: SubscriptionActivated;
|
|
1354
|
-
ended?: SubscriptionEnded;
|
|
1355
|
-
canceled?: SubscriptionCanceled;
|
|
1356
|
-
paused?: SubscriptionPaused;
|
|
1357
|
-
resumed?: SubscriptionResumed;
|
|
1358
|
-
pauseRequested?: PauseSubscriptionRequested;
|
|
1359
|
-
resumeRequested?: ResumeSubscriptionRequested;
|
|
1360
|
-
scheduledPauseCanceled?: ScheduledPauseCanceled;
|
|
1361
|
-
scheduledResumeCanceled?: ScheduledResumeCanceled;
|
|
1362
|
-
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
1363
|
-
autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
|
|
1364
|
-
autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
|
|
1365
|
-
cycleReadyToPay?: SubscriptionCycleReadyToPay;
|
|
1366
|
-
extended?: SubscriptionExtended;
|
|
1367
|
-
initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
|
|
1368
|
-
latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
|
|
1369
|
-
revived?: SubscriptionRevived;
|
|
1370
|
-
billingDateUpdated?: SubscriptionBillingDateUpdated;
|
|
1371
|
-
futureUpdatesRequested?: FutureUpdatesRequested;
|
|
1372
|
-
updatesApplied?: UpdatesApplied;
|
|
1373
|
-
resetPendingUpdates?: ResetPendingUpdates;
|
|
1374
|
-
gracePeriodStarted?: GracePeriodStarted;
|
|
1375
|
-
gracePeriodEnded?: GracePeriodEnded;
|
|
1376
|
-
paymentMethodUpdated?: PaymentMethodUpdated;
|
|
1377
|
-
collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
|
|
1378
|
-
freeTrailStarted?: FreeTrailStarted;
|
|
1379
|
-
freeTrailEnded?: FreeTrailEnded;
|
|
1380
|
-
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
1381
|
-
unknown?: UnknownSubscriptionEvent;
|
|
1304
|
+
interface GetSubscriptionRequest {
|
|
1305
|
+
_id: string;
|
|
1382
1306
|
}
|
|
1383
|
-
interface
|
|
1307
|
+
interface GetSubscriptionResponse {
|
|
1384
1308
|
subscription?: Subscription;
|
|
1385
1309
|
}
|
|
1386
|
-
interface
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
}
|
|
1391
|
-
interface SubscriptionDiff {
|
|
1392
|
-
added?: string | null;
|
|
1393
|
-
changed?: string | null;
|
|
1394
|
-
deleted?: string | null;
|
|
1395
|
-
}
|
|
1396
|
-
interface SubscriptionDeleted {
|
|
1397
|
-
subscriptionId?: string;
|
|
1398
|
-
}
|
|
1399
|
-
/**
|
|
1400
|
-
* Sent each time a subscription status has been set to Active
|
|
1401
|
-
* Active shows that a subscription is live and operational.
|
|
1402
|
-
* For example:
|
|
1403
|
-
* * For subscription with free trial, free trial start date is also the activation date.
|
|
1404
|
-
* * For a subscription with future start date, the start date is also the activation date.
|
|
1405
|
-
* * When a subscription is resumed from a pause status, the resume date is also the activation date.
|
|
1406
|
-
*/
|
|
1407
|
-
interface SubscriptionActivated {
|
|
1408
|
-
subscription?: Subscription;
|
|
1310
|
+
interface CustomerCancelSubscriptionRequest {
|
|
1311
|
+
_id: string;
|
|
1312
|
+
/** Optional action reason message */
|
|
1313
|
+
reason?: string | null;
|
|
1409
1314
|
}
|
|
1410
|
-
|
|
1411
|
-
* Sent each time a subscription status has been set to Ended
|
|
1412
|
-
* Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
|
|
1413
|
-
* This is different from a Canceled subscription which ends the subscription before a designated end date.
|
|
1414
|
-
* Therefore, Ended and Canceled are mutually exclusive.
|
|
1415
|
-
*/
|
|
1416
|
-
interface SubscriptionEnded {
|
|
1315
|
+
interface CustomerCancelSubscriptionResponse {
|
|
1417
1316
|
subscription?: Subscription;
|
|
1418
1317
|
}
|
|
1419
1318
|
/**
|
|
@@ -1431,48 +1330,32 @@ interface ActionDetails {
|
|
|
1431
1330
|
initiator?: HistoryActionInitiator;
|
|
1432
1331
|
reason?: string | null;
|
|
1433
1332
|
}
|
|
1434
|
-
interface
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
}
|
|
1439
|
-
interface SubscriptionResumed {
|
|
1440
|
-
subscription?: Subscription;
|
|
1441
|
-
actionDetails?: ActionDetails;
|
|
1442
|
-
}
|
|
1443
|
-
interface PauseSubscriptionRequested {
|
|
1444
|
-
subscription?: Subscription;
|
|
1445
|
-
pauseAt?: PauseAt;
|
|
1446
|
-
pausePolicy?: PausePolicy;
|
|
1447
|
-
actionDetails?: ActionDetails;
|
|
1448
|
-
}
|
|
1449
|
-
interface ResumeSubscriptionRequested {
|
|
1450
|
-
subscription?: Subscription;
|
|
1451
|
-
resumeAt?: ResumeAt;
|
|
1452
|
-
actionDetails?: ActionDetails;
|
|
1453
|
-
}
|
|
1454
|
-
interface ScheduledPauseCanceled {
|
|
1455
|
-
subscription?: Subscription;
|
|
1456
|
-
actionDetails?: ActionDetails;
|
|
1333
|
+
interface CustomerTurnOnAutoRenewalRequest {
|
|
1334
|
+
_id: string;
|
|
1335
|
+
/** Optional action reason message */
|
|
1336
|
+
reason?: string | null;
|
|
1457
1337
|
}
|
|
1458
|
-
interface
|
|
1338
|
+
interface CustomerTurnOnAutoRenewalResponse {
|
|
1459
1339
|
subscription?: Subscription;
|
|
1460
|
-
actionDetails?: ActionDetails;
|
|
1461
1340
|
}
|
|
1462
|
-
interface
|
|
1463
|
-
|
|
1464
|
-
/**
|
|
1465
|
-
|
|
1341
|
+
interface CustomerTurnOffAutoRenewalRequest {
|
|
1342
|
+
_id: string;
|
|
1343
|
+
/** Optional action reason message */
|
|
1344
|
+
reason?: string | null;
|
|
1466
1345
|
}
|
|
1467
|
-
interface
|
|
1346
|
+
interface CustomerTurnOffAutoRenewalResponse {
|
|
1468
1347
|
subscription?: Subscription;
|
|
1469
|
-
actionDetails?: ActionDetails;
|
|
1470
1348
|
}
|
|
1471
|
-
interface
|
|
1472
|
-
subscription
|
|
1473
|
-
|
|
1349
|
+
interface CustomerExtendSubscriptionRequest {
|
|
1350
|
+
/** The ID of the subscription to be extended */
|
|
1351
|
+
_id: string;
|
|
1352
|
+
/** Optional action reason message */
|
|
1353
|
+
reason?: string | null;
|
|
1354
|
+
/** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
|
|
1355
|
+
billingCyclesToAdd: number | null;
|
|
1474
1356
|
}
|
|
1475
|
-
interface
|
|
1357
|
+
interface CustomerExtendSubscriptionResponse {
|
|
1358
|
+
/** The now extended subscription */
|
|
1476
1359
|
subscription?: Subscription;
|
|
1477
1360
|
}
|
|
1478
1361
|
interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
|
|
@@ -1486,95 +1369,68 @@ interface SubscriptionExtendedExtendPolicyOneOf {
|
|
|
1486
1369
|
extensionPeriod?: Duration;
|
|
1487
1370
|
extensionBillingCycles?: number;
|
|
1488
1371
|
}
|
|
1489
|
-
interface
|
|
1490
|
-
|
|
1491
|
-
actionDetails?: ActionDetails;
|
|
1492
|
-
paymentTransactionId?: string | null;
|
|
1372
|
+
interface QuerySubscriptionsRequest {
|
|
1373
|
+
query?: QueryV2;
|
|
1493
1374
|
}
|
|
1494
|
-
interface
|
|
1495
|
-
|
|
1375
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1376
|
+
/** Paging options to limit and skip the number of items. */
|
|
1377
|
+
paging?: Paging;
|
|
1378
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1379
|
+
cursorPaging?: CursorPaging;
|
|
1380
|
+
/**
|
|
1381
|
+
* Filter object.
|
|
1382
|
+
*
|
|
1383
|
+
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
1384
|
+
*/
|
|
1385
|
+
filter?: Record<string, any> | null;
|
|
1386
|
+
/**
|
|
1387
|
+
* Sort object.
|
|
1388
|
+
*
|
|
1389
|
+
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
1390
|
+
*/
|
|
1391
|
+
sort?: Sorting[];
|
|
1392
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1393
|
+
fields?: string[];
|
|
1394
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1395
|
+
fieldsets?: string[];
|
|
1496
1396
|
}
|
|
1497
|
-
|
|
1498
|
-
|
|
1397
|
+
/** @oneof */
|
|
1398
|
+
interface QueryV2PagingMethodOneOf {
|
|
1399
|
+
/** Paging options to limit and skip the number of items. */
|
|
1400
|
+
paging?: Paging;
|
|
1401
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1402
|
+
cursorPaging?: CursorPaging;
|
|
1499
1403
|
}
|
|
1500
|
-
interface
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1404
|
+
interface Sorting {
|
|
1405
|
+
/** Name of the field to sort by. */
|
|
1406
|
+
fieldName?: string;
|
|
1407
|
+
/** Sort order. */
|
|
1408
|
+
order?: SortOrder;
|
|
1504
1409
|
}
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
}
|
|
1509
|
-
interface UpdatesApplied {
|
|
1510
|
-
subscription?: Subscription;
|
|
1511
|
-
updateAction?: UpdateAction;
|
|
1512
|
-
appliedUpdateData?: SubscriptionUpdateData;
|
|
1513
|
-
}
|
|
1514
|
-
declare enum UpdateAction {
|
|
1515
|
-
NONE = "NONE",
|
|
1516
|
-
/** Update subscription immediately, please note proration for updates changing price are not yet supported */
|
|
1517
|
-
IMMEDIATELY = "IMMEDIATELY",
|
|
1518
|
-
/** Request updates that will take affect only at the start of the next billing cycle. */
|
|
1519
|
-
NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
|
|
1520
|
-
/** Reset all pending updates */
|
|
1521
|
-
RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
|
|
1522
|
-
/** Request updates that will take affect only at a specific date. */
|
|
1523
|
-
SPECIFIC_DATE = "SPECIFIC_DATE"
|
|
1524
|
-
}
|
|
1525
|
-
interface ResetPendingUpdates {
|
|
1526
|
-
subscription?: Subscription;
|
|
1527
|
-
}
|
|
1528
|
-
interface GracePeriodStarted {
|
|
1529
|
-
subscription?: Subscription;
|
|
1530
|
-
}
|
|
1531
|
-
interface GracePeriodEnded {
|
|
1532
|
-
subscription?: Subscription;
|
|
1533
|
-
/** Indication for the payment settlement method. */
|
|
1534
|
-
paymentSettlementMethod?: PaymentSettlementMethod;
|
|
1535
|
-
}
|
|
1536
|
-
declare enum PaymentSettlementMethod {
|
|
1537
|
-
UNKNOWN = "UNKNOWN",
|
|
1538
|
-
/** System-defined payment settlement. */
|
|
1539
|
-
SYSTEM = "SYSTEM",
|
|
1540
|
-
/** Manually mark the payment as paid. */
|
|
1541
|
-
MARK_AS_PAID = "MARK_AS_PAID",
|
|
1542
|
-
/** Require the customer to pay immediately, by insert a new payment method. */
|
|
1543
|
-
CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
|
|
1544
|
-
}
|
|
1545
|
-
interface PaymentMethodUpdated {
|
|
1546
|
-
subscription?: Subscription;
|
|
1547
|
-
initiator?: HistoryActionInitiator;
|
|
1548
|
-
paymentMode?: PaymentMode;
|
|
1549
|
-
}
|
|
1550
|
-
declare enum PaymentMode {
|
|
1551
|
-
NONE = "NONE",
|
|
1552
|
-
/** The latest invoice of the subscription will be charged. */
|
|
1553
|
-
CHARGE = "CHARGE",
|
|
1554
|
-
/** An authorization invoice with zero amount will be created. */
|
|
1555
|
-
AUTHORIZATION = "AUTHORIZATION"
|
|
1556
|
-
}
|
|
1557
|
-
interface SubscriptionCollectionMethodUpdated {
|
|
1558
|
-
subscription?: Subscription;
|
|
1559
|
-
newCollectionMethod?: CollectionMethodEnumCollectionMethod;
|
|
1560
|
-
previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
|
|
1561
|
-
}
|
|
1562
|
-
interface FreeTrailStarted {
|
|
1563
|
-
subscription?: Subscription;
|
|
1410
|
+
declare enum SortOrder {
|
|
1411
|
+
ASC = "ASC",
|
|
1412
|
+
DESC = "DESC"
|
|
1564
1413
|
}
|
|
1565
|
-
interface
|
|
1566
|
-
|
|
1414
|
+
interface Paging {
|
|
1415
|
+
/** Number of items to load. */
|
|
1416
|
+
limit?: number | null;
|
|
1417
|
+
/** Number of items to skip in the current sort order. */
|
|
1418
|
+
offset?: number | null;
|
|
1567
1419
|
}
|
|
1568
|
-
interface
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1420
|
+
interface CursorPaging {
|
|
1421
|
+
/** Maximum number of items to return in the results. */
|
|
1422
|
+
limit?: number | null;
|
|
1423
|
+
/**
|
|
1424
|
+
* Pointer to the next or previous page in the list of results.
|
|
1425
|
+
*
|
|
1426
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
1427
|
+
* Not relevant for the first request.
|
|
1428
|
+
*/
|
|
1429
|
+
cursor?: string | null;
|
|
1574
1430
|
}
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1431
|
+
interface QuerySubscriptionsResponse {
|
|
1432
|
+
subscriptions?: Subscription[];
|
|
1433
|
+
metadata?: PagingMetadataV2;
|
|
1578
1434
|
}
|
|
1579
1435
|
interface PagingMetadataV2 {
|
|
1580
1436
|
/** Number of items returned in the response. */
|
|
@@ -1594,100 +1450,6 @@ interface Cursors {
|
|
|
1594
1450
|
/** Cursor pointing to the previous page in the list of results. */
|
|
1595
1451
|
prev?: string | null;
|
|
1596
1452
|
}
|
|
1597
|
-
interface GetSubscriptionRequest {
|
|
1598
|
-
_id: string;
|
|
1599
|
-
}
|
|
1600
|
-
interface GetSubscriptionResponse {
|
|
1601
|
-
subscription?: Subscription;
|
|
1602
|
-
}
|
|
1603
|
-
interface CustomerCancelSubscriptionRequest {
|
|
1604
|
-
_id: string;
|
|
1605
|
-
/** Optional action reason message */
|
|
1606
|
-
reason?: string | null;
|
|
1607
|
-
}
|
|
1608
|
-
interface CustomerCancelSubscriptionResponse {
|
|
1609
|
-
subscription?: Subscription;
|
|
1610
|
-
}
|
|
1611
|
-
interface CustomerTurnOnAutoRenewalRequest {
|
|
1612
|
-
_id: string;
|
|
1613
|
-
/** Optional action reason message */
|
|
1614
|
-
reason?: string | null;
|
|
1615
|
-
}
|
|
1616
|
-
interface CustomerTurnOnAutoRenewalResponse {
|
|
1617
|
-
subscription?: Subscription;
|
|
1618
|
-
}
|
|
1619
|
-
interface CustomerTurnOffAutoRenewalRequest {
|
|
1620
|
-
_id: string;
|
|
1621
|
-
/** Optional action reason message */
|
|
1622
|
-
reason?: string | null;
|
|
1623
|
-
}
|
|
1624
|
-
interface CustomerTurnOffAutoRenewalResponse {
|
|
1625
|
-
subscription?: Subscription;
|
|
1626
|
-
}
|
|
1627
|
-
interface CustomerExtendSubscriptionRequest {
|
|
1628
|
-
/** The ID of the subscription to be extended */
|
|
1629
|
-
_id: string;
|
|
1630
|
-
/** Optional action reason message */
|
|
1631
|
-
reason?: string | null;
|
|
1632
|
-
/** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
|
|
1633
|
-
billingCyclesToAdd: number | null;
|
|
1634
|
-
}
|
|
1635
|
-
interface CustomerExtendSubscriptionResponse {
|
|
1636
|
-
/** The now extended subscription */
|
|
1637
|
-
subscription?: Subscription;
|
|
1638
|
-
}
|
|
1639
|
-
interface QuerySubscriptionsRequest {
|
|
1640
|
-
query?: QueryV2;
|
|
1641
|
-
}
|
|
1642
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1643
|
-
/** Paging options to limit and skip the number of items. */
|
|
1644
|
-
paging?: Paging;
|
|
1645
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1646
|
-
cursorPaging?: CursorPaging;
|
|
1647
|
-
/**
|
|
1648
|
-
* Filter object.
|
|
1649
|
-
*
|
|
1650
|
-
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
1651
|
-
*/
|
|
1652
|
-
filter?: Record<string, any> | null;
|
|
1653
|
-
/**
|
|
1654
|
-
* Sort object.
|
|
1655
|
-
*
|
|
1656
|
-
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
1657
|
-
*/
|
|
1658
|
-
sort?: Sorting[];
|
|
1659
|
-
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1660
|
-
fields?: string[];
|
|
1661
|
-
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1662
|
-
fieldsets?: string[];
|
|
1663
|
-
}
|
|
1664
|
-
/** @oneof */
|
|
1665
|
-
interface QueryV2PagingMethodOneOf {
|
|
1666
|
-
/** Paging options to limit and skip the number of items. */
|
|
1667
|
-
paging?: Paging;
|
|
1668
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1669
|
-
cursorPaging?: CursorPaging;
|
|
1670
|
-
}
|
|
1671
|
-
interface Sorting {
|
|
1672
|
-
/** Name of the field to sort by. */
|
|
1673
|
-
fieldName?: string;
|
|
1674
|
-
/** Sort order. */
|
|
1675
|
-
order?: SortOrder;
|
|
1676
|
-
}
|
|
1677
|
-
declare enum SortOrder {
|
|
1678
|
-
ASC = "ASC",
|
|
1679
|
-
DESC = "DESC"
|
|
1680
|
-
}
|
|
1681
|
-
interface Paging {
|
|
1682
|
-
/** Number of items to load. */
|
|
1683
|
-
limit?: number | null;
|
|
1684
|
-
/** Number of items to skip in the current sort order. */
|
|
1685
|
-
offset?: number | null;
|
|
1686
|
-
}
|
|
1687
|
-
interface QuerySubscriptionsResponse {
|
|
1688
|
-
subscriptions?: Subscription[];
|
|
1689
|
-
metadata?: PagingMetadataV2;
|
|
1690
|
-
}
|
|
1691
1453
|
interface CountSubscriptionsRequest {
|
|
1692
1454
|
/** Filters to specify which subscriptions are counted. */
|
|
1693
1455
|
filter?: CountSubscriptionFilter;
|
|
@@ -1991,6 +1753,13 @@ interface InitiatePaymentMethodSetupRequest {
|
|
|
1991
1753
|
paymentMode?: PaymentMode;
|
|
1992
1754
|
paymentSettings?: PaymentSettings;
|
|
1993
1755
|
}
|
|
1756
|
+
declare enum PaymentMode {
|
|
1757
|
+
NONE = "NONE",
|
|
1758
|
+
/** The latest invoice of the subscription will be charged. */
|
|
1759
|
+
CHARGE = "CHARGE",
|
|
1760
|
+
/** An authorization invoice with zero amount will be created. */
|
|
1761
|
+
AUTHORIZATION = "AUTHORIZATION"
|
|
1762
|
+
}
|
|
1994
1763
|
interface PaymentSettings {
|
|
1995
1764
|
/** Allowed payment providers for Subscriptions, for example to limit subscriptions to be created only with "Wix Payments" provider. */
|
|
1996
1765
|
allowedProviderIds?: string[];
|
|
@@ -2143,21 +1912,12 @@ declare enum WebhookIdentityType {
|
|
|
2143
1912
|
WIX_USER = "WIX_USER",
|
|
2144
1913
|
APP = "APP"
|
|
2145
1914
|
}
|
|
2146
|
-
interface
|
|
2147
|
-
|
|
2148
|
-
}
|
|
2149
|
-
interface SubscriptionDelayedSyncEvent {
|
|
2150
|
-
subscriptionId?: string;
|
|
2151
|
-
}
|
|
2152
|
-
interface InvoiceAction extends InvoiceActionActionTypeOneOf {
|
|
2153
|
-
payRecurring?: PayRecurringInvoice;
|
|
1915
|
+
interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
|
|
1916
|
+
activeSubscription?: CreateSubscriptionRequest;
|
|
2154
1917
|
}
|
|
2155
1918
|
/** @oneof */
|
|
2156
|
-
interface
|
|
2157
|
-
|
|
2158
|
-
}
|
|
2159
|
-
interface PayRecurringInvoice {
|
|
2160
|
-
invoiceId?: string;
|
|
1919
|
+
interface CreateSubscriptionInStateRequestModeOneOf {
|
|
1920
|
+
activeSubscription?: CreateSubscriptionRequest;
|
|
2161
1921
|
}
|
|
2162
1922
|
interface CreateSubscriptionRequest {
|
|
2163
1923
|
subscription?: Subscription;
|
|
@@ -2172,443 +1932,810 @@ interface OriginOverride {
|
|
|
2172
1932
|
appId?: string;
|
|
2173
1933
|
instanceId?: string;
|
|
2174
1934
|
}
|
|
2175
|
-
interface
|
|
2176
|
-
|
|
2177
|
-
/** Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions. */
|
|
2178
|
-
paymentOrderId?: string | null;
|
|
2179
|
-
}
|
|
2180
|
-
interface UpdateSubscriptionRequest {
|
|
2181
|
-
/** Revision is validated if Subscription.revision is set */
|
|
2182
|
-
subscription?: Subscription;
|
|
1935
|
+
interface CreateSubscriptionInStateResponse {
|
|
1936
|
+
subscriptionId?: string;
|
|
2183
1937
|
}
|
|
2184
|
-
interface
|
|
2185
|
-
|
|
1938
|
+
interface PayCycleRequest {
|
|
1939
|
+
subscriptionId: string;
|
|
1940
|
+
paymentTestMode?: PaymentTestMode;
|
|
1941
|
+
tenantId: string;
|
|
2186
1942
|
}
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
* By setting start_date in the future, end_date will be recalculated for termed Subscriptions
|
|
2193
|
-
* cycles_to_pay_on_creation will be set to 1 if no free trial is set
|
|
2194
|
-
*/
|
|
2195
|
-
startDate?: Date | null;
|
|
1943
|
+
declare enum PaymentTestMode {
|
|
1944
|
+
REGULAR = "REGULAR",
|
|
1945
|
+
FAIL_TECHNICAL = "FAIL_TECHNICAL",
|
|
1946
|
+
FAIL_DECLINE = "FAIL_DECLINE",
|
|
1947
|
+
FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
|
|
2196
1948
|
}
|
|
2197
|
-
interface
|
|
1949
|
+
interface PayCycleResponse {
|
|
1950
|
+
invoiceId?: string;
|
|
1951
|
+
paymentOrderId?: string | null;
|
|
2198
1952
|
subscription?: Subscription;
|
|
2199
1953
|
}
|
|
2200
|
-
interface
|
|
2201
|
-
/** Subscription ID */
|
|
1954
|
+
interface GetFullSubscriptionDataRequest {
|
|
2202
1955
|
_id?: string;
|
|
2203
|
-
cancellableByCustomer?: boolean | null;
|
|
2204
1956
|
}
|
|
2205
|
-
interface
|
|
2206
|
-
|
|
2207
|
-
|
|
1957
|
+
interface GetFullSubscriptionDataResponse {
|
|
1958
|
+
subscription?: Subscription;
|
|
1959
|
+
internalSubscriptionData?: InternalSubscriptionData;
|
|
2208
1960
|
}
|
|
2209
|
-
interface
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
* amount based on the number of days added to or removed from the current billing
|
|
2219
|
-
* cycle. Alternatively, you can use your own custom method to calculate the
|
|
2220
|
-
* proration amount. The custom proration amount can't exceed the total of the
|
|
2221
|
-
* current billing cycle.
|
|
2222
|
-
*/
|
|
2223
|
-
proration?: Proration;
|
|
1961
|
+
interface InternalSubscriptionData {
|
|
1962
|
+
originInstanceId?: string;
|
|
1963
|
+
source?: string | null;
|
|
1964
|
+
billingType?: string;
|
|
1965
|
+
isOneTime?: boolean;
|
|
1966
|
+
migrationDetails?: MigrationDetails;
|
|
1967
|
+
pausePaidDuration?: string | null;
|
|
1968
|
+
authorizationPaymentData?: PaymentData;
|
|
1969
|
+
currentCyclePausePeriods?: PausePeriod[];
|
|
2224
1970
|
}
|
|
2225
|
-
interface
|
|
2226
|
-
/**
|
|
2227
|
-
|
|
1971
|
+
interface MigrationDetails {
|
|
1972
|
+
/** system (application) where the Subscription has been created */
|
|
1973
|
+
originSystem?: string;
|
|
1974
|
+
/** date when the Subscription started to be managed in BASS */
|
|
1975
|
+
shiftManagementDate?: Date | null;
|
|
2228
1976
|
}
|
|
2229
|
-
interface
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
/** Origin entity ID of the subscription to update. */
|
|
2233
|
-
entityId?: string;
|
|
1977
|
+
interface PausePeriod {
|
|
1978
|
+
startDate?: Date | null;
|
|
1979
|
+
endDate?: Date | null;
|
|
2234
1980
|
}
|
|
2235
|
-
interface
|
|
2236
|
-
|
|
1981
|
+
interface GetSubscriptionAndInternalDataRequest {
|
|
1982
|
+
subscriptionId?: string;
|
|
1983
|
+
tenantId?: string;
|
|
1984
|
+
}
|
|
1985
|
+
interface GetSubscriptionAndInternalDataResponse {
|
|
2237
1986
|
subscription?: Subscription;
|
|
1987
|
+
internalSubscriptionData?: InternalSubscriptionData;
|
|
2238
1988
|
}
|
|
2239
|
-
interface
|
|
2240
|
-
/** Subscription ID */
|
|
1989
|
+
interface SearchSubscriptionRequest {
|
|
2241
1990
|
_id?: string;
|
|
2242
|
-
|
|
2243
|
-
items?: Item[];
|
|
1991
|
+
tenantId?: string;
|
|
2244
1992
|
}
|
|
2245
|
-
interface
|
|
1993
|
+
interface SearchSubscriptionResponse {
|
|
2246
1994
|
subscription?: Subscription;
|
|
2247
1995
|
}
|
|
2248
|
-
interface
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
updateAction?: UpdateAction;
|
|
2253
|
-
/** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
|
|
2254
|
-
scheduleAdditionalInfo?: ScheduleAdditionalInfo;
|
|
2255
|
-
/** Existing items to update */
|
|
2256
|
-
itemsToUpdate?: ItemChange[];
|
|
2257
|
-
/** Items to add */
|
|
2258
|
-
itemsToAdd?: Item[];
|
|
2259
|
-
/** Existing items to delete */
|
|
2260
|
-
itemsToDelete?: string[] | null;
|
|
1996
|
+
interface UpdatePausePaidDurationRequest {
|
|
1997
|
+
subscriptionId?: string;
|
|
1998
|
+
pausePaidDurationSeconds?: string;
|
|
1999
|
+
tenantId?: string;
|
|
2261
2000
|
}
|
|
2262
|
-
interface
|
|
2263
|
-
/**
|
|
2264
|
-
* Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
|
|
2265
|
-
* format. The use of this field may be restricted in various BASS endpoints.
|
|
2266
|
-
* For example, in _Bulk Update Subscription Items_ it's only available in
|
|
2267
|
-
* combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
|
|
2268
|
-
* only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
|
|
2269
|
-
* _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
|
|
2270
|
-
*/
|
|
2271
|
-
specificDate?: Date | null;
|
|
2272
|
-
/**
|
|
2273
|
-
* When the update becomes effective, as number of billing cycles from now.
|
|
2274
|
-
* The use of this field may be restricted in various BASS endpoints.
|
|
2275
|
-
* For example, in _Pause Subscription_ it's only available in
|
|
2276
|
-
* combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
|
|
2277
|
-
* __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
|
|
2278
|
-
*/
|
|
2279
|
-
numberOfCycles?: number;
|
|
2001
|
+
interface UpdatePausePaidDurationResponse {
|
|
2280
2002
|
}
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
* format. The use of this field may be restricted in various BASS endpoints.
|
|
2286
|
-
* For example, in _Bulk Update Subscription Items_ it's only available in
|
|
2287
|
-
* combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
|
|
2288
|
-
* only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
|
|
2289
|
-
* _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
|
|
2290
|
-
*/
|
|
2291
|
-
specificDate?: Date | null;
|
|
2292
|
-
/**
|
|
2293
|
-
* When the update becomes effective, as number of billing cycles from now.
|
|
2294
|
-
* The use of this field may be restricted in various BASS endpoints.
|
|
2295
|
-
* For example, in _Pause Subscription_ it's only available in
|
|
2296
|
-
* combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
|
|
2297
|
-
* __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
|
|
2298
|
-
*/
|
|
2299
|
-
numberOfCycles?: number;
|
|
2003
|
+
interface UpdateStatusRequest {
|
|
2004
|
+
subscriptionId?: string;
|
|
2005
|
+
tenantId?: string;
|
|
2006
|
+
status?: SubscriptionStatusEnumSubscriptionStatus;
|
|
2300
2007
|
}
|
|
2301
|
-
interface
|
|
2008
|
+
interface UpdateStatusResponse {
|
|
2302
2009
|
subscription?: Subscription;
|
|
2303
2010
|
}
|
|
2304
|
-
interface
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
* [Search and Query: Bulk Update Subscription Items By Filter](https://bo.wix.com/wix-docs/rest/drafts/subscriptions-by-billing-by-wix/search-and-query#drafts_subscriptions-by-billing-by-wix_search-and-query_bulk-update-subscription-items-by-filter).
|
|
2309
|
-
* Sending an empty subscription filter results in a validation error.
|
|
2310
|
-
* In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
|
|
2311
|
-
* `subscriptionId` field inside this filter. Passing any other filter results
|
|
2312
|
-
* in a failed validation error.
|
|
2313
|
-
*/
|
|
2314
|
-
subscriptionFilter?: Record<string, any> | null;
|
|
2315
|
-
/**
|
|
2316
|
-
* Filter to specify which subscription items are updated. Make sure to use
|
|
2317
|
-
* the catalog item ID and not the item's unique ID. All subscription items
|
|
2318
|
-
* with matching `items.catalogReference.catalogItemId` are updated.
|
|
2319
|
-
*
|
|
2320
|
-
* Max: `100` reference catalog item IDs
|
|
2321
|
-
*/
|
|
2322
|
-
catalogReferenceIds?: string[] | null;
|
|
2323
|
-
/**
|
|
2324
|
-
* Information about the update timing and update type.
|
|
2325
|
-
*
|
|
2326
|
-
* + `"IMMEDIATELY"`: The updates become effective immediately.
|
|
2327
|
-
* + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
|
|
2328
|
-
* + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
|
|
2329
|
-
* + `"RESET_PENDING_UPDATES"`: All currently scheduled updates for the specified supcriptions are canceled. Use only the `subscriptionId` field inside `subscriptionFilter`, all other filters result in failed validation errors.
|
|
2330
|
-
*/
|
|
2331
|
-
updateAction?: UpdateAction;
|
|
2332
|
-
/**
|
|
2333
|
-
* Additional information for updates. Currently, only supported for
|
|
2334
|
-
* `{"updateAction": "SPECIFIC_DATE"}`.
|
|
2335
|
-
*/
|
|
2336
|
-
scheduleAdditionalInfo?: ScheduleAdditionalInfo;
|
|
2337
|
-
/**
|
|
2338
|
-
* Update details for the susbcription items that match the filtering.
|
|
2339
|
-
* Currently, you can update only the item price, quantity, and tax. Note
|
|
2340
|
-
* that all item properties are updated to the same values. In case you want set
|
|
2341
|
-
* different values for individual items, you must call
|
|
2342
|
-
* _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
|
|
2343
|
-
*/
|
|
2344
|
-
bulkItemUpdateData?: BulkItemChange;
|
|
2345
|
-
/** __Not implemented yet__. Items to add to the subscriptions matching the filtering. */
|
|
2346
|
-
itemsToAdd?: Item[];
|
|
2011
|
+
interface UpdatePaymentStatusRequest {
|
|
2012
|
+
subscriptionId?: string;
|
|
2013
|
+
tenantId?: string;
|
|
2014
|
+
paymentStatus?: PaymentStatus;
|
|
2347
2015
|
}
|
|
2348
|
-
interface
|
|
2349
|
-
|
|
2350
|
-
pricingModel?: PricingModel;
|
|
2351
|
-
/**
|
|
2352
|
-
* New item quantity.
|
|
2353
|
-
*
|
|
2354
|
-
* Min: `1`
|
|
2355
|
-
*/
|
|
2356
|
-
quantity?: number | null;
|
|
2357
|
-
/** Information about the new item tax. */
|
|
2358
|
-
tax?: Tax;
|
|
2016
|
+
interface UpdatePaymentStatusResponse {
|
|
2017
|
+
subscription?: Subscription;
|
|
2359
2018
|
}
|
|
2360
|
-
interface
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
*/
|
|
2366
|
-
jobId?: string;
|
|
2019
|
+
interface ReviveSubscriptionRequest {
|
|
2020
|
+
tenantId?: string;
|
|
2021
|
+
subscriptionId?: string;
|
|
2022
|
+
revivePolicy?: RevivePolicy;
|
|
2023
|
+
isTestRun?: boolean;
|
|
2367
2024
|
}
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2025
|
+
declare enum RevivePolicy {
|
|
2026
|
+
SIMPLE = "SIMPLE",
|
|
2027
|
+
RESUME = "RESUME"
|
|
2371
2028
|
}
|
|
2372
|
-
interface
|
|
2029
|
+
interface ReviveSubscriptionResponse {
|
|
2030
|
+
subscription?: Subscription;
|
|
2373
2031
|
}
|
|
2374
|
-
interface
|
|
2375
|
-
|
|
2376
|
-
actionContext: ActionContext;
|
|
2032
|
+
interface ConvertSapiRequest {
|
|
2033
|
+
subscriptionId?: string;
|
|
2377
2034
|
}
|
|
2378
|
-
interface
|
|
2379
|
-
|
|
2380
|
-
/** Optional action reason message */
|
|
2381
|
-
reason?: string | null;
|
|
2035
|
+
interface ConvertSapiResponse {
|
|
2036
|
+
subscription?: Subscription;
|
|
2382
2037
|
}
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
BUSINESS = "BUSINESS",
|
|
2386
|
-
CUSTOMER = "CUSTOMER",
|
|
2387
|
-
SYSTEM = "SYSTEM"
|
|
2038
|
+
interface GetSubscriptionInvoicesRequest {
|
|
2039
|
+
_id?: string;
|
|
2388
2040
|
}
|
|
2389
|
-
interface
|
|
2390
|
-
|
|
2041
|
+
interface GetSubscriptionInvoicesResponse {
|
|
2042
|
+
invoices?: SubscriptionInvoice[];
|
|
2391
2043
|
}
|
|
2392
|
-
interface
|
|
2393
|
-
_id
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
/** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
|
|
2397
|
-
pauseAtSchedule?: ScheduleAdditionalInfo;
|
|
2398
|
-
/** contains additional scheduling information for certain auto_resume_at either specific date */
|
|
2399
|
-
autoResumeAtSchedule?: ScheduleAdditionalInfo;
|
|
2400
|
-
actionContext: ActionContext;
|
|
2044
|
+
interface SubscriptionInvoice {
|
|
2045
|
+
_id?: string;
|
|
2046
|
+
subscriptionCycle?: number;
|
|
2047
|
+
_createdDate?: Date | null;
|
|
2401
2048
|
}
|
|
2402
|
-
interface
|
|
2049
|
+
interface FinishFreeTrialNowRequest {
|
|
2050
|
+
subscriptionId?: string;
|
|
2051
|
+
tenantId?: string;
|
|
2052
|
+
}
|
|
2053
|
+
interface FinishFreeTrialNowResponse {
|
|
2403
2054
|
subscription?: Subscription;
|
|
2404
2055
|
}
|
|
2405
|
-
interface
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
resumeAtSchedule?: ScheduleAdditionalInfo;
|
|
2410
|
-
actionContext: ActionContext;
|
|
2056
|
+
interface SendTimeCapsuleTaskCanceledBIRequest {
|
|
2057
|
+
tenantId?: string;
|
|
2058
|
+
subscriptionId?: string;
|
|
2059
|
+
taskType?: string;
|
|
2411
2060
|
}
|
|
2412
|
-
interface
|
|
2413
|
-
subscription?: Subscription;
|
|
2061
|
+
interface Empty {
|
|
2414
2062
|
}
|
|
2415
|
-
interface
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
/** A filter object */
|
|
2421
|
-
filter?: any;
|
|
2422
|
-
/** A Sorting option by field name and order. */
|
|
2423
|
-
sorting?: SortingClauses;
|
|
2063
|
+
interface ScheduleTimeCapsuleTaskRequest {
|
|
2064
|
+
subscriptionId?: string;
|
|
2065
|
+
taskType?: string;
|
|
2066
|
+
executionTime?: Date | null;
|
|
2067
|
+
tenantId?: string;
|
|
2424
2068
|
}
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
|
-
/** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
|
|
2430
|
-
cursor?: CursorPaging;
|
|
2069
|
+
interface CancelTimeCapsuleTaskRequest {
|
|
2070
|
+
tenantId?: string;
|
|
2071
|
+
subscriptionId?: string;
|
|
2072
|
+
taskType?: string;
|
|
2431
2073
|
}
|
|
2432
|
-
interface
|
|
2433
|
-
|
|
2074
|
+
interface UpdateFullSubscriptionRequest {
|
|
2075
|
+
tenantId?: string;
|
|
2076
|
+
subscription?: Subscription;
|
|
2434
2077
|
}
|
|
2435
|
-
interface
|
|
2436
|
-
|
|
2437
|
-
cursor?: CursorPaging;
|
|
2078
|
+
interface UpdateFullSubscriptionResponse {
|
|
2079
|
+
subscription?: Subscription;
|
|
2438
2080
|
}
|
|
2439
|
-
interface
|
|
2440
|
-
|
|
2441
|
-
|
|
2081
|
+
interface UpdateSubscriptionInvoiceCycleRequest {
|
|
2082
|
+
subscriptionId?: string;
|
|
2083
|
+
tenantId?: string;
|
|
2084
|
+
invoiceId?: string;
|
|
2085
|
+
subscriptionCycle?: number;
|
|
2442
2086
|
}
|
|
2443
|
-
interface
|
|
2444
|
-
|
|
2087
|
+
interface UpdateSubscriptionInvoiceCycleResponse {
|
|
2088
|
+
subscriptionInvoice?: SubscriptionInvoice;
|
|
2445
2089
|
}
|
|
2446
|
-
interface
|
|
2447
|
-
|
|
2448
|
-
|
|
2090
|
+
interface AddPausePeriodRequest {
|
|
2091
|
+
tenantId?: string;
|
|
2092
|
+
subscriptionId?: string;
|
|
2093
|
+
pauseStartDate?: Date | null;
|
|
2094
|
+
pauseEndDate?: Date | null;
|
|
2449
2095
|
}
|
|
2450
|
-
interface
|
|
2096
|
+
interface AddPausePeriodResponse {
|
|
2451
2097
|
subscription?: Subscription;
|
|
2452
2098
|
}
|
|
2453
|
-
interface
|
|
2454
|
-
|
|
2455
|
-
subscriptionId
|
|
2099
|
+
interface RunTimeCapsuleTaskNowRequest {
|
|
2100
|
+
tenantId?: string;
|
|
2101
|
+
subscriptionId?: string;
|
|
2102
|
+
taskType?: string;
|
|
2456
2103
|
}
|
|
2457
|
-
interface
|
|
2458
|
-
|
|
2104
|
+
interface CreateRecurringInvoiceBORequest {
|
|
2105
|
+
subscriptionId?: string;
|
|
2106
|
+
tenantId?: string;
|
|
2107
|
+
cycleNumber?: number;
|
|
2459
2108
|
}
|
|
2460
|
-
interface
|
|
2109
|
+
interface CreateRecurringInvoiceBOResponse {
|
|
2110
|
+
invoiceId?: string;
|
|
2461
2111
|
}
|
|
2462
|
-
interface
|
|
2463
|
-
|
|
2464
|
-
|
|
2112
|
+
interface SetShiftingDataRequest {
|
|
2113
|
+
subscriptionId?: string;
|
|
2114
|
+
tenantId?: string;
|
|
2115
|
+
isBassManaged?: boolean;
|
|
2116
|
+
shiftManagementDate?: Date | null;
|
|
2465
2117
|
}
|
|
2466
|
-
interface
|
|
2467
|
-
|
|
2468
|
-
amount?: number;
|
|
2118
|
+
interface SetShiftingDataResponse {
|
|
2119
|
+
subscription?: Subscription;
|
|
2469
2120
|
}
|
|
2470
|
-
interface
|
|
2471
|
-
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
/** The ID of the subscription to be extended */
|
|
2476
|
-
_id: string;
|
|
2477
|
-
actionContext: ActionContext;
|
|
2121
|
+
interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
|
|
2122
|
+
attachInvoice?: AttachInvoice;
|
|
2123
|
+
detachInvoice?: DetachInvoice;
|
|
2124
|
+
tenantId?: string;
|
|
2125
|
+
subscriptionId?: string;
|
|
2478
2126
|
}
|
|
2479
2127
|
/** @oneof */
|
|
2480
|
-
interface
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
/** user will be charged for billing cycles added */
|
|
2484
|
-
extensionBillingCycles?: number;
|
|
2485
|
-
}
|
|
2486
|
-
interface ExtendSubscriptionResponse {
|
|
2487
|
-
/** The now extended subscription */
|
|
2488
|
-
subscription?: Subscription;
|
|
2128
|
+
interface FixSubscriptionInvoicesRequestModeOneOf {
|
|
2129
|
+
attachInvoice?: AttachInvoice;
|
|
2130
|
+
detachInvoice?: DetachInvoice;
|
|
2489
2131
|
}
|
|
2490
|
-
interface
|
|
2491
|
-
|
|
2492
|
-
/** List of additional fields to be included in the response. */
|
|
2493
|
-
fields?: RequestedFields[];
|
|
2132
|
+
interface AttachInvoice {
|
|
2133
|
+
invoiceId?: string;
|
|
2494
2134
|
}
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
/** Include unsupported action list, including the reasons for the lack of support */
|
|
2498
|
-
UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
|
|
2135
|
+
interface DetachInvoice {
|
|
2136
|
+
invoiceId?: string;
|
|
2499
2137
|
}
|
|
2500
|
-
interface
|
|
2501
|
-
|
|
2502
|
-
actions?: Action[];
|
|
2503
|
-
/** List of actions that are not supported, included only if requested. Provides reasons for each unsupported action. */
|
|
2504
|
-
unsupportedActions?: UnsupportedAction[];
|
|
2138
|
+
interface FixSubscriptionInvoicesResponse {
|
|
2139
|
+
invoices?: SubscriptionInvoice[];
|
|
2505
2140
|
}
|
|
2506
|
-
interface
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
reasons?: UnsupportedReason[];
|
|
2141
|
+
interface RestoreDraftSubscriptionRequest {
|
|
2142
|
+
tenantId?: string;
|
|
2143
|
+
subscriptionId?: string;
|
|
2510
2144
|
}
|
|
2511
|
-
interface
|
|
2512
|
-
|
|
2513
|
-
description?: string | null;
|
|
2145
|
+
interface RestoreDraftSubscriptionResponse {
|
|
2146
|
+
subscription?: Subscription;
|
|
2514
2147
|
}
|
|
2515
|
-
interface
|
|
2516
|
-
|
|
2517
|
-
subscriptionId
|
|
2518
|
-
/** Period of time to provide charged for. If not provided,then only next charge will be returned. */
|
|
2519
|
-
customDuration?: Duration;
|
|
2520
|
-
/**
|
|
2521
|
-
* Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
|
|
2522
|
-
* If not provided, the upcoming charges will be calculated according to the existing next billing date.
|
|
2523
|
-
*/
|
|
2524
|
-
nextBillingDate?: Date | null;
|
|
2148
|
+
interface DeleteDraftSubscriptionRequest {
|
|
2149
|
+
tenantId?: string;
|
|
2150
|
+
subscriptionId?: string;
|
|
2525
2151
|
}
|
|
2526
|
-
interface
|
|
2527
|
-
|
|
2152
|
+
interface DeleteDraftSubscriptionResponse {
|
|
2153
|
+
subscription?: Subscription;
|
|
2528
2154
|
}
|
|
2529
|
-
interface
|
|
2530
|
-
|
|
2531
|
-
|
|
2155
|
+
interface DeleteSubscriptionBORequest {
|
|
2156
|
+
tenantId?: string;
|
|
2157
|
+
subscriptionId?: string;
|
|
2532
2158
|
}
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
|
-
/** Information about a non-existing subscription. */
|
|
2536
|
-
subscriptionInfo?: SubscriptionInfo;
|
|
2159
|
+
interface DeleteSubscriptionBOResponse {
|
|
2160
|
+
subscription?: Subscription;
|
|
2537
2161
|
}
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2162
|
+
interface CancelSubscriptionBORequest {
|
|
2163
|
+
tenantId?: string;
|
|
2164
|
+
subscriptionId?: string;
|
|
2165
|
+
initiator?: ActionInitiator;
|
|
2166
|
+
reason?: string | null;
|
|
2543
2167
|
}
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2168
|
+
declare enum ActionInitiator {
|
|
2169
|
+
UNDEFINED = "UNDEFINED",
|
|
2170
|
+
BUSINESS = "BUSINESS",
|
|
2171
|
+
CUSTOMER = "CUSTOMER",
|
|
2172
|
+
SYSTEM = "SYSTEM"
|
|
2547
2173
|
}
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
/** The cycle number from which the charge starts. */
|
|
2551
|
-
cycleFrom?: number;
|
|
2552
|
-
/** The number of cycles for which the charge is applicable. */
|
|
2553
|
-
cycleCount?: number | null;
|
|
2554
|
-
/** The breakdown of the charge */
|
|
2555
|
-
totals?: Totals;
|
|
2556
|
-
/** The billing date from which the charge starts */
|
|
2557
|
-
cycleBillingDate?: Date | null;
|
|
2174
|
+
interface CancelSubscriptionBOResponse {
|
|
2175
|
+
subscription?: Subscription;
|
|
2558
2176
|
}
|
|
2559
|
-
interface
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
2564
|
-
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
2565
|
-
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
2566
|
-
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
2567
|
-
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
2568
|
-
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
2569
|
-
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
2570
|
-
* in this case, charges for cycle 1 through 3.
|
|
2571
|
-
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
2572
|
-
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
2573
|
-
*/
|
|
2574
|
-
numberOfNextRecurringCharges?: number | null;
|
|
2177
|
+
interface UpdatePaymentMethodBORequest {
|
|
2178
|
+
tenantId?: string;
|
|
2179
|
+
subscriptionId?: string;
|
|
2180
|
+
paymentMethodId?: string;
|
|
2575
2181
|
}
|
|
2576
|
-
interface
|
|
2577
|
-
|
|
2578
|
-
externalId?: string | null;
|
|
2579
|
-
/** Billing details parameters including schedule, currency, etc. */
|
|
2580
|
-
billingSettings?: BillingSettings;
|
|
2581
|
-
/** Items, minSize is 1, maxSize is 100 */
|
|
2582
|
-
items?: Item[];
|
|
2583
|
-
/** Subscription start date, now if not set */
|
|
2584
|
-
startDate?: Date | null;
|
|
2585
|
-
/** Shipping address associated with subscription. At the moment used only for payments. Optional. */
|
|
2586
|
-
shippingAddress?: FullAddressDetails;
|
|
2182
|
+
interface UpdatePaymentMethodBOResponse {
|
|
2183
|
+
subscription?: Subscription;
|
|
2587
2184
|
}
|
|
2588
|
-
interface
|
|
2589
|
-
|
|
2590
|
-
|
|
2185
|
+
interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
|
|
2186
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
2187
|
+
tenantId?: string;
|
|
2188
|
+
subscriptionId?: string;
|
|
2591
2189
|
}
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
|
|
2595
|
-
/** Charges for subscription. */
|
|
2596
|
-
charges?: Charge[];
|
|
2190
|
+
/** @oneof */
|
|
2191
|
+
interface SendSubscriptionActionEventBORequestEventOneOf {
|
|
2192
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
2597
2193
|
}
|
|
2598
|
-
interface
|
|
2599
|
-
/** Subscription needs to be created */
|
|
2194
|
+
interface SubscriptionBillingCycleStarted {
|
|
2600
2195
|
subscription?: Subscription;
|
|
2601
|
-
/**
|
|
2602
|
-
|
|
2196
|
+
/** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
|
|
2197
|
+
paymentTransactionId?: string | null;
|
|
2603
2198
|
}
|
|
2604
|
-
interface
|
|
2605
|
-
/** Created subscription */
|
|
2606
|
-
subscription?: Subscription;
|
|
2607
|
-
/** Non-persistent invoice */
|
|
2608
|
-
invoice?: Invoice;
|
|
2199
|
+
interface SendSubscriptionActionEventResponse {
|
|
2609
2200
|
}
|
|
2610
|
-
|
|
2611
|
-
|
|
2201
|
+
interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
|
|
2202
|
+
tenantId?: string;
|
|
2203
|
+
subscriptionId?: string;
|
|
2204
|
+
transactionId?: string;
|
|
2205
|
+
}
|
|
2206
|
+
interface SetIsMigratedEvent {
|
|
2207
|
+
subscriptionId?: string;
|
|
2208
|
+
}
|
|
2209
|
+
interface SubscriptionDelayedSyncEvent {
|
|
2210
|
+
subscriptionId?: string;
|
|
2211
|
+
}
|
|
2212
|
+
interface InvoiceAction extends InvoiceActionActionTypeOneOf {
|
|
2213
|
+
payRecurring?: PayRecurringInvoice;
|
|
2214
|
+
}
|
|
2215
|
+
/** @oneof */
|
|
2216
|
+
interface InvoiceActionActionTypeOneOf {
|
|
2217
|
+
payRecurring?: PayRecurringInvoice;
|
|
2218
|
+
}
|
|
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;
|
|
2730
|
+
}
|
|
2731
|
+
interface CreateSubscriptionForOrderResponse {
|
|
2732
|
+
/** Created subscription */
|
|
2733
|
+
subscription?: Subscription;
|
|
2734
|
+
/** Non-persistent invoice */
|
|
2735
|
+
invoice?: Invoice;
|
|
2736
|
+
}
|
|
2737
|
+
/** An invoice includes information about the subscription and the customer. */
|
|
2738
|
+
interface Invoice {
|
|
2612
2739
|
/**
|
|
2613
2740
|
* Invoice ID.
|
|
2614
2741
|
* @readonly
|
|
@@ -2919,8 +3046,6 @@ interface Reschedule {
|
|
|
2919
3046
|
executeAt?: Date | null;
|
|
2920
3047
|
payload?: string | null;
|
|
2921
3048
|
}
|
|
2922
|
-
interface Empty {
|
|
2923
|
-
}
|
|
2924
3049
|
interface V1SubscriptionEvent extends V1SubscriptionEventEventOneOf {
|
|
2925
3050
|
/** A subscriptions was created */
|
|
2926
3051
|
created?: V1SubscriptionCreated;
|
|
@@ -3118,368 +3243,271 @@ interface V2Subscription {
|
|
|
3118
3243
|
trial?: SubscriptionTrialPeriod;
|
|
3119
3244
|
/**
|
|
3120
3245
|
* how many billing cycles should be done before subscription finishes
|
|
3121
|
-
* (optional, 0 by default means endless subscription)
|
|
3122
|
-
*/
|
|
3123
|
-
billingCycles?: number;
|
|
3124
|
-
/**
|
|
3125
|
-
* date in the future or in the past when the first billing cycle begins
|
|
3126
|
-
* (the first off-session payment is performed when it ends)
|
|
3127
|
-
*/
|
|
3128
|
-
firstCycleStartDate?: Date | null;
|
|
3129
|
-
}
|
|
3130
|
-
/** Frequency unit of recurring payment */
|
|
3131
|
-
declare enum SubscriptionFrequency {
|
|
3132
|
-
UNDEFINED = "UNDEFINED",
|
|
3133
|
-
DAY = "DAY",
|
|
3134
|
-
WEEK = "WEEK",
|
|
3135
|
-
MONTH = "MONTH",
|
|
3136
|
-
YEAR = "YEAR"
|
|
3137
|
-
}
|
|
3138
|
-
/** Trial period of subscription */
|
|
3139
|
-
interface SubscriptionTrialPeriod {
|
|
3140
|
-
/** trial period in units (required) */
|
|
3141
|
-
period?: number;
|
|
3142
|
-
/** units in which trial period is described (optional, default DAY) */
|
|
3143
|
-
unit?: SubscriptionFrequency;
|
|
3144
|
-
}
|
|
3145
|
-
declare enum CancellationInitiator {
|
|
3146
|
-
/** Cancellation initiator undefined */
|
|
3147
|
-
UNDEFINED = "UNDEFINED",
|
|
3148
|
-
/** Subscription was canceled by site owner (default if canceled by user or service identity) */
|
|
3149
|
-
OWNER = "OWNER",
|
|
3150
|
-
/** Subscription was canceled by member (default if canceled by member identity) */
|
|
3151
|
-
MEMBER = "MEMBER",
|
|
3152
|
-
/** Subscription was canceled because of payment failure */
|
|
3153
|
-
PAYMENT_FAILURE = "PAYMENT_FAILURE",
|
|
3154
|
-
/** Subscription was canceled because of payment setup failure */
|
|
3155
|
-
SETUP_FAILURE = "SETUP_FAILURE"
|
|
3156
|
-
}
|
|
3157
|
-
interface SubscriptionPolicy {
|
|
3158
|
-
/** Subscription expiration date can be updated */
|
|
3159
|
-
expiryDateChangeable?: boolean;
|
|
3160
|
-
/** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
|
|
3161
|
-
cancellableByMember?: boolean;
|
|
3162
|
-
/** Subscription expiration date on cancellation can be set to next payment date */
|
|
3163
|
-
cancellableAtNextPaymentCycle?: boolean;
|
|
3164
|
-
}
|
|
3165
|
-
interface Suspension {
|
|
3166
|
-
status?: Status;
|
|
3167
|
-
/** Beginning of the suspended period */
|
|
3168
|
-
startsAt?: Date | null;
|
|
3169
|
-
/** End of the suspended period */
|
|
3170
|
-
endsAt?: Date | null;
|
|
3171
|
-
}
|
|
3172
|
-
declare enum Status {
|
|
3173
|
-
UNDEFINED = "UNDEFINED",
|
|
3174
|
-
ACTIVE = "ACTIVE",
|
|
3175
|
-
ENDED = "ENDED"
|
|
3176
|
-
}
|
|
3177
|
-
/** A duration expressed in amount of time units. */
|
|
3178
|
-
interface V1Duration {
|
|
3179
|
-
/** Amount of the unit */
|
|
3180
|
-
amount?: number;
|
|
3181
|
-
/** Day, Week, Month, Year. */
|
|
3182
|
-
unit?: SubscriptionFrequency;
|
|
3183
|
-
}
|
|
3184
|
-
interface V1SubscriptionActivated {
|
|
3185
|
-
subscription?: V1Subscription;
|
|
3186
|
-
}
|
|
3187
|
-
interface V1SubscriptionCanceled {
|
|
3188
|
-
subscription?: V1Subscription;
|
|
3189
|
-
}
|
|
3190
|
-
interface V1SubscriptionUpdated {
|
|
3191
|
-
subscription?: V1Subscription;
|
|
3192
|
-
}
|
|
3193
|
-
interface SubscriptionCycleTriggered {
|
|
3194
|
-
subscription?: V1Subscription;
|
|
3195
|
-
billingCycle?: number;
|
|
3196
|
-
/** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
|
|
3197
|
-
transactionId?: string | null;
|
|
3198
|
-
}
|
|
3199
|
-
interface SubscriptionMarkedAsPaid {
|
|
3200
|
-
subscription?: V1Subscription;
|
|
3201
|
-
/** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
|
|
3202
|
-
billingCycle?: number | null;
|
|
3203
|
-
}
|
|
3204
|
-
interface SubscriptionCancellationRequested {
|
|
3205
|
-
subscription?: V1Subscription;
|
|
3206
|
-
}
|
|
3207
|
-
interface SubscriptionSuspended {
|
|
3208
|
-
subscription?: V1Subscription;
|
|
3209
|
-
}
|
|
3210
|
-
interface V1SubscriptionResumed {
|
|
3211
|
-
subscription?: V1Subscription;
|
|
3212
|
-
}
|
|
3213
|
-
interface SubscriptionExpired {
|
|
3214
|
-
subscription?: V1Subscription;
|
|
3215
|
-
}
|
|
3216
|
-
interface V1SubscriptionInitialPurchaseCompleted {
|
|
3217
|
-
subscription?: V1Subscription;
|
|
3218
|
-
}
|
|
3219
|
-
interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
|
|
3220
|
-
activeSubscription?: CreateSubscriptionRequest;
|
|
3221
|
-
}
|
|
3222
|
-
/** @oneof */
|
|
3223
|
-
interface CreateSubscriptionInStateRequestModeOneOf {
|
|
3224
|
-
activeSubscription?: CreateSubscriptionRequest;
|
|
3225
|
-
}
|
|
3226
|
-
interface CreateSubscriptionInStateResponse {
|
|
3227
|
-
subscriptionId?: string;
|
|
3228
|
-
}
|
|
3229
|
-
interface PayCycleRequest {
|
|
3230
|
-
subscriptionId: string;
|
|
3231
|
-
paymentTestMode?: PaymentTestMode;
|
|
3232
|
-
tenantId: string;
|
|
3233
|
-
}
|
|
3234
|
-
declare enum PaymentTestMode {
|
|
3235
|
-
REGULAR = "REGULAR",
|
|
3236
|
-
FAIL_TECHNICAL = "FAIL_TECHNICAL",
|
|
3237
|
-
FAIL_DECLINE = "FAIL_DECLINE",
|
|
3238
|
-
FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
|
|
3239
|
-
}
|
|
3240
|
-
interface PayCycleResponse {
|
|
3241
|
-
invoiceId?: string;
|
|
3242
|
-
paymentOrderId?: string | null;
|
|
3243
|
-
subscription?: Subscription;
|
|
3244
|
-
}
|
|
3245
|
-
interface GetFullSubscriptionDataRequest {
|
|
3246
|
-
_id?: string;
|
|
3247
|
-
}
|
|
3248
|
-
interface GetFullSubscriptionDataResponse {
|
|
3249
|
-
subscription?: Subscription;
|
|
3250
|
-
internalSubscriptionData?: InternalSubscriptionData;
|
|
3251
|
-
}
|
|
3252
|
-
interface InternalSubscriptionData {
|
|
3253
|
-
originInstanceId?: string;
|
|
3254
|
-
source?: string | null;
|
|
3255
|
-
billingType?: string;
|
|
3256
|
-
isOneTime?: boolean;
|
|
3257
|
-
migrationDetails?: MigrationDetails;
|
|
3258
|
-
pausePaidDuration?: string | null;
|
|
3259
|
-
authorizationPaymentData?: PaymentData;
|
|
3260
|
-
currentCyclePausePeriods?: PausePeriod[];
|
|
3261
|
-
}
|
|
3262
|
-
interface MigrationDetails {
|
|
3263
|
-
/** system (application) where the Subscription has been created */
|
|
3264
|
-
originSystem?: string;
|
|
3265
|
-
/** date when the Subscription started to be managed in BASS */
|
|
3266
|
-
shiftManagementDate?: Date | null;
|
|
3267
|
-
}
|
|
3268
|
-
interface PausePeriod {
|
|
3269
|
-
startDate?: Date | null;
|
|
3270
|
-
endDate?: Date | null;
|
|
3271
|
-
}
|
|
3272
|
-
interface GetSubscriptionAndInternalDataRequest {
|
|
3273
|
-
subscriptionId?: string;
|
|
3274
|
-
tenantId?: string;
|
|
3275
|
-
}
|
|
3276
|
-
interface GetSubscriptionAndInternalDataResponse {
|
|
3277
|
-
subscription?: Subscription;
|
|
3278
|
-
internalSubscriptionData?: InternalSubscriptionData;
|
|
3279
|
-
}
|
|
3280
|
-
interface SearchSubscriptionRequest {
|
|
3281
|
-
_id?: string;
|
|
3282
|
-
tenantId?: string;
|
|
3283
|
-
}
|
|
3284
|
-
interface SearchSubscriptionResponse {
|
|
3285
|
-
subscription?: Subscription;
|
|
3286
|
-
}
|
|
3287
|
-
interface UpdatePausePaidDurationRequest {
|
|
3288
|
-
subscriptionId?: string;
|
|
3289
|
-
pausePaidDurationSeconds?: string;
|
|
3290
|
-
tenantId?: string;
|
|
3291
|
-
}
|
|
3292
|
-
interface UpdatePausePaidDurationResponse {
|
|
3293
|
-
}
|
|
3294
|
-
interface UpdateStatusRequest {
|
|
3295
|
-
subscriptionId?: string;
|
|
3296
|
-
tenantId?: string;
|
|
3297
|
-
status?: SubscriptionStatusEnumSubscriptionStatus;
|
|
3298
|
-
}
|
|
3299
|
-
interface UpdateStatusResponse {
|
|
3300
|
-
subscription?: Subscription;
|
|
3301
|
-
}
|
|
3302
|
-
interface UpdatePaymentStatusRequest {
|
|
3303
|
-
subscriptionId?: string;
|
|
3304
|
-
tenantId?: string;
|
|
3305
|
-
paymentStatus?: PaymentStatus;
|
|
3306
|
-
}
|
|
3307
|
-
interface UpdatePaymentStatusResponse {
|
|
3308
|
-
subscription?: Subscription;
|
|
3309
|
-
}
|
|
3310
|
-
interface ReviveSubscriptionRequest {
|
|
3311
|
-
tenantId?: string;
|
|
3312
|
-
subscriptionId?: string;
|
|
3313
|
-
revivePolicy?: RevivePolicy;
|
|
3314
|
-
isTestRun?: boolean;
|
|
3315
|
-
}
|
|
3316
|
-
declare enum RevivePolicy {
|
|
3317
|
-
SIMPLE = "SIMPLE",
|
|
3318
|
-
RESUME = "RESUME"
|
|
3319
|
-
}
|
|
3320
|
-
interface ReviveSubscriptionResponse {
|
|
3321
|
-
subscription?: Subscription;
|
|
3246
|
+
* (optional, 0 by default means endless subscription)
|
|
3247
|
+
*/
|
|
3248
|
+
billingCycles?: number;
|
|
3249
|
+
/**
|
|
3250
|
+
* date in the future or in the past when the first billing cycle begins
|
|
3251
|
+
* (the first off-session payment is performed when it ends)
|
|
3252
|
+
*/
|
|
3253
|
+
firstCycleStartDate?: Date | null;
|
|
3322
3254
|
}
|
|
3323
|
-
|
|
3324
|
-
|
|
3255
|
+
/** Frequency unit of recurring payment */
|
|
3256
|
+
declare enum SubscriptionFrequency {
|
|
3257
|
+
UNDEFINED = "UNDEFINED",
|
|
3258
|
+
DAY = "DAY",
|
|
3259
|
+
WEEK = "WEEK",
|
|
3260
|
+
MONTH = "MONTH",
|
|
3261
|
+
YEAR = "YEAR"
|
|
3325
3262
|
}
|
|
3326
|
-
|
|
3327
|
-
|
|
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;
|
|
3328
3269
|
}
|
|
3329
|
-
|
|
3330
|
-
|
|
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"
|
|
3331
3281
|
}
|
|
3332
|
-
interface
|
|
3333
|
-
|
|
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;
|
|
3334
3289
|
}
|
|
3335
|
-
interface
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
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;
|
|
3339
3296
|
}
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
|
|
3297
|
+
declare enum Status {
|
|
3298
|
+
UNDEFINED = "UNDEFINED",
|
|
3299
|
+
ACTIVE = "ACTIVE",
|
|
3300
|
+
ENDED = "ENDED"
|
|
3343
3301
|
}
|
|
3344
|
-
|
|
3345
|
-
|
|
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;
|
|
3346
3308
|
}
|
|
3347
|
-
interface
|
|
3348
|
-
|
|
3349
|
-
subscriptionId?: string;
|
|
3350
|
-
taskType?: string;
|
|
3309
|
+
interface V1SubscriptionActivated {
|
|
3310
|
+
subscription?: V1Subscription;
|
|
3351
3311
|
}
|
|
3352
|
-
interface
|
|
3353
|
-
|
|
3354
|
-
taskType?: string;
|
|
3355
|
-
executionTime?: Date | null;
|
|
3356
|
-
tenantId?: string;
|
|
3312
|
+
interface V1SubscriptionCanceled {
|
|
3313
|
+
subscription?: V1Subscription;
|
|
3357
3314
|
}
|
|
3358
|
-
interface
|
|
3359
|
-
|
|
3360
|
-
subscriptionId?: string;
|
|
3361
|
-
taskType?: string;
|
|
3315
|
+
interface V1SubscriptionUpdated {
|
|
3316
|
+
subscription?: V1Subscription;
|
|
3362
3317
|
}
|
|
3363
|
-
interface
|
|
3364
|
-
|
|
3365
|
-
|
|
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;
|
|
3366
3323
|
}
|
|
3367
|
-
interface
|
|
3368
|
-
subscription?:
|
|
3324
|
+
interface SubscriptionMarkedAsPaid {
|
|
3325
|
+
subscription?: V1Subscription;
|
|
3326
|
+
/** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
|
|
3327
|
+
billingCycle?: number | null;
|
|
3369
3328
|
}
|
|
3370
|
-
interface
|
|
3371
|
-
|
|
3372
|
-
tenantId?: string;
|
|
3373
|
-
invoiceId?: string;
|
|
3374
|
-
subscriptionCycle?: number;
|
|
3329
|
+
interface SubscriptionCancellationRequested {
|
|
3330
|
+
subscription?: V1Subscription;
|
|
3375
3331
|
}
|
|
3376
|
-
interface
|
|
3377
|
-
|
|
3332
|
+
interface SubscriptionSuspended {
|
|
3333
|
+
subscription?: V1Subscription;
|
|
3378
3334
|
}
|
|
3379
|
-
interface
|
|
3380
|
-
|
|
3381
|
-
subscriptionId?: string;
|
|
3382
|
-
pauseStartDate?: Date | null;
|
|
3383
|
-
pauseEndDate?: Date | null;
|
|
3335
|
+
interface V1SubscriptionResumed {
|
|
3336
|
+
subscription?: V1Subscription;
|
|
3384
3337
|
}
|
|
3385
|
-
interface
|
|
3386
|
-
subscription?:
|
|
3338
|
+
interface SubscriptionExpired {
|
|
3339
|
+
subscription?: V1Subscription;
|
|
3387
3340
|
}
|
|
3388
|
-
interface
|
|
3389
|
-
|
|
3390
|
-
subscriptionId?: string;
|
|
3391
|
-
taskType?: string;
|
|
3341
|
+
interface V1SubscriptionInitialPurchaseCompleted {
|
|
3342
|
+
subscription?: V1Subscription;
|
|
3392
3343
|
}
|
|
3393
|
-
interface
|
|
3394
|
-
subscriptionId
|
|
3395
|
-
|
|
3396
|
-
|
|
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;
|
|
3397
3350
|
}
|
|
3398
|
-
|
|
3399
|
-
|
|
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"
|
|
3400
3357
|
}
|
|
3401
|
-
interface
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
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;
|
|
3406
3363
|
}
|
|
3407
|
-
interface
|
|
3408
|
-
|
|
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;
|
|
3409
3370
|
}
|
|
3410
|
-
interface
|
|
3411
|
-
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
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;
|
|
3415
3404
|
}
|
|
3416
3405
|
/** @oneof */
|
|
3417
|
-
interface
|
|
3418
|
-
|
|
3419
|
-
|
|
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;
|
|
3420
3439
|
}
|
|
3421
|
-
interface
|
|
3422
|
-
|
|
3440
|
+
interface SubscriptionCreated {
|
|
3441
|
+
subscription?: Subscription;
|
|
3423
3442
|
}
|
|
3424
|
-
interface
|
|
3425
|
-
|
|
3443
|
+
interface SubscriptionUpdated {
|
|
3444
|
+
current?: Subscription;
|
|
3445
|
+
previous?: Subscription;
|
|
3446
|
+
diff?: SubscriptionDiff;
|
|
3426
3447
|
}
|
|
3427
|
-
interface
|
|
3428
|
-
|
|
3448
|
+
interface SubscriptionDiff {
|
|
3449
|
+
added?: string | null;
|
|
3450
|
+
changed?: string | null;
|
|
3451
|
+
deleted?: string | null;
|
|
3429
3452
|
}
|
|
3430
|
-
interface
|
|
3431
|
-
tenantId?: string;
|
|
3453
|
+
interface SubscriptionDeleted {
|
|
3432
3454
|
subscriptionId?: string;
|
|
3433
3455
|
}
|
|
3434
|
-
interface
|
|
3456
|
+
interface FutureUpdatesRequested {
|
|
3435
3457
|
subscription?: Subscription;
|
|
3458
|
+
requestedUpdateData?: SubscriptionUpdateData;
|
|
3436
3459
|
}
|
|
3437
|
-
interface
|
|
3438
|
-
|
|
3439
|
-
|
|
3460
|
+
interface UpdatesApplied {
|
|
3461
|
+
subscription?: Subscription;
|
|
3462
|
+
updateAction?: UpdateAction;
|
|
3463
|
+
appliedUpdateData?: SubscriptionUpdateData;
|
|
3440
3464
|
}
|
|
3441
|
-
interface
|
|
3465
|
+
interface ResetPendingUpdates {
|
|
3442
3466
|
subscription?: Subscription;
|
|
3443
3467
|
}
|
|
3444
|
-
interface
|
|
3445
|
-
|
|
3446
|
-
subscriptionId?: string;
|
|
3468
|
+
interface GracePeriodStarted {
|
|
3469
|
+
subscription?: Subscription;
|
|
3447
3470
|
}
|
|
3448
|
-
interface
|
|
3471
|
+
interface GracePeriodEnded {
|
|
3449
3472
|
subscription?: Subscription;
|
|
3473
|
+
/** Indication for the payment settlement method. */
|
|
3474
|
+
paymentSettlementMethod?: PaymentSettlementMethod;
|
|
3450
3475
|
}
|
|
3451
|
-
|
|
3452
|
-
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
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"
|
|
3456
3484
|
}
|
|
3457
|
-
interface
|
|
3485
|
+
interface PaymentMethodUpdated {
|
|
3458
3486
|
subscription?: Subscription;
|
|
3487
|
+
initiator?: HistoryActionInitiator;
|
|
3488
|
+
paymentMode?: PaymentMode;
|
|
3459
3489
|
}
|
|
3460
|
-
interface
|
|
3461
|
-
tenantId?: string;
|
|
3462
|
-
subscriptionId?: string;
|
|
3463
|
-
paymentMethodId?: string;
|
|
3464
|
-
}
|
|
3465
|
-
interface UpdatePaymentMethodBOResponse {
|
|
3490
|
+
interface SubscriptionCollectionMethodUpdated {
|
|
3466
3491
|
subscription?: Subscription;
|
|
3492
|
+
newCollectionMethod?: CollectionMethodEnumCollectionMethod;
|
|
3493
|
+
previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
|
|
3467
3494
|
}
|
|
3468
|
-
interface
|
|
3469
|
-
|
|
3470
|
-
tenantId?: string;
|
|
3471
|
-
subscriptionId?: string;
|
|
3495
|
+
interface FreeTrailStarted {
|
|
3496
|
+
subscription?: Subscription;
|
|
3472
3497
|
}
|
|
3473
|
-
|
|
3474
|
-
|
|
3475
|
-
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
3498
|
+
interface FreeTrailEnded {
|
|
3499
|
+
subscription?: Subscription;
|
|
3476
3500
|
}
|
|
3477
|
-
interface
|
|
3501
|
+
interface SubscriptionBackOfficeAction {
|
|
3502
|
+
subscription?: Subscription;
|
|
3503
|
+
/** The backoffice method name */
|
|
3504
|
+
name?: string;
|
|
3505
|
+
/** json as string format, to store the flatted request object */
|
|
3506
|
+
params?: string;
|
|
3478
3507
|
}
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
transactionId?: string;
|
|
3508
|
+
/** Defines unknown events restored from the logs */
|
|
3509
|
+
interface UnknownSubscriptionEvent {
|
|
3510
|
+
subscriptionAsString?: string | null;
|
|
3483
3511
|
}
|
|
3484
3512
|
interface CustomerNonNullableFields {
|
|
3485
3513
|
visitorId: string;
|
|
@@ -3514,11 +3542,15 @@ interface TaxNonNullableFields {
|
|
|
3514
3542
|
percentage: string;
|
|
3515
3543
|
dynamic?: DynamicTaxNonNullableFields;
|
|
3516
3544
|
}
|
|
3545
|
+
interface CyclesNonNullableFields {
|
|
3546
|
+
cycleFrom: number;
|
|
3547
|
+
}
|
|
3517
3548
|
interface AdditionalFeeNonNullableFields {
|
|
3518
3549
|
name: string;
|
|
3519
3550
|
amount: string;
|
|
3520
3551
|
trigger: AdditionalFeeTrigger;
|
|
3521
3552
|
tax?: TaxNonNullableFields;
|
|
3553
|
+
cycles?: CyclesNonNullableFields;
|
|
3522
3554
|
}
|
|
3523
3555
|
interface DiscountCyclesNonNullableFields {
|
|
3524
3556
|
cycleFrom: number;
|
|
@@ -3610,45 +3642,205 @@ interface ItemChangeNonNullableFields {
|
|
|
3610
3642
|
pricingModel?: PricingModelNonNullableFields;
|
|
3611
3643
|
tax?: TaxNonNullableFields;
|
|
3612
3644
|
}
|
|
3613
|
-
interface CatalogReferenceNonNullableFields {
|
|
3614
|
-
catalogItemId: string;
|
|
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[];
|
|
3615
3824
|
}
|
|
3616
|
-
interface
|
|
3617
|
-
|
|
3618
|
-
|
|
3825
|
+
interface AllowedActionsResponseNonNullableFields {
|
|
3826
|
+
actions: ActionNonNullableFields[];
|
|
3827
|
+
unsupportedActions: UnsupportedActionNonNullableFields[];
|
|
3619
3828
|
}
|
|
3620
|
-
interface
|
|
3621
|
-
|
|
3622
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
3623
|
-
category: ItemCategory;
|
|
3624
|
-
quantity: number;
|
|
3625
|
-
pricingModel?: PricingModelNonNullableFields;
|
|
3626
|
-
tax?: TaxNonNullableFields;
|
|
3627
|
-
discounts: DiscountNonNullableFields[];
|
|
3628
|
-
applicationFee?: ApplicationFeeNonNullableFields;
|
|
3829
|
+
interface ListUpcomingChargesResponseNonNullableFields {
|
|
3830
|
+
upcomingCharges: SubscriptionChargeNonNullableFields[];
|
|
3629
3831
|
}
|
|
3630
|
-
interface
|
|
3631
|
-
|
|
3632
|
-
|
|
3633
|
-
numberOfRequests: number;
|
|
3832
|
+
interface ChargeNonNullableFields {
|
|
3833
|
+
cycleFrom: number;
|
|
3834
|
+
totals?: TotalsNonNullableFields;
|
|
3634
3835
|
}
|
|
3635
|
-
interface
|
|
3636
|
-
|
|
3836
|
+
interface PreviewSubscriptionChargesResponseNonNullableFields {
|
|
3837
|
+
charges: ChargeNonNullableFields[];
|
|
3637
3838
|
}
|
|
3638
|
-
interface
|
|
3639
|
-
|
|
3640
|
-
|
|
3641
|
-
|
|
3642
|
-
|
|
3643
|
-
billingStatus?: BillingStatusNonNullableFields;
|
|
3644
|
-
shippingAddress?: FullAddressDetailsNonNullableFields;
|
|
3645
|
-
policies?: SubscriptionPoliciesNonNullableFields;
|
|
3646
|
-
pauseInfo?: PauseInfoNonNullableFields;
|
|
3647
|
-
cancellationInfo?: CancellationInfoNonNullableFields;
|
|
3648
|
-
pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
|
|
3649
|
-
bassManaged: boolean;
|
|
3650
|
-
specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
|
|
3651
|
-
items: ItemNonNullableFields[];
|
|
3839
|
+
interface SubscriptionChargesNonNullableFields {
|
|
3840
|
+
charges: ChargeNonNullableFields[];
|
|
3841
|
+
}
|
|
3842
|
+
interface PreviewSubscriptionsChargesResponseNonNullableFields {
|
|
3843
|
+
subscriptionsCharges: SubscriptionChargesNonNullableFields[];
|
|
3652
3844
|
}
|
|
3653
3845
|
interface SubscriptionCreatedNonNullableFields {
|
|
3654
3846
|
subscription?: SubscriptionNonNullableFields;
|
|
@@ -3816,166 +4008,6 @@ interface SubscriptionHistoryEntryNonNullableFields {
|
|
|
3816
4008
|
interface ListSubscriptionHistoryResponseNonNullableFields {
|
|
3817
4009
|
historyEntries: SubscriptionHistoryEntryNonNullableFields[];
|
|
3818
4010
|
}
|
|
3819
|
-
interface GetSubscriptionResponseNonNullableFields {
|
|
3820
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3821
|
-
}
|
|
3822
|
-
interface CustomerCancelSubscriptionResponseNonNullableFields {
|
|
3823
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3824
|
-
}
|
|
3825
|
-
interface CustomerTurnOnAutoRenewalResponseNonNullableFields {
|
|
3826
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3827
|
-
}
|
|
3828
|
-
interface CustomerTurnOffAutoRenewalResponseNonNullableFields {
|
|
3829
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3830
|
-
}
|
|
3831
|
-
interface CustomerExtendSubscriptionResponseNonNullableFields {
|
|
3832
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3833
|
-
}
|
|
3834
|
-
interface QuerySubscriptionsResponseNonNullableFields {
|
|
3835
|
-
subscriptions: SubscriptionNonNullableFields[];
|
|
3836
|
-
}
|
|
3837
|
-
interface UpdateSubscriptionPaymentMethodResponseNonNullableFields {
|
|
3838
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3839
|
-
}
|
|
3840
|
-
interface ActionNonNullableFields {
|
|
3841
|
-
actionType: ActionType;
|
|
3842
|
-
pausePolicies: PausePolicy[];
|
|
3843
|
-
pauseAt: PauseAt[];
|
|
3844
|
-
resumeAt: ResumeAt[];
|
|
3845
|
-
extendPolicies: ExtendPolicyType[];
|
|
3846
|
-
}
|
|
3847
|
-
interface CustomerAllowedActionsResponseNonNullableFields {
|
|
3848
|
-
actions: ActionNonNullableFields[];
|
|
3849
|
-
}
|
|
3850
|
-
interface RecurringNonNullableFields {
|
|
3851
|
-
cycleNumber: number;
|
|
3852
|
-
}
|
|
3853
|
-
interface InvoiceDiscountNonNullableFields {
|
|
3854
|
-
amount: string;
|
|
3855
|
-
percentage: string;
|
|
3856
|
-
origin?: DiscountOriginNonNullableFields;
|
|
3857
|
-
}
|
|
3858
|
-
interface InvoiceApplicationFeeNonNullableFields {
|
|
3859
|
-
amount: string;
|
|
3860
|
-
discount?: InvoiceDiscountNonNullableFields;
|
|
3861
|
-
}
|
|
3862
|
-
interface PriceDetailsNonNullableFields {
|
|
3863
|
-
price: string;
|
|
3864
|
-
tax?: TaxNonNullableFields;
|
|
3865
|
-
discount?: InvoiceDiscountNonNullableFields;
|
|
3866
|
-
applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
|
|
3867
|
-
}
|
|
3868
|
-
interface LineItemTaxSummaryNonNullableFields {
|
|
3869
|
-
aggregatedTaxAmount: string;
|
|
3870
|
-
aggregatedTaxRate: string;
|
|
3871
|
-
taxableAmount: string;
|
|
3872
|
-
}
|
|
3873
|
-
interface TaxBreakdownNonNullableFields {
|
|
3874
|
-
taxType: string;
|
|
3875
|
-
taxRate: string;
|
|
3876
|
-
jurisdictionType: string;
|
|
3877
|
-
}
|
|
3878
|
-
interface ItemTaxDataNonNullableFields {
|
|
3879
|
-
lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields;
|
|
3880
|
-
taxBreakdowns: TaxBreakdownNonNullableFields[];
|
|
3881
|
-
}
|
|
3882
|
-
interface InvoiceItemNonNullableFields {
|
|
3883
|
-
recurring?: RecurringNonNullableFields;
|
|
3884
|
-
_id: string;
|
|
3885
|
-
name: string;
|
|
3886
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
3887
|
-
category: ItemCategory;
|
|
3888
|
-
quantity: number;
|
|
3889
|
-
priceDetails?: PriceDetailsNonNullableFields;
|
|
3890
|
-
totals?: TotalsNonNullableFields;
|
|
3891
|
-
taxData?: ItemTaxDataNonNullableFields;
|
|
3892
|
-
}
|
|
3893
|
-
interface SubscriptionChargeNonNullableFields {
|
|
3894
|
-
cycle: number;
|
|
3895
|
-
totals?: TotalsNonNullableFields;
|
|
3896
|
-
invoiceItems: InvoiceItemNonNullableFields[];
|
|
3897
|
-
discount?: InvoiceDiscountNonNullableFields;
|
|
3898
|
-
}
|
|
3899
|
-
interface CustomerListUpcomingChargesResponseNonNullableFields {
|
|
3900
|
-
upcomingCharge?: SubscriptionChargeNonNullableFields;
|
|
3901
|
-
}
|
|
3902
|
-
interface InitiatePaymentMethodSetupResponseNonNullableFields {
|
|
3903
|
-
paymentOrderId: string;
|
|
3904
|
-
}
|
|
3905
|
-
interface UpdateSubscriptionBillingDateResponseNonNullableFields {
|
|
3906
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3907
|
-
}
|
|
3908
|
-
interface CancelSubscriptionResponseNonNullableFields {
|
|
3909
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3910
|
-
}
|
|
3911
|
-
interface PauseSubscriptionResponseNonNullableFields {
|
|
3912
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3913
|
-
}
|
|
3914
|
-
interface ResumeSubscriptionResponseNonNullableFields {
|
|
3915
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3916
|
-
}
|
|
3917
|
-
interface SearchSubscriptionsResponseNonNullableFields {
|
|
3918
|
-
subscriptions: SubscriptionNonNullableFields[];
|
|
3919
|
-
}
|
|
3920
|
-
interface CountByStatusNonNullableFields {
|
|
3921
|
-
status: SubscriptionStatusEnumSubscriptionStatus;
|
|
3922
|
-
count: number;
|
|
3923
|
-
}
|
|
3924
|
-
interface CountSubscriptionsResponseNonNullableFields {
|
|
3925
|
-
countByStatus: CountByStatusNonNullableFields[];
|
|
3926
|
-
total: number;
|
|
3927
|
-
}
|
|
3928
|
-
interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
|
|
3929
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3930
|
-
}
|
|
3931
|
-
interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
|
|
3932
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3933
|
-
}
|
|
3934
|
-
interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
|
|
3935
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3936
|
-
}
|
|
3937
|
-
interface AmountByStatusNonNullableFields {
|
|
3938
|
-
status: SubscriptionStatusEnumSubscriptionStatus;
|
|
3939
|
-
amount: number;
|
|
3940
|
-
}
|
|
3941
|
-
interface GetSubscriptionsStatsResponseNonNullableFields {
|
|
3942
|
-
amountByStatuses: AmountByStatusNonNullableFields[];
|
|
3943
|
-
total: number;
|
|
3944
|
-
}
|
|
3945
|
-
interface ExtendSubscriptionResponseNonNullableFields {
|
|
3946
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3947
|
-
}
|
|
3948
|
-
interface UnsupportedReasonNonNullableFields {
|
|
3949
|
-
code: string;
|
|
3950
|
-
}
|
|
3951
|
-
interface UnsupportedActionNonNullableFields {
|
|
3952
|
-
actionType: ActionType;
|
|
3953
|
-
reasons: UnsupportedReasonNonNullableFields[];
|
|
3954
|
-
}
|
|
3955
|
-
interface AllowedActionsResponseNonNullableFields {
|
|
3956
|
-
actions: ActionNonNullableFields[];
|
|
3957
|
-
unsupportedActions: UnsupportedActionNonNullableFields[];
|
|
3958
|
-
}
|
|
3959
|
-
interface ListUpcomingChargesResponseNonNullableFields {
|
|
3960
|
-
upcomingCharges: SubscriptionChargeNonNullableFields[];
|
|
3961
|
-
}
|
|
3962
|
-
interface ChargeNonNullableFields {
|
|
3963
|
-
cycleFrom: number;
|
|
3964
|
-
totals?: TotalsNonNullableFields;
|
|
3965
|
-
}
|
|
3966
|
-
interface PreviewSubscriptionChargesResponseNonNullableFields {
|
|
3967
|
-
charges: ChargeNonNullableFields[];
|
|
3968
|
-
}
|
|
3969
|
-
interface SubscriptionChargesNonNullableFields {
|
|
3970
|
-
charges: ChargeNonNullableFields[];
|
|
3971
|
-
}
|
|
3972
|
-
interface PreviewSubscriptionsChargesResponseNonNullableFields {
|
|
3973
|
-
subscriptionsCharges: SubscriptionChargesNonNullableFields[];
|
|
3974
|
-
}
|
|
3975
|
-
interface PayCycleResponseNonNullableFields {
|
|
3976
|
-
invoiceId: string;
|
|
3977
|
-
subscription?: SubscriptionNonNullableFields;
|
|
3978
|
-
}
|
|
3979
4011
|
interface BaseEventMetadata {
|
|
3980
4012
|
/** App instance ID. */
|
|
3981
4013
|
instanceId?: string | null;
|
|
@@ -4074,12 +4106,6 @@ interface SubscriptionResumedEnvelope {
|
|
|
4074
4106
|
data: SubscriptionResumed;
|
|
4075
4107
|
metadata: EventMetadata;
|
|
4076
4108
|
}
|
|
4077
|
-
interface ListSubscriptionHistoryOptions {
|
|
4078
|
-
/** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
|
|
4079
|
-
mode?: HistoryViewMode;
|
|
4080
|
-
/** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
|
|
4081
|
-
cursor?: CursorPaging;
|
|
4082
|
-
}
|
|
4083
4109
|
interface CustomerCancelSubscriptionOptions {
|
|
4084
4110
|
/** Optional action reason message */
|
|
4085
4111
|
reason?: string | null;
|
|
@@ -4105,6 +4131,10 @@ interface CustomerInitiatePaymentMethodSetupOptions {
|
|
|
4105
4131
|
paymentMode?: PaymentMode;
|
|
4106
4132
|
paymentSettings?: PaymentSettings;
|
|
4107
4133
|
}
|
|
4134
|
+
interface PayCycleOptions {
|
|
4135
|
+
paymentTestMode?: PaymentTestMode;
|
|
4136
|
+
tenantId: string;
|
|
4137
|
+
}
|
|
4108
4138
|
interface UpdateSubscriptionBillingDateOptions {
|
|
4109
4139
|
/**
|
|
4110
4140
|
* Information about how BASS adjusts the total of the next invoice. Extending
|
|
@@ -4190,16 +4220,13 @@ interface InitiatePaymentMethodSetupOptions {
|
|
|
4190
4220
|
paymentMode?: PaymentMode;
|
|
4191
4221
|
paymentSettings?: PaymentSettings;
|
|
4192
4222
|
}
|
|
4193
|
-
interface
|
|
4194
|
-
|
|
4195
|
-
|
|
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;
|
|
4196
4228
|
}
|
|
4197
4229
|
|
|
4198
|
-
declare function listSubscriptionHistory$1(httpClient: HttpClient): ListSubscriptionHistorySignature;
|
|
4199
|
-
interface ListSubscriptionHistorySignature {
|
|
4200
|
-
/** */
|
|
4201
|
-
(subscriptionId: string, options?: ListSubscriptionHistoryOptions | undefined): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
|
|
4202
|
-
}
|
|
4203
4230
|
declare function customerGetSubscription$1(httpClient: HttpClient): CustomerGetSubscriptionSignature;
|
|
4204
4231
|
interface CustomerGetSubscriptionSignature {
|
|
4205
4232
|
/**
|
|
@@ -4269,6 +4296,13 @@ interface CustomerInitiatePaymentMethodSetupSignature {
|
|
|
4269
4296
|
*/
|
|
4270
4297
|
(_id: string, options?: CustomerInitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
|
|
4271
4298
|
}
|
|
4299
|
+
declare function payCycle$1(httpClient: HttpClient): PayCycleSignature;
|
|
4300
|
+
interface PayCycleSignature {
|
|
4301
|
+
/**
|
|
4302
|
+
* This used only for automation and permitted tenants (QA & testing)
|
|
4303
|
+
*/
|
|
4304
|
+
(subscriptionId: string, options?: PayCycleOptions | undefined): Promise<PayCycleResponse & PayCycleResponseNonNullableFields>;
|
|
4305
|
+
}
|
|
4272
4306
|
declare function getSubscription$1(httpClient: HttpClient): GetSubscriptionSignature;
|
|
4273
4307
|
interface GetSubscriptionSignature {
|
|
4274
4308
|
/**
|
|
@@ -4441,12 +4475,10 @@ interface InitiatePaymentMethodSetupSignature {
|
|
|
4441
4475
|
*/
|
|
4442
4476
|
(_id: string, options?: InitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
|
|
4443
4477
|
}
|
|
4444
|
-
declare function
|
|
4445
|
-
interface
|
|
4446
|
-
/**
|
|
4447
|
-
|
|
4448
|
-
*/
|
|
4449
|
-
(subscriptionId: string, options?: PayCycleOptions | undefined): Promise<PayCycleResponse & PayCycleResponseNonNullableFields>;
|
|
4478
|
+
declare function listSubscriptionHistory$1(httpClient: HttpClient): ListSubscriptionHistorySignature;
|
|
4479
|
+
interface ListSubscriptionHistorySignature {
|
|
4480
|
+
/** */
|
|
4481
|
+
(subscriptionId: string, options?: ListSubscriptionHistoryOptions | undefined): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
|
|
4450
4482
|
}
|
|
4451
4483
|
declare const onSubscriptionCanceled$1: EventDefinition<SubscriptionCanceledEnvelope, "wix.billing.v1.subscription_canceled">;
|
|
4452
4484
|
declare const onSubscriptionExtended$1: EventDefinition<SubscriptionExtendedEnvelope, "wix.billing.v1.subscription_extended">;
|
|
@@ -4464,7 +4496,6 @@ declare const onSubscriptionResumed$1: EventDefinition<SubscriptionResumedEnvelo
|
|
|
4464
4496
|
|
|
4465
4497
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
4466
4498
|
|
|
4467
|
-
declare const listSubscriptionHistory: MaybeContext<BuildRESTFunction<typeof listSubscriptionHistory$1> & typeof listSubscriptionHistory$1>;
|
|
4468
4499
|
declare const customerGetSubscription: MaybeContext<BuildRESTFunction<typeof customerGetSubscription$1> & typeof customerGetSubscription$1>;
|
|
4469
4500
|
declare const customerCancelSubscription: MaybeContext<BuildRESTFunction<typeof customerCancelSubscription$1> & typeof customerCancelSubscription$1>;
|
|
4470
4501
|
declare const customerTurnOnSubscriptionAutoRenewal: MaybeContext<BuildRESTFunction<typeof customerTurnOnSubscriptionAutoRenewal$1> & typeof customerTurnOnSubscriptionAutoRenewal$1>;
|
|
@@ -4475,6 +4506,7 @@ declare const customerUpdateSubscriptionPaymentMethod: MaybeContext<BuildRESTFun
|
|
|
4475
4506
|
declare const customerAllowedActions: MaybeContext<BuildRESTFunction<typeof customerAllowedActions$1> & typeof customerAllowedActions$1>;
|
|
4476
4507
|
declare const customerListUpcomingCharges: MaybeContext<BuildRESTFunction<typeof customerListUpcomingCharges$1> & typeof customerListUpcomingCharges$1>;
|
|
4477
4508
|
declare const customerInitiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof customerInitiatePaymentMethodSetup$1> & typeof customerInitiatePaymentMethodSetup$1>;
|
|
4509
|
+
declare const payCycle: MaybeContext<BuildRESTFunction<typeof payCycle$1> & typeof payCycle$1>;
|
|
4478
4510
|
declare const getSubscription: MaybeContext<BuildRESTFunction<typeof getSubscription$1> & typeof getSubscription$1>;
|
|
4479
4511
|
declare const updateSubscriptionPaymentMethod: MaybeContext<BuildRESTFunction<typeof updateSubscriptionPaymentMethod$1> & typeof updateSubscriptionPaymentMethod$1>;
|
|
4480
4512
|
declare const updateSubscriptionBillingDate: MaybeContext<BuildRESTFunction<typeof updateSubscriptionBillingDate$1> & typeof updateSubscriptionBillingDate$1>;
|
|
@@ -4494,7 +4526,7 @@ declare const listUpcomingCharges: MaybeContext<BuildRESTFunction<typeof listUpc
|
|
|
4494
4526
|
declare const previewSubscriptionCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionCharges$1> & typeof previewSubscriptionCharges$1>;
|
|
4495
4527
|
declare const previewSubscriptionsCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionsCharges$1> & typeof previewSubscriptionsCharges$1>;
|
|
4496
4528
|
declare const initiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof initiatePaymentMethodSetup$1> & typeof initiatePaymentMethodSetup$1>;
|
|
4497
|
-
declare const
|
|
4529
|
+
declare const listSubscriptionHistory: MaybeContext<BuildRESTFunction<typeof listSubscriptionHistory$1> & typeof listSubscriptionHistory$1>;
|
|
4498
4530
|
|
|
4499
4531
|
type _publicOnSubscriptionCanceledType = typeof onSubscriptionCanceled$1;
|
|
4500
4532
|
/**
|
|
@@ -4673,6 +4705,7 @@ type context_CustomerTurnOnAutoRenewalRequest = CustomerTurnOnAutoRenewalRequest
|
|
|
4673
4705
|
type context_CustomerTurnOnAutoRenewalResponse = CustomerTurnOnAutoRenewalResponse;
|
|
4674
4706
|
type context_CustomerTurnOnAutoRenewalResponseNonNullableFields = CustomerTurnOnAutoRenewalResponseNonNullableFields;
|
|
4675
4707
|
type context_CustomerTurnOnSubscriptionAutoRenewalOptions = CustomerTurnOnSubscriptionAutoRenewalOptions;
|
|
4708
|
+
type context_Cycles = Cycles;
|
|
4676
4709
|
type context_DeleteDraftSubscriptionRequest = DeleteDraftSubscriptionRequest;
|
|
4677
4710
|
type context_DeleteDraftSubscriptionResponse = DeleteDraftSubscriptionResponse;
|
|
4678
4711
|
type context_DeleteSubscriptionBORequest = DeleteSubscriptionBORequest;
|
|
@@ -5083,7 +5116,7 @@ declare const context_turnOnSubscriptionAutoRenewal: typeof turnOnSubscriptionAu
|
|
|
5083
5116
|
declare const context_updateSubscriptionBillingDate: typeof updateSubscriptionBillingDate;
|
|
5084
5117
|
declare const context_updateSubscriptionPaymentMethod: typeof updateSubscriptionPaymentMethod;
|
|
5085
5118
|
declare namespace context {
|
|
5086
|
-
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_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 };
|
|
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 };
|
|
5087
5120
|
}
|
|
5088
5121
|
|
|
5089
5122
|
export { context as subscriptions };
|