@wix/auto_sdk_subscription_subscriptions 1.0.47 → 1.0.48
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/build/cjs/index.d.ts +3 -11
- package/build/cjs/index.js +197 -222
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1816 -1618
- package/build/cjs/index.typings.js +153 -171
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1793 -1612
- package/build/cjs/meta.js +143 -146
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +3 -11
- package/build/es/index.mjs +194 -221
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1816 -1618
- package/build/es/index.typings.mjs +150 -170
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1793 -1612
- package/build/es/meta.mjs +140 -145
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +3 -11
- package/build/internal/cjs/index.typings.d.ts +1862 -1603
- package/build/internal/cjs/meta.d.ts +1878 -1585
- package/build/internal/es/index.d.mts +3 -11
- package/build/internal/es/index.typings.d.mts +1862 -1603
- package/build/internal/es/meta.d.mts +1878 -1585
- package/package.json +4 -4
- package/build/internal/cjs/index.js +0 -6659
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.js +0 -5629
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.js +0 -4712
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/es/index.mjs +0 -6543
- package/build/internal/es/index.mjs.map +0 -1
- package/build/internal/es/index.typings.mjs +0 -5526
- package/build/internal/es/index.typings.mjs.map +0 -1
- package/build/internal/es/meta.mjs +0 -4606
- package/build/internal/es/meta.mjs.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { GetSubscriptionRequest as GetSubscriptionRequest$1, GetSubscriptionResponse as GetSubscriptionResponse$1, CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequest$1, CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponse$1, CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequest$1, CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponse$1, CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequest$1, CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponse$1, CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequest$1, CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponse$1, QuerySubscriptionsRequest as QuerySubscriptionsRequest$1, QuerySubscriptionsResponse as QuerySubscriptionsResponse$1, UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequest$1, UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponse$1, CustomerAllowedActionsRequest as CustomerAllowedActionsRequest$1, CustomerAllowedActionsResponse as CustomerAllowedActionsResponse$1, CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequest$1, CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponse$1, InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequest$1, InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponse$1, CustomerSkipCycleRequest as CustomerSkipCycleRequest$1, CustomerSkipCycleResponse as CustomerSkipCycleResponse$1, CustomerCancelScheduledSkipRequest as CustomerCancelScheduledSkipRequest$1, CustomerCancelScheduledSkipResponse as CustomerCancelScheduledSkipResponse$1, CustomerPauseSubscriptionRequest as CustomerPauseSubscriptionRequest$1, CustomerPauseSubscriptionResponse as CustomerPauseSubscriptionResponse$1, CustomerResumeSubscriptionRequest as CustomerResumeSubscriptionRequest$1, CustomerResumeSubscriptionResponse as CustomerResumeSubscriptionResponse$1, CustomerCancelScheduledPauseRequest as CustomerCancelScheduledPauseRequest$1, CustomerCancelScheduledPauseResponse as CustomerCancelScheduledPauseResponse$1, CustomerUpdateBillingDateRequest as CustomerUpdateBillingDateRequest$1, CustomerUpdateBillingDateResponse as CustomerUpdateBillingDateResponse$1,
|
|
1
|
+
import { GetSubscriptionRequest as GetSubscriptionRequest$1, GetSubscriptionResponse as GetSubscriptionResponse$1, CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequest$1, CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponse$1, CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequest$1, CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponse$1, CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequest$1, CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponse$1, CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequest$1, CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponse$1, QuerySubscriptionsRequest as QuerySubscriptionsRequest$1, QuerySubscriptionsResponse as QuerySubscriptionsResponse$1, UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequest$1, UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponse$1, CustomerAllowedActionsRequest as CustomerAllowedActionsRequest$1, CustomerAllowedActionsResponse as CustomerAllowedActionsResponse$1, CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequest$1, CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponse$1, InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequest$1, InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponse$1, CustomerSkipCycleRequest as CustomerSkipCycleRequest$1, CustomerSkipCycleResponse as CustomerSkipCycleResponse$1, CustomerCancelScheduledSkipRequest as CustomerCancelScheduledSkipRequest$1, CustomerCancelScheduledSkipResponse as CustomerCancelScheduledSkipResponse$1, CustomerPauseSubscriptionRequest as CustomerPauseSubscriptionRequest$1, CustomerPauseSubscriptionResponse as CustomerPauseSubscriptionResponse$1, CustomerResumeSubscriptionRequest as CustomerResumeSubscriptionRequest$1, CustomerResumeSubscriptionResponse as CustomerResumeSubscriptionResponse$1, CustomerCancelScheduledPauseRequest as CustomerCancelScheduledPauseRequest$1, CustomerCancelScheduledPauseResponse as CustomerCancelScheduledPauseResponse$1, CustomerUpdateBillingDateRequest as CustomerUpdateBillingDateRequest$1, CustomerUpdateBillingDateResponse as CustomerUpdateBillingDateResponse$1, UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequest$1, UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponse$1, ReviseSubscriptionRequest as ReviseSubscriptionRequest$1, ReviseSubscriptionResponse as ReviseSubscriptionResponse$1, CancelSubscriptionRequest as CancelSubscriptionRequest$1, CancelSubscriptionResponse as CancelSubscriptionResponse$1, PauseSubscriptionRequest as PauseSubscriptionRequest$1, PauseSubscriptionResponse as PauseSubscriptionResponse$1, ResumeSubscriptionRequest as ResumeSubscriptionRequest$1, ResumeSubscriptionResponse as ResumeSubscriptionResponse$1, SearchSubscriptionsRequest as SearchSubscriptionsRequest$1, SearchSubscriptionsResponse as SearchSubscriptionsResponse$1, CountSubscriptionsRequest as CountSubscriptionsRequest$1, CountSubscriptionsResponse as CountSubscriptionsResponse$1, TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequest$1, TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponse$1, TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequest$1, TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponse$1, MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequest$1, MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponse$1, MarkBillingCycleAsPaidRequest as MarkBillingCycleAsPaidRequest$1, MarkBillingCycleAsPaidResponse as MarkBillingCycleAsPaidResponse$1, GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequest$1, GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponse$1, ExtendSubscriptionRequest as ExtendSubscriptionRequest$1, ExtendSubscriptionResponse as ExtendSubscriptionResponse$1, AllowedActionsRequest as AllowedActionsRequest$1, AllowedActionsResponse as AllowedActionsResponse$1, ListUpcomingChargesRequest as ListUpcomingChargesRequest$1, ListUpcomingChargesResponse as ListUpcomingChargesResponse$1, PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequest$1, PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponse$1, PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequest$1, PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponse$1, ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Subscription {
|
|
@@ -80,6 +80,12 @@ interface Subscription {
|
|
|
80
80
|
* @readonly
|
|
81
81
|
*/
|
|
82
82
|
pendingUpdateData?: SubscriptionUpdateData;
|
|
83
|
+
/**
|
|
84
|
+
* Indicator whether subscription is managed by BASS or external system, like SAPI, for example.
|
|
85
|
+
* @internal
|
|
86
|
+
* @readonly
|
|
87
|
+
*/
|
|
88
|
+
bassManaged?: boolean;
|
|
83
89
|
/**
|
|
84
90
|
* Key / Value store to keep up to 10 additional values related to the subscription.
|
|
85
91
|
* Key max length = 50, Value max length = 200. Value can not be empty.
|
|
@@ -109,6 +115,12 @@ interface Subscription {
|
|
|
109
115
|
* @format GUID
|
|
110
116
|
*/
|
|
111
117
|
businessLocationId?: string | null;
|
|
118
|
+
/**
|
|
119
|
+
* Indicates BASS needs an operator choice for billing start when resuming this subscription.
|
|
120
|
+
* @internal
|
|
121
|
+
* @readonly
|
|
122
|
+
*/
|
|
123
|
+
requiresResumeBillingStartChoice?: boolean;
|
|
112
124
|
/**
|
|
113
125
|
* items, minSize is 1, maxSize is 100
|
|
114
126
|
* @maxSize 100
|
|
@@ -247,6 +259,15 @@ interface BillingSettings {
|
|
|
247
259
|
* Only set when the collection_method is EXTERNAL.
|
|
248
260
|
*/
|
|
249
261
|
externalCollectionDetails?: ExternalCollectionDetails;
|
|
262
|
+
/**
|
|
263
|
+
* Day of month (1-28) on which the first recurring billing date is anchored.
|
|
264
|
+
* Applies to monthly subscriptions only. Subsequent billing dates may shift
|
|
265
|
+
* if the subscription is modified (e.g. payment date update, pause/resume).
|
|
266
|
+
* @internal
|
|
267
|
+
* @min 1
|
|
268
|
+
* @max 28
|
|
269
|
+
*/
|
|
270
|
+
billingAnchorDay?: number | null;
|
|
250
271
|
}
|
|
251
272
|
interface PaymentMethod {
|
|
252
273
|
/**
|
|
@@ -593,6 +614,11 @@ interface BillingStatus {
|
|
|
593
614
|
latestPaymentData?: PaymentData;
|
|
594
615
|
/** Free trial data */
|
|
595
616
|
freeTrialData?: FreeTrialData;
|
|
617
|
+
/**
|
|
618
|
+
* Update billing date operation data
|
|
619
|
+
* @internal
|
|
620
|
+
*/
|
|
621
|
+
updateBillingDateData?: UpdateBillingDateData;
|
|
596
622
|
/**
|
|
597
623
|
* Grace period information during grace period after payment failure
|
|
598
624
|
* @readonly
|
|
@@ -652,6 +678,13 @@ interface Totals {
|
|
|
652
678
|
* @readonly
|
|
653
679
|
*/
|
|
654
680
|
tax?: string | null;
|
|
681
|
+
/**
|
|
682
|
+
* Tax-exempt amount.
|
|
683
|
+
* @format DECIMAL_VALUE
|
|
684
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
685
|
+
* @readonly
|
|
686
|
+
*/
|
|
687
|
+
exempt?: string | null;
|
|
655
688
|
/**
|
|
656
689
|
* Total discount.
|
|
657
690
|
* @format DECIMAL_VALUE
|
|
@@ -854,11 +887,16 @@ interface SubscriptionPolicies {
|
|
|
854
887
|
/** Subscription can be canceled not only immediately, but also at end of billing cycle by turning off auto-renew */
|
|
855
888
|
allowEndOfCycleCancellation?: boolean;
|
|
856
889
|
/**
|
|
857
|
-
*
|
|
858
|
-
*
|
|
859
|
-
*
|
|
890
|
+
* Deprecated. Never in production. BASS does not read or write this field; UoU gates use
|
|
891
|
+
* `CustomerSettingsResolver` → BBS `customer_settings_by_app_def_id` or Legacy booleans above.
|
|
892
|
+
* @deprecated
|
|
860
893
|
*/
|
|
861
894
|
customerActionSettings?: CustomerActionSettings;
|
|
895
|
+
/**
|
|
896
|
+
* Number of self-service actions already used on this subscription.
|
|
897
|
+
* @readonly
|
|
898
|
+
*/
|
|
899
|
+
customerActionCounters?: CustomerActionCounters;
|
|
862
900
|
}
|
|
863
901
|
/**
|
|
864
902
|
* Per-action merchant configuration for customer self-service actions.
|
|
@@ -975,6 +1013,18 @@ interface UpdateBillingDateActionConfiguration {
|
|
|
975
1013
|
/** Whether to allow advancing billing date for weekly subscriptions */
|
|
976
1014
|
allowAdvanceForWeekly?: boolean | null;
|
|
977
1015
|
}
|
|
1016
|
+
interface CustomerActionCounters {
|
|
1017
|
+
/**
|
|
1018
|
+
* Number of self-service skips already used. Unset means zero.
|
|
1019
|
+
* @readonly
|
|
1020
|
+
*/
|
|
1021
|
+
skipCount?: number | null;
|
|
1022
|
+
/**
|
|
1023
|
+
* Number of self-service pauses already used. Unset means zero.
|
|
1024
|
+
* @readonly
|
|
1025
|
+
*/
|
|
1026
|
+
pauseCount?: number | null;
|
|
1027
|
+
}
|
|
978
1028
|
interface PauseInfo {
|
|
979
1029
|
pausePolicy?: PausePolicyWithLiterals;
|
|
980
1030
|
pauseAt?: PauseAtWithLiterals;
|
|
@@ -1345,6 +1395,25 @@ interface Sorting {
|
|
|
1345
1395
|
fieldName?: string;
|
|
1346
1396
|
/** Sort order. */
|
|
1347
1397
|
order?: SortOrderWithLiterals;
|
|
1398
|
+
/**
|
|
1399
|
+
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
1400
|
+
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
1401
|
+
*
|
|
1402
|
+
* If multiple filters are provided, they are combined with AND operator.
|
|
1403
|
+
*
|
|
1404
|
+
* Example:
|
|
1405
|
+
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
1406
|
+
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
1407
|
+
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
1408
|
+
* @internal
|
|
1409
|
+
* @maxSize 10
|
|
1410
|
+
*/
|
|
1411
|
+
selectItemsBy?: Record<string, any>[] | null;
|
|
1412
|
+
/**
|
|
1413
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
1414
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1415
|
+
*/
|
|
1416
|
+
origin?: AddressLocation;
|
|
1348
1417
|
}
|
|
1349
1418
|
declare enum SortOrder {
|
|
1350
1419
|
ASC = "ASC",
|
|
@@ -1352,6 +1421,12 @@ declare enum SortOrder {
|
|
|
1352
1421
|
}
|
|
1353
1422
|
/** @enumType */
|
|
1354
1423
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1424
|
+
interface AddressLocation {
|
|
1425
|
+
/** Address latitude. */
|
|
1426
|
+
latitude?: number | null;
|
|
1427
|
+
/** Address longitude. */
|
|
1428
|
+
longitude?: number | null;
|
|
1429
|
+
}
|
|
1355
1430
|
interface Paging {
|
|
1356
1431
|
/** Number of items to load. */
|
|
1357
1432
|
limit?: number | null;
|
|
@@ -1388,6 +1463,13 @@ interface PagingMetadataV2 {
|
|
|
1388
1463
|
tooManyToCount?: boolean | null;
|
|
1389
1464
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1390
1465
|
cursors?: Cursors;
|
|
1466
|
+
/**
|
|
1467
|
+
* Indicates if there are more results after the current page.
|
|
1468
|
+
* If `true`, another page of results can be retrieved.
|
|
1469
|
+
* If `false`, this is the last page.
|
|
1470
|
+
* @internal
|
|
1471
|
+
*/
|
|
1472
|
+
hasNext?: boolean | null;
|
|
1391
1473
|
}
|
|
1392
1474
|
interface Cursors {
|
|
1393
1475
|
/**
|
|
@@ -1451,6 +1533,8 @@ interface SubscriptionStatus {
|
|
|
1451
1533
|
statuses?: SubscriptionStatusEnumSubscriptionStatusWithLiterals[];
|
|
1452
1534
|
}
|
|
1453
1535
|
declare enum SubscriptionStatusGroup {
|
|
1536
|
+
/** @internal */
|
|
1537
|
+
UNKNOWN_STATUS_GROUP = "UNKNOWN_STATUS_GROUP",
|
|
1454
1538
|
ALL = "ALL",
|
|
1455
1539
|
/** Union of ACTIVE, PAUSED and PENDING */
|
|
1456
1540
|
LIVE = "LIVE"
|
|
@@ -1516,10 +1600,11 @@ declare enum ActionType {
|
|
|
1516
1600
|
UPDATE_BILLING_DATE = "UPDATE_BILLING_DATE",
|
|
1517
1601
|
UPDATE_COLLECTION_METHOD = "UPDATE_COLLECTION_METHOD",
|
|
1518
1602
|
SKIP_CYCLE = "SKIP_CYCLE",
|
|
1519
|
-
CUSTOMER_UPDATE_BILLING_DATE = "CUSTOMER_UPDATE_BILLING_DATE"
|
|
1603
|
+
CUSTOMER_UPDATE_BILLING_DATE = "CUSTOMER_UPDATE_BILLING_DATE",
|
|
1604
|
+
CHANGE_SUBSCRIPTION = "CHANGE_SUBSCRIPTION"
|
|
1520
1605
|
}
|
|
1521
1606
|
/** @enumType */
|
|
1522
|
-
type ActionTypeWithLiterals = ActionType | 'NONE' | 'CREATION' | 'CANCEL' | 'CYCLE_AUTO_RENEW_ON' | 'CYCLE_AUTO_RENEW_OFF' | 'PAUSE' | 'RESUME' | 'MARK_AS_PAID' | 'EXTEND' | 'UPDATE' | 'UPDATE_START_DATE' | 'UPM' | 'UPDATE_BILLING_DATE' | 'UPDATE_COLLECTION_METHOD' | 'SKIP_CYCLE' | 'CUSTOMER_UPDATE_BILLING_DATE';
|
|
1607
|
+
type ActionTypeWithLiterals = ActionType | 'NONE' | 'CREATION' | 'CANCEL' | 'CYCLE_AUTO_RENEW_ON' | 'CYCLE_AUTO_RENEW_OFF' | 'PAUSE' | 'RESUME' | 'MARK_AS_PAID' | 'EXTEND' | 'UPDATE' | 'UPDATE_START_DATE' | 'UPM' | 'UPDATE_BILLING_DATE' | 'UPDATE_COLLECTION_METHOD' | 'SKIP_CYCLE' | 'CUSTOMER_UPDATE_BILLING_DATE' | 'CHANGE_SUBSCRIPTION';
|
|
1523
1608
|
declare enum ExtendPolicyType {
|
|
1524
1609
|
PERIOD = "PERIOD",
|
|
1525
1610
|
BILLING_CYCLE = "BILLING_CYCLE"
|
|
@@ -1853,6 +1938,12 @@ interface LineItemTaxSummary {
|
|
|
1853
1938
|
* @decimalValue options { maxScale:4 }
|
|
1854
1939
|
*/
|
|
1855
1940
|
finalTaxAmount?: string | null;
|
|
1941
|
+
/**
|
|
1942
|
+
* Tax amount the merchant is NOT collecting because the customer is responsible for paying the authority directly (reverse charge / exempt). Optional; absence is treated as zero.
|
|
1943
|
+
* @format DECIMAL_VALUE
|
|
1944
|
+
* @decimalValue options { maxScale:4 }
|
|
1945
|
+
*/
|
|
1946
|
+
exemptAmount?: string | null;
|
|
1856
1947
|
}
|
|
1857
1948
|
interface FixedPriceConfig {
|
|
1858
1949
|
}
|
|
@@ -2090,7 +2181,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2090
2181
|
/** If present, indicates the action that triggered the event. */
|
|
2091
2182
|
originatedFrom?: string | null;
|
|
2092
2183
|
/**
|
|
2093
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01
|
|
2184
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
2094
2185
|
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
2095
2186
|
*/
|
|
2096
2187
|
entityEventSequence?: string | null;
|
|
@@ -2104,8 +2195,18 @@ interface DomainEventBodyOneOf {
|
|
|
2104
2195
|
}
|
|
2105
2196
|
interface EntityCreatedEvent {
|
|
2106
2197
|
entityAsJson?: string;
|
|
2198
|
+
/**
|
|
2199
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
2200
|
+
* @internal
|
|
2201
|
+
*/
|
|
2202
|
+
triggeredByUndelete?: boolean | null;
|
|
2107
2203
|
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2108
2204
|
restoreInfo?: RestoreInfo;
|
|
2205
|
+
/**
|
|
2206
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
2207
|
+
* @internal
|
|
2208
|
+
*/
|
|
2209
|
+
additionalMetadataAsJson?: string | null;
|
|
2109
2210
|
}
|
|
2110
2211
|
interface RestoreInfo {
|
|
2111
2212
|
deletedDate?: Date | null;
|
|
@@ -2117,10 +2218,42 @@ interface EntityUpdatedEvent {
|
|
|
2117
2218
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2118
2219
|
*/
|
|
2119
2220
|
currentEntityAsJson?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
2223
|
+
* wont populate it / have any reference to it in the API.
|
|
2224
|
+
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
2225
|
+
* the developer should send only the new (current) entity.
|
|
2226
|
+
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
2227
|
+
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
2228
|
+
* @internal
|
|
2229
|
+
* @deprecated
|
|
2230
|
+
*/
|
|
2231
|
+
previousEntityAsJson?: string | null;
|
|
2232
|
+
/**
|
|
2233
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
2234
|
+
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
2235
|
+
* @internal
|
|
2236
|
+
*/
|
|
2237
|
+
modifiedFields?: Record<string, any>;
|
|
2238
|
+
/**
|
|
2239
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
2240
|
+
* @internal
|
|
2241
|
+
*/
|
|
2242
|
+
additionalMetadataAsJson?: string | null;
|
|
2120
2243
|
}
|
|
2121
2244
|
interface EntityDeletedEvent {
|
|
2245
|
+
/**
|
|
2246
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
2247
|
+
* @internal
|
|
2248
|
+
*/
|
|
2249
|
+
movedToTrash?: boolean | null;
|
|
2122
2250
|
/** Entity that was deleted. */
|
|
2123
2251
|
deletedEntityAsJson?: string | null;
|
|
2252
|
+
/**
|
|
2253
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
2254
|
+
* @internal
|
|
2255
|
+
*/
|
|
2256
|
+
additionalMetadataAsJson?: string | null;
|
|
2124
2257
|
}
|
|
2125
2258
|
interface ActionEvent {
|
|
2126
2259
|
bodyAsJson?: string;
|
|
@@ -2216,12 +2349,64 @@ interface AccountInfo {
|
|
|
2216
2349
|
*/
|
|
2217
2350
|
siteId?: string | null;
|
|
2218
2351
|
}
|
|
2219
|
-
interface
|
|
2220
|
-
|
|
2352
|
+
interface SetIsMigratedEvent {
|
|
2353
|
+
/** @format GUID */
|
|
2354
|
+
subscriptionId?: string;
|
|
2355
|
+
}
|
|
2356
|
+
interface SubscriptionDelayedSyncEvent {
|
|
2357
|
+
/** @format GUID */
|
|
2358
|
+
subscriptionId?: string;
|
|
2359
|
+
}
|
|
2360
|
+
interface InvoiceAction extends InvoiceActionActionTypeOneOf {
|
|
2361
|
+
payRecurring?: PayRecurringInvoice;
|
|
2221
2362
|
}
|
|
2222
2363
|
/** @oneof */
|
|
2223
|
-
interface
|
|
2224
|
-
|
|
2364
|
+
interface InvoiceActionActionTypeOneOf {
|
|
2365
|
+
payRecurring?: PayRecurringInvoice;
|
|
2366
|
+
}
|
|
2367
|
+
interface PayRecurringInvoice {
|
|
2368
|
+
/** @format GUID */
|
|
2369
|
+
invoiceId?: string;
|
|
2370
|
+
}
|
|
2371
|
+
/**
|
|
2372
|
+
* Sent each time a subscription status has been set to Active
|
|
2373
|
+
* Active shows that a subscription is live and operational.
|
|
2374
|
+
* For example:
|
|
2375
|
+
* * For subscription with free trial, free trial start date is also the activation date.
|
|
2376
|
+
* * For a subscription with future start date, the start date is also the activation date.
|
|
2377
|
+
* * When a subscription is resumed from a pause status, the resume date is also the activation date.
|
|
2378
|
+
*/
|
|
2379
|
+
interface SubscriptionActivated {
|
|
2380
|
+
subscription?: Subscription;
|
|
2381
|
+
}
|
|
2382
|
+
/**
|
|
2383
|
+
* Sent each time a subscription status has been set to Ended
|
|
2384
|
+
* Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
|
|
2385
|
+
* This is different from a Canceled subscription which ends the subscription before a designated end date.
|
|
2386
|
+
* Therefore, Ended and Canceled are mutually exclusive.
|
|
2387
|
+
*/
|
|
2388
|
+
interface SubscriptionEnded {
|
|
2389
|
+
subscription?: Subscription;
|
|
2390
|
+
}
|
|
2391
|
+
interface SubscriptionInitialPurchaseCompleted {
|
|
2392
|
+
subscription?: Subscription;
|
|
2393
|
+
actionDetails?: ActionDetails;
|
|
2394
|
+
/** @format GUID */
|
|
2395
|
+
paymentTransactionId?: string | null;
|
|
2396
|
+
}
|
|
2397
|
+
interface SubscriptionCycleReadyToPay {
|
|
2398
|
+
subscription?: Subscription;
|
|
2399
|
+
}
|
|
2400
|
+
interface SubscriptionBillingCycleStarted {
|
|
2401
|
+
subscription?: Subscription;
|
|
2402
|
+
/**
|
|
2403
|
+
* Wix Pay transaction id, optional. Exists if event was triggered by a payment.
|
|
2404
|
+
* @format GUID
|
|
2405
|
+
*/
|
|
2406
|
+
paymentTransactionId?: string | null;
|
|
2407
|
+
}
|
|
2408
|
+
interface SubscriptionRevived {
|
|
2409
|
+
subscription?: Subscription;
|
|
2225
2410
|
}
|
|
2226
2411
|
interface CreateSubscriptionRequest {
|
|
2227
2412
|
subscription?: Subscription;
|
|
@@ -2241,1595 +2426,1358 @@ interface OriginOverride {
|
|
|
2241
2426
|
/** @format GUID */
|
|
2242
2427
|
instanceId?: string;
|
|
2243
2428
|
}
|
|
2244
|
-
interface
|
|
2245
|
-
/** @format GUID */
|
|
2246
|
-
subscriptionId?: string;
|
|
2247
|
-
}
|
|
2248
|
-
interface PayCycleRequest {
|
|
2249
|
-
/** @format GUID */
|
|
2250
|
-
subscriptionId: string;
|
|
2251
|
-
paymentTestMode?: PaymentTestModeWithLiterals;
|
|
2252
|
-
/** @format GUID */
|
|
2253
|
-
tenantId: string;
|
|
2254
|
-
}
|
|
2255
|
-
declare enum PaymentTestMode {
|
|
2256
|
-
REGULAR = "REGULAR",
|
|
2257
|
-
FAIL_TECHNICAL = "FAIL_TECHNICAL",
|
|
2258
|
-
FAIL_DECLINE = "FAIL_DECLINE",
|
|
2259
|
-
FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
|
|
2260
|
-
}
|
|
2261
|
-
/** @enumType */
|
|
2262
|
-
type PaymentTestModeWithLiterals = PaymentTestMode | 'REGULAR' | 'FAIL_TECHNICAL' | 'FAIL_DECLINE' | 'FAIL_RETRYABLE_DECLINE';
|
|
2263
|
-
interface PayCycleResponse {
|
|
2264
|
-
/** @format GUID */
|
|
2265
|
-
invoiceId?: string;
|
|
2266
|
-
/** @format GUID */
|
|
2267
|
-
paymentOrderId?: string | null;
|
|
2429
|
+
interface CreateSubscriptionResponse {
|
|
2268
2430
|
subscription?: Subscription;
|
|
2431
|
+
/**
|
|
2432
|
+
* Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions.
|
|
2433
|
+
* @format GUID
|
|
2434
|
+
*/
|
|
2435
|
+
paymentOrderId?: string | null;
|
|
2269
2436
|
}
|
|
2270
|
-
interface
|
|
2271
|
-
/**
|
|
2272
|
-
id?: string;
|
|
2273
|
-
}
|
|
2274
|
-
interface GetFullSubscriptionDataResponse {
|
|
2437
|
+
interface UpdateSubscriptionRequest {
|
|
2438
|
+
/** Revision is validated if Subscription.revision is set */
|
|
2275
2439
|
subscription?: Subscription;
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
interface InternalSubscriptionData {
|
|
2279
|
-
/** @format GUID */
|
|
2280
|
-
originInstanceId?: string;
|
|
2281
|
-
source?: string | null;
|
|
2282
|
-
billingType?: string;
|
|
2283
|
-
isOneTime?: boolean;
|
|
2284
|
-
migrationDetails?: MigrationDetails;
|
|
2285
|
-
pausePaidDuration?: string | null;
|
|
2286
|
-
authorizationPaymentData?: PaymentData;
|
|
2287
|
-
currentCyclePausePeriods?: PausePeriod[];
|
|
2440
|
+
/** Supported fields: customer, metadata */
|
|
2441
|
+
fieldMask?: string[];
|
|
2288
2442
|
}
|
|
2289
|
-
interface
|
|
2290
|
-
|
|
2291
|
-
originSystem?: string;
|
|
2292
|
-
/** date when the Subscription started to be managed in BASS */
|
|
2293
|
-
shiftManagementDate?: Date | null;
|
|
2443
|
+
interface UpdateSubscriptionResponse {
|
|
2444
|
+
subscription?: Subscription;
|
|
2294
2445
|
}
|
|
2295
|
-
interface
|
|
2446
|
+
interface UpdateSubscriptionStartDateRequest {
|
|
2447
|
+
/**
|
|
2448
|
+
* Subscription ID
|
|
2449
|
+
* @format GUID
|
|
2450
|
+
*/
|
|
2451
|
+
id?: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* Can be updated only if Subscription is in Draft state
|
|
2454
|
+
* By setting start_date in the future, end_date will be recalculated for termed Subscriptions
|
|
2455
|
+
* cycles_to_pay_on_creation will be set to 1 if no free trial is set
|
|
2456
|
+
*/
|
|
2296
2457
|
startDate?: Date | null;
|
|
2297
|
-
endDate?: Date | null;
|
|
2298
|
-
}
|
|
2299
|
-
interface GetSubscriptionAndInternalDataRequest {
|
|
2300
|
-
/** @format GUID */
|
|
2301
|
-
subscriptionId?: string;
|
|
2302
|
-
/** @format GUID */
|
|
2303
|
-
tenantId?: string;
|
|
2304
2458
|
}
|
|
2305
|
-
interface
|
|
2459
|
+
interface UpdateSubscriptionStartDateResponse {
|
|
2306
2460
|
subscription?: Subscription;
|
|
2307
|
-
internalSubscriptionData?: InternalSubscriptionData;
|
|
2308
2461
|
}
|
|
2309
|
-
interface
|
|
2310
|
-
/**
|
|
2462
|
+
interface BassToSapiPaypalMigrationRequest {
|
|
2463
|
+
/**
|
|
2464
|
+
* Subscription ID
|
|
2465
|
+
* @format GUID
|
|
2466
|
+
*/
|
|
2311
2467
|
id?: string;
|
|
2312
|
-
|
|
2313
|
-
tenantId?: string;
|
|
2468
|
+
collectionMethod?: CollectionMethodEnumCollectionMethodWithLiterals;
|
|
2314
2469
|
}
|
|
2315
|
-
interface
|
|
2470
|
+
interface BassToSapiPaypalMigrationResponse {
|
|
2316
2471
|
subscription?: Subscription;
|
|
2317
2472
|
}
|
|
2318
|
-
interface
|
|
2319
|
-
/** @format GUID */
|
|
2320
|
-
subscriptionId?: string;
|
|
2473
|
+
interface UpdateSubscriptionPoliciesRequest {
|
|
2321
2474
|
/**
|
|
2322
|
-
*
|
|
2323
|
-
* @
|
|
2475
|
+
* Subscription ID
|
|
2476
|
+
* @format GUID
|
|
2324
2477
|
*/
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
tenantId?: string;
|
|
2478
|
+
id?: string;
|
|
2479
|
+
cancellableByCustomer?: boolean | null;
|
|
2328
2480
|
}
|
|
2329
|
-
interface
|
|
2481
|
+
interface UpdateSubscriptionPoliciesResponse {
|
|
2482
|
+
/** Updated policies of the subscription */
|
|
2483
|
+
policies?: SubscriptionPolicies;
|
|
2330
2484
|
}
|
|
2331
|
-
interface
|
|
2332
|
-
/**
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2485
|
+
interface UpdateSubscriptionBillingDateRequest {
|
|
2486
|
+
/**
|
|
2487
|
+
* ID of the subscription to update the billing date for.
|
|
2488
|
+
* @format GUID
|
|
2489
|
+
*/
|
|
2490
|
+
id: string;
|
|
2491
|
+
/** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
|
|
2492
|
+
billingDate: Date | null;
|
|
2493
|
+
/**
|
|
2494
|
+
* Information about how BASS adjusts the total of the next invoice. Extending
|
|
2495
|
+
* the current billing cycle results in a higher payment, while shortening it
|
|
2496
|
+
* leads to a lower payment. BASS offers automatic calculation of the proration
|
|
2497
|
+
* amount based on the number of days added to or removed from the current billing
|
|
2498
|
+
* cycle. Alternatively, you can use your own custom method to calculate the
|
|
2499
|
+
* proration amount. The custom proration amount can't exceed the total of the
|
|
2500
|
+
* current billing cycle.
|
|
2501
|
+
*/
|
|
2502
|
+
proration?: Proration;
|
|
2337
2503
|
}
|
|
2338
|
-
interface
|
|
2504
|
+
interface UpdateSubscriptionBillingDateResponse {
|
|
2505
|
+
/** Updated subscription. */
|
|
2339
2506
|
subscription?: Subscription;
|
|
2340
2507
|
}
|
|
2341
|
-
interface
|
|
2342
|
-
/** @format GUID */
|
|
2343
|
-
subscriptionId?: string;
|
|
2344
|
-
/** @format GUID */
|
|
2345
|
-
tenantId?: string;
|
|
2346
|
-
paymentStatus?: PaymentStatusWithLiterals;
|
|
2347
|
-
}
|
|
2348
|
-
interface UpdatePaymentStatusResponse {
|
|
2508
|
+
interface SubscriptionBillingDateUpdated {
|
|
2349
2509
|
subscription?: Subscription;
|
|
2510
|
+
billingDate?: Date | null;
|
|
2511
|
+
proration?: Proration;
|
|
2350
2512
|
}
|
|
2351
|
-
interface
|
|
2352
|
-
/**
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2513
|
+
interface UpdateSubscriptionOriginRequest {
|
|
2514
|
+
/**
|
|
2515
|
+
* ID of the subscription to update origin.
|
|
2516
|
+
* @format GUID
|
|
2517
|
+
*/
|
|
2518
|
+
id?: string;
|
|
2519
|
+
/**
|
|
2520
|
+
* Origin entity ID of the subscription to update.
|
|
2521
|
+
* @format GUID
|
|
2522
|
+
*/
|
|
2523
|
+
entityId?: string;
|
|
2356
2524
|
}
|
|
2357
|
-
interface
|
|
2525
|
+
interface UpdateSubscriptionOriginResponse {
|
|
2526
|
+
/** Updated subscription. */
|
|
2358
2527
|
subscription?: Subscription;
|
|
2359
2528
|
}
|
|
2360
|
-
interface
|
|
2361
|
-
/**
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2529
|
+
interface ReviseSubscriptionRequest {
|
|
2530
|
+
/**
|
|
2531
|
+
* Subscription ID
|
|
2532
|
+
* @format GUID
|
|
2533
|
+
*/
|
|
2534
|
+
id: string;
|
|
2535
|
+
/**
|
|
2536
|
+
* 0 for no revision, maxSize is 100
|
|
2537
|
+
* @maxSize 100
|
|
2538
|
+
*/
|
|
2539
|
+
items?: Item[];
|
|
2365
2540
|
}
|
|
2366
|
-
interface
|
|
2541
|
+
interface ReviseSubscriptionResponse {
|
|
2367
2542
|
subscription?: Subscription;
|
|
2368
2543
|
}
|
|
2369
|
-
interface
|
|
2370
|
-
/**
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2544
|
+
interface UpdateSubscriptionItemsRequest {
|
|
2545
|
+
/**
|
|
2546
|
+
* Subscription ID
|
|
2547
|
+
* @format GUID
|
|
2548
|
+
*/
|
|
2549
|
+
id?: string;
|
|
2550
|
+
/** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
|
|
2551
|
+
updateAction?: UpdateActionWithLiterals;
|
|
2552
|
+
/** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
|
|
2553
|
+
scheduleAdditionalInfo?: ScheduleAdditionalInfo;
|
|
2554
|
+
/**
|
|
2555
|
+
* Existing items to update
|
|
2556
|
+
* @maxSize 100
|
|
2557
|
+
*/
|
|
2558
|
+
itemsToUpdate?: ItemChange[];
|
|
2559
|
+
/**
|
|
2560
|
+
* Items to add
|
|
2561
|
+
* @maxSize 99
|
|
2562
|
+
*/
|
|
2563
|
+
itemsToAdd?: Item[];
|
|
2564
|
+
/**
|
|
2565
|
+
* Existing items to delete
|
|
2566
|
+
* @format GUID
|
|
2567
|
+
* @maxSize 99
|
|
2568
|
+
*/
|
|
2569
|
+
itemsToDelete?: string[] | null;
|
|
2376
2570
|
}
|
|
2377
|
-
declare enum
|
|
2378
|
-
|
|
2379
|
-
|
|
2571
|
+
declare enum UpdateAction {
|
|
2572
|
+
NONE = "NONE",
|
|
2573
|
+
/** Update subscription immediately, please note proration for updates changing price are not yet supported */
|
|
2574
|
+
IMMEDIATELY = "IMMEDIATELY",
|
|
2575
|
+
/** Request updates that will take affect only at the start of the next billing cycle. */
|
|
2576
|
+
NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
|
|
2577
|
+
/** Reset all pending updates */
|
|
2578
|
+
RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
|
|
2579
|
+
/** Request updates that will take affect only at a specific date. */
|
|
2580
|
+
SPECIFIC_DATE = "SPECIFIC_DATE"
|
|
2380
2581
|
}
|
|
2381
2582
|
/** @enumType */
|
|
2382
|
-
type
|
|
2383
|
-
interface
|
|
2583
|
+
type UpdateActionWithLiterals = UpdateAction | 'NONE' | 'IMMEDIATELY' | 'NEXT_BILLING_CYCLE' | 'RESET_PENDING_UPDATES' | 'SPECIFIC_DATE';
|
|
2584
|
+
interface UpdateSubscriptionItemsResponse {
|
|
2384
2585
|
subscription?: Subscription;
|
|
2385
2586
|
}
|
|
2386
|
-
interface
|
|
2387
|
-
/**
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2587
|
+
interface BulkUpdateSubscriptionItemsByFilterRequest {
|
|
2588
|
+
/**
|
|
2589
|
+
* Filter to identify the subscriptions for which items are updated. For
|
|
2590
|
+
* supported fields see
|
|
2591
|
+
* [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).
|
|
2592
|
+
* Sending an empty subscription filter results in a validation error.
|
|
2593
|
+
* In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
|
|
2594
|
+
* `subscriptionId` field inside this filter. Passing any other filter results
|
|
2595
|
+
* in a failed validation error.
|
|
2596
|
+
*/
|
|
2597
|
+
subscriptionFilter?: Record<string, any> | null;
|
|
2598
|
+
/**
|
|
2599
|
+
* Filter to specify which subscription items are updated. Make sure to use
|
|
2600
|
+
* the catalog item ID and not the item's unique ID. All subscription items
|
|
2601
|
+
* with matching `items.catalogReference.catalogItemId` are updated.
|
|
2602
|
+
*
|
|
2603
|
+
* Max: `100` reference catalog item IDs
|
|
2604
|
+
* @format GUID
|
|
2605
|
+
* @maxSize 100
|
|
2606
|
+
*/
|
|
2607
|
+
catalogReferenceIds?: string[] | null;
|
|
2608
|
+
/**
|
|
2609
|
+
* Information about the update timing and update type.
|
|
2610
|
+
*
|
|
2611
|
+
* + `"IMMEDIATELY"`: The updates become effective immediately.
|
|
2612
|
+
* + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
|
|
2613
|
+
* + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
|
|
2614
|
+
* + `"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.
|
|
2615
|
+
*/
|
|
2616
|
+
updateAction?: UpdateActionWithLiterals;
|
|
2617
|
+
/**
|
|
2618
|
+
* Additional information for updates. Currently, only supported for
|
|
2619
|
+
* `{"updateAction": "SPECIFIC_DATE"}`.
|
|
2620
|
+
*/
|
|
2621
|
+
scheduleAdditionalInfo?: ScheduleAdditionalInfo;
|
|
2622
|
+
/**
|
|
2623
|
+
* Update details for the susbcription items that match the filtering.
|
|
2624
|
+
* Currently, you can update only the item price, quantity, and tax. Note
|
|
2625
|
+
* that all item properties are updated to the same values. In case you want set
|
|
2626
|
+
* different values for individual items, you must call
|
|
2627
|
+
* _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
|
|
2628
|
+
*/
|
|
2629
|
+
bulkItemUpdateData?: BulkItemChange;
|
|
2630
|
+
/**
|
|
2631
|
+
* __Not implemented yet__. Items to add to the subscriptions matching the filtering.
|
|
2632
|
+
* @maxSize 99
|
|
2633
|
+
*/
|
|
2634
|
+
itemsToAdd?: Item[];
|
|
2392
2635
|
}
|
|
2393
|
-
interface
|
|
2394
|
-
/**
|
|
2395
|
-
|
|
2636
|
+
interface BulkItemChange {
|
|
2637
|
+
/** Information about the new item price. */
|
|
2638
|
+
pricingModel?: PricingModel;
|
|
2639
|
+
/**
|
|
2640
|
+
* New item quantity.
|
|
2641
|
+
*
|
|
2642
|
+
* Min: `1`
|
|
2643
|
+
* @min 1
|
|
2644
|
+
*/
|
|
2645
|
+
quantity?: number | null;
|
|
2646
|
+
/** Information about the new item tax. */
|
|
2647
|
+
tax?: Tax;
|
|
2396
2648
|
}
|
|
2397
|
-
interface
|
|
2398
|
-
|
|
2649
|
+
interface BulkUpdateSubscriptionItemsByFilterResponse {
|
|
2650
|
+
/**
|
|
2651
|
+
* ID of your bulk job. You can use
|
|
2652
|
+
* [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)
|
|
2653
|
+
* to retrieve information about the job status.
|
|
2654
|
+
*/
|
|
2655
|
+
jobId?: string;
|
|
2399
2656
|
}
|
|
2400
|
-
interface
|
|
2657
|
+
interface DeleteSubscriptionRequest {
|
|
2401
2658
|
/** @format GUID */
|
|
2402
2659
|
id?: string;
|
|
2403
|
-
|
|
2404
|
-
createdDate?: Date | null;
|
|
2405
|
-
}
|
|
2406
|
-
interface FinishFreeTrialNowRequest {
|
|
2407
|
-
/** @format GUID */
|
|
2408
|
-
subscriptionId?: string;
|
|
2409
|
-
/** @format GUID */
|
|
2410
|
-
tenantId?: string;
|
|
2660
|
+
revision?: string;
|
|
2411
2661
|
}
|
|
2412
|
-
interface
|
|
2413
|
-
subscription?: Subscription;
|
|
2662
|
+
interface DeleteSubscriptionResponse {
|
|
2414
2663
|
}
|
|
2415
|
-
interface
|
|
2416
|
-
/** @format GUID */
|
|
2417
|
-
subscriptionId?: string;
|
|
2664
|
+
interface CancelSubscriptionRequest {
|
|
2418
2665
|
/** @format GUID */
|
|
2419
|
-
|
|
2666
|
+
id: string;
|
|
2667
|
+
actionContext: ActionContext;
|
|
2420
2668
|
}
|
|
2421
|
-
interface
|
|
2669
|
+
interface ActionContext {
|
|
2670
|
+
initiator?: ActionInitiatorWithLiterals;
|
|
2671
|
+
/** Optional action reason message */
|
|
2672
|
+
reason?: string | null;
|
|
2422
2673
|
}
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
/** @minLength 1 */
|
|
2429
|
-
taskType?: string;
|
|
2674
|
+
declare enum ActionInitiator {
|
|
2675
|
+
UNDEFINED = "UNDEFINED",
|
|
2676
|
+
BUSINESS = "BUSINESS",
|
|
2677
|
+
CUSTOMER = "CUSTOMER",
|
|
2678
|
+
SYSTEM = "SYSTEM"
|
|
2430
2679
|
}
|
|
2431
|
-
|
|
2680
|
+
/** @enumType */
|
|
2681
|
+
type ActionInitiatorWithLiterals = ActionInitiator | 'UNDEFINED' | 'BUSINESS' | 'CUSTOMER' | 'SYSTEM';
|
|
2682
|
+
interface CancelSubscriptionResponse {
|
|
2683
|
+
subscription?: Subscription;
|
|
2432
2684
|
}
|
|
2433
|
-
interface
|
|
2434
|
-
/** @format GUID */
|
|
2435
|
-
subscriptionId?: string;
|
|
2436
|
-
/** @minLength 1 */
|
|
2437
|
-
taskType?: string;
|
|
2438
|
-
executionTime?: Date | null;
|
|
2685
|
+
interface PauseSubscriptionRequest {
|
|
2439
2686
|
/** @format GUID */
|
|
2440
|
-
|
|
2687
|
+
id: string;
|
|
2688
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
2689
|
+
pauseAt?: PauseAtWithLiterals;
|
|
2690
|
+
/** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
|
|
2691
|
+
pauseAtSchedule?: ScheduleAdditionalInfo;
|
|
2692
|
+
/** contains additional scheduling information for certain auto_resume_at either specific date */
|
|
2693
|
+
autoResumeAtSchedule?: ScheduleAdditionalInfo;
|
|
2694
|
+
actionContext: ActionContext;
|
|
2441
2695
|
}
|
|
2442
|
-
interface
|
|
2443
|
-
|
|
2444
|
-
tenantId?: string;
|
|
2445
|
-
/** @format GUID */
|
|
2446
|
-
subscriptionId?: string;
|
|
2447
|
-
/** @minLength 1 */
|
|
2448
|
-
taskType?: string;
|
|
2696
|
+
interface PauseSubscriptionResponse {
|
|
2697
|
+
subscription?: Subscription;
|
|
2449
2698
|
}
|
|
2450
|
-
interface
|
|
2451
|
-
/** @format GUID */
|
|
2452
|
-
tenantId?: string;
|
|
2699
|
+
interface SubscriptionPaused {
|
|
2453
2700
|
subscription?: Subscription;
|
|
2701
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
2702
|
+
actionDetails?: ActionDetails;
|
|
2454
2703
|
}
|
|
2455
|
-
interface
|
|
2704
|
+
interface PauseSubscriptionRequested {
|
|
2456
2705
|
subscription?: Subscription;
|
|
2706
|
+
pauseAt?: PauseAtWithLiterals;
|
|
2707
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
2708
|
+
actionDetails?: ActionDetails;
|
|
2457
2709
|
}
|
|
2458
|
-
interface
|
|
2459
|
-
/**
|
|
2460
|
-
* Tenant ID (instance ID) of the subscription
|
|
2461
|
-
* @format GUID
|
|
2462
|
-
*/
|
|
2463
|
-
tenantId?: string;
|
|
2464
|
-
/**
|
|
2465
|
-
* Subscription ID to patch
|
|
2466
|
-
* @format GUID
|
|
2467
|
-
*/
|
|
2468
|
-
subscriptionId?: string;
|
|
2469
|
-
/** Partial subscription with updated values */
|
|
2470
|
-
subscription?: Subscription;
|
|
2471
|
-
/** Fields to update (e.g., "name", "billing_settings.collection_method") */
|
|
2472
|
-
fieldMask?: string[];
|
|
2473
|
-
}
|
|
2474
|
-
interface PatchSubscriptionResponse {
|
|
2475
|
-
/** The updated subscription */
|
|
2710
|
+
interface ScheduledPauseCanceled {
|
|
2476
2711
|
subscription?: Subscription;
|
|
2712
|
+
actionDetails?: ActionDetails;
|
|
2477
2713
|
}
|
|
2478
|
-
interface
|
|
2479
|
-
/** @format GUID */
|
|
2480
|
-
subscriptionId?: string;
|
|
2481
|
-
/** @format GUID */
|
|
2482
|
-
tenantId?: string;
|
|
2714
|
+
interface ResumeSubscriptionRequest {
|
|
2483
2715
|
/** @format GUID */
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
|
|
2716
|
+
id: string;
|
|
2717
|
+
resumeAt?: ResumeAtWithLiterals;
|
|
2718
|
+
/** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
|
|
2719
|
+
resumeAtSchedule?: ScheduleAdditionalInfo;
|
|
2720
|
+
actionContext: ActionContext;
|
|
2721
|
+
/** Strategy for resuming a migrated paused subscription when the previous billing date is missing. */
|
|
2722
|
+
missingPreviousBillingDateResumeStrategy?: MissingPreviousBillingDateResumeStrategyWithLiterals;
|
|
2489
2723
|
}
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
pauseEndDate?: Date | null;
|
|
2724
|
+
declare enum MissingPreviousBillingDateResumeStrategy {
|
|
2725
|
+
UNKNOWN = "UNKNOWN",
|
|
2726
|
+
/** Use a fallback that makes the next billing date resolve to now. */
|
|
2727
|
+
START_BILLING_IMMEDIATELY = "START_BILLING_IMMEDIATELY",
|
|
2728
|
+
/** Use a fallback that makes the next billing date resolve to one full cycle from now. */
|
|
2729
|
+
START_BILLING_AFTER_ONE_FULL_CYCLE = "START_BILLING_AFTER_ONE_FULL_CYCLE"
|
|
2497
2730
|
}
|
|
2498
|
-
|
|
2731
|
+
/** @enumType */
|
|
2732
|
+
type MissingPreviousBillingDateResumeStrategyWithLiterals = MissingPreviousBillingDateResumeStrategy | 'UNKNOWN' | 'START_BILLING_IMMEDIATELY' | 'START_BILLING_AFTER_ONE_FULL_CYCLE';
|
|
2733
|
+
interface ResumeSubscriptionResponse {
|
|
2499
2734
|
subscription?: Subscription;
|
|
2500
2735
|
}
|
|
2501
|
-
interface
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
subscriptionId?: string;
|
|
2506
|
-
/** @minLength 1 */
|
|
2507
|
-
taskType?: string;
|
|
2508
|
-
}
|
|
2509
|
-
interface CreateRecurringInvoiceBORequest {
|
|
2510
|
-
/** @format GUID */
|
|
2511
|
-
subscriptionId?: string;
|
|
2512
|
-
/** @format GUID */
|
|
2513
|
-
tenantId?: string;
|
|
2514
|
-
/** @min 2 */
|
|
2515
|
-
cycleNumber?: number;
|
|
2516
|
-
}
|
|
2517
|
-
interface CreateRecurringInvoiceBOResponse {
|
|
2518
|
-
invoiceId?: string;
|
|
2736
|
+
interface SubscriptionResumed {
|
|
2737
|
+
subscription?: Subscription;
|
|
2738
|
+
actionDetails?: ActionDetails;
|
|
2739
|
+
pauseInfo?: PauseInfo;
|
|
2519
2740
|
}
|
|
2520
|
-
interface
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2524
|
-
tenantId?: string;
|
|
2525
|
-
isBassManaged?: boolean;
|
|
2526
|
-
shiftManagementDate?: Date | null;
|
|
2741
|
+
interface ResumeSubscriptionRequested {
|
|
2742
|
+
subscription?: Subscription;
|
|
2743
|
+
resumeAt?: ResumeAtWithLiterals;
|
|
2744
|
+
actionDetails?: ActionDetails;
|
|
2527
2745
|
}
|
|
2528
|
-
interface
|
|
2746
|
+
interface ScheduledResumeCanceled {
|
|
2529
2747
|
subscription?: Subscription;
|
|
2748
|
+
actionDetails?: ActionDetails;
|
|
2530
2749
|
}
|
|
2531
|
-
interface
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
|
-
/**
|
|
2535
|
-
|
|
2536
|
-
/**
|
|
2537
|
-
|
|
2750
|
+
interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
|
|
2751
|
+
/** Limit number of results and enable to skip rows. The default limit is 25. */
|
|
2752
|
+
paging?: Paging;
|
|
2753
|
+
/** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
|
|
2754
|
+
cursor?: CursorPaging;
|
|
2755
|
+
/** A filter object */
|
|
2756
|
+
filter?: any;
|
|
2757
|
+
/** A Sorting option by field name and order. */
|
|
2758
|
+
sorting?: SortingClauses;
|
|
2538
2759
|
}
|
|
2539
2760
|
/** @oneof */
|
|
2540
|
-
interface
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
/** @format GUID */
|
|
2546
|
-
invoiceId?: string;
|
|
2547
|
-
}
|
|
2548
|
-
interface DetachInvoice {
|
|
2549
|
-
/** @format GUID */
|
|
2550
|
-
invoiceId?: string;
|
|
2761
|
+
interface SearchSubscriptionsRequestPagingMethodOneOf {
|
|
2762
|
+
/** Limit number of results and enable to skip rows. The default limit is 25. */
|
|
2763
|
+
paging?: Paging;
|
|
2764
|
+
/** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
|
|
2765
|
+
cursor?: CursorPaging;
|
|
2551
2766
|
}
|
|
2552
|
-
interface
|
|
2553
|
-
|
|
2767
|
+
interface SortingClauses {
|
|
2768
|
+
sorting?: Sorting[];
|
|
2554
2769
|
}
|
|
2555
|
-
interface
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
subscriptionId?: string;
|
|
2770
|
+
interface SearchSubscriptionsResponse {
|
|
2771
|
+
subscriptions?: Subscription[];
|
|
2772
|
+
cursor?: CursorPaging;
|
|
2773
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
2560
2774
|
}
|
|
2561
|
-
interface
|
|
2562
|
-
|
|
2775
|
+
interface CursorPagingMetadata {
|
|
2776
|
+
/** Total number of items matching the filter. Available only on the first page of *Search* */
|
|
2777
|
+
total?: number | null;
|
|
2563
2778
|
}
|
|
2564
|
-
interface
|
|
2565
|
-
/** @format GUID */
|
|
2566
|
-
tenantId?: string;
|
|
2779
|
+
interface TurnOnSubscriptionAutoRenewalRequest {
|
|
2567
2780
|
/** @format GUID */
|
|
2568
|
-
|
|
2781
|
+
id: string;
|
|
2782
|
+
actionContext: ActionContext;
|
|
2569
2783
|
}
|
|
2570
|
-
interface
|
|
2784
|
+
interface TurnOnSubscriptionAutoRenewalResponse {
|
|
2571
2785
|
subscription?: Subscription;
|
|
2572
2786
|
}
|
|
2573
|
-
interface
|
|
2574
|
-
/** @format GUID */
|
|
2575
|
-
tenantId?: string;
|
|
2576
|
-
/** @format GUID */
|
|
2577
|
-
subscriptionId?: string;
|
|
2578
|
-
}
|
|
2579
|
-
interface DeleteSubscriptionBOResponse {
|
|
2787
|
+
interface SubscriptionAutoRenewalTurnedOn {
|
|
2580
2788
|
subscription?: Subscription;
|
|
2789
|
+
actionDetails?: ActionDetails;
|
|
2581
2790
|
}
|
|
2582
|
-
interface
|
|
2583
|
-
/** @format GUID */
|
|
2584
|
-
tenantId?: string;
|
|
2791
|
+
interface TurnOffSubscriptionAutoRenewalRequest {
|
|
2585
2792
|
/** @format GUID */
|
|
2586
|
-
|
|
2587
|
-
|
|
2588
|
-
reason?: string | null;
|
|
2589
|
-
}
|
|
2590
|
-
declare enum ActionInitiator {
|
|
2591
|
-
UNDEFINED = "UNDEFINED",
|
|
2592
|
-
BUSINESS = "BUSINESS",
|
|
2593
|
-
CUSTOMER = "CUSTOMER",
|
|
2594
|
-
SYSTEM = "SYSTEM"
|
|
2793
|
+
id: string;
|
|
2794
|
+
actionContext: ActionContext;
|
|
2595
2795
|
}
|
|
2596
|
-
|
|
2597
|
-
type ActionInitiatorWithLiterals = ActionInitiator | 'UNDEFINED' | 'BUSINESS' | 'CUSTOMER' | 'SYSTEM';
|
|
2598
|
-
interface CancelSubscriptionBOResponse {
|
|
2796
|
+
interface TurnOffSubscriptionAutoRenewalResponse {
|
|
2599
2797
|
subscription?: Subscription;
|
|
2600
2798
|
}
|
|
2601
|
-
interface
|
|
2602
|
-
/** @format GUID */
|
|
2603
|
-
tenantId?: string;
|
|
2604
|
-
/** @format GUID */
|
|
2605
|
-
subscriptionId?: string;
|
|
2606
|
-
/** @format GUID */
|
|
2607
|
-
paymentMethodId?: string;
|
|
2608
|
-
}
|
|
2609
|
-
interface UpdatePaymentMethodBOResponse {
|
|
2799
|
+
interface SubscriptionAutoRenewalTurnedOff {
|
|
2610
2800
|
subscription?: Subscription;
|
|
2801
|
+
actionDetails?: ActionDetails;
|
|
2611
2802
|
}
|
|
2612
|
-
interface
|
|
2613
|
-
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
2614
|
-
/** @format GUID */
|
|
2615
|
-
tenantId?: string;
|
|
2616
|
-
/** @format GUID */
|
|
2617
|
-
subscriptionId?: string;
|
|
2618
|
-
}
|
|
2619
|
-
/** @oneof */
|
|
2620
|
-
interface SendSubscriptionActionEventBORequestEventOneOf {
|
|
2621
|
-
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
2622
|
-
}
|
|
2623
|
-
interface SubscriptionBillingCycleStarted {
|
|
2624
|
-
subscription?: Subscription;
|
|
2803
|
+
interface MarkLatestInvoiceAsPaidRequest {
|
|
2625
2804
|
/**
|
|
2626
|
-
*
|
|
2805
|
+
* The ID of the offline subscription to mark as paid its latest invoice
|
|
2627
2806
|
* @format GUID
|
|
2628
2807
|
*/
|
|
2629
|
-
|
|
2630
|
-
}
|
|
2631
|
-
interface SendSubscriptionActionEventResponse {
|
|
2632
|
-
}
|
|
2633
|
-
interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
|
|
2634
|
-
/** @format GUID */
|
|
2635
|
-
tenantId?: string;
|
|
2636
|
-
/** @format GUID */
|
|
2637
|
-
subscriptionId?: string;
|
|
2638
|
-
transactionId?: string;
|
|
2639
|
-
}
|
|
2640
|
-
interface PauseSubscriptionBORequest {
|
|
2641
|
-
/** @format GUID */
|
|
2642
|
-
tenantId?: string;
|
|
2643
|
-
/** @format GUID */
|
|
2644
|
-
subscriptionId?: string;
|
|
2645
|
-
pausePolicy?: PausePolicyWithLiterals;
|
|
2646
|
-
pauseAt?: PauseAtWithLiterals;
|
|
2647
|
-
initiator?: ActionInitiatorWithLiterals;
|
|
2648
|
-
/** @maxLength 500 */
|
|
2649
|
-
reason?: string | null;
|
|
2808
|
+
subscriptionId: string;
|
|
2650
2809
|
}
|
|
2651
|
-
interface
|
|
2810
|
+
interface MarkLatestInvoiceAsPaidResponse {
|
|
2652
2811
|
subscription?: Subscription;
|
|
2653
2812
|
}
|
|
2654
|
-
interface
|
|
2655
|
-
|
|
2656
|
-
tenantId?: string;
|
|
2657
|
-
/** @format GUID */
|
|
2658
|
-
subscriptionId?: string;
|
|
2659
|
-
}
|
|
2660
|
-
interface FixSubscriptionInvoicesConsistencyResponse {
|
|
2813
|
+
interface LatestInvoiceMarkedAsPaid {
|
|
2814
|
+
subscription?: Subscription;
|
|
2661
2815
|
}
|
|
2662
|
-
interface
|
|
2816
|
+
interface MultipleSubscriptionsOnOrdersInvoice {
|
|
2663
2817
|
/**
|
|
2664
|
-
*
|
|
2818
|
+
* the invoice id of the affected subscription
|
|
2665
2819
|
* @format GUID
|
|
2666
2820
|
*/
|
|
2667
|
-
|
|
2821
|
+
invoiceId?: string;
|
|
2668
2822
|
/**
|
|
2669
|
-
*
|
|
2823
|
+
* the order id of the affected subscription
|
|
2670
2824
|
* @format GUID
|
|
2671
2825
|
*/
|
|
2672
|
-
|
|
2826
|
+
orderId?: string;
|
|
2827
|
+
}
|
|
2828
|
+
interface MarkBillingCycleAsPaidRequest {
|
|
2673
2829
|
/**
|
|
2674
|
-
*
|
|
2675
|
-
* @format
|
|
2830
|
+
* The ID of the subscription to mark as paid its invoice.
|
|
2831
|
+
* @format GUID
|
|
2676
2832
|
*/
|
|
2677
|
-
|
|
2833
|
+
subscriptionId: string;
|
|
2678
2834
|
/**
|
|
2679
|
-
*
|
|
2680
|
-
*
|
|
2835
|
+
* The subscription cycle for which the invoice is to be marked as paid.
|
|
2836
|
+
* If left empty, the most recent cycle will be selected.
|
|
2837
|
+
* @min 1
|
|
2681
2838
|
*/
|
|
2682
|
-
|
|
2839
|
+
paidCycle?: number | null;
|
|
2683
2840
|
}
|
|
2684
|
-
interface
|
|
2685
|
-
/** The updated subscription with new currency and converted amounts */
|
|
2841
|
+
interface MarkBillingCycleAsPaidResponse {
|
|
2686
2842
|
subscription?: Subscription;
|
|
2687
2843
|
}
|
|
2688
|
-
interface
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
|
|
2844
|
+
interface GetSubscriptionsStatsRequest {
|
|
2845
|
+
}
|
|
2846
|
+
interface GetSubscriptionsStatsResponse {
|
|
2847
|
+
amountByStatuses?: AmountByStatus[];
|
|
2848
|
+
total?: number;
|
|
2849
|
+
}
|
|
2850
|
+
interface AmountByStatus {
|
|
2851
|
+
status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
|
|
2852
|
+
amount?: number;
|
|
2853
|
+
}
|
|
2854
|
+
interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
|
|
2855
|
+
/** User won't be charged for additional period added on top of subscription end date. */
|
|
2856
|
+
extensionPeriod?: Duration;
|
|
2857
|
+
/**
|
|
2858
|
+
* user will be charged for billing cycles added
|
|
2859
|
+
* @min 1
|
|
2692
2860
|
*/
|
|
2693
|
-
|
|
2861
|
+
extensionBillingCycles?: number;
|
|
2694
2862
|
/**
|
|
2695
|
-
*
|
|
2863
|
+
* The ID of the subscription to be extended
|
|
2696
2864
|
* @format GUID
|
|
2697
2865
|
*/
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
platformOrigin?: PlatformOrigin;
|
|
2701
|
-
}
|
|
2702
|
-
interface UpdateSubscriptionPlatformOriginResponse {
|
|
2703
|
-
/** The updated subscription with new platform origin */
|
|
2704
|
-
subscription?: Subscription;
|
|
2705
|
-
}
|
|
2706
|
-
interface SetIsMigratedEvent {
|
|
2707
|
-
/** @format GUID */
|
|
2708
|
-
subscriptionId?: string;
|
|
2709
|
-
}
|
|
2710
|
-
interface SubscriptionDelayedSyncEvent {
|
|
2711
|
-
/** @format GUID */
|
|
2712
|
-
subscriptionId?: string;
|
|
2713
|
-
}
|
|
2714
|
-
interface InvoiceAction extends InvoiceActionActionTypeOneOf {
|
|
2715
|
-
payRecurring?: PayRecurringInvoice;
|
|
2866
|
+
id: string;
|
|
2867
|
+
actionContext: ActionContext;
|
|
2716
2868
|
}
|
|
2717
2869
|
/** @oneof */
|
|
2718
|
-
interface
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
* Sent each time a subscription status has been set to Active
|
|
2727
|
-
* Active shows that a subscription is live and operational.
|
|
2728
|
-
* For example:
|
|
2729
|
-
* * For subscription with free trial, free trial start date is also the activation date.
|
|
2730
|
-
* * For a subscription with future start date, the start date is also the activation date.
|
|
2731
|
-
* * When a subscription is resumed from a pause status, the resume date is also the activation date.
|
|
2732
|
-
*/
|
|
2733
|
-
interface SubscriptionActivated {
|
|
2734
|
-
subscription?: Subscription;
|
|
2870
|
+
interface ExtendSubscriptionRequestExtendPolicyOneOf {
|
|
2871
|
+
/** User won't be charged for additional period added on top of subscription end date. */
|
|
2872
|
+
extensionPeriod?: Duration;
|
|
2873
|
+
/**
|
|
2874
|
+
* user will be charged for billing cycles added
|
|
2875
|
+
* @min 1
|
|
2876
|
+
*/
|
|
2877
|
+
extensionBillingCycles?: number;
|
|
2735
2878
|
}
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
* Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
|
|
2739
|
-
* This is different from a Canceled subscription which ends the subscription before a designated end date.
|
|
2740
|
-
* Therefore, Ended and Canceled are mutually exclusive.
|
|
2741
|
-
*/
|
|
2742
|
-
interface SubscriptionEnded {
|
|
2879
|
+
interface ExtendSubscriptionResponse {
|
|
2880
|
+
/** The now extended subscription */
|
|
2743
2881
|
subscription?: Subscription;
|
|
2744
2882
|
}
|
|
2745
|
-
interface
|
|
2746
|
-
subscription?: Subscription;
|
|
2747
|
-
actionDetails?: ActionDetails;
|
|
2883
|
+
interface AllowedActionsRequest {
|
|
2748
2884
|
/** @format GUID */
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
|
|
2885
|
+
id: string;
|
|
2886
|
+
/**
|
|
2887
|
+
* List of additional fields to be included in the response.
|
|
2888
|
+
* @maxSize 1
|
|
2889
|
+
*/
|
|
2890
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2753
2891
|
}
|
|
2754
|
-
|
|
2755
|
-
|
|
2892
|
+
declare enum RequestedFields {
|
|
2893
|
+
/** Include unsupported action list, including the reasons for the lack of support */
|
|
2894
|
+
UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
|
|
2756
2895
|
}
|
|
2757
|
-
|
|
2758
|
-
|
|
2896
|
+
/** @enumType */
|
|
2897
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNSUPPORTED_ACTION';
|
|
2898
|
+
interface AllowedActionsResponse {
|
|
2899
|
+
/** List of actions that are allowed. */
|
|
2900
|
+
actions?: Action[];
|
|
2759
2901
|
/**
|
|
2760
|
-
*
|
|
2761
|
-
* @
|
|
2902
|
+
* List of actions that are not supported, included only if requested. Provides reasons for each unsupported action.
|
|
2903
|
+
* @maxSize 20
|
|
2762
2904
|
*/
|
|
2763
|
-
|
|
2905
|
+
unsupportedActions?: UnsupportedAction[];
|
|
2764
2906
|
}
|
|
2765
|
-
interface
|
|
2766
|
-
|
|
2767
|
-
subscription?: Subscription;
|
|
2907
|
+
interface UnsupportedAction {
|
|
2908
|
+
actionType?: ActionTypeWithLiterals;
|
|
2768
2909
|
/**
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2910
|
+
* Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed.
|
|
2911
|
+
* @maxSize 20
|
|
2771
2912
|
*/
|
|
2772
|
-
|
|
2913
|
+
reasons?: UnsupportedReason[];
|
|
2773
2914
|
}
|
|
2774
|
-
interface
|
|
2775
|
-
|
|
2915
|
+
interface UnsupportedReason {
|
|
2916
|
+
code?: string;
|
|
2917
|
+
description?: string | null;
|
|
2776
2918
|
}
|
|
2777
|
-
interface
|
|
2919
|
+
interface ListUpcomingChargesRequest {
|
|
2778
2920
|
/**
|
|
2779
|
-
* Subscription
|
|
2921
|
+
* Subscription id charges to be previewed for
|
|
2780
2922
|
* @format GUID
|
|
2781
2923
|
*/
|
|
2782
|
-
|
|
2783
|
-
/**
|
|
2784
|
-
|
|
2785
|
-
* By setting start_date in the future, end_date will be recalculated for termed Subscriptions
|
|
2786
|
-
* cycles_to_pay_on_creation will be set to 1 if no free trial is set
|
|
2787
|
-
*/
|
|
2788
|
-
startDate?: Date | null;
|
|
2789
|
-
}
|
|
2790
|
-
interface UpdateSubscriptionStartDateResponse {
|
|
2791
|
-
subscription?: Subscription;
|
|
2792
|
-
}
|
|
2793
|
-
interface BassToSapiPaypalMigrationRequest {
|
|
2924
|
+
subscriptionId: string;
|
|
2925
|
+
/** Period of time to provide charged for. If not provided,then only next charge will be returned. */
|
|
2926
|
+
customDuration?: Duration;
|
|
2794
2927
|
/**
|
|
2795
|
-
*
|
|
2796
|
-
*
|
|
2928
|
+
* Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
|
|
2929
|
+
* If not provided, the upcoming charges will be calculated according to the existing next billing date.
|
|
2797
2930
|
*/
|
|
2798
|
-
|
|
2799
|
-
collectionMethod?: CollectionMethodEnumCollectionMethodWithLiterals;
|
|
2931
|
+
nextBillingDate?: Date | null;
|
|
2800
2932
|
}
|
|
2801
|
-
interface
|
|
2802
|
-
|
|
2933
|
+
interface ListUpcomingChargesResponse {
|
|
2934
|
+
upcomingCharges?: SubscriptionCharge[];
|
|
2803
2935
|
}
|
|
2804
|
-
interface
|
|
2805
|
-
/**
|
|
2806
|
-
|
|
2807
|
-
* @format GUID
|
|
2808
|
-
*/
|
|
2809
|
-
id?: string;
|
|
2810
|
-
cancellableByCustomer?: boolean | null;
|
|
2936
|
+
interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
|
|
2937
|
+
/** Information about a non-existing subscription. */
|
|
2938
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
2811
2939
|
}
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
|
|
2940
|
+
/** @oneof */
|
|
2941
|
+
interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
|
|
2942
|
+
/** Information about a non-existing subscription. */
|
|
2943
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
2815
2944
|
}
|
|
2816
|
-
|
|
2817
|
-
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
|
-
id: string;
|
|
2822
|
-
/** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
|
|
2823
|
-
billingDate: Date | null;
|
|
2945
|
+
/** Subscription information to use for calculating the preview of charges for a subscription. */
|
|
2946
|
+
interface SubscriptionInfo {
|
|
2947
|
+
billingSettings?: BillingSettings;
|
|
2948
|
+
items?: Item[];
|
|
2949
|
+
startDate?: Date | null;
|
|
2824
2950
|
/**
|
|
2825
|
-
*
|
|
2826
|
-
*
|
|
2827
|
-
*
|
|
2828
|
-
* amount based on the number of days added to or removed from the current billing
|
|
2829
|
-
* cycle. Alternatively, you can use your own custom method to calculate the
|
|
2830
|
-
* proration amount. The custom proration amount can't exceed the total of the
|
|
2831
|
-
* current billing cycle.
|
|
2951
|
+
* Customer the subscription belongs to. When provided, used for accurate tax calculation.
|
|
2952
|
+
* Optional for backward compatibility; if omitted, a synthetic id is used (legacy behavior)
|
|
2953
|
+
* and customer-specific tax rules (VAT exemptions, tax IDs) will not apply.
|
|
2832
2954
|
*/
|
|
2833
|
-
|
|
2955
|
+
customer?: Customer;
|
|
2834
2956
|
}
|
|
2835
|
-
interface
|
|
2836
|
-
/**
|
|
2837
|
-
|
|
2957
|
+
interface PreviewSubscriptionChargesResponse {
|
|
2958
|
+
/** Charges for subscription. */
|
|
2959
|
+
charges?: Charge[];
|
|
2838
2960
|
}
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
|
|
2961
|
+
/** Represents a charge applicable to a subscription. */
|
|
2962
|
+
interface Charge {
|
|
2963
|
+
/** The cycle number from which the charge starts. */
|
|
2964
|
+
cycleFrom?: number;
|
|
2965
|
+
/** The number of cycles for which the charge is applicable. */
|
|
2966
|
+
cycleCount?: number | null;
|
|
2967
|
+
/** The breakdown of the charge */
|
|
2968
|
+
totals?: Totals;
|
|
2969
|
+
/** The billing date from which the charge starts */
|
|
2970
|
+
cycleBillingDate?: Date | null;
|
|
2843
2971
|
}
|
|
2844
|
-
interface
|
|
2972
|
+
interface PreviewSubscriptionsChargesRequest {
|
|
2845
2973
|
/**
|
|
2846
|
-
*
|
|
2847
|
-
* @
|
|
2974
|
+
* Information required to calculate the preview charges for the subscriptions, including an identifier.
|
|
2975
|
+
* @minSize 1
|
|
2976
|
+
* @maxSize 10
|
|
2848
2977
|
*/
|
|
2849
|
-
|
|
2978
|
+
subscriptionsBillingDetails?: SubscriptionBillingDetails[];
|
|
2850
2979
|
/**
|
|
2851
|
-
*
|
|
2852
|
-
*
|
|
2980
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
2981
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
2982
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
2983
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
2984
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
2985
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
2986
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
2987
|
+
* in this case, charges for cycle 1 through 3.
|
|
2988
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
2989
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
2990
|
+
* @min 1
|
|
2991
|
+
* @max 10
|
|
2853
2992
|
*/
|
|
2854
|
-
|
|
2855
|
-
}
|
|
2856
|
-
interface UpdateSubscriptionOriginResponse {
|
|
2857
|
-
/** Updated subscription. */
|
|
2858
|
-
subscription?: Subscription;
|
|
2993
|
+
numberOfNextRecurringCharges?: number | null;
|
|
2859
2994
|
}
|
|
2860
|
-
interface
|
|
2995
|
+
interface SubscriptionBillingDetails {
|
|
2861
2996
|
/**
|
|
2862
|
-
*
|
|
2997
|
+
* External identifier of the subscription
|
|
2863
2998
|
* @format GUID
|
|
2864
2999
|
*/
|
|
2865
|
-
|
|
3000
|
+
externalId?: string | null;
|
|
3001
|
+
/** Billing details parameters including schedule, currency, etc. */
|
|
3002
|
+
billingSettings?: BillingSettings;
|
|
2866
3003
|
/**
|
|
2867
|
-
*
|
|
3004
|
+
* Items, minSize is 1, maxSize is 100
|
|
3005
|
+
* @minSize 1
|
|
2868
3006
|
* @maxSize 100
|
|
2869
3007
|
*/
|
|
2870
3008
|
items?: Item[];
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
subscription
|
|
2874
|
-
|
|
2875
|
-
interface UpdateSubscriptionItemsRequest {
|
|
2876
|
-
/**
|
|
2877
|
-
* Subscription ID
|
|
2878
|
-
* @format GUID
|
|
2879
|
-
*/
|
|
2880
|
-
id?: string;
|
|
2881
|
-
/** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
|
|
2882
|
-
updateAction?: UpdateActionWithLiterals;
|
|
2883
|
-
/** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
|
|
2884
|
-
scheduleAdditionalInfo?: ScheduleAdditionalInfo;
|
|
3009
|
+
/** Subscription start date, now if not set */
|
|
3010
|
+
startDate?: Date | null;
|
|
3011
|
+
/** Shipping address associated with subscription. At the moment used only for payments. Optional. */
|
|
3012
|
+
shippingAddress?: FullAddressDetails;
|
|
2885
3013
|
/**
|
|
2886
|
-
*
|
|
2887
|
-
*
|
|
3014
|
+
* Customer the subscription belongs to. When provided, used for accurate tax calculation.
|
|
3015
|
+
* Optional for backward compatibility; if omitted, a synthetic id is used (legacy behavior).
|
|
2888
3016
|
*/
|
|
2889
|
-
|
|
3017
|
+
customer?: Customer;
|
|
3018
|
+
}
|
|
3019
|
+
interface PreviewSubscriptionsChargesResponse {
|
|
3020
|
+
/** Charges for the subscriptions, including an identifier. */
|
|
3021
|
+
subscriptionsCharges?: SubscriptionCharges[];
|
|
3022
|
+
}
|
|
3023
|
+
interface SubscriptionCharges {
|
|
2890
3024
|
/**
|
|
2891
|
-
*
|
|
2892
|
-
* @
|
|
3025
|
+
* External identifier of the subscription
|
|
3026
|
+
* @format GUID
|
|
2893
3027
|
*/
|
|
2894
|
-
|
|
3028
|
+
externalId?: string | null;
|
|
3029
|
+
/** Charges for subscription. */
|
|
3030
|
+
charges?: Charge[];
|
|
3031
|
+
}
|
|
3032
|
+
interface CreateSubscriptionForOrderRequest {
|
|
3033
|
+
/** Subscription needs to be created */
|
|
3034
|
+
subscription?: Subscription;
|
|
2895
3035
|
/**
|
|
2896
|
-
*
|
|
3036
|
+
* Optional unique identifier for this request in order to prevent subscription duplications
|
|
2897
3037
|
* @format GUID
|
|
2898
|
-
* @maxSize 99
|
|
2899
3038
|
*/
|
|
2900
|
-
|
|
2901
|
-
}
|
|
2902
|
-
declare enum UpdateAction {
|
|
2903
|
-
NONE = "NONE",
|
|
2904
|
-
/** Update subscription immediately, please note proration for updates changing price are not yet supported */
|
|
2905
|
-
IMMEDIATELY = "IMMEDIATELY",
|
|
2906
|
-
/** Request updates that will take affect only at the start of the next billing cycle. */
|
|
2907
|
-
NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
|
|
2908
|
-
/** Reset all pending updates */
|
|
2909
|
-
RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
|
|
2910
|
-
/** Request updates that will take affect only at a specific date. */
|
|
2911
|
-
SPECIFIC_DATE = "SPECIFIC_DATE"
|
|
3039
|
+
idempotencyKey?: string | null;
|
|
2912
3040
|
}
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
interface UpdateSubscriptionItemsResponse {
|
|
3041
|
+
interface CreateSubscriptionForOrderResponse {
|
|
3042
|
+
/** Created subscription */
|
|
2916
3043
|
subscription?: Subscription;
|
|
3044
|
+
/** Non-persistent invoice */
|
|
3045
|
+
invoice?: Invoice;
|
|
2917
3046
|
}
|
|
2918
|
-
|
|
3047
|
+
/** An invoice includes information about the subscription and the customer. */
|
|
3048
|
+
interface Invoice {
|
|
2919
3049
|
/**
|
|
2920
|
-
*
|
|
2921
|
-
*
|
|
2922
|
-
*
|
|
2923
|
-
* Sending an empty subscription filter results in a validation error.
|
|
2924
|
-
* In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
|
|
2925
|
-
* `subscriptionId` field inside this filter. Passing any other filter results
|
|
2926
|
-
* in a failed validation error.
|
|
3050
|
+
* Invoice ID.
|
|
3051
|
+
* @format GUID
|
|
3052
|
+
* @readonly
|
|
2927
3053
|
*/
|
|
2928
|
-
|
|
3054
|
+
id?: string | null;
|
|
2929
3055
|
/**
|
|
2930
|
-
*
|
|
2931
|
-
*
|
|
2932
|
-
|
|
3056
|
+
* Date and time the invoice was created.
|
|
3057
|
+
* @readonly
|
|
3058
|
+
*/
|
|
3059
|
+
createdDate?: Date | null;
|
|
3060
|
+
/**
|
|
3061
|
+
* Date and time the invoice was last updated.
|
|
3062
|
+
* @readonly
|
|
3063
|
+
*/
|
|
3064
|
+
updatedDate?: Date | null;
|
|
3065
|
+
/**
|
|
3066
|
+
* Revision number, which increments by 1 each time the invoice is updated.
|
|
3067
|
+
* To prevent conflicting changes,
|
|
3068
|
+
* the current revision must be passed when updating the invoice.
|
|
2933
3069
|
*
|
|
2934
|
-
*
|
|
2935
|
-
* @
|
|
2936
|
-
* @maxSize 100
|
|
3070
|
+
* Ignored when creating a invoice.
|
|
3071
|
+
* @readonly
|
|
2937
3072
|
*/
|
|
2938
|
-
|
|
3073
|
+
revision?: string | null;
|
|
2939
3074
|
/**
|
|
2940
|
-
*
|
|
3075
|
+
* Source of the invoice.
|
|
3076
|
+
* @internal
|
|
3077
|
+
*/
|
|
3078
|
+
source?: string | null;
|
|
3079
|
+
/** Information about the invoice origin. */
|
|
3080
|
+
origin?: BusinessOriginData;
|
|
3081
|
+
/**
|
|
3082
|
+
* Invoice status.
|
|
2941
3083
|
*
|
|
2942
|
-
* + `"
|
|
2943
|
-
* + `"
|
|
2944
|
-
* + `"
|
|
2945
|
-
* + `"
|
|
3084
|
+
* + `"UNKNOWN"`: There is no information about the invoice status.
|
|
3085
|
+
* + `"OPEN"`: BASS has created the invoice but hasn't initiated the payment process.
|
|
3086
|
+
* + `"PAID"`: The customer has successfully paid for the invoice.
|
|
3087
|
+
* + `"ATTEMPT_FAILED"`: The payment process has started and there has been at least one unsuccessful payment attempt.
|
|
3088
|
+
* + `"FAILED"`: The payment process has failed and there are no more retries.
|
|
3089
|
+
* + `"CANCELED"`: The payment process has been stopped because the related subscription has been canceled.
|
|
3090
|
+
* @readonly
|
|
2946
3091
|
*/
|
|
2947
|
-
|
|
3092
|
+
status?: InvoiceStatusWithLiterals;
|
|
2948
3093
|
/**
|
|
2949
|
-
*
|
|
2950
|
-
*
|
|
3094
|
+
* 3-letter currency code of the invoice in
|
|
3095
|
+
* [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3096
|
+
* @format CURRENCY
|
|
2951
3097
|
*/
|
|
2952
|
-
|
|
3098
|
+
currency?: string;
|
|
3099
|
+
/** Information about the customer. */
|
|
3100
|
+
customer?: Customer;
|
|
2953
3101
|
/**
|
|
2954
|
-
*
|
|
2955
|
-
*
|
|
2956
|
-
*
|
|
2957
|
-
*
|
|
2958
|
-
*
|
|
3102
|
+
* Whether the payment is processed through Wix and whether the customer must provide some input.
|
|
3103
|
+
*
|
|
3104
|
+
* + `"UNKNOWN"`: There is no information about the collection method.
|
|
3105
|
+
* + `"AUTO_CHARGE"`: The customer pays automatically through Wix.
|
|
3106
|
+
* + `"SEND_INVOICE"`: The customer pays through Wix, but some manual input is required.
|
|
3107
|
+
* + `"OFFLINE"`: The customer pays outside of Wix.
|
|
2959
3108
|
*/
|
|
2960
|
-
|
|
3109
|
+
collectionMethod?: CollectionMethodWithLiterals;
|
|
2961
3110
|
/**
|
|
2962
|
-
*
|
|
2963
|
-
*
|
|
3111
|
+
* ID of the
|
|
3112
|
+
* [payment method](https://bo.wix.com/wix-docs/rest/wix-cashier/settings/payment-method-type/payment-method-type-object).
|
|
3113
|
+
* Not available for the first payment of a subscription and all offline
|
|
3114
|
+
* payments.
|
|
3115
|
+
* @format GUID
|
|
2964
3116
|
*/
|
|
2965
|
-
|
|
2966
|
-
}
|
|
2967
|
-
interface BulkItemChange {
|
|
2968
|
-
/** Information about the new item price. */
|
|
2969
|
-
pricingModel?: PricingModel;
|
|
3117
|
+
paymentMethodId?: string | null;
|
|
2970
3118
|
/**
|
|
2971
|
-
*
|
|
3119
|
+
* Cashier [Order ID](https://dev.wix.com/docs/rest/payments/wix-cashier/pay/order#order-object)
|
|
3120
|
+
* for the corresponding payment.
|
|
3121
|
+
* @format GUID
|
|
3122
|
+
* @readonly
|
|
3123
|
+
*/
|
|
3124
|
+
paymentOrderId?: string | null;
|
|
3125
|
+
/** Information about a discount. Available only for invoices that include a discount. */
|
|
3126
|
+
discount?: InvoiceDiscount;
|
|
3127
|
+
/** Billing address. */
|
|
3128
|
+
billingAddress?: FullAddressDetails;
|
|
3129
|
+
/** Shipping address. Available only for `"PHYSICAL"` line items. */
|
|
3130
|
+
shippingAddress?: FullAddressDetails;
|
|
3131
|
+
/**
|
|
3132
|
+
* Shipping fee in `0.00` format.
|
|
3133
|
+
* @format DECIMAL_VALUE
|
|
3134
|
+
*/
|
|
3135
|
+
shippingFee?: string | null;
|
|
3136
|
+
/**
|
|
3137
|
+
* Information about the invoice's totals.
|
|
3138
|
+
* @readonly
|
|
3139
|
+
*/
|
|
3140
|
+
totals?: Totals;
|
|
3141
|
+
/** Line items belonging to the invoice. */
|
|
3142
|
+
invoiceItems?: InvoiceItem[];
|
|
3143
|
+
/**
|
|
3144
|
+
* Whether the invoice is used to validate payment details.
|
|
2972
3145
|
*
|
|
2973
|
-
*
|
|
2974
|
-
*
|
|
3146
|
+
* + `true`: BASS uses the invoice to test payment details. Relevant for free trials. Ensures that Wix can collect the payment of the first billing cycle.
|
|
3147
|
+
* + `false`: Standard invoice.
|
|
2975
3148
|
*/
|
|
2976
|
-
|
|
2977
|
-
/**
|
|
2978
|
-
|
|
2979
|
-
}
|
|
2980
|
-
interface BulkUpdateSubscriptionItemsByFilterResponse {
|
|
3149
|
+
isAuthorization?: boolean | null;
|
|
3150
|
+
/** Whether the invoice's `totals.totalPrice` includes tax. */
|
|
3151
|
+
isTaxInclusive?: boolean | null;
|
|
2981
3152
|
/**
|
|
2982
|
-
*
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
3153
|
+
* Information about the invoice creation process.
|
|
3154
|
+
*
|
|
3155
|
+
* + `"UNKNOWN"`: There is no information about how BASS created the invoice.
|
|
3156
|
+
* + `"SYSTEM"`: BASS automatically created the invoice.
|
|
3157
|
+
* + `"MANUAL"`: A BASS system admin manually created the invoice.
|
|
3158
|
+
* @internal
|
|
2985
3159
|
*/
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
/**
|
|
2990
|
-
|
|
2991
|
-
|
|
3160
|
+
creationMode?: CreationModeWithLiterals;
|
|
3161
|
+
/** Details of the latest payment attempt. */
|
|
3162
|
+
latestPaymentAttempt?: LatestPaymentAttempt;
|
|
3163
|
+
/** List of charges and credits that adjust the invoice's `totals.totalPrice`. */
|
|
3164
|
+
adjustments?: PriceAdjustment[];
|
|
3165
|
+
/**
|
|
3166
|
+
* Invoice Number.
|
|
3167
|
+
* @maxLength 10
|
|
3168
|
+
* @readonly
|
|
3169
|
+
*/
|
|
3170
|
+
invoiceNumber?: string | null;
|
|
3171
|
+
/**
|
|
3172
|
+
* Shipping charges for the invoice.
|
|
3173
|
+
* Supports only one discount without cycles.
|
|
3174
|
+
* Discounts with cycles (repeated discounts across different billing cycles) are not supported for shipping
|
|
3175
|
+
*/
|
|
3176
|
+
shippingCharges?: InvoiceShippingCharges;
|
|
3177
|
+
/** Information about the invoice tax */
|
|
3178
|
+
taxData?: TaxData;
|
|
3179
|
+
/** Business address. */
|
|
3180
|
+
businessAddress?: Address;
|
|
3181
|
+
/**
|
|
3182
|
+
* ID of the billing order that created this invoice.
|
|
3183
|
+
* @format GUID
|
|
3184
|
+
*/
|
|
3185
|
+
orderId?: string | null;
|
|
3186
|
+
/**
|
|
3187
|
+
* Platform origin the invoice is originated from.
|
|
3188
|
+
* @format GUID
|
|
3189
|
+
*/
|
|
3190
|
+
platformOriginAppId?: string | null;
|
|
3191
|
+
/**
|
|
3192
|
+
* Refund information, provided that there are refunds for this invoice.
|
|
3193
|
+
* @readonly
|
|
3194
|
+
*/
|
|
3195
|
+
refundInfo?: RefundInfo;
|
|
2992
3196
|
}
|
|
2993
|
-
interface
|
|
3197
|
+
interface BusinessOriginData {
|
|
3198
|
+
/**
|
|
3199
|
+
* ID of the app for which BASS has created the invoice. For example,
|
|
3200
|
+
* `"1380b703-ce81-ff05-f115-39571d94dfcd"` for the Wix eCommerce app.
|
|
3201
|
+
* @format GUID
|
|
3202
|
+
*/
|
|
3203
|
+
appId?: string;
|
|
3204
|
+
/**
|
|
3205
|
+
* [Instance ID](https://dev.wix.com/api/rest/app-management/apps/app-instance/get-app-instance)
|
|
3206
|
+
* of the app for which BASS has created the invoice.
|
|
3207
|
+
* @format GUID
|
|
3208
|
+
*/
|
|
3209
|
+
instanceId?: string;
|
|
3210
|
+
/**
|
|
3211
|
+
* ID of the entity that triggered the invoice creation. For example, the ID of a
|
|
3212
|
+
* [pricing plan](https://dev.wix.com/docs/rest/payments/pricing-plans/pricing-plans/plan#plan-object).
|
|
3213
|
+
* @format GUID
|
|
3214
|
+
*/
|
|
3215
|
+
entityId?: string;
|
|
2994
3216
|
}
|
|
2995
|
-
|
|
2996
|
-
|
|
2997
|
-
|
|
2998
|
-
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
}
|
|
3005
|
-
interface CancelSubscriptionResponse {
|
|
3006
|
-
subscription?: Subscription;
|
|
3007
|
-
}
|
|
3008
|
-
interface PauseSubscriptionRequest {
|
|
3009
|
-
/** @format GUID */
|
|
3010
|
-
id: string;
|
|
3011
|
-
pausePolicy?: PausePolicyWithLiterals;
|
|
3012
|
-
pauseAt?: PauseAtWithLiterals;
|
|
3013
|
-
/** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
|
|
3014
|
-
pauseAtSchedule?: ScheduleAdditionalInfo;
|
|
3015
|
-
/** contains additional scheduling information for certain auto_resume_at either specific date */
|
|
3016
|
-
autoResumeAtSchedule?: ScheduleAdditionalInfo;
|
|
3017
|
-
actionContext: ActionContext;
|
|
3018
|
-
}
|
|
3019
|
-
interface PauseSubscriptionResponse {
|
|
3020
|
-
subscription?: Subscription;
|
|
3021
|
-
}
|
|
3022
|
-
interface SubscriptionPaused {
|
|
3023
|
-
subscription?: Subscription;
|
|
3024
|
-
pausePolicy?: PausePolicyWithLiterals;
|
|
3025
|
-
actionDetails?: ActionDetails;
|
|
3026
|
-
}
|
|
3027
|
-
interface PauseSubscriptionRequested {
|
|
3028
|
-
subscription?: Subscription;
|
|
3029
|
-
pauseAt?: PauseAtWithLiterals;
|
|
3030
|
-
pausePolicy?: PausePolicyWithLiterals;
|
|
3031
|
-
actionDetails?: ActionDetails;
|
|
3032
|
-
}
|
|
3033
|
-
interface ScheduledPauseCanceled {
|
|
3034
|
-
subscription?: Subscription;
|
|
3035
|
-
actionDetails?: ActionDetails;
|
|
3036
|
-
}
|
|
3037
|
-
interface ResumeSubscriptionRequest {
|
|
3038
|
-
/** @format GUID */
|
|
3039
|
-
id: string;
|
|
3040
|
-
resumeAt?: ResumeAtWithLiterals;
|
|
3041
|
-
/** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
|
|
3042
|
-
resumeAtSchedule?: ScheduleAdditionalInfo;
|
|
3043
|
-
actionContext: ActionContext;
|
|
3044
|
-
}
|
|
3045
|
-
interface ResumeSubscriptionResponse {
|
|
3046
|
-
subscription?: Subscription;
|
|
3047
|
-
}
|
|
3048
|
-
interface SubscriptionResumed {
|
|
3049
|
-
subscription?: Subscription;
|
|
3050
|
-
actionDetails?: ActionDetails;
|
|
3051
|
-
pauseInfo?: PauseInfo;
|
|
3052
|
-
}
|
|
3053
|
-
interface ResumeSubscriptionRequested {
|
|
3054
|
-
subscription?: Subscription;
|
|
3055
|
-
resumeAt?: ResumeAtWithLiterals;
|
|
3056
|
-
actionDetails?: ActionDetails;
|
|
3057
|
-
}
|
|
3058
|
-
interface ScheduledResumeCanceled {
|
|
3059
|
-
subscription?: Subscription;
|
|
3060
|
-
actionDetails?: ActionDetails;
|
|
3061
|
-
}
|
|
3062
|
-
interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
|
|
3063
|
-
/** Limit number of results and enable to skip rows. The default limit is 25. */
|
|
3064
|
-
paging?: Paging;
|
|
3065
|
-
/** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
|
|
3066
|
-
cursor?: CursorPaging;
|
|
3067
|
-
/** A filter object */
|
|
3068
|
-
filter?: any;
|
|
3069
|
-
/** A Sorting option by field name and order. */
|
|
3070
|
-
sorting?: SortingClauses;
|
|
3071
|
-
}
|
|
3072
|
-
/** @oneof */
|
|
3073
|
-
interface SearchSubscriptionsRequestPagingMethodOneOf {
|
|
3074
|
-
/** Limit number of results and enable to skip rows. The default limit is 25. */
|
|
3075
|
-
paging?: Paging;
|
|
3076
|
-
/** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
|
|
3077
|
-
cursor?: CursorPaging;
|
|
3078
|
-
}
|
|
3079
|
-
interface SortingClauses {
|
|
3080
|
-
sorting?: Sorting[];
|
|
3081
|
-
}
|
|
3082
|
-
interface SearchSubscriptionsResponse {
|
|
3083
|
-
subscriptions?: Subscription[];
|
|
3084
|
-
cursor?: CursorPaging;
|
|
3085
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
3086
|
-
}
|
|
3087
|
-
interface CursorPagingMetadata {
|
|
3088
|
-
/** Total number of items matching the filter. Available only on the first page of *Search* */
|
|
3089
|
-
total?: number | null;
|
|
3090
|
-
}
|
|
3091
|
-
interface TurnOnSubscriptionAutoRenewalRequest {
|
|
3092
|
-
/** @format GUID */
|
|
3093
|
-
id: string;
|
|
3094
|
-
actionContext: ActionContext;
|
|
3095
|
-
}
|
|
3096
|
-
interface TurnOnSubscriptionAutoRenewalResponse {
|
|
3097
|
-
subscription?: Subscription;
|
|
3098
|
-
}
|
|
3099
|
-
interface SubscriptionAutoRenewalTurnedOn {
|
|
3100
|
-
subscription?: Subscription;
|
|
3101
|
-
actionDetails?: ActionDetails;
|
|
3102
|
-
}
|
|
3103
|
-
interface TurnOffSubscriptionAutoRenewalRequest {
|
|
3104
|
-
/** @format GUID */
|
|
3105
|
-
id: string;
|
|
3106
|
-
actionContext: ActionContext;
|
|
3217
|
+
declare enum InvoiceStatus {
|
|
3218
|
+
UNKNOWN = "UNKNOWN",
|
|
3219
|
+
OPEN = "OPEN",
|
|
3220
|
+
PAID = "PAID",
|
|
3221
|
+
FAILED = "FAILED",
|
|
3222
|
+
ATTEMPT_FAILED = "ATTEMPT_FAILED",
|
|
3223
|
+
CANCELED = "CANCELED",
|
|
3224
|
+
REFUNDED = "REFUNDED",
|
|
3225
|
+
CHARGEBACKED = "CHARGEBACKED"
|
|
3107
3226
|
}
|
|
3108
|
-
|
|
3109
|
-
|
|
3227
|
+
/** @enumType */
|
|
3228
|
+
type InvoiceStatusWithLiterals = InvoiceStatus | 'UNKNOWN' | 'OPEN' | 'PAID' | 'FAILED' | 'ATTEMPT_FAILED' | 'CANCELED' | 'REFUNDED' | 'CHARGEBACKED';
|
|
3229
|
+
declare enum CollectionMethod {
|
|
3230
|
+
UNKNOWN = "UNKNOWN",
|
|
3231
|
+
AUTO_CHARGE = "AUTO_CHARGE",
|
|
3232
|
+
OFFLINE = "OFFLINE",
|
|
3233
|
+
SEND_INVOICE = "SEND_INVOICE"
|
|
3110
3234
|
}
|
|
3111
|
-
|
|
3112
|
-
|
|
3113
|
-
|
|
3235
|
+
/** @enumType */
|
|
3236
|
+
type CollectionMethodWithLiterals = CollectionMethod | 'UNKNOWN' | 'AUTO_CHARGE' | 'OFFLINE' | 'SEND_INVOICE';
|
|
3237
|
+
declare enum CreationMode {
|
|
3238
|
+
UNKNOWN = "UNKNOWN",
|
|
3239
|
+
SYSTEM = "SYSTEM",
|
|
3240
|
+
MANUAL = "MANUAL"
|
|
3114
3241
|
}
|
|
3115
|
-
|
|
3242
|
+
/** @enumType */
|
|
3243
|
+
type CreationModeWithLiterals = CreationMode | 'UNKNOWN' | 'SYSTEM' | 'MANUAL';
|
|
3244
|
+
interface LatestPaymentAttempt {
|
|
3116
3245
|
/**
|
|
3117
|
-
*
|
|
3246
|
+
* ID of the latest payment attempt.
|
|
3118
3247
|
* @format GUID
|
|
3248
|
+
* @readonly
|
|
3119
3249
|
*/
|
|
3120
|
-
|
|
3121
|
-
}
|
|
3122
|
-
interface MarkLatestInvoiceAsPaidResponse {
|
|
3123
|
-
subscription?: Subscription;
|
|
3124
|
-
}
|
|
3125
|
-
interface LatestInvoiceMarkedAsPaid {
|
|
3126
|
-
subscription?: Subscription;
|
|
3127
|
-
}
|
|
3128
|
-
interface MultipleSubscriptionsOnOrdersInvoice {
|
|
3250
|
+
paymentAttemptId?: string;
|
|
3129
3251
|
/**
|
|
3130
|
-
*
|
|
3131
|
-
* @
|
|
3252
|
+
* Date and time of the latest payment attempt in `YYYY-MM-DDThh:mm.sssZ` format.
|
|
3253
|
+
* @readonly
|
|
3132
3254
|
*/
|
|
3133
|
-
|
|
3255
|
+
dateAttempt?: Date | null;
|
|
3256
|
+
/** Number of the latest payment attempt. */
|
|
3257
|
+
attemptNumber?: number;
|
|
3134
3258
|
/**
|
|
3135
|
-
*
|
|
3136
|
-
*
|
|
3259
|
+
* Status of the latest payment attempt.
|
|
3260
|
+
*
|
|
3261
|
+
* + `"UNKNOWN"`: There is no information about the status of the latest payment attempt.
|
|
3262
|
+
* + `"SCHEDULED"`: The latest payment attempt is scheduled but hasn't started yet.
|
|
3263
|
+
* + `"IN_PROGRESS"`: The latest payment attempt is in progress.
|
|
3264
|
+
* + `"PAID"`: The latest payment attempt resulted in a successful payment.
|
|
3265
|
+
* + `"DECLINED"`: The latest payment attempt has been declined.
|
|
3266
|
+
* + `"TECHNICAL_FAILURE"`: The latest payment attempt couldn't be process due to a technical failure.
|
|
3267
|
+
* + `"CANCELED"`: The latest payment attempt has been canceled by BASS.
|
|
3268
|
+
* @readonly
|
|
3137
3269
|
*/
|
|
3138
|
-
|
|
3139
|
-
}
|
|
3140
|
-
interface MarkBillingCycleAsPaidRequest {
|
|
3270
|
+
status?: PaymentAttemptStatusWithLiterals;
|
|
3141
3271
|
/**
|
|
3142
|
-
*
|
|
3143
|
-
*
|
|
3272
|
+
* Whether BASS tries to collect the payment another time. Available only when
|
|
3273
|
+
* `latestPaymentAttempt.status` is set to `"DECLINED"`.
|
|
3144
3274
|
*/
|
|
3145
|
-
|
|
3275
|
+
retryable?: boolean;
|
|
3146
3276
|
/**
|
|
3147
|
-
*
|
|
3148
|
-
*
|
|
3149
|
-
* @
|
|
3277
|
+
* Platform fee that was collected on this transaction.
|
|
3278
|
+
* @format DECIMAL_VALUE
|
|
3279
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3280
|
+
* @readonly
|
|
3150
3281
|
*/
|
|
3151
|
-
|
|
3152
|
-
}
|
|
3153
|
-
interface MarkBillingCycleAsPaidResponse {
|
|
3154
|
-
subscription?: Subscription;
|
|
3282
|
+
appliedPlatformFee?: string | null;
|
|
3155
3283
|
}
|
|
3156
|
-
|
|
3284
|
+
declare enum PaymentAttemptStatus {
|
|
3285
|
+
UNKNOWN = "UNKNOWN",
|
|
3286
|
+
SCHEDULED = "SCHEDULED",
|
|
3287
|
+
IN_PROGRESS = "IN_PROGRESS",
|
|
3288
|
+
PAID = "PAID",
|
|
3289
|
+
DECLINED = "DECLINED",
|
|
3290
|
+
TECHNICAL_FAILURE = "TECHNICAL_FAILURE",
|
|
3291
|
+
CANCELED = "CANCELED",
|
|
3292
|
+
PENDING = "PENDING",
|
|
3293
|
+
REFUNDED = "REFUNDED",
|
|
3294
|
+
CHARGEBACKED = "CHARGEBACKED"
|
|
3157
3295
|
}
|
|
3158
|
-
|
|
3159
|
-
|
|
3160
|
-
|
|
3296
|
+
/** @enumType */
|
|
3297
|
+
type PaymentAttemptStatusWithLiterals = PaymentAttemptStatus | 'UNKNOWN' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAID' | 'DECLINED' | 'TECHNICAL_FAILURE' | 'CANCELED' | 'PENDING' | 'REFUNDED' | 'CHARGEBACKED';
|
|
3298
|
+
interface PriceAdjustment extends PriceAdjustmentAdjustmentTypeOneOf {
|
|
3299
|
+
/** Adjustment that increases the price. */
|
|
3300
|
+
charge?: PriceAdjustmentValue;
|
|
3301
|
+
/** Adjustment that lowers the price. */
|
|
3302
|
+
credit?: PriceAdjustmentValue;
|
|
3303
|
+
/** Reason for this price adjustment. Used to categorize proration adjustments. */
|
|
3304
|
+
reason?: PriceAdjustmentReasonWithLiterals;
|
|
3161
3305
|
}
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3306
|
+
/** @oneof */
|
|
3307
|
+
interface PriceAdjustmentAdjustmentTypeOneOf {
|
|
3308
|
+
/** Adjustment that increases the price. */
|
|
3309
|
+
charge?: PriceAdjustmentValue;
|
|
3310
|
+
/** Adjustment that lowers the price. */
|
|
3311
|
+
credit?: PriceAdjustmentValue;
|
|
3165
3312
|
}
|
|
3166
|
-
interface
|
|
3167
|
-
/** User won't be charged for additional period added on top of subscription end date. */
|
|
3168
|
-
extensionPeriod?: Duration;
|
|
3313
|
+
interface PriceAdjustmentValue extends PriceAdjustmentValueAdjustmentValueTypeOneOf {
|
|
3169
3314
|
/**
|
|
3170
|
-
*
|
|
3171
|
-
*
|
|
3315
|
+
* Absolute amount that adjusts the price.
|
|
3316
|
+
*
|
|
3317
|
+
* Min: `0.01`
|
|
3318
|
+
* @decimalValue options { gt:0.00 }
|
|
3172
3319
|
*/
|
|
3173
|
-
|
|
3320
|
+
amount?: string;
|
|
3174
3321
|
/**
|
|
3175
|
-
*
|
|
3176
|
-
*
|
|
3322
|
+
* Relative factor that adjusts the price. For example, setting
|
|
3323
|
+
* `multiplier` to:
|
|
3324
|
+
* - `0.50` results in a price adjustment of 50% of the original value.
|
|
3325
|
+
* - `0.75` results in a price adjustment of 75% of the original value.
|
|
3326
|
+
* - `1.00` results in a price adjustment of 100% of the original value.
|
|
3327
|
+
*
|
|
3328
|
+
* Min: `0.01`
|
|
3329
|
+
* Max: `1.00`
|
|
3330
|
+
* @decimalValue options { gt:0.00, lte:1 }
|
|
3177
3331
|
*/
|
|
3178
|
-
|
|
3179
|
-
actionContext: ActionContext;
|
|
3332
|
+
multiplier?: string;
|
|
3180
3333
|
}
|
|
3181
3334
|
/** @oneof */
|
|
3182
|
-
interface
|
|
3183
|
-
/** User won't be charged for additional period added on top of subscription end date. */
|
|
3184
|
-
extensionPeriod?: Duration;
|
|
3335
|
+
interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
|
|
3185
3336
|
/**
|
|
3186
|
-
*
|
|
3187
|
-
*
|
|
3337
|
+
* Absolute amount that adjusts the price.
|
|
3338
|
+
*
|
|
3339
|
+
* Min: `0.01`
|
|
3340
|
+
* @decimalValue options { gt:0.00 }
|
|
3188
3341
|
*/
|
|
3189
|
-
|
|
3190
|
-
}
|
|
3191
|
-
interface ExtendSubscriptionResponse {
|
|
3192
|
-
/** The now extended subscription */
|
|
3193
|
-
subscription?: Subscription;
|
|
3194
|
-
}
|
|
3195
|
-
interface AllowedActionsRequest {
|
|
3196
|
-
/** @format GUID */
|
|
3197
|
-
id: string;
|
|
3342
|
+
amount?: string;
|
|
3198
3343
|
/**
|
|
3199
|
-
*
|
|
3200
|
-
*
|
|
3344
|
+
* Relative factor that adjusts the price. For example, setting
|
|
3345
|
+
* `multiplier` to:
|
|
3346
|
+
* - `0.50` results in a price adjustment of 50% of the original value.
|
|
3347
|
+
* - `0.75` results in a price adjustment of 75% of the original value.
|
|
3348
|
+
* - `1.00` results in a price adjustment of 100% of the original value.
|
|
3349
|
+
*
|
|
3350
|
+
* Min: `0.01`
|
|
3351
|
+
* Max: `1.00`
|
|
3352
|
+
* @decimalValue options { gt:0.00, lte:1 }
|
|
3201
3353
|
*/
|
|
3202
|
-
|
|
3354
|
+
multiplier?: string;
|
|
3203
3355
|
}
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3356
|
+
/** Reason for a price adjustment. Categorizes different types of proration adjustments. */
|
|
3357
|
+
declare enum PriceAdjustmentReason {
|
|
3358
|
+
/** Default value. Used for adjustments without a specific categorization. */
|
|
3359
|
+
PRICE_ADJUSTMENT_REASON_UNSPECIFIED = "PRICE_ADJUSTMENT_REASON_UNSPECIFIED",
|
|
3360
|
+
/** Adjustment due to a billing date change. */
|
|
3361
|
+
BILLING_DATE_CHANGE = "BILLING_DATE_CHANGE",
|
|
3362
|
+
/** Proration adjustment from changing the subscription plan. */
|
|
3363
|
+
PLAN_CHANGE_PRORATION = "PLAN_CHANGE_PRORATION",
|
|
3364
|
+
/** Proration adjustment from changing the billing cycle (e.g., monthly to yearly). */
|
|
3365
|
+
CYCLE_CHANGE_PRORATION = "CYCLE_CHANGE_PRORATION",
|
|
3366
|
+
/** Proration adjustment from changing the subscription quantity. */
|
|
3367
|
+
QUANTITY_CHANGE_PRORATION = "QUANTITY_CHANGE_PRORATION",
|
|
3368
|
+
/** Custom adjustment provided by the caller. */
|
|
3369
|
+
CUSTOM_PRICE_ADJUSTMENT = "CUSTOM_PRICE_ADJUSTMENT"
|
|
3207
3370
|
}
|
|
3208
3371
|
/** @enumType */
|
|
3209
|
-
type
|
|
3210
|
-
interface
|
|
3211
|
-
/** List of actions that are allowed. */
|
|
3212
|
-
actions?: Action[];
|
|
3372
|
+
type PriceAdjustmentReasonWithLiterals = PriceAdjustmentReason | 'PRICE_ADJUSTMENT_REASON_UNSPECIFIED' | 'BILLING_DATE_CHANGE' | 'PLAN_CHANGE_PRORATION' | 'CYCLE_CHANGE_PRORATION' | 'QUANTITY_CHANGE_PRORATION' | 'CUSTOM_PRICE_ADJUSTMENT';
|
|
3373
|
+
interface InvoiceShippingCharges {
|
|
3213
3374
|
/**
|
|
3214
|
-
*
|
|
3215
|
-
*
|
|
3375
|
+
* Amount of the shipping fee in `0.00` format.
|
|
3376
|
+
*
|
|
3377
|
+
* Min: `0.01`
|
|
3378
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3216
3379
|
*/
|
|
3217
|
-
|
|
3380
|
+
amount?: string;
|
|
3381
|
+
/** Tax of the shipping fee */
|
|
3382
|
+
tax?: Tax;
|
|
3383
|
+
/** Information about the shipping charges tax data */
|
|
3384
|
+
taxData?: ItemTaxData;
|
|
3385
|
+
discount?: Discount;
|
|
3218
3386
|
}
|
|
3219
|
-
|
|
3220
|
-
|
|
3387
|
+
/** Tax data from all items */
|
|
3388
|
+
interface TaxData {
|
|
3389
|
+
/** Aggregated tax data from all items */
|
|
3390
|
+
taxSummary?: TaxSummary;
|
|
3391
|
+
}
|
|
3392
|
+
interface TaxSummary {
|
|
3221
3393
|
/**
|
|
3222
|
-
*
|
|
3223
|
-
* @
|
|
3394
|
+
* Aggregated from tax_breakdowns with exemptions excluded from amount
|
|
3395
|
+
* @format DECIMAL_VALUE
|
|
3224
3396
|
*/
|
|
3225
|
-
|
|
3226
|
-
}
|
|
3227
|
-
interface UnsupportedReason {
|
|
3228
|
-
code?: string;
|
|
3229
|
-
description?: string | null;
|
|
3230
|
-
}
|
|
3231
|
-
interface ListUpcomingChargesRequest {
|
|
3397
|
+
aggregatedTaxAmount?: string;
|
|
3232
3398
|
/**
|
|
3233
|
-
*
|
|
3234
|
-
* @
|
|
3399
|
+
* Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`.
|
|
3400
|
+
* @maxSize 50
|
|
3235
3401
|
*/
|
|
3236
|
-
|
|
3237
|
-
/** Period of time to provide charged for. If not provided,then only next charge will be returned. */
|
|
3238
|
-
customDuration?: Duration;
|
|
3402
|
+
aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
|
|
3239
3403
|
/**
|
|
3240
|
-
*
|
|
3241
|
-
*
|
|
3404
|
+
* Tax amount the merchant is NOT collecting because the customer is responsible for paying the authority directly (reverse charge / exempt). Optional; absence is treated as zero.
|
|
3405
|
+
* @format DECIMAL_VALUE
|
|
3406
|
+
* @decimalValue options { maxScale:4 }
|
|
3242
3407
|
*/
|
|
3243
|
-
|
|
3244
|
-
}
|
|
3245
|
-
interface ListUpcomingChargesResponse {
|
|
3246
|
-
upcomingCharges?: SubscriptionCharge[];
|
|
3247
|
-
}
|
|
3248
|
-
interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
|
|
3249
|
-
/** Information about a non-existing subscription. */
|
|
3250
|
-
subscriptionInfo?: SubscriptionInfo;
|
|
3251
|
-
}
|
|
3252
|
-
/** @oneof */
|
|
3253
|
-
interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
|
|
3254
|
-
/** Information about a non-existing subscription. */
|
|
3255
|
-
subscriptionInfo?: SubscriptionInfo;
|
|
3256
|
-
}
|
|
3257
|
-
/** Subscription information to use for calculating the preview of charges for a subscription. */
|
|
3258
|
-
interface SubscriptionInfo {
|
|
3259
|
-
billingSettings?: BillingSettings;
|
|
3260
|
-
items?: Item[];
|
|
3261
|
-
startDate?: Date | null;
|
|
3262
|
-
}
|
|
3263
|
-
interface PreviewSubscriptionChargesResponse {
|
|
3264
|
-
/** Charges for subscription. */
|
|
3265
|
-
charges?: Charge[];
|
|
3266
|
-
}
|
|
3267
|
-
/** Represents a charge applicable to a subscription. */
|
|
3268
|
-
interface Charge {
|
|
3269
|
-
/** The cycle number from which the charge starts. */
|
|
3270
|
-
cycleFrom?: number;
|
|
3271
|
-
/** The number of cycles for which the charge is applicable. */
|
|
3272
|
-
cycleCount?: number | null;
|
|
3273
|
-
/** The breakdown of the charge */
|
|
3274
|
-
totals?: Totals;
|
|
3275
|
-
/** The billing date from which the charge starts */
|
|
3276
|
-
cycleBillingDate?: Date | null;
|
|
3408
|
+
exemptAmount?: string | null;
|
|
3277
3409
|
}
|
|
3278
|
-
interface
|
|
3410
|
+
interface AggregatedTaxBreakdown {
|
|
3279
3411
|
/**
|
|
3280
|
-
*
|
|
3281
|
-
* @
|
|
3282
|
-
* @maxSize 10
|
|
3412
|
+
* Name of the tax that was calculated.
|
|
3413
|
+
* @maxLength 200
|
|
3283
3414
|
*/
|
|
3284
|
-
|
|
3415
|
+
taxName?: string;
|
|
3285
3416
|
/**
|
|
3286
|
-
*
|
|
3287
|
-
*
|
|
3288
|
-
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
3289
|
-
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
3290
|
-
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
3291
|
-
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
3292
|
-
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
3293
|
-
* in this case, charges for cycle 1 through 3.
|
|
3294
|
-
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
3295
|
-
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
3296
|
-
* @min 1
|
|
3297
|
-
* @max 10
|
|
3417
|
+
* Type of tax that was calculated.
|
|
3418
|
+
* @maxLength 200
|
|
3298
3419
|
*/
|
|
3299
|
-
|
|
3300
|
-
}
|
|
3301
|
-
interface SubscriptionBillingDetails {
|
|
3420
|
+
taxType?: string;
|
|
3302
3421
|
/**
|
|
3303
|
-
*
|
|
3304
|
-
* @
|
|
3422
|
+
* Jurisdiction that taxes were calculated for.
|
|
3423
|
+
* @maxLength 200
|
|
3305
3424
|
*/
|
|
3306
|
-
|
|
3307
|
-
/**
|
|
3308
|
-
|
|
3425
|
+
jurisdiction?: string;
|
|
3426
|
+
/** Type of jurisdiction that taxes were calculated for. */
|
|
3427
|
+
jurisdictionType?: string;
|
|
3309
3428
|
/**
|
|
3310
|
-
*
|
|
3311
|
-
* @
|
|
3312
|
-
* @maxSize 100
|
|
3429
|
+
* Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`.
|
|
3430
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
3313
3431
|
*/
|
|
3314
|
-
|
|
3315
|
-
/** Subscription start date, now if not set */
|
|
3316
|
-
startDate?: Date | null;
|
|
3317
|
-
/** Shipping address associated with subscription. At the moment used only for payments. Optional. */
|
|
3318
|
-
shippingAddress?: FullAddressDetails;
|
|
3319
|
-
}
|
|
3320
|
-
interface PreviewSubscriptionsChargesResponse {
|
|
3321
|
-
/** Charges for the subscriptions, including an identifier. */
|
|
3322
|
-
subscriptionsCharges?: SubscriptionCharges[];
|
|
3323
|
-
}
|
|
3324
|
-
interface SubscriptionCharges {
|
|
3432
|
+
rate?: string;
|
|
3325
3433
|
/**
|
|
3326
|
-
*
|
|
3327
|
-
* @format
|
|
3434
|
+
* Total amount of this tax for this jurisdiction.
|
|
3435
|
+
* @format DECIMAL_VALUE
|
|
3436
|
+
* @decimalValue options { maxScale:4 }
|
|
3328
3437
|
*/
|
|
3329
|
-
|
|
3330
|
-
/** Charges for subscription. */
|
|
3331
|
-
charges?: Charge[];
|
|
3332
|
-
}
|
|
3333
|
-
interface CreateSubscriptionForOrderRequest {
|
|
3334
|
-
/** Subscription needs to be created */
|
|
3335
|
-
subscription?: Subscription;
|
|
3438
|
+
aggregatedTaxAmount?: string;
|
|
3336
3439
|
/**
|
|
3337
|
-
*
|
|
3338
|
-
* @
|
|
3440
|
+
* Total taxable amount of this tax
|
|
3441
|
+
* @internal
|
|
3442
|
+
* @format DECIMAL_VALUE
|
|
3443
|
+
* @decimalValue options { maxScale:4 }
|
|
3339
3444
|
*/
|
|
3340
|
-
|
|
3341
|
-
}
|
|
3342
|
-
interface CreateSubscriptionForOrderResponse {
|
|
3343
|
-
/** Created subscription */
|
|
3344
|
-
subscription?: Subscription;
|
|
3345
|
-
/** Non-persistent invoice */
|
|
3346
|
-
invoice?: Invoice;
|
|
3445
|
+
aggregatedTaxableAmount?: string;
|
|
3347
3446
|
}
|
|
3348
|
-
|
|
3349
|
-
interface Invoice {
|
|
3447
|
+
interface RefundInfo {
|
|
3350
3448
|
/**
|
|
3351
|
-
*
|
|
3352
|
-
* @format
|
|
3353
|
-
* @
|
|
3449
|
+
* If refunds are present, this will include the total amount refunded.
|
|
3450
|
+
* @format DECIMAL_VALUE
|
|
3451
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3354
3452
|
*/
|
|
3355
|
-
|
|
3453
|
+
totalRefundAmount?: string | null;
|
|
3356
3454
|
/**
|
|
3357
|
-
*
|
|
3358
|
-
* @
|
|
3455
|
+
* The refunds that have been applied to this invoice
|
|
3456
|
+
* @maxSize 20
|
|
3359
3457
|
*/
|
|
3360
|
-
|
|
3458
|
+
refunds?: Refund[];
|
|
3459
|
+
}
|
|
3460
|
+
interface Refund {
|
|
3361
3461
|
/**
|
|
3362
|
-
*
|
|
3363
|
-
* @
|
|
3462
|
+
* refund amount
|
|
3463
|
+
* @format DECIMAL_VALUE
|
|
3464
|
+
* @decimalValue options { gt:0.00, maxScale:2 }
|
|
3364
3465
|
*/
|
|
3365
|
-
|
|
3466
|
+
amount?: string;
|
|
3467
|
+
/** the date of the refund transaction */
|
|
3468
|
+
transactionDate?: Date | null;
|
|
3366
3469
|
/**
|
|
3367
|
-
*
|
|
3368
|
-
*
|
|
3369
|
-
* the current revision must be passed when updating the invoice.
|
|
3370
|
-
*
|
|
3371
|
-
* Ignored when creating a invoice.
|
|
3372
|
-
* @readonly
|
|
3470
|
+
* the transaction id associated with this refund
|
|
3471
|
+
* @format GUID
|
|
3373
3472
|
*/
|
|
3374
|
-
|
|
3375
|
-
/**
|
|
3376
|
-
|
|
3473
|
+
transactionId?: string;
|
|
3474
|
+
/** a reason for the refund */
|
|
3475
|
+
reason?: RefundReasonWithLiterals;
|
|
3377
3476
|
/**
|
|
3378
|
-
*
|
|
3379
|
-
*
|
|
3380
|
-
* + `"UNKNOWN"`: There is no information about the invoice status.
|
|
3381
|
-
* + `"OPEN"`: BASS has created the invoice but hasn't initiated the payment process.
|
|
3382
|
-
* + `"PAID"`: The customer has successfully paid for the invoice.
|
|
3383
|
-
* + `"ATTEMPT_FAILED"`: The payment process has started and there has been at least one unsuccessful payment attempt.
|
|
3384
|
-
* + `"FAILED"`: The payment process has failed and there are no more retries.
|
|
3385
|
-
* + `"CANCELED"`: The payment process has been stopped because the related subscription has been canceled.
|
|
3386
|
-
* @readonly
|
|
3387
|
-
*/
|
|
3388
|
-
status?: InvoiceStatusWithLiterals;
|
|
3389
|
-
/**
|
|
3390
|
-
* 3-letter currency code of the invoice in
|
|
3391
|
-
* [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3392
|
-
* @format CURRENCY
|
|
3393
|
-
*/
|
|
3394
|
-
currency?: string;
|
|
3395
|
-
/** Information about the customer. */
|
|
3396
|
-
customer?: Customer;
|
|
3397
|
-
/**
|
|
3398
|
-
* Whether the payment is processed through Wix and whether the customer must provide some input.
|
|
3399
|
-
*
|
|
3400
|
-
* + `"UNKNOWN"`: There is no information about the collection method.
|
|
3401
|
-
* + `"AUTO_CHARGE"`: The customer pays automatically through Wix.
|
|
3402
|
-
* + `"SEND_INVOICE"`: The customer pays through Wix, but some manual input is required.
|
|
3403
|
-
* + `"OFFLINE"`: The customer pays outside of Wix.
|
|
3404
|
-
*/
|
|
3405
|
-
collectionMethod?: CollectionMethodWithLiterals;
|
|
3406
|
-
/**
|
|
3407
|
-
* ID of the
|
|
3408
|
-
* [payment method](https://bo.wix.com/wix-docs/rest/wix-cashier/settings/payment-method-type/payment-method-type-object).
|
|
3409
|
-
* Not available for the first payment of a subscription and all offline
|
|
3410
|
-
* payments.
|
|
3411
|
-
* @format GUID
|
|
3477
|
+
* a description of the refund - this is a free text field for the initiator
|
|
3478
|
+
* @maxLength 255
|
|
3412
3479
|
*/
|
|
3413
|
-
|
|
3480
|
+
description?: string | null;
|
|
3481
|
+
}
|
|
3482
|
+
declare enum RefundReason {
|
|
3483
|
+
DUPLICATE_CHARGE = "DUPLICATE_CHARGE",
|
|
3484
|
+
FRAUDULENT = "FRAUDULENT",
|
|
3485
|
+
CUSTOMER_REQUEST = "CUSTOMER_REQUEST",
|
|
3486
|
+
PROVISION_FAILED = "PROVISION_FAILED",
|
|
3487
|
+
OTHER = "OTHER"
|
|
3488
|
+
}
|
|
3489
|
+
/** @enumType */
|
|
3490
|
+
type RefundReasonWithLiterals = RefundReason | 'DUPLICATE_CHARGE' | 'FRAUDULENT' | 'CUSTOMER_REQUEST' | 'PROVISION_FAILED' | 'OTHER';
|
|
3491
|
+
interface ChangeSubscriptionRequest {
|
|
3414
3492
|
/**
|
|
3415
|
-
*
|
|
3416
|
-
* for the corresponding payment.
|
|
3493
|
+
* ID of the subscription to change
|
|
3417
3494
|
* @format GUID
|
|
3418
|
-
* @readonly
|
|
3419
|
-
*/
|
|
3420
|
-
paymentOrderId?: string | null;
|
|
3421
|
-
/** Information about a discount. Available only for invoices that include a discount. */
|
|
3422
|
-
discount?: InvoiceDiscount;
|
|
3423
|
-
/** Billing address. */
|
|
3424
|
-
billingAddress?: FullAddressDetails;
|
|
3425
|
-
/** Shipping address. Available only for `"PHYSICAL"` line items. */
|
|
3426
|
-
shippingAddress?: FullAddressDetails;
|
|
3427
|
-
/**
|
|
3428
|
-
* Shipping fee in `0.00` format.
|
|
3429
|
-
* @format DECIMAL_VALUE
|
|
3430
|
-
*/
|
|
3431
|
-
shippingFee?: string | null;
|
|
3432
|
-
/**
|
|
3433
|
-
* Information about the invoice's totals.
|
|
3434
|
-
* @readonly
|
|
3435
|
-
*/
|
|
3436
|
-
totals?: Totals;
|
|
3437
|
-
/** Line items belonging to the invoice. */
|
|
3438
|
-
invoiceItems?: InvoiceItem[];
|
|
3439
|
-
/**
|
|
3440
|
-
* Whether the invoice is used to validate payment details.
|
|
3441
|
-
*
|
|
3442
|
-
* + `true`: BASS uses the invoice to test payment details. Relevant for free trials. Ensures that Wix can collect the payment of the first billing cycle.
|
|
3443
|
-
* + `false`: Standard invoice.
|
|
3444
|
-
*/
|
|
3445
|
-
isAuthorization?: boolean | null;
|
|
3446
|
-
/** Whether the invoice's `totals.totalPrice` includes tax. */
|
|
3447
|
-
isTaxInclusive?: boolean | null;
|
|
3448
|
-
/** Details of the latest payment attempt. */
|
|
3449
|
-
latestPaymentAttempt?: LatestPaymentAttempt;
|
|
3450
|
-
/** List of charges and credits that adjust the invoice's `totals.totalPrice`. */
|
|
3451
|
-
adjustments?: PriceAdjustment[];
|
|
3452
|
-
/**
|
|
3453
|
-
* Invoice Number.
|
|
3454
|
-
* @maxLength 10
|
|
3455
|
-
* @readonly
|
|
3456
3495
|
*/
|
|
3457
|
-
|
|
3496
|
+
subscriptionId?: string;
|
|
3458
3497
|
/**
|
|
3459
|
-
*
|
|
3460
|
-
*
|
|
3461
|
-
*
|
|
3498
|
+
* Item-level changes. Each entry targets one existing item by ID.
|
|
3499
|
+
* Caller passes CONCRETE new values (price, quantity, name) — BASS does not resolve pricing.
|
|
3500
|
+
* BASS uses these for proration: old values (from subscription) vs new values (from here).
|
|
3462
3501
|
*/
|
|
3463
|
-
|
|
3464
|
-
/** Information about the invoice tax */
|
|
3465
|
-
taxData?: TaxData;
|
|
3466
|
-
/** Business address. */
|
|
3467
|
-
businessAddress?: Address;
|
|
3502
|
+
itemChanges?: SubscriptionItemChange[];
|
|
3468
3503
|
/**
|
|
3469
|
-
*
|
|
3470
|
-
*
|
|
3504
|
+
* Subscription-level: new billing cycle (e.g., monthly to yearly).
|
|
3505
|
+
* Affects the billing period for ALL items.
|
|
3506
|
+
* When changing cycle, caller MUST also pass new prices in item_changes.
|
|
3471
3507
|
*/
|
|
3472
|
-
|
|
3508
|
+
newCycle?: Duration;
|
|
3509
|
+
/** When the change takes effect. */
|
|
3510
|
+
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
3511
|
+
/** How to handle proration for immediate changes. Ignored for AT_NEXT_RENEWAL. */
|
|
3512
|
+
prorationBehavior?: ProrationBehaviorEnumProrationBehaviorWithLiterals;
|
|
3513
|
+
/** Payment context for immediate changes without checkout flow. */
|
|
3514
|
+
paymentContext?: ChangePaymentContext;
|
|
3515
|
+
}
|
|
3516
|
+
/**
|
|
3517
|
+
* Describes a change to a single subscription item.
|
|
3518
|
+
* The caller (BG/CVS) resolves pricing from their catalog and passes concrete values.
|
|
3519
|
+
*/
|
|
3520
|
+
interface SubscriptionItemChange {
|
|
3473
3521
|
/**
|
|
3474
|
-
*
|
|
3522
|
+
* Which item to change. Must match an existing item ID in the subscription.
|
|
3475
3523
|
* @format GUID
|
|
3476
3524
|
*/
|
|
3477
|
-
|
|
3525
|
+
itemId?: string;
|
|
3478
3526
|
/**
|
|
3479
|
-
*
|
|
3480
|
-
*
|
|
3527
|
+
* New price per unit. Caller resolves this from their product catalog.
|
|
3528
|
+
* Required when changing product/plan. Optional for quantity-only changes (uses current price).
|
|
3529
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3481
3530
|
*/
|
|
3482
|
-
|
|
3483
|
-
}
|
|
3484
|
-
interface BusinessOriginData {
|
|
3531
|
+
newPrice?: string | null;
|
|
3485
3532
|
/**
|
|
3486
|
-
*
|
|
3487
|
-
*
|
|
3488
|
-
* @format GUID
|
|
3533
|
+
* New quantity (seats/licenses). Optional — unchanged if not set.
|
|
3534
|
+
* @min 1
|
|
3489
3535
|
*/
|
|
3490
|
-
|
|
3536
|
+
newQuantity?: number | null;
|
|
3491
3537
|
/**
|
|
3492
|
-
*
|
|
3493
|
-
*
|
|
3494
|
-
* @format GUID
|
|
3538
|
+
* New catalog reference. Optional — set when changing to a different product.
|
|
3539
|
+
* This is metadata for the caller's tracking; BASS does not use it for pricing.
|
|
3495
3540
|
*/
|
|
3496
|
-
|
|
3541
|
+
newCatalogReference?: CatalogReference;
|
|
3497
3542
|
/**
|
|
3498
|
-
*
|
|
3499
|
-
*
|
|
3500
|
-
* @format GUID
|
|
3543
|
+
* New item name. Optional — set when changing to a different product.
|
|
3544
|
+
* @maxLength 200
|
|
3501
3545
|
*/
|
|
3502
|
-
|
|
3546
|
+
newName?: string | null;
|
|
3503
3547
|
}
|
|
3504
|
-
declare enum
|
|
3548
|
+
declare enum ChangeEffectiveTime {
|
|
3505
3549
|
UNKNOWN = "UNKNOWN",
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
CANCELED = "CANCELED",
|
|
3511
|
-
REFUNDED = "REFUNDED",
|
|
3512
|
-
CHARGEBACKED = "CHARGEBACKED"
|
|
3550
|
+
/** Apply change immediately with proration */
|
|
3551
|
+
IMMEDIATELY = "IMMEDIATELY",
|
|
3552
|
+
/** Schedule change for the next billing cycle */
|
|
3553
|
+
AT_NEXT_RENEWAL = "AT_NEXT_RENEWAL"
|
|
3513
3554
|
}
|
|
3514
3555
|
/** @enumType */
|
|
3515
|
-
type
|
|
3516
|
-
declare enum
|
|
3556
|
+
type ChangeEffectiveTimeWithLiterals = ChangeEffectiveTime | 'UNKNOWN' | 'IMMEDIATELY' | 'AT_NEXT_RENEWAL';
|
|
3557
|
+
declare enum ProrationBehaviorEnumProrationBehavior {
|
|
3517
3558
|
UNKNOWN = "UNKNOWN",
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
|
|
3559
|
+
/** Credit unused time + charge new prorated price (default for upgrades) */
|
|
3560
|
+
PRORATE_AND_CHARGE = "PRORATE_AND_CHARGE",
|
|
3561
|
+
/** Credit unused time + refund to payment method (downgrades) */
|
|
3562
|
+
PRORATE_AND_REFUND = "PRORATE_AND_REFUND",
|
|
3563
|
+
/** Convert unused value to extra days, no financial transaction */
|
|
3564
|
+
PRORATE_AND_EXTEND = "PRORATE_AND_EXTEND",
|
|
3565
|
+
/** Immediate switch with no financial adjustment */
|
|
3566
|
+
NO_PRORATION = "NO_PRORATION"
|
|
3521
3567
|
}
|
|
3522
3568
|
/** @enumType */
|
|
3523
|
-
type
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3569
|
+
type ProrationBehaviorEnumProrationBehaviorWithLiterals = ProrationBehaviorEnumProrationBehavior | 'UNKNOWN' | 'PRORATE_AND_CHARGE' | 'PRORATE_AND_REFUND' | 'PRORATE_AND_EXTEND' | 'NO_PRORATION';
|
|
3570
|
+
/** Payment context for immediate subscription changes without the checkout flow. */
|
|
3571
|
+
interface ChangePaymentContext {
|
|
3572
|
+
/** Payment settings override for this change */
|
|
3573
|
+
paymentSettings?: PaymentSettings;
|
|
3528
3574
|
}
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
|
|
3575
|
+
interface ChangeSubscriptionResponse {
|
|
3576
|
+
/** Updated subscription */
|
|
3577
|
+
subscription?: Subscription;
|
|
3578
|
+
/** Proration calculation result. Present for immediate changes with proration. */
|
|
3579
|
+
prorationResult?: V1ProrationResult;
|
|
3532
3580
|
/**
|
|
3533
|
-
* ID of the
|
|
3581
|
+
* ID of the adjustment invoice created for the proration charge or refund.
|
|
3534
3582
|
* @format GUID
|
|
3535
|
-
* @readonly
|
|
3536
3583
|
*/
|
|
3537
|
-
|
|
3584
|
+
adjustmentInvoiceId?: string | null;
|
|
3585
|
+
}
|
|
3586
|
+
/** Result of a proration calculation applied during a subscription change. */
|
|
3587
|
+
interface V1ProrationResult {
|
|
3538
3588
|
/**
|
|
3539
|
-
*
|
|
3540
|
-
* @
|
|
3589
|
+
* Credit amount for unused time on the current plan
|
|
3590
|
+
* @format DECIMAL_VALUE
|
|
3541
3591
|
*/
|
|
3542
|
-
|
|
3543
|
-
/** Number of the latest payment attempt. */
|
|
3544
|
-
attemptNumber?: number;
|
|
3592
|
+
creditAmount?: string;
|
|
3545
3593
|
/**
|
|
3546
|
-
*
|
|
3547
|
-
*
|
|
3548
|
-
* + `"UNKNOWN"`: There is no information about the status of the latest payment attempt.
|
|
3549
|
-
* + `"SCHEDULED"`: The latest payment attempt is scheduled but hasn't started yet.
|
|
3550
|
-
* + `"IN_PROGRESS"`: The latest payment attempt is in progress.
|
|
3551
|
-
* + `"PAID"`: The latest payment attempt resulted in a successful payment.
|
|
3552
|
-
* + `"DECLINED"`: The latest payment attempt has been declined.
|
|
3553
|
-
* + `"TECHNICAL_FAILURE"`: The latest payment attempt couldn't be process due to a technical failure.
|
|
3554
|
-
* + `"CANCELED"`: The latest payment attempt has been canceled by BASS.
|
|
3555
|
-
* @readonly
|
|
3594
|
+
* Charge amount for the new plan's prorated price
|
|
3595
|
+
* @format DECIMAL_VALUE
|
|
3556
3596
|
*/
|
|
3557
|
-
|
|
3597
|
+
chargeAmount?: string;
|
|
3558
3598
|
/**
|
|
3559
|
-
*
|
|
3560
|
-
*
|
|
3599
|
+
* Net amount (charge minus credit). Positive means customer pays, negative means refund.
|
|
3600
|
+
* @format DECIMAL_VALUE
|
|
3561
3601
|
*/
|
|
3562
|
-
|
|
3602
|
+
netAmount?: string;
|
|
3603
|
+
/** Date when the proration was calculated */
|
|
3604
|
+
prorationDate?: Date | null;
|
|
3605
|
+
/** Remaining seconds in the current billing period at time of change */
|
|
3606
|
+
remainingSeconds?: string;
|
|
3607
|
+
/** Total seconds in the current billing cycle */
|
|
3608
|
+
totalCycleSeconds?: string;
|
|
3609
|
+
}
|
|
3610
|
+
interface PreviewChangeSubscriptionRequest {
|
|
3563
3611
|
/**
|
|
3564
|
-
*
|
|
3565
|
-
* @format
|
|
3566
|
-
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3567
|
-
* @readonly
|
|
3612
|
+
* ID of the subscription to preview the change for
|
|
3613
|
+
* @format GUID
|
|
3568
3614
|
*/
|
|
3569
|
-
|
|
3615
|
+
subscriptionId?: string;
|
|
3616
|
+
/** Item-level changes to preview. Same structure as ChangeSubscriptionRequest. */
|
|
3617
|
+
itemChanges?: SubscriptionItemChange[];
|
|
3618
|
+
/** Subscription-level: preview a cycle change. */
|
|
3619
|
+
newCycle?: Duration;
|
|
3620
|
+
/** When the change would take effect. */
|
|
3621
|
+
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
3622
|
+
/** How proration would be handled for immediate changes. */
|
|
3623
|
+
prorationBehavior?: ProrationBehaviorEnumProrationBehaviorWithLiterals;
|
|
3570
3624
|
}
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
|
|
3578
|
-
|
|
3579
|
-
|
|
3580
|
-
REFUNDED = "REFUNDED",
|
|
3581
|
-
CHARGEBACKED = "CHARGEBACKED"
|
|
3582
|
-
}
|
|
3583
|
-
/** @enumType */
|
|
3584
|
-
type PaymentAttemptStatusWithLiterals = PaymentAttemptStatus | 'UNKNOWN' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAID' | 'DECLINED' | 'TECHNICAL_FAILURE' | 'CANCELED' | 'PENDING' | 'REFUNDED' | 'CHARGEBACKED';
|
|
3585
|
-
interface PriceAdjustment extends PriceAdjustmentAdjustmentTypeOneOf {
|
|
3586
|
-
/** Adjustment that increases the price. */
|
|
3587
|
-
charge?: PriceAdjustmentValue;
|
|
3588
|
-
/** Adjustment that lowers the price. */
|
|
3589
|
-
credit?: PriceAdjustmentValue;
|
|
3590
|
-
/** Reason for this price adjustment. Used to categorize proration adjustments. */
|
|
3591
|
-
reason?: PriceAdjustmentReasonWithLiterals;
|
|
3592
|
-
}
|
|
3593
|
-
/** @oneof */
|
|
3594
|
-
interface PriceAdjustmentAdjustmentTypeOneOf {
|
|
3595
|
-
/** Adjustment that increases the price. */
|
|
3596
|
-
charge?: PriceAdjustmentValue;
|
|
3597
|
-
/** Adjustment that lowers the price. */
|
|
3598
|
-
credit?: PriceAdjustmentValue;
|
|
3599
|
-
}
|
|
3600
|
-
interface PriceAdjustmentValue extends PriceAdjustmentValueAdjustmentValueTypeOneOf {
|
|
3601
|
-
/**
|
|
3602
|
-
* Absolute amount that adjusts the price.
|
|
3603
|
-
*
|
|
3604
|
-
* Min: `0.01`
|
|
3605
|
-
* @decimalValue options { gt:0.00 }
|
|
3606
|
-
*/
|
|
3607
|
-
amount?: string;
|
|
3608
|
-
/**
|
|
3609
|
-
* Relative factor that adjusts the price. For example, setting
|
|
3610
|
-
* `multiplier` to:
|
|
3611
|
-
* - `0.50` results in a price adjustment of 50% of the original value.
|
|
3612
|
-
* - `0.75` results in a price adjustment of 75% of the original value.
|
|
3613
|
-
* - `1.00` results in a price adjustment of 100% of the original value.
|
|
3614
|
-
*
|
|
3615
|
-
* Min: `0.01`
|
|
3616
|
-
* Max: `1.00`
|
|
3617
|
-
* @decimalValue options { gt:0.00, lte:1 }
|
|
3618
|
-
*/
|
|
3619
|
-
multiplier?: string;
|
|
3620
|
-
}
|
|
3621
|
-
/** @oneof */
|
|
3622
|
-
interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
|
|
3623
|
-
/**
|
|
3624
|
-
* Absolute amount that adjusts the price.
|
|
3625
|
-
*
|
|
3626
|
-
* Min: `0.01`
|
|
3627
|
-
* @decimalValue options { gt:0.00 }
|
|
3628
|
-
*/
|
|
3629
|
-
amount?: string;
|
|
3630
|
-
/**
|
|
3631
|
-
* Relative factor that adjusts the price. For example, setting
|
|
3632
|
-
* `multiplier` to:
|
|
3633
|
-
* - `0.50` results in a price adjustment of 50% of the original value.
|
|
3634
|
-
* - `0.75` results in a price adjustment of 75% of the original value.
|
|
3635
|
-
* - `1.00` results in a price adjustment of 100% of the original value.
|
|
3636
|
-
*
|
|
3637
|
-
* Min: `0.01`
|
|
3638
|
-
* Max: `1.00`
|
|
3639
|
-
* @decimalValue options { gt:0.00, lte:1 }
|
|
3640
|
-
*/
|
|
3641
|
-
multiplier?: string;
|
|
3642
|
-
}
|
|
3643
|
-
/** Reason for a price adjustment. Categorizes different types of proration adjustments. */
|
|
3644
|
-
declare enum PriceAdjustmentReason {
|
|
3645
|
-
/** Default value. Used for adjustments without a specific categorization. */
|
|
3646
|
-
PRICE_ADJUSTMENT_REASON_UNSPECIFIED = "PRICE_ADJUSTMENT_REASON_UNSPECIFIED",
|
|
3647
|
-
/** Adjustment due to a billing date change. */
|
|
3648
|
-
BILLING_DATE_CHANGE = "BILLING_DATE_CHANGE",
|
|
3649
|
-
/** Proration adjustment from changing the subscription plan. */
|
|
3650
|
-
PLAN_CHANGE_PRORATION = "PLAN_CHANGE_PRORATION",
|
|
3651
|
-
/** Proration adjustment from changing the billing cycle (e.g., monthly to yearly). */
|
|
3652
|
-
CYCLE_CHANGE_PRORATION = "CYCLE_CHANGE_PRORATION",
|
|
3653
|
-
/** Proration adjustment from changing the subscription quantity. */
|
|
3654
|
-
QUANTITY_CHANGE_PRORATION = "QUANTITY_CHANGE_PRORATION",
|
|
3655
|
-
/** Custom adjustment provided by the caller. */
|
|
3656
|
-
CUSTOM_PRICE_ADJUSTMENT = "CUSTOM_PRICE_ADJUSTMENT"
|
|
3625
|
+
interface PreviewChangeSubscriptionResponse {
|
|
3626
|
+
/** Summary of the current subscription state */
|
|
3627
|
+
current?: SubscriptionChangeSummary;
|
|
3628
|
+
/** Summary of the proposed subscription state after the change */
|
|
3629
|
+
proposed?: SubscriptionChangeSummary;
|
|
3630
|
+
/** Proration preview details. Present only for immediate changes. */
|
|
3631
|
+
proration?: ProrationPreview;
|
|
3632
|
+
/** Renewal preview. Present only for changes at next renewal. */
|
|
3633
|
+
renewalPreview?: RenewalPreview;
|
|
3657
3634
|
}
|
|
3658
|
-
/**
|
|
3659
|
-
|
|
3660
|
-
|
|
3635
|
+
/** Summary of a subscription's state, used in change previews. */
|
|
3636
|
+
interface SubscriptionChangeSummary {
|
|
3637
|
+
/** Product ID */
|
|
3638
|
+
productId?: string;
|
|
3639
|
+
/** Product name */
|
|
3640
|
+
productName?: string;
|
|
3641
|
+
/** Billing cycle duration */
|
|
3642
|
+
cycle?: Duration;
|
|
3643
|
+
/** Number of units */
|
|
3644
|
+
quantity?: number;
|
|
3661
3645
|
/**
|
|
3662
|
-
*
|
|
3663
|
-
*
|
|
3664
|
-
* Min: `0.01`
|
|
3665
|
-
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3646
|
+
* Price per unit
|
|
3647
|
+
* @format DECIMAL_VALUE
|
|
3666
3648
|
*/
|
|
3667
|
-
|
|
3668
|
-
/** Tax of the shipping fee */
|
|
3669
|
-
tax?: Tax;
|
|
3670
|
-
/** Information about the shipping charges tax data */
|
|
3671
|
-
taxData?: ItemTaxData;
|
|
3672
|
-
discount?: Discount;
|
|
3673
|
-
}
|
|
3674
|
-
/** Tax data from all items */
|
|
3675
|
-
interface TaxData {
|
|
3676
|
-
/** Aggregated tax data from all items */
|
|
3677
|
-
taxSummary?: TaxSummary;
|
|
3678
|
-
}
|
|
3679
|
-
interface TaxSummary {
|
|
3649
|
+
pricePerUnit?: string;
|
|
3680
3650
|
/**
|
|
3681
|
-
*
|
|
3651
|
+
* Total price (price_per_unit * quantity)
|
|
3682
3652
|
* @format DECIMAL_VALUE
|
|
3683
3653
|
*/
|
|
3684
|
-
|
|
3654
|
+
totalPrice?: string;
|
|
3685
3655
|
/**
|
|
3686
|
-
*
|
|
3687
|
-
* @
|
|
3656
|
+
* Currency code (ISO 4217)
|
|
3657
|
+
* @format CURRENCY
|
|
3688
3658
|
*/
|
|
3689
|
-
|
|
3659
|
+
currency?: string;
|
|
3660
|
+
/** Current billing period start */
|
|
3661
|
+
periodStart?: Date | null;
|
|
3662
|
+
/** Current billing period end */
|
|
3663
|
+
periodEnd?: Date | null;
|
|
3690
3664
|
}
|
|
3691
|
-
|
|
3665
|
+
/** Preview of proration amounts for a proposed subscription change. */
|
|
3666
|
+
interface ProrationPreview {
|
|
3692
3667
|
/**
|
|
3693
|
-
*
|
|
3694
|
-
* @
|
|
3668
|
+
* Credit amount for unused time on the current plan
|
|
3669
|
+
* @format DECIMAL_VALUE
|
|
3695
3670
|
*/
|
|
3696
|
-
|
|
3671
|
+
creditAmount?: string;
|
|
3697
3672
|
/**
|
|
3698
|
-
*
|
|
3699
|
-
* @
|
|
3673
|
+
* Charge amount for the new plan's prorated price
|
|
3674
|
+
* @format DECIMAL_VALUE
|
|
3700
3675
|
*/
|
|
3701
|
-
|
|
3676
|
+
chargeAmount?: string;
|
|
3702
3677
|
/**
|
|
3703
|
-
*
|
|
3704
|
-
* @
|
|
3678
|
+
* Net amount (charge minus credit)
|
|
3679
|
+
* @format DECIMAL_VALUE
|
|
3705
3680
|
*/
|
|
3706
|
-
|
|
3707
|
-
/** Type of jurisdiction that taxes were calculated for. */
|
|
3708
|
-
jurisdictionType?: string;
|
|
3681
|
+
netAmount?: string;
|
|
3709
3682
|
/**
|
|
3710
|
-
* Tax
|
|
3711
|
-
* @
|
|
3683
|
+
* Tax amount on the net proration
|
|
3684
|
+
* @format DECIMAL_VALUE
|
|
3712
3685
|
*/
|
|
3713
|
-
|
|
3686
|
+
taxAmount?: string;
|
|
3714
3687
|
/**
|
|
3715
|
-
* Total amount
|
|
3688
|
+
* Total amount including tax
|
|
3716
3689
|
* @format DECIMAL_VALUE
|
|
3717
|
-
* @decimalValue options { maxScale:4 }
|
|
3718
3690
|
*/
|
|
3719
|
-
|
|
3691
|
+
totalAmount?: string;
|
|
3692
|
+
/** Remaining seconds in the current billing period */
|
|
3693
|
+
remainingSeconds?: string;
|
|
3694
|
+
/** Total seconds in the current billing cycle */
|
|
3695
|
+
totalCycleSeconds?: string;
|
|
3696
|
+
/** New period end date. Present when proration_behavior is PRORATE_AND_EXTEND. */
|
|
3697
|
+
newPeriodEnd?: Date | null;
|
|
3698
|
+
/** Number of days added to the billing period. Present when proration_behavior is PRORATE_AND_EXTEND. */
|
|
3699
|
+
daysAdded?: number;
|
|
3700
|
+
/** The proration action that would be taken */
|
|
3701
|
+
action?: ProrationActionWithLiterals;
|
|
3720
3702
|
}
|
|
3721
|
-
|
|
3703
|
+
declare enum ProrationAction {
|
|
3704
|
+
UNKNOWN = "UNKNOWN",
|
|
3705
|
+
/** Net charge to customer */
|
|
3706
|
+
CHARGE = "CHARGE",
|
|
3707
|
+
/** Net refund to customer */
|
|
3708
|
+
REFUND = "REFUND",
|
|
3709
|
+
/** Extend billing period instead of refund */
|
|
3710
|
+
EXTEND_PERIOD = "EXTEND_PERIOD",
|
|
3711
|
+
/** No financial change needed */
|
|
3712
|
+
NO_CHANGE = "NO_CHANGE"
|
|
3713
|
+
}
|
|
3714
|
+
/** @enumType */
|
|
3715
|
+
type ProrationActionWithLiterals = ProrationAction | 'UNKNOWN' | 'CHARGE' | 'REFUND' | 'EXTEND_PERIOD' | 'NO_CHANGE';
|
|
3716
|
+
/** Preview of what the next renewal will look like after a change. */
|
|
3717
|
+
interface RenewalPreview {
|
|
3722
3718
|
/**
|
|
3723
|
-
*
|
|
3719
|
+
* New price per unit at next renewal
|
|
3724
3720
|
* @format DECIMAL_VALUE
|
|
3725
|
-
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3726
3721
|
*/
|
|
3727
|
-
|
|
3722
|
+
newPrice?: string;
|
|
3728
3723
|
/**
|
|
3729
|
-
*
|
|
3730
|
-
* @
|
|
3724
|
+
* New total at next renewal (price * quantity)
|
|
3725
|
+
* @format DECIMAL_VALUE
|
|
3731
3726
|
*/
|
|
3732
|
-
|
|
3727
|
+
newTotal?: string;
|
|
3728
|
+
/** Date of the next renewal */
|
|
3729
|
+
nextRenewalDate?: Date | null;
|
|
3733
3730
|
}
|
|
3734
|
-
interface
|
|
3731
|
+
interface CancelPendingChangeRequest {
|
|
3735
3732
|
/**
|
|
3736
|
-
*
|
|
3737
|
-
* @format
|
|
3738
|
-
* @decimalValue options { gt:0.00, maxScale:2 }
|
|
3733
|
+
* ID of the subscription to cancel the pending change for
|
|
3734
|
+
* @format GUID
|
|
3739
3735
|
*/
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
|
|
3736
|
+
subscriptionId?: string;
|
|
3737
|
+
}
|
|
3738
|
+
interface CancelPendingChangeResponse {
|
|
3739
|
+
/** Updated subscription with cleared pending data */
|
|
3740
|
+
subscription?: Subscription;
|
|
3741
|
+
}
|
|
3742
|
+
interface ChangeSubscriptionForOrderRequest {
|
|
3743
|
+
/** The new subscription definition from the order (items, billing settings). */
|
|
3744
|
+
subscription?: Subscription;
|
|
3745
|
+
/** Context of the change: source subscription, change type, proration behavior. */
|
|
3746
|
+
changeContext?: ChangeContext;
|
|
3747
|
+
}
|
|
3748
|
+
/**
|
|
3749
|
+
* Context for subscription changes within the order/checkout flow.
|
|
3750
|
+
* Carries the source subscription reference and change parameters.
|
|
3751
|
+
* Present on an OrderSubscription when it represents a modification of an
|
|
3752
|
+
* existing subscription rather than a new purchase.
|
|
3753
|
+
*/
|
|
3754
|
+
interface ChangeContext {
|
|
3743
3755
|
/**
|
|
3744
|
-
*
|
|
3756
|
+
* ID of the existing subscription being changed.
|
|
3745
3757
|
* @format GUID
|
|
3746
3758
|
*/
|
|
3747
|
-
|
|
3748
|
-
/**
|
|
3749
|
-
|
|
3759
|
+
sourceSubscriptionId?: string;
|
|
3760
|
+
/** Type of change being performed. */
|
|
3761
|
+
changeType?: ChangeTypeWithLiterals;
|
|
3762
|
+
/** How proration should be handled. */
|
|
3763
|
+
prorationBehavior?: ProrationBehaviorWithLiterals;
|
|
3750
3764
|
/**
|
|
3751
|
-
*
|
|
3752
|
-
*
|
|
3765
|
+
* System-populated: proration result after calculation.
|
|
3766
|
+
* Populated by billing-subscriptions during order processing.
|
|
3753
3767
|
*/
|
|
3754
|
-
|
|
3768
|
+
prorationResult?: ProrationResult;
|
|
3755
3769
|
}
|
|
3756
|
-
declare enum
|
|
3757
|
-
|
|
3758
|
-
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
|
|
3770
|
+
declare enum ChangeType {
|
|
3771
|
+
CHANGE_TYPE_UNKNOWN = "CHANGE_TYPE_UNKNOWN",
|
|
3772
|
+
UPGRADE = "UPGRADE",
|
|
3773
|
+
DOWNGRADE = "DOWNGRADE",
|
|
3774
|
+
CYCLE_CHANGE = "CYCLE_CHANGE",
|
|
3775
|
+
QUANTITY_CHANGE = "QUANTITY_CHANGE"
|
|
3762
3776
|
}
|
|
3763
3777
|
/** @enumType */
|
|
3764
|
-
type
|
|
3765
|
-
interface ChangeSubscriptionRequest {
|
|
3766
|
-
/**
|
|
3767
|
-
* ID of the subscription to change
|
|
3768
|
-
* @format GUID
|
|
3769
|
-
*/
|
|
3770
|
-
subscriptionId?: string;
|
|
3771
|
-
/**
|
|
3772
|
-
* Item-level changes. Each entry targets one existing item by ID.
|
|
3773
|
-
* Caller passes CONCRETE new values (price, quantity, name) — BASS does not resolve pricing.
|
|
3774
|
-
* BASS uses these for proration: old values (from subscription) vs new values (from here).
|
|
3775
|
-
*/
|
|
3776
|
-
itemChanges?: SubscriptionItemChange[];
|
|
3777
|
-
/**
|
|
3778
|
-
* Subscription-level: new billing cycle (e.g., monthly to yearly).
|
|
3779
|
-
* Affects the billing period for ALL items.
|
|
3780
|
-
* When changing cycle, caller MUST also pass new prices in item_changes.
|
|
3781
|
-
*/
|
|
3782
|
-
newCycle?: Duration;
|
|
3783
|
-
/** When the change takes effect. */
|
|
3784
|
-
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
3785
|
-
/** How to handle proration for immediate changes. Ignored for AT_NEXT_RENEWAL. */
|
|
3786
|
-
prorationBehavior?: ProrationBehaviorWithLiterals;
|
|
3787
|
-
/** Payment context for immediate changes without checkout flow. */
|
|
3788
|
-
paymentContext?: ChangePaymentContext;
|
|
3789
|
-
}
|
|
3790
|
-
/**
|
|
3791
|
-
* Describes a change to a single subscription item.
|
|
3792
|
-
* The caller (BG/CVS) resolves pricing from their catalog and passes concrete values.
|
|
3793
|
-
*/
|
|
3794
|
-
interface SubscriptionItemChange {
|
|
3795
|
-
/**
|
|
3796
|
-
* Which item to change. Must match an existing item ID in the subscription.
|
|
3797
|
-
* @format GUID
|
|
3798
|
-
*/
|
|
3799
|
-
itemId?: string;
|
|
3800
|
-
/**
|
|
3801
|
-
* New price per unit. Caller resolves this from their product catalog.
|
|
3802
|
-
* Required when changing product/plan. Optional for quantity-only changes (uses current price).
|
|
3803
|
-
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3804
|
-
*/
|
|
3805
|
-
newPrice?: string | null;
|
|
3806
|
-
/**
|
|
3807
|
-
* New quantity (seats/licenses). Optional — unchanged if not set.
|
|
3808
|
-
* @min 1
|
|
3809
|
-
*/
|
|
3810
|
-
newQuantity?: number | null;
|
|
3811
|
-
/**
|
|
3812
|
-
* New catalog reference. Optional — set when changing to a different product.
|
|
3813
|
-
* This is metadata for the caller's tracking; BASS does not use it for pricing.
|
|
3814
|
-
*/
|
|
3815
|
-
newCatalogReference?: CatalogReference;
|
|
3816
|
-
/**
|
|
3817
|
-
* New item name. Optional — set when changing to a different product.
|
|
3818
|
-
* @maxLength 200
|
|
3819
|
-
*/
|
|
3820
|
-
newName?: string | null;
|
|
3821
|
-
}
|
|
3822
|
-
declare enum ChangeEffectiveTime {
|
|
3823
|
-
UNKNOWN = "UNKNOWN",
|
|
3824
|
-
/** Apply change immediately with proration */
|
|
3825
|
-
IMMEDIATELY = "IMMEDIATELY",
|
|
3826
|
-
/** Schedule change for the next billing cycle */
|
|
3827
|
-
AT_NEXT_RENEWAL = "AT_NEXT_RENEWAL"
|
|
3828
|
-
}
|
|
3829
|
-
/** @enumType */
|
|
3830
|
-
type ChangeEffectiveTimeWithLiterals = ChangeEffectiveTime | 'UNKNOWN' | 'IMMEDIATELY' | 'AT_NEXT_RENEWAL';
|
|
3778
|
+
type ChangeTypeWithLiterals = ChangeType | 'CHANGE_TYPE_UNKNOWN' | 'UPGRADE' | 'DOWNGRADE' | 'CYCLE_CHANGE' | 'QUANTITY_CHANGE';
|
|
3831
3779
|
declare enum ProrationBehavior {
|
|
3832
|
-
|
|
3780
|
+
PRORATION_BEHAVIOR_UNKNOWN = "PRORATION_BEHAVIOR_UNKNOWN",
|
|
3833
3781
|
/** Credit unused time + charge new prorated price (default for upgrades) */
|
|
3834
3782
|
PRORATE_AND_CHARGE = "PRORATE_AND_CHARGE",
|
|
3835
3783
|
/** Credit unused time + refund to payment method (downgrades) */
|
|
@@ -3840,24 +3788,11 @@ declare enum ProrationBehavior {
|
|
|
3840
3788
|
NO_PRORATION = "NO_PRORATION"
|
|
3841
3789
|
}
|
|
3842
3790
|
/** @enumType */
|
|
3843
|
-
type ProrationBehaviorWithLiterals = ProrationBehavior | '
|
|
3844
|
-
/**
|
|
3845
|
-
|
|
3846
|
-
|
|
3847
|
-
|
|
3848
|
-
}
|
|
3849
|
-
interface ChangeSubscriptionResponse {
|
|
3850
|
-
/** Updated subscription */
|
|
3851
|
-
subscription?: Subscription;
|
|
3852
|
-
/** Proration calculation result. Present for immediate changes with proration. */
|
|
3853
|
-
prorationResult?: ProrationResult;
|
|
3854
|
-
/**
|
|
3855
|
-
* ID of the adjustment invoice created for the proration charge or refund.
|
|
3856
|
-
* @format GUID
|
|
3857
|
-
*/
|
|
3858
|
-
adjustmentInvoiceId?: string | null;
|
|
3859
|
-
}
|
|
3860
|
-
/** Result of a proration calculation applied during a subscription change. */
|
|
3791
|
+
type ProrationBehaviorWithLiterals = ProrationBehavior | 'PRORATION_BEHAVIOR_UNKNOWN' | 'PRORATE_AND_CHARGE' | 'PRORATE_AND_REFUND' | 'PRORATE_AND_EXTEND' | 'NO_PRORATION';
|
|
3792
|
+
/**
|
|
3793
|
+
* Result of a proration calculation. Contains the credit, charge, and net amounts
|
|
3794
|
+
* computed during a subscription change.
|
|
3795
|
+
*/
|
|
3861
3796
|
interface ProrationResult {
|
|
3862
3797
|
/**
|
|
3863
3798
|
* Credit amount for unused time on the current plan
|
|
@@ -3881,137 +3816,13 @@ interface ProrationResult {
|
|
|
3881
3816
|
/** Total seconds in the current billing cycle */
|
|
3882
3817
|
totalCycleSeconds?: string;
|
|
3883
3818
|
}
|
|
3884
|
-
interface
|
|
3885
|
-
/**
|
|
3886
|
-
* ID of the subscription to preview the change for
|
|
3887
|
-
* @format GUID
|
|
3888
|
-
*/
|
|
3889
|
-
subscriptionId?: string;
|
|
3890
|
-
/** Item-level changes to preview. Same structure as ChangeSubscriptionRequest. */
|
|
3891
|
-
itemChanges?: SubscriptionItemChange[];
|
|
3892
|
-
/** Subscription-level: preview a cycle change. */
|
|
3893
|
-
newCycle?: Duration;
|
|
3894
|
-
/** When the change would take effect. */
|
|
3895
|
-
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
3896
|
-
/** How proration would be handled for immediate changes. */
|
|
3897
|
-
prorationBehavior?: ProrationBehaviorWithLiterals;
|
|
3898
|
-
}
|
|
3899
|
-
interface PreviewChangeSubscriptionResponse {
|
|
3900
|
-
/** Summary of the current subscription state */
|
|
3901
|
-
current?: SubscriptionChangeSummary;
|
|
3902
|
-
/** Summary of the proposed subscription state after the change */
|
|
3903
|
-
proposed?: SubscriptionChangeSummary;
|
|
3904
|
-
/** Proration preview details. Present only for immediate changes. */
|
|
3905
|
-
proration?: ProrationPreview;
|
|
3906
|
-
/** Renewal preview. Present only for changes at next renewal. */
|
|
3907
|
-
renewalPreview?: RenewalPreview;
|
|
3908
|
-
}
|
|
3909
|
-
/** Summary of a subscription's state, used in change previews. */
|
|
3910
|
-
interface SubscriptionChangeSummary {
|
|
3911
|
-
/** Product ID */
|
|
3912
|
-
productId?: string;
|
|
3913
|
-
/** Product name */
|
|
3914
|
-
productName?: string;
|
|
3915
|
-
/** Billing cycle duration */
|
|
3916
|
-
cycle?: Duration;
|
|
3917
|
-
/** Number of units */
|
|
3918
|
-
quantity?: number;
|
|
3919
|
-
/**
|
|
3920
|
-
* Price per unit
|
|
3921
|
-
* @format DECIMAL_VALUE
|
|
3922
|
-
*/
|
|
3923
|
-
pricePerUnit?: string;
|
|
3924
|
-
/**
|
|
3925
|
-
* Total price (price_per_unit * quantity)
|
|
3926
|
-
* @format DECIMAL_VALUE
|
|
3927
|
-
*/
|
|
3928
|
-
totalPrice?: string;
|
|
3929
|
-
/**
|
|
3930
|
-
* Currency code (ISO 4217)
|
|
3931
|
-
* @format CURRENCY
|
|
3932
|
-
*/
|
|
3933
|
-
currency?: string;
|
|
3934
|
-
/** Current billing period start */
|
|
3935
|
-
periodStart?: Date | null;
|
|
3936
|
-
/** Current billing period end */
|
|
3937
|
-
periodEnd?: Date | null;
|
|
3938
|
-
}
|
|
3939
|
-
/** Preview of proration amounts for a proposed subscription change. */
|
|
3940
|
-
interface ProrationPreview {
|
|
3941
|
-
/**
|
|
3942
|
-
* Credit amount for unused time on the current plan
|
|
3943
|
-
* @format DECIMAL_VALUE
|
|
3944
|
-
*/
|
|
3945
|
-
creditAmount?: string;
|
|
3946
|
-
/**
|
|
3947
|
-
* Charge amount for the new plan's prorated price
|
|
3948
|
-
* @format DECIMAL_VALUE
|
|
3949
|
-
*/
|
|
3950
|
-
chargeAmount?: string;
|
|
3951
|
-
/**
|
|
3952
|
-
* Net amount (charge minus credit)
|
|
3953
|
-
* @format DECIMAL_VALUE
|
|
3954
|
-
*/
|
|
3955
|
-
netAmount?: string;
|
|
3956
|
-
/**
|
|
3957
|
-
* Tax amount on the net proration
|
|
3958
|
-
* @format DECIMAL_VALUE
|
|
3959
|
-
*/
|
|
3960
|
-
taxAmount?: string;
|
|
3961
|
-
/**
|
|
3962
|
-
* Total amount including tax
|
|
3963
|
-
* @format DECIMAL_VALUE
|
|
3964
|
-
*/
|
|
3965
|
-
totalAmount?: string;
|
|
3966
|
-
/** Remaining seconds in the current billing period */
|
|
3967
|
-
remainingSeconds?: string;
|
|
3968
|
-
/** Total seconds in the current billing cycle */
|
|
3969
|
-
totalCycleSeconds?: string;
|
|
3970
|
-
/** New period end date. Present when proration_behavior is PRORATE_AND_EXTEND. */
|
|
3971
|
-
newPeriodEnd?: Date | null;
|
|
3972
|
-
/** Number of days added to the billing period. Present when proration_behavior is PRORATE_AND_EXTEND. */
|
|
3973
|
-
daysAdded?: number;
|
|
3974
|
-
/** The proration action that would be taken */
|
|
3975
|
-
action?: ProrationActionWithLiterals;
|
|
3976
|
-
}
|
|
3977
|
-
declare enum ProrationAction {
|
|
3978
|
-
UNKNOWN = "UNKNOWN",
|
|
3979
|
-
/** Net charge to customer */
|
|
3980
|
-
CHARGE = "CHARGE",
|
|
3981
|
-
/** Net refund to customer */
|
|
3982
|
-
REFUND = "REFUND",
|
|
3983
|
-
/** Extend billing period instead of refund */
|
|
3984
|
-
EXTEND_PERIOD = "EXTEND_PERIOD",
|
|
3985
|
-
/** No financial change needed */
|
|
3986
|
-
NO_CHANGE = "NO_CHANGE"
|
|
3987
|
-
}
|
|
3988
|
-
/** @enumType */
|
|
3989
|
-
type ProrationActionWithLiterals = ProrationAction | 'UNKNOWN' | 'CHARGE' | 'REFUND' | 'EXTEND_PERIOD' | 'NO_CHANGE';
|
|
3990
|
-
/** Preview of what the next renewal will look like after a change. */
|
|
3991
|
-
interface RenewalPreview {
|
|
3992
|
-
/**
|
|
3993
|
-
* New price per unit at next renewal
|
|
3994
|
-
* @format DECIMAL_VALUE
|
|
3995
|
-
*/
|
|
3996
|
-
newPrice?: string;
|
|
3997
|
-
/**
|
|
3998
|
-
* New total at next renewal (price * quantity)
|
|
3999
|
-
* @format DECIMAL_VALUE
|
|
4000
|
-
*/
|
|
4001
|
-
newTotal?: string;
|
|
4002
|
-
/** Date of the next renewal */
|
|
4003
|
-
nextRenewalDate?: Date | null;
|
|
4004
|
-
}
|
|
4005
|
-
interface CancelPendingChangeRequest {
|
|
4006
|
-
/**
|
|
4007
|
-
* ID of the subscription to cancel the pending change for
|
|
4008
|
-
* @format GUID
|
|
4009
|
-
*/
|
|
4010
|
-
subscriptionId?: string;
|
|
4011
|
-
}
|
|
4012
|
-
interface CancelPendingChangeResponse {
|
|
4013
|
-
/** Updated subscription with cleared pending data */
|
|
3819
|
+
interface ChangeSubscriptionForOrderResponse {
|
|
3820
|
+
/** The source subscription (unchanged, for reference). */
|
|
4014
3821
|
subscription?: Subscription;
|
|
3822
|
+
/** Non-persistent invoice with proration adjustments. */
|
|
3823
|
+
invoice?: Invoice;
|
|
3824
|
+
/** Calculated proration result. */
|
|
3825
|
+
prorationResult?: ProrationResult;
|
|
4015
3826
|
}
|
|
4016
3827
|
interface Task {
|
|
4017
3828
|
key?: TaskKey;
|
|
@@ -4042,6 +3853,8 @@ interface Reschedule {
|
|
|
4042
3853
|
executeAt?: Date | null;
|
|
4043
3854
|
payload?: string | null;
|
|
4044
3855
|
}
|
|
3856
|
+
interface Empty {
|
|
3857
|
+
}
|
|
4045
3858
|
interface V1SubscriptionEvent extends V1SubscriptionEventEventOneOf {
|
|
4046
3859
|
/** A subscriptions was created */
|
|
4047
3860
|
created?: V1SubscriptionCreated;
|
|
@@ -4213,176 +4026,651 @@ interface Money {
|
|
|
4213
4026
|
*/
|
|
4214
4027
|
currency?: string;
|
|
4215
4028
|
}
|
|
4216
|
-
declare enum SubscriptionType {
|
|
4217
|
-
UNDEFINED = "UNDEFINED",
|
|
4218
|
-
/** Payments made by the subscriber */
|
|
4219
|
-
ONLINE = "ONLINE",
|
|
4220
|
-
/** Payments managed manually by the site owner */
|
|
4221
|
-
OFFLINE = "OFFLINE"
|
|
4029
|
+
declare enum SubscriptionType {
|
|
4030
|
+
UNDEFINED = "UNDEFINED",
|
|
4031
|
+
/** Payments made by the subscriber */
|
|
4032
|
+
ONLINE = "ONLINE",
|
|
4033
|
+
/** Payments managed manually by the site owner */
|
|
4034
|
+
OFFLINE = "OFFLINE"
|
|
4035
|
+
}
|
|
4036
|
+
/** @enumType */
|
|
4037
|
+
type SubscriptionTypeWithLiterals = SubscriptionType | 'UNDEFINED' | 'ONLINE' | 'OFFLINE';
|
|
4038
|
+
declare enum V1SubscriptionStatusEnumSubscriptionStatus {
|
|
4039
|
+
/** Subscription status undefined */
|
|
4040
|
+
UNDEFINED = "UNDEFINED",
|
|
4041
|
+
/** Subscription created, but hasn't been paid for yet. This status if filtered out in ListSubscriptions response by default. */
|
|
4042
|
+
DRAFT = "DRAFT",
|
|
4043
|
+
/** Subscription has been paid for, but the start date is in the future */
|
|
4044
|
+
PENDING = "PENDING",
|
|
4045
|
+
/** Subscription is active */
|
|
4046
|
+
ACTIVE = "ACTIVE",
|
|
4047
|
+
/** Subscription has expired */
|
|
4048
|
+
EXPIRED = "EXPIRED",
|
|
4049
|
+
/** Subscription has been canceled */
|
|
4050
|
+
CANCELED = "CANCELED",
|
|
4051
|
+
/** Subscription has been set to be canceled at a future date */
|
|
4052
|
+
PENDING_CANCELLATION = "PENDING_CANCELLATION",
|
|
4053
|
+
/** Subscription is suspended */
|
|
4054
|
+
SUSPENDED = "SUSPENDED"
|
|
4055
|
+
}
|
|
4056
|
+
/** @enumType */
|
|
4057
|
+
type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals = V1SubscriptionStatusEnumSubscriptionStatus | 'UNDEFINED' | 'DRAFT' | 'PENDING' | 'ACTIVE' | 'EXPIRED' | 'CANCELED' | 'PENDING_CANCELLATION' | 'SUSPENDED';
|
|
4058
|
+
declare enum PaymentStatusEnumPaymentStatus {
|
|
4059
|
+
/** Payment status undefined */
|
|
4060
|
+
UNDEFINED = "UNDEFINED",
|
|
4061
|
+
/** Payment has been paid */
|
|
4062
|
+
PAID = "PAID",
|
|
4063
|
+
/** Payment has been refunded */
|
|
4064
|
+
REFUNDED = "REFUNDED",
|
|
4065
|
+
/** Recurring payment has failed */
|
|
4066
|
+
FAILED = "FAILED",
|
|
4067
|
+
/** Payment has not been paid */
|
|
4068
|
+
UNPAID = "UNPAID",
|
|
4069
|
+
/** Billing has been initialized, but actual charge is yet to be made. Can happen for free trial and PayPal */
|
|
4070
|
+
PENDING = "PENDING"
|
|
4071
|
+
}
|
|
4072
|
+
/** @enumType */
|
|
4073
|
+
type PaymentStatusEnumPaymentStatusWithLiterals = PaymentStatusEnumPaymentStatus | 'UNDEFINED' | 'PAID' | 'REFUNDED' | 'FAILED' | 'UNPAID' | 'PENDING';
|
|
4074
|
+
/**
|
|
4075
|
+
* Recurring payment is described by `frequency` (day, week, month) and `interval`.
|
|
4076
|
+
*
|
|
4077
|
+
* For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.
|
|
4078
|
+
*
|
|
4079
|
+
* In some cases there should be a trial period for the order, after which payments start to occur.
|
|
4080
|
+
* Trial period is also defined as `frequency` and `interval` pair.
|
|
4081
|
+
*
|
|
4082
|
+
* So one can define a monthly 'subscription' with a 14 days trial period.
|
|
4083
|
+
*/
|
|
4084
|
+
interface V2Subscription {
|
|
4085
|
+
/** frequency of recurring payment (required) */
|
|
4086
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
4087
|
+
/** interval of recurring payment (required) */
|
|
4088
|
+
interval?: number;
|
|
4089
|
+
/** trial period for recurring payment (optional) */
|
|
4090
|
+
trial?: SubscriptionTrialPeriod;
|
|
4091
|
+
/**
|
|
4092
|
+
* how many billing cycles should be done before subscription finishes
|
|
4093
|
+
* (optional, 0 by default means endless subscription)
|
|
4094
|
+
*/
|
|
4095
|
+
billingCycles?: number;
|
|
4096
|
+
/**
|
|
4097
|
+
* date in the future or in the past when the first billing cycle begins
|
|
4098
|
+
* (the first off-session payment is performed when it ends)
|
|
4099
|
+
*/
|
|
4100
|
+
firstCycleStartDate?: Date | null;
|
|
4101
|
+
}
|
|
4102
|
+
/** Frequency unit of recurring payment */
|
|
4103
|
+
declare enum SubscriptionFrequency {
|
|
4104
|
+
UNDEFINED = "UNDEFINED",
|
|
4105
|
+
DAY = "DAY",
|
|
4106
|
+
WEEK = "WEEK",
|
|
4107
|
+
MONTH = "MONTH",
|
|
4108
|
+
YEAR = "YEAR"
|
|
4109
|
+
}
|
|
4110
|
+
/** @enumType */
|
|
4111
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
4112
|
+
/** Trial period of subscription */
|
|
4113
|
+
interface SubscriptionTrialPeriod {
|
|
4114
|
+
/** trial period in units (required) */
|
|
4115
|
+
period?: number;
|
|
4116
|
+
/** units in which trial period is described (optional, default DAY) */
|
|
4117
|
+
unit?: SubscriptionFrequencyWithLiterals;
|
|
4118
|
+
}
|
|
4119
|
+
declare enum CancellationInitiator {
|
|
4120
|
+
/** Cancellation initiator undefined */
|
|
4121
|
+
UNDEFINED = "UNDEFINED",
|
|
4122
|
+
/** Subscription was canceled by site owner (default if canceled by user or service identity) */
|
|
4123
|
+
OWNER = "OWNER",
|
|
4124
|
+
/** Subscription was canceled by member (default if canceled by member identity) */
|
|
4125
|
+
MEMBER = "MEMBER",
|
|
4126
|
+
/** Subscription was canceled because of payment failure */
|
|
4127
|
+
PAYMENT_FAILURE = "PAYMENT_FAILURE",
|
|
4128
|
+
/** Subscription was canceled because of payment setup failure */
|
|
4129
|
+
SETUP_FAILURE = "SETUP_FAILURE"
|
|
4130
|
+
}
|
|
4131
|
+
/** @enumType */
|
|
4132
|
+
type CancellationInitiatorWithLiterals = CancellationInitiator | 'UNDEFINED' | 'OWNER' | 'MEMBER' | 'PAYMENT_FAILURE' | 'SETUP_FAILURE';
|
|
4133
|
+
interface SubscriptionPolicy {
|
|
4134
|
+
/** Subscription expiration date can be updated */
|
|
4135
|
+
expiryDateChangeable?: boolean;
|
|
4136
|
+
/** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
|
|
4137
|
+
cancellableByMember?: boolean;
|
|
4138
|
+
/** Subscription expiration date on cancellation can be set to next payment date */
|
|
4139
|
+
cancellableAtNextPaymentCycle?: boolean;
|
|
4140
|
+
}
|
|
4141
|
+
interface Suspension {
|
|
4142
|
+
status?: StatusWithLiterals;
|
|
4143
|
+
/** Beginning of the suspended period */
|
|
4144
|
+
startsAt?: Date | null;
|
|
4145
|
+
/** End of the suspended period */
|
|
4146
|
+
endsAt?: Date | null;
|
|
4147
|
+
}
|
|
4148
|
+
declare enum Status {
|
|
4149
|
+
UNDEFINED = "UNDEFINED",
|
|
4150
|
+
ACTIVE = "ACTIVE",
|
|
4151
|
+
ENDED = "ENDED"
|
|
4152
|
+
}
|
|
4153
|
+
/** @enumType */
|
|
4154
|
+
type StatusWithLiterals = Status | 'UNDEFINED' | 'ACTIVE' | 'ENDED';
|
|
4155
|
+
/** A duration expressed in amount of time units. */
|
|
4156
|
+
interface V1Duration {
|
|
4157
|
+
/** Amount of the unit */
|
|
4158
|
+
amount?: number;
|
|
4159
|
+
/** Day, Week, Month, Year. */
|
|
4160
|
+
unit?: SubscriptionFrequencyWithLiterals;
|
|
4161
|
+
}
|
|
4162
|
+
interface V1SubscriptionActivated {
|
|
4163
|
+
subscription?: V1Subscription;
|
|
4164
|
+
}
|
|
4165
|
+
interface V1SubscriptionCanceled {
|
|
4166
|
+
subscription?: V1Subscription;
|
|
4167
|
+
}
|
|
4168
|
+
interface V1SubscriptionUpdated {
|
|
4169
|
+
subscription?: V1Subscription;
|
|
4170
|
+
}
|
|
4171
|
+
interface SubscriptionCycleTriggered {
|
|
4172
|
+
subscription?: V1Subscription;
|
|
4173
|
+
billingCycle?: number;
|
|
4174
|
+
/**
|
|
4175
|
+
* Wix Pay transaction id, optional. Exists if event was triggered by a payment.
|
|
4176
|
+
* @format GUID
|
|
4177
|
+
*/
|
|
4178
|
+
transactionId?: string | null;
|
|
4179
|
+
}
|
|
4180
|
+
interface SubscriptionMarkedAsPaid {
|
|
4181
|
+
subscription?: V1Subscription;
|
|
4182
|
+
/** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
|
|
4183
|
+
billingCycle?: number | null;
|
|
4184
|
+
}
|
|
4185
|
+
interface SubscriptionCancellationRequested {
|
|
4186
|
+
subscription?: V1Subscription;
|
|
4187
|
+
}
|
|
4188
|
+
interface SubscriptionSuspended {
|
|
4189
|
+
subscription?: V1Subscription;
|
|
4190
|
+
}
|
|
4191
|
+
interface V1SubscriptionResumed {
|
|
4192
|
+
subscription?: V1Subscription;
|
|
4193
|
+
}
|
|
4194
|
+
interface SubscriptionExpired {
|
|
4195
|
+
subscription?: V1Subscription;
|
|
4196
|
+
}
|
|
4197
|
+
interface V1SubscriptionInitialPurchaseCompleted {
|
|
4198
|
+
subscription?: V1Subscription;
|
|
4199
|
+
}
|
|
4200
|
+
interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
|
|
4201
|
+
activeSubscription?: CreateSubscriptionRequest;
|
|
4202
|
+
}
|
|
4203
|
+
/** @oneof */
|
|
4204
|
+
interface CreateSubscriptionInStateRequestModeOneOf {
|
|
4205
|
+
activeSubscription?: CreateSubscriptionRequest;
|
|
4206
|
+
}
|
|
4207
|
+
interface CreateSubscriptionInStateResponse {
|
|
4208
|
+
/** @format GUID */
|
|
4209
|
+
subscriptionId?: string;
|
|
4210
|
+
}
|
|
4211
|
+
interface PayCycleRequest {
|
|
4212
|
+
/** @format GUID */
|
|
4213
|
+
subscriptionId?: string;
|
|
4214
|
+
paymentTestMode?: PaymentTestModeWithLiterals;
|
|
4215
|
+
/** @format GUID */
|
|
4216
|
+
tenantId?: string;
|
|
4217
|
+
}
|
|
4218
|
+
declare enum PaymentTestMode {
|
|
4219
|
+
REGULAR = "REGULAR",
|
|
4220
|
+
FAIL_TECHNICAL = "FAIL_TECHNICAL",
|
|
4221
|
+
FAIL_DECLINE = "FAIL_DECLINE",
|
|
4222
|
+
FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
|
|
4223
|
+
}
|
|
4224
|
+
/** @enumType */
|
|
4225
|
+
type PaymentTestModeWithLiterals = PaymentTestMode | 'REGULAR' | 'FAIL_TECHNICAL' | 'FAIL_DECLINE' | 'FAIL_RETRYABLE_DECLINE';
|
|
4226
|
+
interface PayCycleResponse {
|
|
4227
|
+
/** @format GUID */
|
|
4228
|
+
invoiceId?: string;
|
|
4229
|
+
/** @format GUID */
|
|
4230
|
+
paymentOrderId?: string | null;
|
|
4231
|
+
subscription?: Subscription;
|
|
4232
|
+
}
|
|
4233
|
+
interface GetFullSubscriptionDataRequest {
|
|
4234
|
+
/** @format GUID */
|
|
4235
|
+
id?: string;
|
|
4236
|
+
}
|
|
4237
|
+
interface GetFullSubscriptionDataResponse {
|
|
4238
|
+
subscription?: Subscription;
|
|
4239
|
+
internalSubscriptionData?: InternalSubscriptionData;
|
|
4240
|
+
}
|
|
4241
|
+
interface InternalSubscriptionData {
|
|
4242
|
+
/** @format GUID */
|
|
4243
|
+
originInstanceId?: string;
|
|
4244
|
+
source?: string | null;
|
|
4245
|
+
billingType?: string;
|
|
4246
|
+
isOneTime?: boolean;
|
|
4247
|
+
migrationDetails?: MigrationDetails;
|
|
4248
|
+
pausePaidDuration?: string | null;
|
|
4249
|
+
authorizationPaymentData?: PaymentData;
|
|
4250
|
+
currentCyclePausePeriods?: PausePeriod[];
|
|
4251
|
+
}
|
|
4252
|
+
interface MigrationDetails {
|
|
4253
|
+
/** system (application) where the Subscription has been created */
|
|
4254
|
+
originSystem?: string;
|
|
4255
|
+
/** date when the Subscription started to be managed in BASS */
|
|
4256
|
+
shiftManagementDate?: Date | null;
|
|
4257
|
+
}
|
|
4258
|
+
interface PausePeriod {
|
|
4259
|
+
startDate?: Date | null;
|
|
4260
|
+
endDate?: Date | null;
|
|
4261
|
+
}
|
|
4262
|
+
interface GetSubscriptionAndInternalDataRequest {
|
|
4263
|
+
/** @format GUID */
|
|
4264
|
+
subscriptionId?: string;
|
|
4265
|
+
/** @format GUID */
|
|
4266
|
+
tenantId?: string;
|
|
4267
|
+
}
|
|
4268
|
+
interface GetSubscriptionAndInternalDataResponse {
|
|
4269
|
+
subscription?: Subscription;
|
|
4270
|
+
internalSubscriptionData?: InternalSubscriptionData;
|
|
4271
|
+
}
|
|
4272
|
+
interface SearchSubscriptionRequest {
|
|
4273
|
+
/** @format GUID */
|
|
4274
|
+
id?: string;
|
|
4275
|
+
/** @format GUID */
|
|
4276
|
+
tenantId?: string;
|
|
4277
|
+
}
|
|
4278
|
+
interface SearchSubscriptionResponse {
|
|
4279
|
+
subscription?: Subscription;
|
|
4280
|
+
}
|
|
4281
|
+
interface UpdatePausePaidDurationRequest {
|
|
4282
|
+
/** @format GUID */
|
|
4283
|
+
subscriptionId?: string;
|
|
4284
|
+
/**
|
|
4285
|
+
* @min 1
|
|
4286
|
+
* @max 10000000
|
|
4287
|
+
*/
|
|
4288
|
+
pausePaidDurationSeconds?: string;
|
|
4289
|
+
/** @format GUID */
|
|
4290
|
+
tenantId?: string;
|
|
4291
|
+
}
|
|
4292
|
+
interface UpdatePausePaidDurationResponse {
|
|
4293
|
+
}
|
|
4294
|
+
interface UpdateStatusRequest {
|
|
4295
|
+
/** @format GUID */
|
|
4296
|
+
subscriptionId?: string;
|
|
4297
|
+
/** @format GUID */
|
|
4298
|
+
tenantId?: string;
|
|
4299
|
+
status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
|
|
4300
|
+
}
|
|
4301
|
+
interface UpdateStatusResponse {
|
|
4302
|
+
subscription?: Subscription;
|
|
4303
|
+
}
|
|
4304
|
+
interface UpdatePaymentStatusRequest {
|
|
4305
|
+
/** @format GUID */
|
|
4306
|
+
subscriptionId?: string;
|
|
4307
|
+
/** @format GUID */
|
|
4308
|
+
tenantId?: string;
|
|
4309
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
4310
|
+
}
|
|
4311
|
+
interface UpdatePaymentStatusResponse {
|
|
4312
|
+
subscription?: Subscription;
|
|
4313
|
+
}
|
|
4314
|
+
interface RemoveCancellationInfoRequest {
|
|
4315
|
+
/** @format GUID */
|
|
4316
|
+
subscriptionId?: string;
|
|
4317
|
+
/** @format GUID */
|
|
4318
|
+
tenantId?: string;
|
|
4319
|
+
}
|
|
4320
|
+
interface RemoveCancellationInfoResponse {
|
|
4321
|
+
subscription?: Subscription;
|
|
4322
|
+
}
|
|
4323
|
+
interface RemovePauseInfoRequest {
|
|
4324
|
+
/** @format GUID */
|
|
4325
|
+
subscriptionId?: string;
|
|
4326
|
+
/** @format GUID */
|
|
4327
|
+
tenantId?: string;
|
|
4328
|
+
}
|
|
4329
|
+
interface RemovePauseInfoResponse {
|
|
4330
|
+
subscription?: Subscription;
|
|
4331
|
+
}
|
|
4332
|
+
interface ReviveSubscriptionRequest {
|
|
4333
|
+
/** @format GUID */
|
|
4334
|
+
tenantId?: string;
|
|
4335
|
+
/** @format GUID */
|
|
4336
|
+
subscriptionId?: string;
|
|
4337
|
+
revivePolicy?: RevivePolicyWithLiterals;
|
|
4338
|
+
isTestRun?: boolean;
|
|
4339
|
+
}
|
|
4340
|
+
declare enum RevivePolicy {
|
|
4341
|
+
SIMPLE = "SIMPLE",
|
|
4342
|
+
RESUME = "RESUME"
|
|
4343
|
+
}
|
|
4344
|
+
/** @enumType */
|
|
4345
|
+
type RevivePolicyWithLiterals = RevivePolicy | 'SIMPLE' | 'RESUME';
|
|
4346
|
+
interface ReviveSubscriptionResponse {
|
|
4347
|
+
subscription?: Subscription;
|
|
4348
|
+
}
|
|
4349
|
+
interface ConvertSapiRequest {
|
|
4350
|
+
/** @format GUID */
|
|
4351
|
+
subscriptionId?: string;
|
|
4352
|
+
}
|
|
4353
|
+
interface ConvertSapiResponse {
|
|
4354
|
+
subscription?: Subscription;
|
|
4355
|
+
}
|
|
4356
|
+
interface GetSubscriptionInvoicesRequest {
|
|
4357
|
+
/** @format GUID */
|
|
4358
|
+
id?: string;
|
|
4359
|
+
}
|
|
4360
|
+
interface GetSubscriptionInvoicesResponse {
|
|
4361
|
+
invoices?: SubscriptionInvoice[];
|
|
4362
|
+
}
|
|
4363
|
+
interface SubscriptionInvoice {
|
|
4364
|
+
/** @format GUID */
|
|
4365
|
+
id?: string;
|
|
4366
|
+
subscriptionCycle?: number;
|
|
4367
|
+
createdDate?: Date | null;
|
|
4368
|
+
}
|
|
4369
|
+
interface FinishFreeTrialNowRequest {
|
|
4370
|
+
/** @format GUID */
|
|
4371
|
+
subscriptionId?: string;
|
|
4372
|
+
/** @format GUID */
|
|
4373
|
+
tenantId?: string;
|
|
4374
|
+
}
|
|
4375
|
+
interface FinishFreeTrialNowResponse {
|
|
4376
|
+
subscription?: Subscription;
|
|
4377
|
+
}
|
|
4378
|
+
interface FixSubscriptionTimeCapsuleTasksRequest {
|
|
4379
|
+
/** @format GUID */
|
|
4380
|
+
subscriptionId?: string;
|
|
4381
|
+
/** @format GUID */
|
|
4382
|
+
tenantId?: string;
|
|
4383
|
+
}
|
|
4384
|
+
interface FixSubscriptionTimeCapsuleTasksResponse {
|
|
4385
|
+
}
|
|
4386
|
+
interface SendTimeCapsuleTaskCanceledBIRequest {
|
|
4387
|
+
/** @format GUID */
|
|
4388
|
+
tenantId?: string;
|
|
4389
|
+
/** @format GUID */
|
|
4390
|
+
subscriptionId?: string;
|
|
4391
|
+
/** @minLength 1 */
|
|
4392
|
+
taskType?: string;
|
|
4393
|
+
}
|
|
4394
|
+
interface ScheduleTimeCapsuleTaskRequest {
|
|
4395
|
+
/** @format GUID */
|
|
4396
|
+
subscriptionId?: string;
|
|
4397
|
+
/** @minLength 1 */
|
|
4398
|
+
taskType?: string;
|
|
4399
|
+
executionTime?: Date | null;
|
|
4400
|
+
/** @format GUID */
|
|
4401
|
+
tenantId?: string;
|
|
4402
|
+
}
|
|
4403
|
+
interface CancelTimeCapsuleTaskRequest {
|
|
4404
|
+
/** @format GUID */
|
|
4405
|
+
tenantId?: string;
|
|
4406
|
+
/** @format GUID */
|
|
4407
|
+
subscriptionId?: string;
|
|
4408
|
+
/** @minLength 1 */
|
|
4409
|
+
taskType?: string;
|
|
4410
|
+
}
|
|
4411
|
+
interface UpdateFullSubscriptionRequest {
|
|
4412
|
+
/** @format GUID */
|
|
4413
|
+
tenantId?: string;
|
|
4414
|
+
subscription?: Subscription;
|
|
4415
|
+
}
|
|
4416
|
+
interface UpdateFullSubscriptionResponse {
|
|
4417
|
+
subscription?: Subscription;
|
|
4418
|
+
}
|
|
4419
|
+
interface PatchSubscriptionRequest {
|
|
4420
|
+
/**
|
|
4421
|
+
* Tenant ID (instance ID) of the subscription
|
|
4422
|
+
* @format GUID
|
|
4423
|
+
*/
|
|
4424
|
+
tenantId?: string;
|
|
4425
|
+
/**
|
|
4426
|
+
* Subscription ID to patch
|
|
4427
|
+
* @format GUID
|
|
4428
|
+
*/
|
|
4429
|
+
subscriptionId?: string;
|
|
4430
|
+
/** Partial subscription with updated values */
|
|
4431
|
+
subscription?: Subscription;
|
|
4432
|
+
/** Fields to update (e.g., "name", "billing_settings.collection_method") */
|
|
4433
|
+
fieldMask?: string[];
|
|
4434
|
+
}
|
|
4435
|
+
interface PatchSubscriptionResponse {
|
|
4436
|
+
/** The updated subscription */
|
|
4437
|
+
subscription?: Subscription;
|
|
4438
|
+
}
|
|
4439
|
+
interface UpdateSubscriptionInvoiceCycleRequest {
|
|
4440
|
+
/** @format GUID */
|
|
4441
|
+
subscriptionId?: string;
|
|
4442
|
+
/** @format GUID */
|
|
4443
|
+
tenantId?: string;
|
|
4444
|
+
/** @format GUID */
|
|
4445
|
+
invoiceId?: string;
|
|
4446
|
+
subscriptionCycle?: number;
|
|
4447
|
+
}
|
|
4448
|
+
interface UpdateSubscriptionInvoiceCycleResponse {
|
|
4449
|
+
subscriptionInvoice?: SubscriptionInvoice;
|
|
4450
|
+
}
|
|
4451
|
+
interface AddPausePeriodRequest {
|
|
4452
|
+
/** @format GUID */
|
|
4453
|
+
tenantId?: string;
|
|
4454
|
+
/** @format GUID */
|
|
4455
|
+
subscriptionId?: string;
|
|
4456
|
+
pauseStartDate?: Date | null;
|
|
4457
|
+
pauseEndDate?: Date | null;
|
|
4458
|
+
}
|
|
4459
|
+
interface AddPausePeriodResponse {
|
|
4460
|
+
subscription?: Subscription;
|
|
4461
|
+
}
|
|
4462
|
+
interface RunTimeCapsuleTaskNowRequest {
|
|
4463
|
+
/** @format GUID */
|
|
4464
|
+
tenantId?: string;
|
|
4465
|
+
/** @format GUID */
|
|
4466
|
+
subscriptionId?: string;
|
|
4467
|
+
/** @minLength 1 */
|
|
4468
|
+
taskType?: string;
|
|
4469
|
+
}
|
|
4470
|
+
interface CreateRecurringInvoiceBORequest {
|
|
4471
|
+
/** @format GUID */
|
|
4472
|
+
subscriptionId?: string;
|
|
4473
|
+
/** @format GUID */
|
|
4474
|
+
tenantId?: string;
|
|
4475
|
+
/** @min 2 */
|
|
4476
|
+
cycleNumber?: number;
|
|
4477
|
+
}
|
|
4478
|
+
interface CreateRecurringInvoiceBOResponse {
|
|
4479
|
+
invoiceId?: string;
|
|
4480
|
+
}
|
|
4481
|
+
interface SetShiftingDataRequest {
|
|
4482
|
+
/** @format GUID */
|
|
4483
|
+
subscriptionId?: string;
|
|
4484
|
+
/** @format GUID */
|
|
4485
|
+
tenantId?: string;
|
|
4486
|
+
isBassManaged?: boolean;
|
|
4487
|
+
shiftManagementDate?: Date | null;
|
|
4488
|
+
}
|
|
4489
|
+
interface SetShiftingDataResponse {
|
|
4490
|
+
subscription?: Subscription;
|
|
4491
|
+
}
|
|
4492
|
+
interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
|
|
4493
|
+
attachInvoice?: AttachInvoice;
|
|
4494
|
+
detachInvoice?: DetachInvoice;
|
|
4495
|
+
/** @format GUID */
|
|
4496
|
+
tenantId?: string;
|
|
4497
|
+
/** @format GUID */
|
|
4498
|
+
subscriptionId?: string;
|
|
4499
|
+
}
|
|
4500
|
+
/** @oneof */
|
|
4501
|
+
interface FixSubscriptionInvoicesRequestModeOneOf {
|
|
4502
|
+
attachInvoice?: AttachInvoice;
|
|
4503
|
+
detachInvoice?: DetachInvoice;
|
|
4504
|
+
}
|
|
4505
|
+
interface AttachInvoice {
|
|
4506
|
+
/** @format GUID */
|
|
4507
|
+
invoiceId?: string;
|
|
4508
|
+
}
|
|
4509
|
+
interface DetachInvoice {
|
|
4510
|
+
/** @format GUID */
|
|
4511
|
+
invoiceId?: string;
|
|
4512
|
+
}
|
|
4513
|
+
interface FixSubscriptionInvoicesResponse {
|
|
4514
|
+
invoices?: SubscriptionInvoice[];
|
|
4515
|
+
}
|
|
4516
|
+
interface RestoreDraftSubscriptionRequest {
|
|
4517
|
+
/** @format GUID */
|
|
4518
|
+
tenantId?: string;
|
|
4519
|
+
/** @format GUID */
|
|
4520
|
+
subscriptionId?: string;
|
|
4521
|
+
}
|
|
4522
|
+
interface RestoreDraftSubscriptionResponse {
|
|
4523
|
+
subscription?: Subscription;
|
|
4524
|
+
}
|
|
4525
|
+
interface DeleteDraftSubscriptionRequest {
|
|
4526
|
+
/** @format GUID */
|
|
4527
|
+
tenantId?: string;
|
|
4528
|
+
/** @format GUID */
|
|
4529
|
+
subscriptionId?: string;
|
|
4530
|
+
}
|
|
4531
|
+
interface DeleteDraftSubscriptionResponse {
|
|
4532
|
+
subscription?: Subscription;
|
|
4533
|
+
}
|
|
4534
|
+
interface DeleteSubscriptionBORequest {
|
|
4535
|
+
/** @format GUID */
|
|
4536
|
+
tenantId?: string;
|
|
4537
|
+
/** @format GUID */
|
|
4538
|
+
subscriptionId?: string;
|
|
4539
|
+
}
|
|
4540
|
+
interface DeleteSubscriptionBOResponse {
|
|
4541
|
+
subscription?: Subscription;
|
|
4222
4542
|
}
|
|
4223
|
-
|
|
4224
|
-
|
|
4225
|
-
|
|
4226
|
-
/**
|
|
4227
|
-
|
|
4228
|
-
|
|
4229
|
-
|
|
4230
|
-
/** Subscription has been paid for, but the start date is in the future */
|
|
4231
|
-
PENDING = "PENDING",
|
|
4232
|
-
/** Subscription is active */
|
|
4233
|
-
ACTIVE = "ACTIVE",
|
|
4234
|
-
/** Subscription has expired */
|
|
4235
|
-
EXPIRED = "EXPIRED",
|
|
4236
|
-
/** Subscription has been canceled */
|
|
4237
|
-
CANCELED = "CANCELED",
|
|
4238
|
-
/** Subscription has been set to be canceled at a future date */
|
|
4239
|
-
PENDING_CANCELLATION = "PENDING_CANCELLATION",
|
|
4240
|
-
/** Subscription is suspended */
|
|
4241
|
-
SUSPENDED = "SUSPENDED"
|
|
4543
|
+
interface CancelSubscriptionBORequest {
|
|
4544
|
+
/** @format GUID */
|
|
4545
|
+
tenantId?: string;
|
|
4546
|
+
/** @format GUID */
|
|
4547
|
+
subscriptionId?: string;
|
|
4548
|
+
initiator?: ActionInitiatorWithLiterals;
|
|
4549
|
+
reason?: string | null;
|
|
4242
4550
|
}
|
|
4243
|
-
|
|
4244
|
-
|
|
4245
|
-
declare enum PaymentStatusEnumPaymentStatus {
|
|
4246
|
-
/** Payment status undefined */
|
|
4247
|
-
UNDEFINED = "UNDEFINED",
|
|
4248
|
-
/** Payment has been paid */
|
|
4249
|
-
PAID = "PAID",
|
|
4250
|
-
/** Payment has been refunded */
|
|
4251
|
-
REFUNDED = "REFUNDED",
|
|
4252
|
-
/** Recurring payment has failed */
|
|
4253
|
-
FAILED = "FAILED",
|
|
4254
|
-
/** Payment has not been paid */
|
|
4255
|
-
UNPAID = "UNPAID",
|
|
4256
|
-
/** Billing has been initialized, but actual charge is yet to be made. Can happen for free trial and PayPal */
|
|
4257
|
-
PENDING = "PENDING"
|
|
4551
|
+
interface CancelSubscriptionBOResponse {
|
|
4552
|
+
subscription?: Subscription;
|
|
4258
4553
|
}
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
|
|
4262
|
-
|
|
4263
|
-
|
|
4264
|
-
|
|
4265
|
-
|
|
4266
|
-
* In some cases there should be a trial period for the order, after which payments start to occur.
|
|
4267
|
-
* Trial period is also defined as `frequency` and `interval` pair.
|
|
4268
|
-
*
|
|
4269
|
-
* So one can define a monthly 'subscription' with a 14 days trial period.
|
|
4270
|
-
*/
|
|
4271
|
-
interface V2Subscription {
|
|
4272
|
-
/** frequency of recurring payment (required) */
|
|
4273
|
-
frequency?: SubscriptionFrequencyWithLiterals;
|
|
4274
|
-
/** interval of recurring payment (required) */
|
|
4275
|
-
interval?: number;
|
|
4276
|
-
/** trial period for recurring payment (optional) */
|
|
4277
|
-
trial?: SubscriptionTrialPeriod;
|
|
4278
|
-
/**
|
|
4279
|
-
* how many billing cycles should be done before subscription finishes
|
|
4280
|
-
* (optional, 0 by default means endless subscription)
|
|
4281
|
-
*/
|
|
4282
|
-
billingCycles?: number;
|
|
4283
|
-
/**
|
|
4284
|
-
* date in the future or in the past when the first billing cycle begins
|
|
4285
|
-
* (the first off-session payment is performed when it ends)
|
|
4286
|
-
*/
|
|
4287
|
-
firstCycleStartDate?: Date | null;
|
|
4554
|
+
interface UpdatePaymentMethodBORequest {
|
|
4555
|
+
/** @format GUID */
|
|
4556
|
+
tenantId?: string;
|
|
4557
|
+
/** @format GUID */
|
|
4558
|
+
subscriptionId?: string;
|
|
4559
|
+
/** @format GUID */
|
|
4560
|
+
paymentMethodId?: string;
|
|
4288
4561
|
}
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
UNDEFINED = "UNDEFINED",
|
|
4292
|
-
DAY = "DAY",
|
|
4293
|
-
WEEK = "WEEK",
|
|
4294
|
-
MONTH = "MONTH",
|
|
4295
|
-
YEAR = "YEAR"
|
|
4562
|
+
interface UpdatePaymentMethodBOResponse {
|
|
4563
|
+
subscription?: Subscription;
|
|
4296
4564
|
}
|
|
4297
|
-
|
|
4298
|
-
|
|
4299
|
-
/**
|
|
4300
|
-
|
|
4301
|
-
/**
|
|
4302
|
-
|
|
4303
|
-
/** units in which trial period is described (optional, default DAY) */
|
|
4304
|
-
unit?: SubscriptionFrequencyWithLiterals;
|
|
4565
|
+
interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
|
|
4566
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
4567
|
+
/** @format GUID */
|
|
4568
|
+
tenantId?: string;
|
|
4569
|
+
/** @format GUID */
|
|
4570
|
+
subscriptionId?: string;
|
|
4305
4571
|
}
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
|
|
4309
|
-
/** Subscription was canceled by site owner (default if canceled by user or service identity) */
|
|
4310
|
-
OWNER = "OWNER",
|
|
4311
|
-
/** Subscription was canceled by member (default if canceled by member identity) */
|
|
4312
|
-
MEMBER = "MEMBER",
|
|
4313
|
-
/** Subscription was canceled because of payment failure */
|
|
4314
|
-
PAYMENT_FAILURE = "PAYMENT_FAILURE",
|
|
4315
|
-
/** Subscription was canceled because of payment setup failure */
|
|
4316
|
-
SETUP_FAILURE = "SETUP_FAILURE"
|
|
4572
|
+
/** @oneof */
|
|
4573
|
+
interface SendSubscriptionActionEventBORequestEventOneOf {
|
|
4574
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
4317
4575
|
}
|
|
4318
|
-
|
|
4319
|
-
type CancellationInitiatorWithLiterals = CancellationInitiator | 'UNDEFINED' | 'OWNER' | 'MEMBER' | 'PAYMENT_FAILURE' | 'SETUP_FAILURE';
|
|
4320
|
-
interface SubscriptionPolicy {
|
|
4321
|
-
/** Subscription expiration date can be updated */
|
|
4322
|
-
expiryDateChangeable?: boolean;
|
|
4323
|
-
/** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
|
|
4324
|
-
cancellableByMember?: boolean;
|
|
4325
|
-
/** Subscription expiration date on cancellation can be set to next payment date */
|
|
4326
|
-
cancellableAtNextPaymentCycle?: boolean;
|
|
4576
|
+
interface SendSubscriptionActionEventResponse {
|
|
4327
4577
|
}
|
|
4328
|
-
interface
|
|
4329
|
-
|
|
4330
|
-
|
|
4331
|
-
|
|
4332
|
-
|
|
4333
|
-
|
|
4578
|
+
interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
|
|
4579
|
+
/** @format GUID */
|
|
4580
|
+
tenantId?: string;
|
|
4581
|
+
/** @format GUID */
|
|
4582
|
+
subscriptionId?: string;
|
|
4583
|
+
transactionId?: string;
|
|
4334
4584
|
}
|
|
4335
|
-
|
|
4336
|
-
|
|
4337
|
-
|
|
4338
|
-
|
|
4585
|
+
interface PauseSubscriptionBORequest {
|
|
4586
|
+
/** @format GUID */
|
|
4587
|
+
tenantId?: string;
|
|
4588
|
+
/** @format GUID */
|
|
4589
|
+
subscriptionId?: string;
|
|
4590
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
4591
|
+
pauseAt?: PauseAtWithLiterals;
|
|
4592
|
+
initiator?: ActionInitiatorWithLiterals;
|
|
4593
|
+
/** @maxLength 500 */
|
|
4594
|
+
reason?: string | null;
|
|
4339
4595
|
}
|
|
4340
|
-
|
|
4341
|
-
|
|
4342
|
-
/** A duration expressed in amount of time units. */
|
|
4343
|
-
interface V1Duration {
|
|
4344
|
-
/** Amount of the unit */
|
|
4345
|
-
amount?: number;
|
|
4346
|
-
/** Day, Week, Month, Year. */
|
|
4347
|
-
unit?: SubscriptionFrequencyWithLiterals;
|
|
4596
|
+
interface PauseSubscriptionBOResponse {
|
|
4597
|
+
subscription?: Subscription;
|
|
4348
4598
|
}
|
|
4349
|
-
interface
|
|
4350
|
-
|
|
4599
|
+
interface FixSubscriptionInvoicesConsistencyRequest {
|
|
4600
|
+
/** @format GUID */
|
|
4601
|
+
tenantId?: string;
|
|
4602
|
+
/** @format GUID */
|
|
4603
|
+
subscriptionId?: string;
|
|
4351
4604
|
}
|
|
4352
|
-
interface
|
|
4353
|
-
subscription?: V1Subscription;
|
|
4605
|
+
interface FixSubscriptionInvoicesConsistencyResponse {
|
|
4354
4606
|
}
|
|
4355
|
-
interface
|
|
4356
|
-
|
|
4607
|
+
interface FixSubscriptionPaymentStatusRequest {
|
|
4608
|
+
/** @format GUID */
|
|
4609
|
+
tenantId?: string;
|
|
4610
|
+
/** @format GUID */
|
|
4611
|
+
subscriptionId?: string;
|
|
4612
|
+
/** When true, verify and report the would-be fix without mutating anything. */
|
|
4613
|
+
dryRun?: boolean;
|
|
4357
4614
|
}
|
|
4358
|
-
interface
|
|
4359
|
-
subscription
|
|
4360
|
-
|
|
4615
|
+
interface FixSubscriptionPaymentStatusResponse {
|
|
4616
|
+
/** The invoice is PAID but the (DRAFT) subscription never processed the paid event. */
|
|
4617
|
+
mismatchDetected?: boolean;
|
|
4618
|
+
/** A real mismatch was found and the invoice-paid activation was re-driven (always false in dry-run). */
|
|
4619
|
+
fixed?: boolean;
|
|
4361
4620
|
/**
|
|
4362
|
-
*
|
|
4363
|
-
* @
|
|
4621
|
+
* Subscription status after the re-drive (ACTIVE / PENDING); in dry-run, the predicted status; "" when no fix ran.
|
|
4622
|
+
* @maxLength 50
|
|
4364
4623
|
*/
|
|
4365
|
-
|
|
4366
|
-
|
|
4367
|
-
|
|
4368
|
-
|
|
4369
|
-
|
|
4370
|
-
|
|
4371
|
-
}
|
|
4372
|
-
interface SubscriptionCancellationRequested {
|
|
4373
|
-
subscription?: V1Subscription;
|
|
4624
|
+
resultingStatus?: string;
|
|
4625
|
+
/**
|
|
4626
|
+
* Human-readable summary of the decision and action.
|
|
4627
|
+
* @maxLength 500
|
|
4628
|
+
*/
|
|
4629
|
+
detail?: string;
|
|
4374
4630
|
}
|
|
4375
|
-
interface
|
|
4376
|
-
|
|
4631
|
+
interface UpdateSubscriptionCurrencyRequest {
|
|
4632
|
+
/**
|
|
4633
|
+
* Tenant ID (instance ID) of the subscription
|
|
4634
|
+
* @format GUID
|
|
4635
|
+
*/
|
|
4636
|
+
tenantId?: string;
|
|
4637
|
+
/**
|
|
4638
|
+
* Subscription ID to update currency for
|
|
4639
|
+
* @format GUID
|
|
4640
|
+
*/
|
|
4641
|
+
subscriptionId?: string;
|
|
4642
|
+
/**
|
|
4643
|
+
* New currency code (e.g., "USD", "EUR") - ISO 4217 format
|
|
4644
|
+
* @format CURRENCY
|
|
4645
|
+
*/
|
|
4646
|
+
newCurrency?: string;
|
|
4647
|
+
/**
|
|
4648
|
+
* Exchange rate from current currency to new currency (newAmount = oldAmount * exchangeRate)
|
|
4649
|
+
* @decimalValue options { gt:0.00, maxScale:6 }
|
|
4650
|
+
*/
|
|
4651
|
+
exchangeRate?: string;
|
|
4377
4652
|
}
|
|
4378
|
-
interface
|
|
4379
|
-
subscription
|
|
4653
|
+
interface UpdateSubscriptionCurrencyResponse {
|
|
4654
|
+
/** The updated subscription with new currency and converted amounts */
|
|
4655
|
+
subscription?: Subscription;
|
|
4380
4656
|
}
|
|
4381
|
-
interface
|
|
4382
|
-
|
|
4657
|
+
interface UpdateSubscriptionPlatformOriginRequest {
|
|
4658
|
+
/**
|
|
4659
|
+
* Subscription ID to update platform origin for
|
|
4660
|
+
* @format GUID
|
|
4661
|
+
*/
|
|
4662
|
+
subscriptionId?: string;
|
|
4663
|
+
/**
|
|
4664
|
+
* Tenant ID (instance ID) of the subscription
|
|
4665
|
+
* @format GUID
|
|
4666
|
+
*/
|
|
4667
|
+
tenantId?: string;
|
|
4668
|
+
/** New platform origin (appId and entityId) */
|
|
4669
|
+
platformOrigin?: PlatformOrigin;
|
|
4383
4670
|
}
|
|
4384
|
-
interface
|
|
4385
|
-
subscription
|
|
4671
|
+
interface UpdateSubscriptionPlatformOriginResponse {
|
|
4672
|
+
/** The updated subscription with new platform origin */
|
|
4673
|
+
subscription?: Subscription;
|
|
4386
4674
|
}
|
|
4387
4675
|
interface ListSubscriptionHistoryRequest {
|
|
4388
4676
|
/** @format GUID */
|
|
@@ -4449,6 +4737,8 @@ interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
|
|
|
4449
4737
|
billingCyclePaid?: SubscriptionBillingCyclePaid;
|
|
4450
4738
|
initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
|
|
4451
4739
|
futurePriceUpdatesRequested?: FuturePriceUpdatesRequested;
|
|
4740
|
+
/** Fired once when an offline subscription purchase is completed (BILL-534). */
|
|
4741
|
+
offlinePurchaseCompleted?: SubscriptionOfflinePurchaseCompleted;
|
|
4452
4742
|
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
4453
4743
|
unknown?: UnknownSubscriptionEvent;
|
|
4454
4744
|
}
|
|
@@ -4487,6 +4777,8 @@ interface SubscriptionEventPayloadOneOf {
|
|
|
4487
4777
|
billingCyclePaid?: SubscriptionBillingCyclePaid;
|
|
4488
4778
|
initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
|
|
4489
4779
|
futurePriceUpdatesRequested?: FuturePriceUpdatesRequested;
|
|
4780
|
+
/** Fired once when an offline subscription purchase is completed (BILL-534). */
|
|
4781
|
+
offlinePurchaseCompleted?: SubscriptionOfflinePurchaseCompleted;
|
|
4490
4782
|
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
4491
4783
|
unknown?: UnknownSubscriptionEvent;
|
|
4492
4784
|
}
|
|
@@ -4560,6 +4852,10 @@ interface FuturePriceUpdatesRequested {
|
|
|
4560
4852
|
subscription?: Subscription;
|
|
4561
4853
|
requestedUpdateData?: SubscriptionUpdateData;
|
|
4562
4854
|
}
|
|
4855
|
+
interface SubscriptionOfflinePurchaseCompleted {
|
|
4856
|
+
subscription?: Subscription;
|
|
4857
|
+
actionDetails?: ActionDetails;
|
|
4858
|
+
}
|
|
4563
4859
|
interface SubscriptionBackOfficeAction {
|
|
4564
4860
|
subscription?: Subscription;
|
|
4565
4861
|
/** The backoffice method name */
|
|
@@ -4806,9 +5102,6 @@ declare function customerCancelScheduledPause(): __PublicMethodMetaInfo<'POST',
|
|
|
4806
5102
|
declare function customerUpdateBillingDate(): __PublicMethodMetaInfo<'POST', {
|
|
4807
5103
|
id: string;
|
|
4808
5104
|
}, CustomerUpdateBillingDateRequest$1, CustomerUpdateBillingDateRequest, CustomerUpdateBillingDateResponse$1, CustomerUpdateBillingDateResponse>;
|
|
4809
|
-
declare function payCycle(): __PublicMethodMetaInfo<'POST', {
|
|
4810
|
-
subscriptionId: string;
|
|
4811
|
-
}, PayCycleRequest$1, PayCycleRequest, PayCycleResponse$1, PayCycleResponse>;
|
|
4812
5105
|
declare function getSubscription(): __PublicMethodMetaInfo<'GET', {
|
|
4813
5106
|
id: string;
|
|
4814
5107
|
}, GetSubscriptionRequest$1, GetSubscriptionRequest, GetSubscriptionResponse$1, GetSubscriptionResponse>;
|
|
@@ -4864,4 +5157,4 @@ declare function listSubscriptionHistory(): __PublicMethodMetaInfo<'GET', {
|
|
|
4864
5157
|
subscriptionId: string;
|
|
4865
5158
|
}, ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryRequest, ListSubscriptionHistoryResponse$1, ListSubscriptionHistoryResponse>;
|
|
4866
5159
|
|
|
4867
|
-
export { type AbsorbFeeConfig as AbsorbFeeConfigOriginal, type AbsorbFeeConfigValueOneOf as AbsorbFeeConfigValueOneOfOriginal, type AccountInfo as AccountInfoOriginal, type ActionContext as ActionContextOriginal, type ActionDetails as ActionDetailsOriginal, type ActionEvent as ActionEventOriginal, ActionInitiator as ActionInitiatorOriginal, type ActionInitiatorWithLiterals as ActionInitiatorWithLiteralsOriginal, type Action as ActionOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type AddPausePeriodRequest as AddPausePeriodRequestOriginal, type AddPausePeriodResponse as AddPausePeriodResponseOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeTrigger as AdditionalFeeTriggerOriginal, type AdditionalFeeTriggerWithLiterals as AdditionalFeeTriggerWithLiteralsOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type AggregatedTaxBreakdown as AggregatedTaxBreakdownOriginal, type AllowedActionsRequest as AllowedActionsRequestOriginal, type AllowedActionsResponse as AllowedActionsResponseOriginal, type AmountByStatus as AmountByStatusOriginal, type ApplicationFee as ApplicationFeeOriginal, type ApplicationFeeValueOneOf as ApplicationFeeValueOneOfOriginal, type AttachInvoice as AttachInvoiceOriginal, type AutomaticRetryData as AutomaticRetryDataOriginal, type BassToSapiPaypalMigrationRequest as BassToSapiPaypalMigrationRequestOriginal, type BassToSapiPaypalMigrationResponse as BassToSapiPaypalMigrationResponseOriginal, type BillingSettings as BillingSettingsOriginal, type BillingStatus as BillingStatusOriginal, type BulkItemChange as BulkItemChangeOriginal, type BulkUpdateSubscriptionItemsByFilterRequest as BulkUpdateSubscriptionItemsByFilterRequestOriginal, type BulkUpdateSubscriptionItemsByFilterResponse as BulkUpdateSubscriptionItemsByFilterResponseOriginal, type BusinessOriginData as BusinessOriginDataOriginal, type BusinessOrigin as BusinessOriginOriginal, type CancelActionConfiguration as CancelActionConfigurationOriginal, type CancelActionSettings as CancelActionSettingsOriginal, type Cancel as CancelOriginal, type CancelPendingChangeRequest as CancelPendingChangeRequestOriginal, type CancelPendingChangeResponse as CancelPendingChangeResponseOriginal, type CancelSubscriptionApplicationErrors as CancelSubscriptionApplicationErrorsOriginal, type CancelSubscriptionBORequest as CancelSubscriptionBORequestOriginal, type CancelSubscriptionBOResponse as CancelSubscriptionBOResponseOriginal, type CancelSubscriptionRequest as CancelSubscriptionRequestOriginal, type CancelSubscriptionResponse as CancelSubscriptionResponseOriginal, type CancelTimeCapsuleTaskRequest as CancelTimeCapsuleTaskRequestOriginal, type CancellationInfo as CancellationInfoOriginal, CancellationInitiator as CancellationInitiatorOriginal, type CancellationInitiatorWithLiterals as CancellationInitiatorWithLiteralsOriginal, type CatalogReference as CatalogReferenceOriginal, ChangeEffectiveTime as ChangeEffectiveTimeOriginal, type ChangeEffectiveTimeWithLiterals as ChangeEffectiveTimeWithLiteralsOriginal, type ChangePaymentContext as ChangePaymentContextOriginal, type ChangeSubscriptionRequest as ChangeSubscriptionRequestOriginal, type ChangeSubscriptionResponse as ChangeSubscriptionResponseOriginal, type Charge as ChargeOriginal, CollectionMethodEnumCollectionMethod as CollectionMethodEnumCollectionMethodOriginal, type CollectionMethodEnumCollectionMethodWithLiterals as CollectionMethodEnumCollectionMethodWithLiteralsOriginal, CollectionMethod as CollectionMethodOriginal, type CollectionMethodWithLiterals as CollectionMethodWithLiteralsOriginal, type Complete as CompleteOriginal, type ConvertSapiRequest as ConvertSapiRequestOriginal, type ConvertSapiResponse as ConvertSapiResponseOriginal, type CountByStatus as CountByStatusOriginal, type CountSubscriptionFilter as CountSubscriptionFilterOriginal, type CountSubscriptionFilterStatusOneOf as CountSubscriptionFilterStatusOneOfOriginal, type CountSubscriptionsRequest as CountSubscriptionsRequestOriginal, type CountSubscriptionsResponse as CountSubscriptionsResponseOriginal, type CreateRecurringInvoiceBORequest as CreateRecurringInvoiceBORequestOriginal, type CreateRecurringInvoiceBOResponse as CreateRecurringInvoiceBOResponseOriginal, type CreateSubscriptionForOrderRequest as CreateSubscriptionForOrderRequestOriginal, type CreateSubscriptionForOrderResponse as CreateSubscriptionForOrderResponseOriginal, type CreateSubscriptionInStateRequestModeOneOf as CreateSubscriptionInStateRequestModeOneOfOriginal, type CreateSubscriptionInStateRequest as CreateSubscriptionInStateRequestOriginal, type CreateSubscriptionInStateResponse as CreateSubscriptionInStateResponseOriginal, type CreateSubscriptionRequest as CreateSubscriptionRequestOriginal, type CreateSubscriptionResponse as CreateSubscriptionResponseOriginal, CreationMode as CreationModeOriginal, type CreationModeWithLiterals as CreationModeWithLiteralsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type CustomBillingSchedule as CustomBillingScheduleOriginal, type CustomProrationAmountOneOf as CustomProrationAmountOneOfOriginal, type CustomProration as CustomProrationOriginal, type CustomerActionConfigurationOneOf as CustomerActionConfigurationOneOfOriginal, type CustomerAction as CustomerActionOriginal, type CustomerActionSettings as CustomerActionSettingsOriginal, type CustomerAllowedActionsRequest as CustomerAllowedActionsRequestOriginal, type CustomerAllowedActionsResponse as CustomerAllowedActionsResponseOriginal, type CustomerCancelConfiguration as CustomerCancelConfigurationOriginal, type CustomerCancelScheduledPauseApplicationErrors as CustomerCancelScheduledPauseApplicationErrorsOriginal, type CustomerCancelScheduledPauseRequest as CustomerCancelScheduledPauseRequestOriginal, type CustomerCancelScheduledPauseResponse as CustomerCancelScheduledPauseResponseOriginal, type CustomerCancelScheduledSkipApplicationErrors as CustomerCancelScheduledSkipApplicationErrorsOriginal, type CustomerCancelScheduledSkipRequest as CustomerCancelScheduledSkipRequestOriginal, type CustomerCancelScheduledSkipResponse as CustomerCancelScheduledSkipResponseOriginal, type CustomerCancelSubscriptionApplicationErrors as CustomerCancelSubscriptionApplicationErrorsOriginal, type CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequestOriginal, type CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponseOriginal, type CustomerExtendSubscriptionApplicationErrors as CustomerExtendSubscriptionApplicationErrorsOriginal, type CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequestOriginal, type CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponseOriginal, type CustomerIdOneOf as CustomerIdOneOfOriginal, type CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequestOriginal, type CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponseOriginal, type Customer as CustomerOriginal, type CustomerPauseResumeConfiguration as CustomerPauseResumeConfigurationOriginal, type CustomerPauseSubscriptionApplicationErrors as CustomerPauseSubscriptionApplicationErrorsOriginal, type CustomerPauseSubscriptionRequest as CustomerPauseSubscriptionRequestOriginal, type CustomerPauseSubscriptionResponse as CustomerPauseSubscriptionResponseOriginal, type CustomerResumeSubscriptionApplicationErrors as CustomerResumeSubscriptionApplicationErrorsOriginal, type CustomerResumeSubscriptionRequest as CustomerResumeSubscriptionRequestOriginal, type CustomerResumeSubscriptionResponse as CustomerResumeSubscriptionResponseOriginal, type CustomerSkipConfiguration as CustomerSkipConfigurationOriginal, type CustomerSkipCycleApplicationErrors as CustomerSkipCycleApplicationErrorsOriginal, type CustomerSkipCycleRequest as CustomerSkipCycleRequestOriginal, type CustomerSkipCycleResponse as CustomerSkipCycleResponseOriginal, type CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequestOriginal, type CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponseOriginal, type CustomerTurnOffSubscriptionAutoRenewalApplicationErrors as CustomerTurnOffSubscriptionAutoRenewalApplicationErrorsOriginal, type CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequestOriginal, type CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponseOriginal, type CustomerTurnOnSubscriptionAutoRenewalApplicationErrors as CustomerTurnOnSubscriptionAutoRenewalApplicationErrorsOriginal, type CustomerUpdateBillingDateApplicationErrors as CustomerUpdateBillingDateApplicationErrorsOriginal, type CustomerUpdateBillingDateConfiguration as CustomerUpdateBillingDateConfigurationOriginal, type CustomerUpdateBillingDateRequest as CustomerUpdateBillingDateRequestOriginal, type CustomerUpdateBillingDateResponse as CustomerUpdateBillingDateResponseOriginal, type Cycles as CyclesOriginal, type DeleteDraftSubscriptionRequest as DeleteDraftSubscriptionRequestOriginal, type DeleteDraftSubscriptionResponse as DeleteDraftSubscriptionResponseOriginal, type DeleteSubscriptionBORequest as DeleteSubscriptionBORequestOriginal, type DeleteSubscriptionBOResponse as DeleteSubscriptionBOResponseOriginal, type DeleteSubscriptionRequest as DeleteSubscriptionRequestOriginal, type DeleteSubscriptionResponse as DeleteSubscriptionResponseOriginal, type DetachInvoice as DetachInvoiceOriginal, type DiscountCycles as DiscountCyclesOriginal, type DiscountOrigin as DiscountOriginOriginal, type Discount as DiscountOriginal, type DiscountValueOneOf as DiscountValueOneOfOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type DynamicTax as DynamicTaxOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, ExtendPolicyType as ExtendPolicyTypeOriginal, type ExtendPolicyTypeWithLiterals as ExtendPolicyTypeWithLiteralsOriginal, type ExtendSubscriptionApplicationErrors as ExtendSubscriptionApplicationErrorsOriginal, type ExtendSubscriptionRequestExtendPolicyOneOf as ExtendSubscriptionRequestExtendPolicyOneOfOriginal, type ExtendSubscriptionRequest as ExtendSubscriptionRequestOriginal, type ExtendSubscriptionResponse as ExtendSubscriptionResponseOriginal, type ExternalCollectionDetails as ExternalCollectionDetailsOriginal, type ExternalPriceConfig as ExternalPriceConfigOriginal, type ExternalPrice as ExternalPriceOriginal, type FinishFreeTrialNowRequest as FinishFreeTrialNowRequestOriginal, type FinishFreeTrialNowResponse as FinishFreeTrialNowResponseOriginal, type FixSubscriptionInvoicesConsistencyRequest as FixSubscriptionInvoicesConsistencyRequestOriginal, type FixSubscriptionInvoicesConsistencyResponse as FixSubscriptionInvoicesConsistencyResponseOriginal, type FixSubscriptionInvoicesRequestModeOneOf as FixSubscriptionInvoicesRequestModeOneOfOriginal, type FixSubscriptionInvoicesRequest as FixSubscriptionInvoicesRequestOriginal, type FixSubscriptionInvoicesResponse as FixSubscriptionInvoicesResponseOriginal, type FixSubscriptionTimeCapsuleTasksRequest as FixSubscriptionTimeCapsuleTasksRequestOriginal, type FixSubscriptionTimeCapsuleTasksResponse as FixSubscriptionTimeCapsuleTasksResponseOriginal, type FixedAmountFee as FixedAmountFeeOriginal, type FixedPriceConfig as FixedPriceConfigOriginal, type FixedPrice as FixedPriceOriginal, type FreeTrailEnded as FreeTrailEndedOriginal, type FreeTrailStarted as FreeTrailStartedOriginal, type FreeTrialData as FreeTrialDataOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FullAddressDetails as FullAddressDetailsOriginal, type FuturePriceUpdatesRequested as FuturePriceUpdatesRequestedOriginal, type FutureUpdatesRequested as FutureUpdatesRequestedOriginal, type GetFullSubscriptionDataRequest as GetFullSubscriptionDataRequestOriginal, type GetFullSubscriptionDataResponse as GetFullSubscriptionDataResponseOriginal, type GetSubscriptionAndInternalDataRequest as GetSubscriptionAndInternalDataRequestOriginal, type GetSubscriptionAndInternalDataResponse as GetSubscriptionAndInternalDataResponseOriginal, type GetSubscriptionInvoicesRequest as GetSubscriptionInvoicesRequestOriginal, type GetSubscriptionInvoicesResponse as GetSubscriptionInvoicesResponseOriginal, type GetSubscriptionRequest as GetSubscriptionRequestOriginal, type GetSubscriptionResponse as GetSubscriptionResponseOriginal, type GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequestOriginal, type GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponseOriginal, type GracePeriodData as GracePeriodDataOriginal, type GracePeriodEnded as GracePeriodEndedOriginal, type GracePeriodStarted as GracePeriodStartedOriginal, type HandleSubscriptionAfterInvoiceMarkedAsPaidRequest as HandleSubscriptionAfterInvoiceMarkedAsPaidRequestOriginal, HistoryActionInitiator as HistoryActionInitiatorOriginal, type HistoryActionInitiatorWithLiterals as HistoryActionInitiatorWithLiteralsOriginal, HistoryViewMode as HistoryViewModeOriginal, type HistoryViewModeWithLiterals as HistoryViewModeWithLiteralsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, IdentityType as IdentityTypeOriginal, type IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal, type InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequestOriginal, type InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponseOriginal, type InitiatedPaymentMethodSetup as InitiatedPaymentMethodSetupOriginal, type InternalSubscriptionData as InternalSubscriptionDataOriginal, type InvoiceActionActionTypeOneOf as InvoiceActionActionTypeOneOfOriginal, type InvoiceAction as InvoiceActionOriginal, type InvoiceApplicationFee as InvoiceApplicationFeeOriginal, type InvoiceApplicationFeeValueOneOf as InvoiceApplicationFeeValueOneOfOriginal, type InvoiceDiscount as InvoiceDiscountOriginal, type InvoiceDiscountValueOneOf as InvoiceDiscountValueOneOfOriginal, type InvoiceItem as InvoiceItemOriginal, type InvoiceItemPaymentTypeOneOf as InvoiceItemPaymentTypeOneOfOriginal, type InvoiceItemPricingModelOneOf as InvoiceItemPricingModelOneOfOriginal, type Invoice as InvoiceOriginal, type InvoicePlatformFeeFeeModelOneOf as InvoicePlatformFeeFeeModelOneOfOriginal, type InvoicePlatformFee as InvoicePlatformFeeOriginal, type InvoiceShippingCharges as InvoiceShippingChargesOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, ItemCategory as ItemCategoryOriginal, type ItemCategoryWithLiterals as ItemCategoryWithLiteralsOriginal, type ItemChange as ItemChangeOriginal, type Item as ItemOriginal, type ItemTaxData as ItemTaxDataOriginal, type LatestInvoiceMarkedAsPaid as LatestInvoiceMarkedAsPaidOriginal, type LatestPaymentAttempt as LatestPaymentAttemptOriginal, type LineItemTaxSummary as LineItemTaxSummaryOriginal, type ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequestOriginal, type ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponseOriginal, type ListUpcomingChargesRequest as ListUpcomingChargesRequestOriginal, type ListUpcomingChargesResponse as ListUpcomingChargesResponseOriginal, type MarkBillingCycleAsPaidApplicationErrors as MarkBillingCycleAsPaidApplicationErrorsOriginal, type MarkBillingCycleAsPaidRequest as MarkBillingCycleAsPaidRequestOriginal, type MarkBillingCycleAsPaidResponse as MarkBillingCycleAsPaidResponseOriginal, type MarkLatestInvoiceAsPaidApplicationErrors as MarkLatestInvoiceAsPaidApplicationErrorsOriginal, type MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequestOriginal, type MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MigrationDetails as MigrationDetailsOriginal, type Money as MoneyOriginal, type MultipleSubscriptionsOnOrdersInvoice as MultipleSubscriptionsOnOrdersInvoiceOriginal, type OneTime as OneTimeOriginal, OrderMethod as OrderMethodOriginal, type OrderMethodWithLiterals as OrderMethodWithLiteralsOriginal, type Origin as OriginOriginal, type OriginOverride as OriginOverrideOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PassOnFeeConfig as PassOnFeeConfigOriginal, type PassOnFeeConfigValueOneOf as PassOnFeeConfigValueOneOfOriginal, type PatchSubscriptionRequest as PatchSubscriptionRequestOriginal, type PatchSubscriptionResponse as PatchSubscriptionResponseOriginal, PauseAt as PauseAtOriginal, type PauseAtWithLiterals as PauseAtWithLiteralsOriginal, type PauseInfo as PauseInfoOriginal, type PausePeriod as PausePeriodOriginal, PausePolicy as PausePolicyOriginal, type PausePolicyWithLiterals as PausePolicyWithLiteralsOriginal, type PauseResumeActionConfiguration as PauseResumeActionConfigurationOriginal, type PauseResumeActionSettings as PauseResumeActionSettingsOriginal, type PauseSubscriptionApplicationErrors as PauseSubscriptionApplicationErrorsOriginal, type PauseSubscriptionBORequest as PauseSubscriptionBORequestOriginal, type PauseSubscriptionBOResponse as PauseSubscriptionBOResponseOriginal, type PauseSubscriptionRequest as PauseSubscriptionRequestOriginal, type PauseSubscriptionRequested as PauseSubscriptionRequestedOriginal, type PauseSubscriptionResponse as PauseSubscriptionResponseOriginal, type PayCycleRequest as PayCycleRequestOriginal, type PayCycleResponse as PayCycleResponseOriginal, type PayRecurringInvoice as PayRecurringInvoiceOriginal, PaymentAttemptStatus as PaymentAttemptStatusOriginal, type PaymentAttemptStatusWithLiterals as PaymentAttemptStatusWithLiteralsOriginal, type PaymentData as PaymentDataOriginal, type PaymentMethod as PaymentMethodOriginal, type PaymentMethodUpdated as PaymentMethodUpdatedOriginal, PaymentMode as PaymentModeOriginal, type PaymentModeWithLiterals as PaymentModeWithLiteralsOriginal, type PaymentOrigin as PaymentOriginOriginal, type PaymentSettings as PaymentSettingsOriginal, PaymentSettlementMethod as PaymentSettlementMethodOriginal, type PaymentSettlementMethodWithLiterals as PaymentSettlementMethodWithLiteralsOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type PaymentTaxData as PaymentTaxDataOriginal, PaymentTestMode as PaymentTestModeOriginal, type PaymentTestModeWithLiterals as PaymentTestModeWithLiteralsOriginal, type PercentageFee as PercentageFeeOriginal, type PlatformOrigin as PlatformOriginOriginal, type PreviewChangeSubscriptionRequest as PreviewChangeSubscriptionRequestOriginal, type PreviewChangeSubscriptionResponse as PreviewChangeSubscriptionResponseOriginal, type PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequestOriginal, type PreviewSubscriptionChargesRequestSubscriptionOneOf as PreviewSubscriptionChargesRequestSubscriptionOneOfOriginal, type PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponseOriginal, type PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequestOriginal, type PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponseOriginal, type PriceAdjustmentAdjustmentTypeOneOf as PriceAdjustmentAdjustmentTypeOneOfOriginal, type PriceAdjustment as PriceAdjustmentOriginal, PriceAdjustmentReason as PriceAdjustmentReasonOriginal, type PriceAdjustmentReasonWithLiterals as PriceAdjustmentReasonWithLiteralsOriginal, type PriceAdjustmentValueAdjustmentValueTypeOneOf as PriceAdjustmentValueAdjustmentValueTypeOneOfOriginal, type PriceAdjustmentValue as PriceAdjustmentValueOriginal, type PriceDetails as PriceDetailsOriginal, type PricingModelModelOneOf as PricingModelModelOneOfOriginal, type PricingModel as PricingModelOriginal, ProrationAction as ProrationActionOriginal, type ProrationActionWithLiterals as ProrationActionWithLiteralsOriginal, ProrationBehavior as ProrationBehaviorOriginal, type ProrationBehaviorWithLiterals as ProrationBehaviorWithLiteralsOriginal, type Proration as ProrationOriginal, type ProrationPreview as ProrationPreviewOriginal, type ProrationResult as ProrationResultOriginal, type ProrationTypeOneOf as ProrationTypeOneOfOriginal, type QuerySubscriptionsRequest as QuerySubscriptionsRequestOriginal, type QuerySubscriptionsResponse as QuerySubscriptionsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type Recurring as RecurringOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundInfo as RefundInfoOriginal, type Refund as RefundOriginal, RefundReason as RefundReasonOriginal, type RefundReasonWithLiterals as RefundReasonWithLiteralsOriginal, type RemoveCancellationInfoRequest as RemoveCancellationInfoRequestOriginal, type RemoveCancellationInfoResponse as RemoveCancellationInfoResponseOriginal, type RemovePauseInfoRequest as RemovePauseInfoRequestOriginal, type RemovePauseInfoResponse as RemovePauseInfoResponseOriginal, type RenewalPreview as RenewalPreviewOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type ResetPendingUpdates as ResetPendingUpdatesOriginal, type RestoreDraftSubscriptionRequest as RestoreDraftSubscriptionRequestOriginal, type RestoreDraftSubscriptionResponse as RestoreDraftSubscriptionResponseOriginal, type RestoreInfo as RestoreInfoOriginal, ResumeAt as ResumeAtOriginal, type ResumeAtWithLiterals as ResumeAtWithLiteralsOriginal, type ResumeSubscriptionApplicationErrors as ResumeSubscriptionApplicationErrorsOriginal, type ResumeSubscriptionRequest as ResumeSubscriptionRequestOriginal, type ResumeSubscriptionRequested as ResumeSubscriptionRequestedOriginal, type ResumeSubscriptionResponse as ResumeSubscriptionResponseOriginal, type ReviseSubscriptionRequest as ReviseSubscriptionRequestOriginal, type ReviseSubscriptionResponse as ReviseSubscriptionResponseOriginal, RevivePolicy as RevivePolicyOriginal, type RevivePolicyWithLiterals as RevivePolicyWithLiteralsOriginal, type ReviveSubscriptionRequest as ReviveSubscriptionRequestOriginal, type ReviveSubscriptionResponse as ReviveSubscriptionResponseOriginal, type RunTimeCapsuleTaskNowRequest as RunTimeCapsuleTaskNowRequestOriginal, type ScheduleAdditionalInfo as ScheduleAdditionalInfoOriginal, type ScheduleAdditionalInfoParamOneOf as ScheduleAdditionalInfoParamOneOfOriginal, type ScheduleTimeCapsuleTaskRequest as ScheduleTimeCapsuleTaskRequestOriginal, type ScheduledPauseCanceled as ScheduledPauseCanceledOriginal, type ScheduledResumeCanceled as ScheduledResumeCanceledOriginal, type SearchSubscriptionRequest as SearchSubscriptionRequestOriginal, type SearchSubscriptionResponse as SearchSubscriptionResponseOriginal, type SearchSubscriptionsRequest as SearchSubscriptionsRequestOriginal, type SearchSubscriptionsRequestPagingMethodOneOf as SearchSubscriptionsRequestPagingMethodOneOfOriginal, type SearchSubscriptionsResponse as SearchSubscriptionsResponseOriginal, type SendSubscriptionActionEventBORequestEventOneOf as SendSubscriptionActionEventBORequestEventOneOfOriginal, type SendSubscriptionActionEventBORequest as SendSubscriptionActionEventBORequestOriginal, type SendSubscriptionActionEventResponse as SendSubscriptionActionEventResponseOriginal, type SendTimeCapsuleTaskCanceledBIRequest as SendTimeCapsuleTaskCanceledBIRequestOriginal, type SetIsMigratedEvent as SetIsMigratedEventOriginal, type SetShiftingDataRequest as SetShiftingDataRequestOriginal, type SetShiftingDataResponse as SetShiftingDataResponseOriginal, type ShippingCharges as ShippingChargesOriginal, type SkipActionConfiguration as SkipActionConfigurationOriginal, type SkipActionSettings as SkipActionSettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type SortingClauses as SortingClausesOriginal, type Sorting as SortingOriginal, type SpecificDateSubscriptionUpdateData as SpecificDateSubscriptionUpdateDataOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type Subscriber as SubscriberOriginal, type SubscriptionActivated as SubscriptionActivatedOriginal, type SubscriptionAutoRenewalTurnedOff as SubscriptionAutoRenewalTurnedOffOriginal, type SubscriptionAutoRenewalTurnedOn as SubscriptionAutoRenewalTurnedOnOriginal, type SubscriptionBackOfficeAction as SubscriptionBackOfficeActionOriginal, type SubscriptionBillingCyclePaid as SubscriptionBillingCyclePaidOriginal, type SubscriptionBillingCycleStarted as SubscriptionBillingCycleStartedOriginal, type SubscriptionBillingDateUpdated as SubscriptionBillingDateUpdatedOriginal, type SubscriptionBillingDetails as SubscriptionBillingDetailsOriginal, type SubscriptionCanceled as SubscriptionCanceledOriginal, type SubscriptionCancellationRequested as SubscriptionCancellationRequestedOriginal, type SubscriptionChangeSummary as SubscriptionChangeSummaryOriginal, type SubscriptionCharge as SubscriptionChargeOriginal, type SubscriptionCharges as SubscriptionChargesOriginal, type SubscriptionCollectionMethodUpdated as SubscriptionCollectionMethodUpdatedOriginal, type SubscriptionCreated as SubscriptionCreatedOriginal, type SubscriptionCycleReadyToPay as SubscriptionCycleReadyToPayOriginal, type SubscriptionCycleTriggered as SubscriptionCycleTriggeredOriginal, type SubscriptionDelayedSyncEvent as SubscriptionDelayedSyncEventOriginal, type SubscriptionDeleted as SubscriptionDeletedOriginal, type SubscriptionDiff as SubscriptionDiffOriginal, type SubscriptionEnded as SubscriptionEndedOriginal, type SubscriptionEvent as SubscriptionEventOriginal, type SubscriptionEventPayloadOneOf as SubscriptionEventPayloadOneOfOriginal, type SubscriptionExpired as SubscriptionExpiredOriginal, type SubscriptionExtendedExtendPolicyOneOf as SubscriptionExtendedExtendPolicyOneOfOriginal, type SubscriptionExtended as SubscriptionExtendedOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionHistoryEntry as SubscriptionHistoryEntryOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionInitialPurchaseCompleted as SubscriptionInitialPurchaseCompletedOriginal, type SubscriptionInvoice as SubscriptionInvoiceOriginal, type SubscriptionItemChange as SubscriptionItemChangeOriginal, type SubscriptionMarkedAsPaid as SubscriptionMarkedAsPaidOriginal, type Subscription as SubscriptionOriginal, type SubscriptionPaused as SubscriptionPausedOriginal, type SubscriptionPolicies as SubscriptionPoliciesOriginal, type SubscriptionPolicy as SubscriptionPolicyOriginal, type SubscriptionResumed as SubscriptionResumedOriginal, type SubscriptionRevived as SubscriptionRevivedOriginal, SubscriptionStatusEnumSubscriptionStatus as SubscriptionStatusEnumSubscriptionStatusOriginal, type SubscriptionStatusEnumSubscriptionStatusWithLiterals as SubscriptionStatusEnumSubscriptionStatusWithLiteralsOriginal, SubscriptionStatusGroup as SubscriptionStatusGroupOriginal, type SubscriptionStatusGroupWithLiterals as SubscriptionStatusGroupWithLiteralsOriginal, type SubscriptionStatus as SubscriptionStatusOriginal, type SubscriptionSuspended as SubscriptionSuspendedOriginal, type SubscriptionTrialPeriod as SubscriptionTrialPeriodOriginal, SubscriptionType as SubscriptionTypeOriginal, type SubscriptionTypeWithLiterals as SubscriptionTypeWithLiteralsOriginal, type SubscriptionUpdateData as SubscriptionUpdateDataOriginal, type SubscriptionUpdated as SubscriptionUpdatedOriginal, type Suspension as SuspensionOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxBreakdown as TaxBreakdownOriginal, type TaxData as TaxDataOriginal, type Tax as TaxOriginal, type TaxSettings as TaxSettingsOriginal, type TaxSummary as TaxSummaryOriginal, type TaxValueOneOf as TaxValueOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TimeBasedProration as TimeBasedProrationOriginal, type Totals as TotalsOriginal, type TurnOffSubscriptionAutoRenewalApplicationErrors as TurnOffSubscriptionAutoRenewalApplicationErrorsOriginal, type TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequestOriginal, type TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponseOriginal, type TurnOnSubscriptionAutoRenewalApplicationErrors as TurnOnSubscriptionAutoRenewalApplicationErrorsOriginal, type TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequestOriginal, type TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponseOriginal, type UnknownSubscriptionEvent as UnknownSubscriptionEventOriginal, type UnsupportedAction as UnsupportedActionOriginal, type UnsupportedReason as UnsupportedReasonOriginal, UpdateAction as UpdateActionOriginal, type UpdateActionWithLiterals as UpdateActionWithLiteralsOriginal, type UpdateBillingDateActionConfiguration as UpdateBillingDateActionConfigurationOriginal, type UpdateBillingDateActionSettings as UpdateBillingDateActionSettingsOriginal, type UpdateBillingDateData as UpdateBillingDateDataOriginal, type UpdateFullSubscriptionRequest as UpdateFullSubscriptionRequestOriginal, type UpdateFullSubscriptionResponse as UpdateFullSubscriptionResponseOriginal, type UpdatePausePaidDurationRequest as UpdatePausePaidDurationRequestOriginal, type UpdatePausePaidDurationResponse as UpdatePausePaidDurationResponseOriginal, type UpdatePaymentMethodBORequest as UpdatePaymentMethodBORequestOriginal, type UpdatePaymentMethodBOResponse as UpdatePaymentMethodBOResponseOriginal, type UpdatePaymentStatusRequest as UpdatePaymentStatusRequestOriginal, type UpdatePaymentStatusResponse as UpdatePaymentStatusResponseOriginal, type UpdateStatusRequest as UpdateStatusRequestOriginal, type UpdateStatusResponse as UpdateStatusResponseOriginal, type UpdateSubscriptionBillingDateApplicationErrors as UpdateSubscriptionBillingDateApplicationErrorsOriginal, type UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequestOriginal, type UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponseOriginal, type UpdateSubscriptionCurrencyRequest as UpdateSubscriptionCurrencyRequestOriginal, type UpdateSubscriptionCurrencyResponse as UpdateSubscriptionCurrencyResponseOriginal, type UpdateSubscriptionInvoiceCycleRequest as UpdateSubscriptionInvoiceCycleRequestOriginal, type UpdateSubscriptionInvoiceCycleResponse as UpdateSubscriptionInvoiceCycleResponseOriginal, type UpdateSubscriptionItemsRequest as UpdateSubscriptionItemsRequestOriginal, type UpdateSubscriptionItemsResponse as UpdateSubscriptionItemsResponseOriginal, type UpdateSubscriptionOriginRequest as UpdateSubscriptionOriginRequestOriginal, type UpdateSubscriptionOriginResponse as UpdateSubscriptionOriginResponseOriginal, type UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequestOriginal, type UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponseOriginal, type UpdateSubscriptionPlatformOriginRequest as UpdateSubscriptionPlatformOriginRequestOriginal, type UpdateSubscriptionPlatformOriginResponse as UpdateSubscriptionPlatformOriginResponseOriginal, type UpdateSubscriptionPoliciesRequest as UpdateSubscriptionPoliciesRequestOriginal, type UpdateSubscriptionPoliciesResponse as UpdateSubscriptionPoliciesResponseOriginal, type UpdateSubscriptionRequest as UpdateSubscriptionRequestOriginal, type UpdateSubscriptionResponse as UpdateSubscriptionResponseOriginal, type UpdateSubscriptionStartDateRequest as UpdateSubscriptionStartDateRequestOriginal, type UpdateSubscriptionStartDateResponse as UpdateSubscriptionStartDateResponseOriginal, type UpdatesApplied as UpdatesAppliedOriginal, type UpmActionSettings as UpmActionSettingsOriginal, type V1Duration as V1DurationOriginal, type V1SubscriptionActivated as V1SubscriptionActivatedOriginal, type V1SubscriptionCanceled as V1SubscriptionCanceledOriginal, type V1SubscriptionCreated as V1SubscriptionCreatedOriginal, type V1SubscriptionEventEventOneOf as V1SubscriptionEventEventOneOfOriginal, type V1SubscriptionEvent as V1SubscriptionEventOriginal, type V1SubscriptionInitialPurchaseCompleted as V1SubscriptionInitialPurchaseCompletedOriginal, type V1Subscription as V1SubscriptionOriginal, type V1SubscriptionResumed as V1SubscriptionResumedOriginal, V1SubscriptionStatusEnumSubscriptionStatus as V1SubscriptionStatusEnumSubscriptionStatusOriginal, type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals as V1SubscriptionStatusEnumSubscriptionStatusWithLiteralsOriginal, type V1SubscriptionUpdated as V1SubscriptionUpdatedOriginal, type V2Subscription as V2SubscriptionOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, allowedActions, cancelSubscription, countSubscriptions, customerAllowedActions, customerCancelScheduledPause, customerCancelScheduledSkip, customerCancelSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerPauseSubscription, customerQuerySubscriptions, customerResumeSubscription, customerSkipCycle, customerTurnOffSubscriptionAutoRenewal, customerTurnOnSubscriptionAutoRenewal, customerUpdateBillingDate, customerUpdateSubscriptionPaymentMethod, extendSubscription, getSubscription, getSubscriptionsStats, initiatePaymentMethodSetup, listSubscriptionHistory, listUpcomingCharges, markBillingCycleAsPaid, markLatestInvoiceAsPaid, pauseSubscription, payCycle, previewSubscriptionCharges, previewSubscriptionsCharges, querySubscriptions, resumeSubscription, reviseSubscription, searchSubscriptions, turnOffSubscriptionAutoRenewal, turnOnSubscriptionAutoRenewal, updateSubscriptionBillingDate, updateSubscriptionPaymentMethod };
|
|
5160
|
+
export { type AbsorbFeeConfig as AbsorbFeeConfigOriginal, type AbsorbFeeConfigValueOneOf as AbsorbFeeConfigValueOneOfOriginal, type AccountInfo as AccountInfoOriginal, type ActionContext as ActionContextOriginal, type ActionDetails as ActionDetailsOriginal, type ActionEvent as ActionEventOriginal, ActionInitiator as ActionInitiatorOriginal, type ActionInitiatorWithLiterals as ActionInitiatorWithLiteralsOriginal, type Action as ActionOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type AddPausePeriodRequest as AddPausePeriodRequestOriginal, type AddPausePeriodResponse as AddPausePeriodResponseOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeTrigger as AdditionalFeeTriggerOriginal, type AdditionalFeeTriggerWithLiterals as AdditionalFeeTriggerWithLiteralsOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type AggregatedTaxBreakdown as AggregatedTaxBreakdownOriginal, type AllowedActionsRequest as AllowedActionsRequestOriginal, type AllowedActionsResponse as AllowedActionsResponseOriginal, type AmountByStatus as AmountByStatusOriginal, type ApplicationFee as ApplicationFeeOriginal, type ApplicationFeeValueOneOf as ApplicationFeeValueOneOfOriginal, type AttachInvoice as AttachInvoiceOriginal, type AutomaticRetryData as AutomaticRetryDataOriginal, type BassToSapiPaypalMigrationRequest as BassToSapiPaypalMigrationRequestOriginal, type BassToSapiPaypalMigrationResponse as BassToSapiPaypalMigrationResponseOriginal, type BillingSettings as BillingSettingsOriginal, type BillingStatus as BillingStatusOriginal, type BulkItemChange as BulkItemChangeOriginal, type BulkUpdateSubscriptionItemsByFilterRequest as BulkUpdateSubscriptionItemsByFilterRequestOriginal, type BulkUpdateSubscriptionItemsByFilterResponse as BulkUpdateSubscriptionItemsByFilterResponseOriginal, type BusinessOriginData as BusinessOriginDataOriginal, type BusinessOrigin as BusinessOriginOriginal, type CancelActionConfiguration as CancelActionConfigurationOriginal, type CancelActionSettings as CancelActionSettingsOriginal, type Cancel as CancelOriginal, type CancelPendingChangeRequest as CancelPendingChangeRequestOriginal, type CancelPendingChangeResponse as CancelPendingChangeResponseOriginal, type CancelSubscriptionApplicationErrors as CancelSubscriptionApplicationErrorsOriginal, type CancelSubscriptionBORequest as CancelSubscriptionBORequestOriginal, type CancelSubscriptionBOResponse as CancelSubscriptionBOResponseOriginal, type CancelSubscriptionRequest as CancelSubscriptionRequestOriginal, type CancelSubscriptionResponse as CancelSubscriptionResponseOriginal, type CancelTimeCapsuleTaskRequest as CancelTimeCapsuleTaskRequestOriginal, type CancellationInfo as CancellationInfoOriginal, CancellationInitiator as CancellationInitiatorOriginal, type CancellationInitiatorWithLiterals as CancellationInitiatorWithLiteralsOriginal, type CatalogReference as CatalogReferenceOriginal, type ChangeContext as ChangeContextOriginal, ChangeEffectiveTime as ChangeEffectiveTimeOriginal, type ChangeEffectiveTimeWithLiterals as ChangeEffectiveTimeWithLiteralsOriginal, type ChangePaymentContext as ChangePaymentContextOriginal, type ChangeSubscriptionForOrderRequest as ChangeSubscriptionForOrderRequestOriginal, type ChangeSubscriptionForOrderResponse as ChangeSubscriptionForOrderResponseOriginal, type ChangeSubscriptionRequest as ChangeSubscriptionRequestOriginal, type ChangeSubscriptionResponse as ChangeSubscriptionResponseOriginal, ChangeType as ChangeTypeOriginal, type ChangeTypeWithLiterals as ChangeTypeWithLiteralsOriginal, type Charge as ChargeOriginal, CollectionMethodEnumCollectionMethod as CollectionMethodEnumCollectionMethodOriginal, type CollectionMethodEnumCollectionMethodWithLiterals as CollectionMethodEnumCollectionMethodWithLiteralsOriginal, CollectionMethod as CollectionMethodOriginal, type CollectionMethodWithLiterals as CollectionMethodWithLiteralsOriginal, type Complete as CompleteOriginal, type ConvertSapiRequest as ConvertSapiRequestOriginal, type ConvertSapiResponse as ConvertSapiResponseOriginal, type CountByStatus as CountByStatusOriginal, type CountSubscriptionFilter as CountSubscriptionFilterOriginal, type CountSubscriptionFilterStatusOneOf as CountSubscriptionFilterStatusOneOfOriginal, type CountSubscriptionsRequest as CountSubscriptionsRequestOriginal, type CountSubscriptionsResponse as CountSubscriptionsResponseOriginal, type CreateRecurringInvoiceBORequest as CreateRecurringInvoiceBORequestOriginal, type CreateRecurringInvoiceBOResponse as CreateRecurringInvoiceBOResponseOriginal, type CreateSubscriptionForOrderRequest as CreateSubscriptionForOrderRequestOriginal, type CreateSubscriptionForOrderResponse as CreateSubscriptionForOrderResponseOriginal, type CreateSubscriptionInStateRequestModeOneOf as CreateSubscriptionInStateRequestModeOneOfOriginal, type CreateSubscriptionInStateRequest as CreateSubscriptionInStateRequestOriginal, type CreateSubscriptionInStateResponse as CreateSubscriptionInStateResponseOriginal, type CreateSubscriptionRequest as CreateSubscriptionRequestOriginal, type CreateSubscriptionResponse as CreateSubscriptionResponseOriginal, CreationMode as CreationModeOriginal, type CreationModeWithLiterals as CreationModeWithLiteralsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type CustomBillingSchedule as CustomBillingScheduleOriginal, type CustomProrationAmountOneOf as CustomProrationAmountOneOfOriginal, type CustomProration as CustomProrationOriginal, type CustomerActionConfigurationOneOf as CustomerActionConfigurationOneOfOriginal, type CustomerActionCounters as CustomerActionCountersOriginal, type CustomerAction as CustomerActionOriginal, type CustomerActionSettings as CustomerActionSettingsOriginal, type CustomerAllowedActionsRequest as CustomerAllowedActionsRequestOriginal, type CustomerAllowedActionsResponse as CustomerAllowedActionsResponseOriginal, type CustomerCancelConfiguration as CustomerCancelConfigurationOriginal, type CustomerCancelScheduledPauseApplicationErrors as CustomerCancelScheduledPauseApplicationErrorsOriginal, type CustomerCancelScheduledPauseRequest as CustomerCancelScheduledPauseRequestOriginal, type CustomerCancelScheduledPauseResponse as CustomerCancelScheduledPauseResponseOriginal, type CustomerCancelScheduledSkipApplicationErrors as CustomerCancelScheduledSkipApplicationErrorsOriginal, type CustomerCancelScheduledSkipRequest as CustomerCancelScheduledSkipRequestOriginal, type CustomerCancelScheduledSkipResponse as CustomerCancelScheduledSkipResponseOriginal, type CustomerCancelSubscriptionApplicationErrors as CustomerCancelSubscriptionApplicationErrorsOriginal, type CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequestOriginal, type CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponseOriginal, type CustomerExtendSubscriptionApplicationErrors as CustomerExtendSubscriptionApplicationErrorsOriginal, type CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequestOriginal, type CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponseOriginal, type CustomerIdOneOf as CustomerIdOneOfOriginal, type CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequestOriginal, type CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponseOriginal, type Customer as CustomerOriginal, type CustomerPauseResumeConfiguration as CustomerPauseResumeConfigurationOriginal, type CustomerPauseSubscriptionApplicationErrors as CustomerPauseSubscriptionApplicationErrorsOriginal, type CustomerPauseSubscriptionRequest as CustomerPauseSubscriptionRequestOriginal, type CustomerPauseSubscriptionResponse as CustomerPauseSubscriptionResponseOriginal, type CustomerResumeSubscriptionApplicationErrors as CustomerResumeSubscriptionApplicationErrorsOriginal, type CustomerResumeSubscriptionRequest as CustomerResumeSubscriptionRequestOriginal, type CustomerResumeSubscriptionResponse as CustomerResumeSubscriptionResponseOriginal, type CustomerSkipConfiguration as CustomerSkipConfigurationOriginal, type CustomerSkipCycleApplicationErrors as CustomerSkipCycleApplicationErrorsOriginal, type CustomerSkipCycleRequest as CustomerSkipCycleRequestOriginal, type CustomerSkipCycleResponse as CustomerSkipCycleResponseOriginal, type CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequestOriginal, type CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponseOriginal, type CustomerTurnOffSubscriptionAutoRenewalApplicationErrors as CustomerTurnOffSubscriptionAutoRenewalApplicationErrorsOriginal, type CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequestOriginal, type CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponseOriginal, type CustomerTurnOnSubscriptionAutoRenewalApplicationErrors as CustomerTurnOnSubscriptionAutoRenewalApplicationErrorsOriginal, type CustomerUpdateBillingDateApplicationErrors as CustomerUpdateBillingDateApplicationErrorsOriginal, type CustomerUpdateBillingDateConfiguration as CustomerUpdateBillingDateConfigurationOriginal, type CustomerUpdateBillingDateRequest as CustomerUpdateBillingDateRequestOriginal, type CustomerUpdateBillingDateResponse as CustomerUpdateBillingDateResponseOriginal, type Cycles as CyclesOriginal, type DeleteDraftSubscriptionRequest as DeleteDraftSubscriptionRequestOriginal, type DeleteDraftSubscriptionResponse as DeleteDraftSubscriptionResponseOriginal, type DeleteSubscriptionBORequest as DeleteSubscriptionBORequestOriginal, type DeleteSubscriptionBOResponse as DeleteSubscriptionBOResponseOriginal, type DeleteSubscriptionRequest as DeleteSubscriptionRequestOriginal, type DeleteSubscriptionResponse as DeleteSubscriptionResponseOriginal, type DetachInvoice as DetachInvoiceOriginal, type DiscountCycles as DiscountCyclesOriginal, type DiscountOrigin as DiscountOriginOriginal, type Discount as DiscountOriginal, type DiscountValueOneOf as DiscountValueOneOfOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type DynamicTax as DynamicTaxOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, ExtendPolicyType as ExtendPolicyTypeOriginal, type ExtendPolicyTypeWithLiterals as ExtendPolicyTypeWithLiteralsOriginal, type ExtendSubscriptionApplicationErrors as ExtendSubscriptionApplicationErrorsOriginal, type ExtendSubscriptionRequestExtendPolicyOneOf as ExtendSubscriptionRequestExtendPolicyOneOfOriginal, type ExtendSubscriptionRequest as ExtendSubscriptionRequestOriginal, type ExtendSubscriptionResponse as ExtendSubscriptionResponseOriginal, type ExternalCollectionDetails as ExternalCollectionDetailsOriginal, type ExternalPriceConfig as ExternalPriceConfigOriginal, type ExternalPrice as ExternalPriceOriginal, type FinishFreeTrialNowRequest as FinishFreeTrialNowRequestOriginal, type FinishFreeTrialNowResponse as FinishFreeTrialNowResponseOriginal, type FixSubscriptionInvoicesConsistencyRequest as FixSubscriptionInvoicesConsistencyRequestOriginal, type FixSubscriptionInvoicesConsistencyResponse as FixSubscriptionInvoicesConsistencyResponseOriginal, type FixSubscriptionInvoicesRequestModeOneOf as FixSubscriptionInvoicesRequestModeOneOfOriginal, type FixSubscriptionInvoicesRequest as FixSubscriptionInvoicesRequestOriginal, type FixSubscriptionInvoicesResponse as FixSubscriptionInvoicesResponseOriginal, type FixSubscriptionPaymentStatusRequest as FixSubscriptionPaymentStatusRequestOriginal, type FixSubscriptionPaymentStatusResponse as FixSubscriptionPaymentStatusResponseOriginal, type FixSubscriptionTimeCapsuleTasksRequest as FixSubscriptionTimeCapsuleTasksRequestOriginal, type FixSubscriptionTimeCapsuleTasksResponse as FixSubscriptionTimeCapsuleTasksResponseOriginal, type FixedAmountFee as FixedAmountFeeOriginal, type FixedPriceConfig as FixedPriceConfigOriginal, type FixedPrice as FixedPriceOriginal, type FreeTrailEnded as FreeTrailEndedOriginal, type FreeTrailStarted as FreeTrailStartedOriginal, type FreeTrialData as FreeTrialDataOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FullAddressDetails as FullAddressDetailsOriginal, type FuturePriceUpdatesRequested as FuturePriceUpdatesRequestedOriginal, type FutureUpdatesRequested as FutureUpdatesRequestedOriginal, type GetFullSubscriptionDataRequest as GetFullSubscriptionDataRequestOriginal, type GetFullSubscriptionDataResponse as GetFullSubscriptionDataResponseOriginal, type GetSubscriptionAndInternalDataRequest as GetSubscriptionAndInternalDataRequestOriginal, type GetSubscriptionAndInternalDataResponse as GetSubscriptionAndInternalDataResponseOriginal, type GetSubscriptionInvoicesRequest as GetSubscriptionInvoicesRequestOriginal, type GetSubscriptionInvoicesResponse as GetSubscriptionInvoicesResponseOriginal, type GetSubscriptionRequest as GetSubscriptionRequestOriginal, type GetSubscriptionResponse as GetSubscriptionResponseOriginal, type GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequestOriginal, type GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponseOriginal, type GracePeriodData as GracePeriodDataOriginal, type GracePeriodEnded as GracePeriodEndedOriginal, type GracePeriodStarted as GracePeriodStartedOriginal, type HandleSubscriptionAfterInvoiceMarkedAsPaidRequest as HandleSubscriptionAfterInvoiceMarkedAsPaidRequestOriginal, HistoryActionInitiator as HistoryActionInitiatorOriginal, type HistoryActionInitiatorWithLiterals as HistoryActionInitiatorWithLiteralsOriginal, HistoryViewMode as HistoryViewModeOriginal, type HistoryViewModeWithLiterals as HistoryViewModeWithLiteralsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, IdentityType as IdentityTypeOriginal, type IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal, type InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequestOriginal, type InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponseOriginal, type InitiatedPaymentMethodSetup as InitiatedPaymentMethodSetupOriginal, type InternalSubscriptionData as InternalSubscriptionDataOriginal, type InvoiceActionActionTypeOneOf as InvoiceActionActionTypeOneOfOriginal, type InvoiceAction as InvoiceActionOriginal, type InvoiceApplicationFee as InvoiceApplicationFeeOriginal, type InvoiceApplicationFeeValueOneOf as InvoiceApplicationFeeValueOneOfOriginal, type InvoiceDiscount as InvoiceDiscountOriginal, type InvoiceDiscountValueOneOf as InvoiceDiscountValueOneOfOriginal, type InvoiceItem as InvoiceItemOriginal, type InvoiceItemPaymentTypeOneOf as InvoiceItemPaymentTypeOneOfOriginal, type InvoiceItemPricingModelOneOf as InvoiceItemPricingModelOneOfOriginal, type Invoice as InvoiceOriginal, type InvoicePlatformFeeFeeModelOneOf as InvoicePlatformFeeFeeModelOneOfOriginal, type InvoicePlatformFee as InvoicePlatformFeeOriginal, type InvoiceShippingCharges as InvoiceShippingChargesOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, ItemCategory as ItemCategoryOriginal, type ItemCategoryWithLiterals as ItemCategoryWithLiteralsOriginal, type ItemChange as ItemChangeOriginal, type Item as ItemOriginal, type ItemTaxData as ItemTaxDataOriginal, type LatestInvoiceMarkedAsPaid as LatestInvoiceMarkedAsPaidOriginal, type LatestPaymentAttempt as LatestPaymentAttemptOriginal, type LineItemTaxSummary as LineItemTaxSummaryOriginal, type ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequestOriginal, type ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponseOriginal, type ListUpcomingChargesRequest as ListUpcomingChargesRequestOriginal, type ListUpcomingChargesResponse as ListUpcomingChargesResponseOriginal, type MarkBillingCycleAsPaidApplicationErrors as MarkBillingCycleAsPaidApplicationErrorsOriginal, type MarkBillingCycleAsPaidRequest as MarkBillingCycleAsPaidRequestOriginal, type MarkBillingCycleAsPaidResponse as MarkBillingCycleAsPaidResponseOriginal, type MarkLatestInvoiceAsPaidApplicationErrors as MarkLatestInvoiceAsPaidApplicationErrorsOriginal, type MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequestOriginal, type MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MigrationDetails as MigrationDetailsOriginal, MissingPreviousBillingDateResumeStrategy as MissingPreviousBillingDateResumeStrategyOriginal, type MissingPreviousBillingDateResumeStrategyWithLiterals as MissingPreviousBillingDateResumeStrategyWithLiteralsOriginal, type Money as MoneyOriginal, type MultipleSubscriptionsOnOrdersInvoice as MultipleSubscriptionsOnOrdersInvoiceOriginal, type OneTime as OneTimeOriginal, OrderMethod as OrderMethodOriginal, type OrderMethodWithLiterals as OrderMethodWithLiteralsOriginal, type Origin as OriginOriginal, type OriginOverride as OriginOverrideOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PassOnFeeConfig as PassOnFeeConfigOriginal, type PassOnFeeConfigValueOneOf as PassOnFeeConfigValueOneOfOriginal, type PatchSubscriptionRequest as PatchSubscriptionRequestOriginal, type PatchSubscriptionResponse as PatchSubscriptionResponseOriginal, PauseAt as PauseAtOriginal, type PauseAtWithLiterals as PauseAtWithLiteralsOriginal, type PauseInfo as PauseInfoOriginal, type PausePeriod as PausePeriodOriginal, PausePolicy as PausePolicyOriginal, type PausePolicyWithLiterals as PausePolicyWithLiteralsOriginal, type PauseResumeActionConfiguration as PauseResumeActionConfigurationOriginal, type PauseResumeActionSettings as PauseResumeActionSettingsOriginal, type PauseSubscriptionApplicationErrors as PauseSubscriptionApplicationErrorsOriginal, type PauseSubscriptionBORequest as PauseSubscriptionBORequestOriginal, type PauseSubscriptionBOResponse as PauseSubscriptionBOResponseOriginal, type PauseSubscriptionRequest as PauseSubscriptionRequestOriginal, type PauseSubscriptionRequested as PauseSubscriptionRequestedOriginal, type PauseSubscriptionResponse as PauseSubscriptionResponseOriginal, type PayCycleRequest as PayCycleRequestOriginal, type PayCycleResponse as PayCycleResponseOriginal, type PayRecurringInvoice as PayRecurringInvoiceOriginal, PaymentAttemptStatus as PaymentAttemptStatusOriginal, type PaymentAttemptStatusWithLiterals as PaymentAttemptStatusWithLiteralsOriginal, type PaymentData as PaymentDataOriginal, type PaymentMethod as PaymentMethodOriginal, type PaymentMethodUpdated as PaymentMethodUpdatedOriginal, PaymentMode as PaymentModeOriginal, type PaymentModeWithLiterals as PaymentModeWithLiteralsOriginal, type PaymentOrigin as PaymentOriginOriginal, type PaymentSettings as PaymentSettingsOriginal, PaymentSettlementMethod as PaymentSettlementMethodOriginal, type PaymentSettlementMethodWithLiterals as PaymentSettlementMethodWithLiteralsOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type PaymentTaxData as PaymentTaxDataOriginal, PaymentTestMode as PaymentTestModeOriginal, type PaymentTestModeWithLiterals as PaymentTestModeWithLiteralsOriginal, type PercentageFee as PercentageFeeOriginal, type PlatformOrigin as PlatformOriginOriginal, type PreviewChangeSubscriptionRequest as PreviewChangeSubscriptionRequestOriginal, type PreviewChangeSubscriptionResponse as PreviewChangeSubscriptionResponseOriginal, type PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequestOriginal, type PreviewSubscriptionChargesRequestSubscriptionOneOf as PreviewSubscriptionChargesRequestSubscriptionOneOfOriginal, type PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponseOriginal, type PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequestOriginal, type PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponseOriginal, type PriceAdjustmentAdjustmentTypeOneOf as PriceAdjustmentAdjustmentTypeOneOfOriginal, type PriceAdjustment as PriceAdjustmentOriginal, PriceAdjustmentReason as PriceAdjustmentReasonOriginal, type PriceAdjustmentReasonWithLiterals as PriceAdjustmentReasonWithLiteralsOriginal, type PriceAdjustmentValueAdjustmentValueTypeOneOf as PriceAdjustmentValueAdjustmentValueTypeOneOfOriginal, type PriceAdjustmentValue as PriceAdjustmentValueOriginal, type PriceDetails as PriceDetailsOriginal, type PricingModelModelOneOf as PricingModelModelOneOfOriginal, type PricingModel as PricingModelOriginal, ProrationAction as ProrationActionOriginal, type ProrationActionWithLiterals as ProrationActionWithLiteralsOriginal, ProrationBehaviorEnumProrationBehavior as ProrationBehaviorEnumProrationBehaviorOriginal, type ProrationBehaviorEnumProrationBehaviorWithLiterals as ProrationBehaviorEnumProrationBehaviorWithLiteralsOriginal, ProrationBehavior as ProrationBehaviorOriginal, type ProrationBehaviorWithLiterals as ProrationBehaviorWithLiteralsOriginal, type Proration as ProrationOriginal, type ProrationPreview as ProrationPreviewOriginal, type ProrationResult as ProrationResultOriginal, type ProrationTypeOneOf as ProrationTypeOneOfOriginal, type QuerySubscriptionsRequest as QuerySubscriptionsRequestOriginal, type QuerySubscriptionsResponse as QuerySubscriptionsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type Recurring as RecurringOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundInfo as RefundInfoOriginal, type Refund as RefundOriginal, RefundReason as RefundReasonOriginal, type RefundReasonWithLiterals as RefundReasonWithLiteralsOriginal, type RemoveCancellationInfoRequest as RemoveCancellationInfoRequestOriginal, type RemoveCancellationInfoResponse as RemoveCancellationInfoResponseOriginal, type RemovePauseInfoRequest as RemovePauseInfoRequestOriginal, type RemovePauseInfoResponse as RemovePauseInfoResponseOriginal, type RenewalPreview as RenewalPreviewOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type ResetPendingUpdates as ResetPendingUpdatesOriginal, type RestoreDraftSubscriptionRequest as RestoreDraftSubscriptionRequestOriginal, type RestoreDraftSubscriptionResponse as RestoreDraftSubscriptionResponseOriginal, type RestoreInfo as RestoreInfoOriginal, ResumeAt as ResumeAtOriginal, type ResumeAtWithLiterals as ResumeAtWithLiteralsOriginal, type ResumeSubscriptionApplicationErrors as ResumeSubscriptionApplicationErrorsOriginal, type ResumeSubscriptionRequest as ResumeSubscriptionRequestOriginal, type ResumeSubscriptionRequested as ResumeSubscriptionRequestedOriginal, type ResumeSubscriptionResponse as ResumeSubscriptionResponseOriginal, type ReviseSubscriptionRequest as ReviseSubscriptionRequestOriginal, type ReviseSubscriptionResponse as ReviseSubscriptionResponseOriginal, RevivePolicy as RevivePolicyOriginal, type RevivePolicyWithLiterals as RevivePolicyWithLiteralsOriginal, type ReviveSubscriptionRequest as ReviveSubscriptionRequestOriginal, type ReviveSubscriptionResponse as ReviveSubscriptionResponseOriginal, type RunTimeCapsuleTaskNowRequest as RunTimeCapsuleTaskNowRequestOriginal, type ScheduleAdditionalInfo as ScheduleAdditionalInfoOriginal, type ScheduleAdditionalInfoParamOneOf as ScheduleAdditionalInfoParamOneOfOriginal, type ScheduleTimeCapsuleTaskRequest as ScheduleTimeCapsuleTaskRequestOriginal, type ScheduledPauseCanceled as ScheduledPauseCanceledOriginal, type ScheduledResumeCanceled as ScheduledResumeCanceledOriginal, type SearchSubscriptionRequest as SearchSubscriptionRequestOriginal, type SearchSubscriptionResponse as SearchSubscriptionResponseOriginal, type SearchSubscriptionsRequest as SearchSubscriptionsRequestOriginal, type SearchSubscriptionsRequestPagingMethodOneOf as SearchSubscriptionsRequestPagingMethodOneOfOriginal, type SearchSubscriptionsResponse as SearchSubscriptionsResponseOriginal, type SendSubscriptionActionEventBORequestEventOneOf as SendSubscriptionActionEventBORequestEventOneOfOriginal, type SendSubscriptionActionEventBORequest as SendSubscriptionActionEventBORequestOriginal, type SendSubscriptionActionEventResponse as SendSubscriptionActionEventResponseOriginal, type SendTimeCapsuleTaskCanceledBIRequest as SendTimeCapsuleTaskCanceledBIRequestOriginal, type SetIsMigratedEvent as SetIsMigratedEventOriginal, type SetShiftingDataRequest as SetShiftingDataRequestOriginal, type SetShiftingDataResponse as SetShiftingDataResponseOriginal, type ShippingCharges as ShippingChargesOriginal, type SkipActionConfiguration as SkipActionConfigurationOriginal, type SkipActionSettings as SkipActionSettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type SortingClauses as SortingClausesOriginal, type Sorting as SortingOriginal, type SpecificDateSubscriptionUpdateData as SpecificDateSubscriptionUpdateDataOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type Subscriber as SubscriberOriginal, type SubscriptionActivated as SubscriptionActivatedOriginal, type SubscriptionAutoRenewalTurnedOff as SubscriptionAutoRenewalTurnedOffOriginal, type SubscriptionAutoRenewalTurnedOn as SubscriptionAutoRenewalTurnedOnOriginal, type SubscriptionBackOfficeAction as SubscriptionBackOfficeActionOriginal, type SubscriptionBillingCyclePaid as SubscriptionBillingCyclePaidOriginal, type SubscriptionBillingCycleStarted as SubscriptionBillingCycleStartedOriginal, type SubscriptionBillingDateUpdated as SubscriptionBillingDateUpdatedOriginal, type SubscriptionBillingDetails as SubscriptionBillingDetailsOriginal, type SubscriptionCanceled as SubscriptionCanceledOriginal, type SubscriptionCancellationRequested as SubscriptionCancellationRequestedOriginal, type SubscriptionChangeSummary as SubscriptionChangeSummaryOriginal, type SubscriptionCharge as SubscriptionChargeOriginal, type SubscriptionCharges as SubscriptionChargesOriginal, type SubscriptionCollectionMethodUpdated as SubscriptionCollectionMethodUpdatedOriginal, type SubscriptionCreated as SubscriptionCreatedOriginal, type SubscriptionCycleReadyToPay as SubscriptionCycleReadyToPayOriginal, type SubscriptionCycleTriggered as SubscriptionCycleTriggeredOriginal, type SubscriptionDelayedSyncEvent as SubscriptionDelayedSyncEventOriginal, type SubscriptionDeleted as SubscriptionDeletedOriginal, type SubscriptionDiff as SubscriptionDiffOriginal, type SubscriptionEnded as SubscriptionEndedOriginal, type SubscriptionEvent as SubscriptionEventOriginal, type SubscriptionEventPayloadOneOf as SubscriptionEventPayloadOneOfOriginal, type SubscriptionExpired as SubscriptionExpiredOriginal, type SubscriptionExtendedExtendPolicyOneOf as SubscriptionExtendedExtendPolicyOneOfOriginal, type SubscriptionExtended as SubscriptionExtendedOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionHistoryEntry as SubscriptionHistoryEntryOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionInitialPurchaseCompleted as SubscriptionInitialPurchaseCompletedOriginal, type SubscriptionInvoice as SubscriptionInvoiceOriginal, type SubscriptionItemChange as SubscriptionItemChangeOriginal, type SubscriptionMarkedAsPaid as SubscriptionMarkedAsPaidOriginal, type SubscriptionOfflinePurchaseCompleted as SubscriptionOfflinePurchaseCompletedOriginal, type Subscription as SubscriptionOriginal, type SubscriptionPaused as SubscriptionPausedOriginal, type SubscriptionPolicies as SubscriptionPoliciesOriginal, type SubscriptionPolicy as SubscriptionPolicyOriginal, type SubscriptionResumed as SubscriptionResumedOriginal, type SubscriptionRevived as SubscriptionRevivedOriginal, SubscriptionStatusEnumSubscriptionStatus as SubscriptionStatusEnumSubscriptionStatusOriginal, type SubscriptionStatusEnumSubscriptionStatusWithLiterals as SubscriptionStatusEnumSubscriptionStatusWithLiteralsOriginal, SubscriptionStatusGroup as SubscriptionStatusGroupOriginal, type SubscriptionStatusGroupWithLiterals as SubscriptionStatusGroupWithLiteralsOriginal, type SubscriptionStatus as SubscriptionStatusOriginal, type SubscriptionSuspended as SubscriptionSuspendedOriginal, type SubscriptionTrialPeriod as SubscriptionTrialPeriodOriginal, SubscriptionType as SubscriptionTypeOriginal, type SubscriptionTypeWithLiterals as SubscriptionTypeWithLiteralsOriginal, type SubscriptionUpdateData as SubscriptionUpdateDataOriginal, type SubscriptionUpdated as SubscriptionUpdatedOriginal, type Suspension as SuspensionOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxBreakdown as TaxBreakdownOriginal, type TaxData as TaxDataOriginal, type Tax as TaxOriginal, type TaxSettings as TaxSettingsOriginal, type TaxSummary as TaxSummaryOriginal, type TaxValueOneOf as TaxValueOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TimeBasedProration as TimeBasedProrationOriginal, type Totals as TotalsOriginal, type TurnOffSubscriptionAutoRenewalApplicationErrors as TurnOffSubscriptionAutoRenewalApplicationErrorsOriginal, type TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequestOriginal, type TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponseOriginal, type TurnOnSubscriptionAutoRenewalApplicationErrors as TurnOnSubscriptionAutoRenewalApplicationErrorsOriginal, type TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequestOriginal, type TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponseOriginal, type UnknownSubscriptionEvent as UnknownSubscriptionEventOriginal, type UnsupportedAction as UnsupportedActionOriginal, type UnsupportedReason as UnsupportedReasonOriginal, UpdateAction as UpdateActionOriginal, type UpdateActionWithLiterals as UpdateActionWithLiteralsOriginal, type UpdateBillingDateActionConfiguration as UpdateBillingDateActionConfigurationOriginal, type UpdateBillingDateActionSettings as UpdateBillingDateActionSettingsOriginal, type UpdateBillingDateData as UpdateBillingDateDataOriginal, type UpdateFullSubscriptionRequest as UpdateFullSubscriptionRequestOriginal, type UpdateFullSubscriptionResponse as UpdateFullSubscriptionResponseOriginal, type UpdatePausePaidDurationRequest as UpdatePausePaidDurationRequestOriginal, type UpdatePausePaidDurationResponse as UpdatePausePaidDurationResponseOriginal, type UpdatePaymentMethodBORequest as UpdatePaymentMethodBORequestOriginal, type UpdatePaymentMethodBOResponse as UpdatePaymentMethodBOResponseOriginal, type UpdatePaymentStatusRequest as UpdatePaymentStatusRequestOriginal, type UpdatePaymentStatusResponse as UpdatePaymentStatusResponseOriginal, type UpdateStatusRequest as UpdateStatusRequestOriginal, type UpdateStatusResponse as UpdateStatusResponseOriginal, type UpdateSubscriptionBillingDateApplicationErrors as UpdateSubscriptionBillingDateApplicationErrorsOriginal, type UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequestOriginal, type UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponseOriginal, type UpdateSubscriptionCurrencyRequest as UpdateSubscriptionCurrencyRequestOriginal, type UpdateSubscriptionCurrencyResponse as UpdateSubscriptionCurrencyResponseOriginal, type UpdateSubscriptionInvoiceCycleRequest as UpdateSubscriptionInvoiceCycleRequestOriginal, type UpdateSubscriptionInvoiceCycleResponse as UpdateSubscriptionInvoiceCycleResponseOriginal, type UpdateSubscriptionItemsRequest as UpdateSubscriptionItemsRequestOriginal, type UpdateSubscriptionItemsResponse as UpdateSubscriptionItemsResponseOriginal, type UpdateSubscriptionOriginRequest as UpdateSubscriptionOriginRequestOriginal, type UpdateSubscriptionOriginResponse as UpdateSubscriptionOriginResponseOriginal, type UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequestOriginal, type UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponseOriginal, type UpdateSubscriptionPlatformOriginRequest as UpdateSubscriptionPlatformOriginRequestOriginal, type UpdateSubscriptionPlatformOriginResponse as UpdateSubscriptionPlatformOriginResponseOriginal, type UpdateSubscriptionPoliciesRequest as UpdateSubscriptionPoliciesRequestOriginal, type UpdateSubscriptionPoliciesResponse as UpdateSubscriptionPoliciesResponseOriginal, type UpdateSubscriptionRequest as UpdateSubscriptionRequestOriginal, type UpdateSubscriptionResponse as UpdateSubscriptionResponseOriginal, type UpdateSubscriptionStartDateRequest as UpdateSubscriptionStartDateRequestOriginal, type UpdateSubscriptionStartDateResponse as UpdateSubscriptionStartDateResponseOriginal, type UpdatesApplied as UpdatesAppliedOriginal, type UpmActionSettings as UpmActionSettingsOriginal, type V1Duration as V1DurationOriginal, type V1ProrationResult as V1ProrationResultOriginal, type V1SubscriptionActivated as V1SubscriptionActivatedOriginal, type V1SubscriptionCanceled as V1SubscriptionCanceledOriginal, type V1SubscriptionCreated as V1SubscriptionCreatedOriginal, type V1SubscriptionEventEventOneOf as V1SubscriptionEventEventOneOfOriginal, type V1SubscriptionEvent as V1SubscriptionEventOriginal, type V1SubscriptionInitialPurchaseCompleted as V1SubscriptionInitialPurchaseCompletedOriginal, type V1Subscription as V1SubscriptionOriginal, type V1SubscriptionResumed as V1SubscriptionResumedOriginal, V1SubscriptionStatusEnumSubscriptionStatus as V1SubscriptionStatusEnumSubscriptionStatusOriginal, type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals as V1SubscriptionStatusEnumSubscriptionStatusWithLiteralsOriginal, type V1SubscriptionUpdated as V1SubscriptionUpdatedOriginal, type V2Subscription as V2SubscriptionOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, allowedActions, cancelSubscription, countSubscriptions, customerAllowedActions, customerCancelScheduledPause, customerCancelScheduledSkip, customerCancelSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerPauseSubscription, customerQuerySubscriptions, customerResumeSubscription, customerSkipCycle, customerTurnOffSubscriptionAutoRenewal, customerTurnOnSubscriptionAutoRenewal, customerUpdateBillingDate, customerUpdateSubscriptionPaymentMethod, extendSubscription, getSubscription, getSubscriptionsStats, initiatePaymentMethodSetup, listSubscriptionHistory, listUpcomingCharges, markBillingCycleAsPaid, markLatestInvoiceAsPaid, pauseSubscription, previewSubscriptionCharges, previewSubscriptionsCharges, querySubscriptions, resumeSubscription, reviseSubscription, searchSubscriptions, turnOffSubscriptionAutoRenewal, turnOnSubscriptionAutoRenewal, updateSubscriptionBillingDate, updateSubscriptionPaymentMethod };
|