@wix/auto_sdk_subscription_subscriptions 1.0.47 → 1.0.49
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 +402 -142
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2020 -1771
- package/build/cjs/index.typings.js +338 -97
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1991 -1762
- package/build/cjs/meta.js +291 -92
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +3 -11
- package/build/es/index.mjs +396 -141
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2020 -1771
- package/build/es/index.typings.mjs +332 -96
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1991 -1762
- package/build/es/meta.mjs +285 -91
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +28 -10
- package/build/internal/cjs/index.typings.d.ts +1713 -1383
- package/build/internal/cjs/meta.d.ts +2124 -1783
- package/build/internal/es/index.d.mts +28 -10
- package/build/internal/es/index.typings.d.mts +1713 -1383
- package/build/internal/es/meta.d.mts +2124 -1783
- 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
package/build/cjs/meta.d.ts
CHANGED
|
@@ -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, CustomerChangeSubscriptionRequest as CustomerChangeSubscriptionRequest$1, CustomerChangeSubscriptionResponse as CustomerChangeSubscriptionResponse$1, CustomerPreviewChangeSubscriptionRequest as CustomerPreviewChangeSubscriptionRequest$1, CustomerPreviewChangeSubscriptionResponse as CustomerPreviewChangeSubscriptionResponse$1, CustomerCancelPendingChangeRequest as CustomerCancelPendingChangeRequest$1, CustomerCancelPendingChangeResponse as CustomerCancelPendingChangeResponse$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 {
|
|
@@ -652,6 +652,13 @@ interface Totals {
|
|
|
652
652
|
* @readonly
|
|
653
653
|
*/
|
|
654
654
|
tax?: string | null;
|
|
655
|
+
/**
|
|
656
|
+
* Tax-exempt amount.
|
|
657
|
+
* @format DECIMAL_VALUE
|
|
658
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
659
|
+
* @readonly
|
|
660
|
+
*/
|
|
661
|
+
exempt?: string | null;
|
|
655
662
|
/**
|
|
656
663
|
* Total discount.
|
|
657
664
|
* @format DECIMAL_VALUE
|
|
@@ -854,11 +861,16 @@ interface SubscriptionPolicies {
|
|
|
854
861
|
/** Subscription can be canceled not only immediately, but also at end of billing cycle by turning off auto-renew */
|
|
855
862
|
allowEndOfCycleCancellation?: boolean;
|
|
856
863
|
/**
|
|
857
|
-
*
|
|
858
|
-
*
|
|
859
|
-
*
|
|
864
|
+
* Deprecated. Never in production. BASS does not read or write this field; UoU gates use
|
|
865
|
+
* `CustomerSettingsResolver` → BBS `customer_settings_by_app_def_id` or Legacy booleans above.
|
|
866
|
+
* @deprecated
|
|
860
867
|
*/
|
|
861
868
|
customerActionSettings?: CustomerActionSettings;
|
|
869
|
+
/**
|
|
870
|
+
* Number of self-service actions already used on this subscription.
|
|
871
|
+
* @readonly
|
|
872
|
+
*/
|
|
873
|
+
customerActionCounters?: CustomerActionCounters;
|
|
862
874
|
}
|
|
863
875
|
/**
|
|
864
876
|
* Per-action merchant configuration for customer self-service actions.
|
|
@@ -975,6 +987,18 @@ interface UpdateBillingDateActionConfiguration {
|
|
|
975
987
|
/** Whether to allow advancing billing date for weekly subscriptions */
|
|
976
988
|
allowAdvanceForWeekly?: boolean | null;
|
|
977
989
|
}
|
|
990
|
+
interface CustomerActionCounters {
|
|
991
|
+
/**
|
|
992
|
+
* Number of self-service skips already used. Unset means zero.
|
|
993
|
+
* @readonly
|
|
994
|
+
*/
|
|
995
|
+
skipCount?: number | null;
|
|
996
|
+
/**
|
|
997
|
+
* Number of self-service pauses already used. Unset means zero.
|
|
998
|
+
* @readonly
|
|
999
|
+
*/
|
|
1000
|
+
pauseCount?: number | null;
|
|
1001
|
+
}
|
|
978
1002
|
interface PauseInfo {
|
|
979
1003
|
pausePolicy?: PausePolicyWithLiterals;
|
|
980
1004
|
pauseAt?: PauseAtWithLiterals;
|
|
@@ -1345,6 +1369,11 @@ interface Sorting {
|
|
|
1345
1369
|
fieldName?: string;
|
|
1346
1370
|
/** Sort order. */
|
|
1347
1371
|
order?: SortOrderWithLiterals;
|
|
1372
|
+
/**
|
|
1373
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
1374
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1375
|
+
*/
|
|
1376
|
+
origin?: AddressLocation;
|
|
1348
1377
|
}
|
|
1349
1378
|
declare enum SortOrder {
|
|
1350
1379
|
ASC = "ASC",
|
|
@@ -1352,6 +1381,12 @@ declare enum SortOrder {
|
|
|
1352
1381
|
}
|
|
1353
1382
|
/** @enumType */
|
|
1354
1383
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1384
|
+
interface AddressLocation {
|
|
1385
|
+
/** Address latitude. */
|
|
1386
|
+
latitude?: number | null;
|
|
1387
|
+
/** Address longitude. */
|
|
1388
|
+
longitude?: number | null;
|
|
1389
|
+
}
|
|
1355
1390
|
interface Paging {
|
|
1356
1391
|
/** Number of items to load. */
|
|
1357
1392
|
limit?: number | null;
|
|
@@ -1516,10 +1551,11 @@ declare enum ActionType {
|
|
|
1516
1551
|
UPDATE_BILLING_DATE = "UPDATE_BILLING_DATE",
|
|
1517
1552
|
UPDATE_COLLECTION_METHOD = "UPDATE_COLLECTION_METHOD",
|
|
1518
1553
|
SKIP_CYCLE = "SKIP_CYCLE",
|
|
1519
|
-
CUSTOMER_UPDATE_BILLING_DATE = "CUSTOMER_UPDATE_BILLING_DATE"
|
|
1554
|
+
CUSTOMER_UPDATE_BILLING_DATE = "CUSTOMER_UPDATE_BILLING_DATE",
|
|
1555
|
+
CHANGE_SUBSCRIPTION = "CHANGE_SUBSCRIPTION"
|
|
1520
1556
|
}
|
|
1521
1557
|
/** @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';
|
|
1558
|
+
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
1559
|
declare enum ExtendPolicyType {
|
|
1524
1560
|
PERIOD = "PERIOD",
|
|
1525
1561
|
BILLING_CYCLE = "BILLING_CYCLE"
|
|
@@ -1853,6 +1889,12 @@ interface LineItemTaxSummary {
|
|
|
1853
1889
|
* @decimalValue options { maxScale:4 }
|
|
1854
1890
|
*/
|
|
1855
1891
|
finalTaxAmount?: string | null;
|
|
1892
|
+
/**
|
|
1893
|
+
* 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.
|
|
1894
|
+
* @format DECIMAL_VALUE
|
|
1895
|
+
* @decimalValue options { maxScale:4 }
|
|
1896
|
+
*/
|
|
1897
|
+
exemptAmount?: string | null;
|
|
1856
1898
|
}
|
|
1857
1899
|
interface FixedPriceConfig {
|
|
1858
1900
|
}
|
|
@@ -2061,6 +2103,182 @@ interface CustomerUpdateBillingDateRequest {
|
|
|
2061
2103
|
interface CustomerUpdateBillingDateResponse {
|
|
2062
2104
|
subscription?: Subscription;
|
|
2063
2105
|
}
|
|
2106
|
+
interface CustomerChangeSubscriptionRequest {
|
|
2107
|
+
/** @format GUID */
|
|
2108
|
+
subscriptionId: string;
|
|
2109
|
+
/** @maxSize 100 */
|
|
2110
|
+
itemChanges?: SubscriptionItemChange[];
|
|
2111
|
+
newCycle?: Duration;
|
|
2112
|
+
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* Describes a change to a single subscription item.
|
|
2116
|
+
* The caller (BG/CVS) resolves pricing from their catalog and passes concrete values.
|
|
2117
|
+
*/
|
|
2118
|
+
interface SubscriptionItemChange {
|
|
2119
|
+
/**
|
|
2120
|
+
* Which item to change. Must match an existing item ID in the subscription.
|
|
2121
|
+
* @format GUID
|
|
2122
|
+
*/
|
|
2123
|
+
itemId?: string;
|
|
2124
|
+
/**
|
|
2125
|
+
* New price per unit. Caller resolves this from their product catalog.
|
|
2126
|
+
* Required when changing product/plan. Optional for quantity-only changes (uses current price).
|
|
2127
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
2128
|
+
*/
|
|
2129
|
+
newPrice?: string | null;
|
|
2130
|
+
/**
|
|
2131
|
+
* New quantity (seats/licenses). Optional — unchanged if not set.
|
|
2132
|
+
* @min 1
|
|
2133
|
+
*/
|
|
2134
|
+
newQuantity?: number | null;
|
|
2135
|
+
/**
|
|
2136
|
+
* New catalog reference. Optional — set when changing to a different product.
|
|
2137
|
+
* This is metadata for the caller's tracking; BASS does not use it for pricing.
|
|
2138
|
+
*/
|
|
2139
|
+
newCatalogReference?: CatalogReference;
|
|
2140
|
+
/**
|
|
2141
|
+
* New item name. Optional — set when changing to a different product.
|
|
2142
|
+
* @maxLength 200
|
|
2143
|
+
*/
|
|
2144
|
+
newName?: string | null;
|
|
2145
|
+
}
|
|
2146
|
+
declare enum ChangeEffectiveTime {
|
|
2147
|
+
UNKNOWN = "UNKNOWN",
|
|
2148
|
+
/** Apply change immediately with proration */
|
|
2149
|
+
IMMEDIATELY = "IMMEDIATELY",
|
|
2150
|
+
/** Schedule change for the next billing cycle */
|
|
2151
|
+
AT_NEXT_RENEWAL = "AT_NEXT_RENEWAL"
|
|
2152
|
+
}
|
|
2153
|
+
/** @enumType */
|
|
2154
|
+
type ChangeEffectiveTimeWithLiterals = ChangeEffectiveTime | 'UNKNOWN' | 'IMMEDIATELY' | 'AT_NEXT_RENEWAL';
|
|
2155
|
+
interface CustomerChangeSubscriptionResponse {
|
|
2156
|
+
subscription?: Subscription;
|
|
2157
|
+
}
|
|
2158
|
+
interface CustomerPreviewChangeSubscriptionRequest {
|
|
2159
|
+
/** @format GUID */
|
|
2160
|
+
subscriptionId: string;
|
|
2161
|
+
/** @maxSize 100 */
|
|
2162
|
+
itemChanges?: SubscriptionItemChange[];
|
|
2163
|
+
newCycle?: Duration;
|
|
2164
|
+
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
2165
|
+
}
|
|
2166
|
+
interface CustomerPreviewChangeSubscriptionResponse {
|
|
2167
|
+
preview?: PreviewChangeSubscriptionResponse;
|
|
2168
|
+
}
|
|
2169
|
+
interface PreviewChangeSubscriptionResponse {
|
|
2170
|
+
/** Summary of the current subscription state */
|
|
2171
|
+
current?: SubscriptionChangeSummary;
|
|
2172
|
+
/** Summary of the proposed subscription state after the change */
|
|
2173
|
+
proposed?: SubscriptionChangeSummary;
|
|
2174
|
+
/** Proration preview details. Present only for immediate changes. */
|
|
2175
|
+
proration?: ProrationPreview;
|
|
2176
|
+
/** Renewal preview. Present only for changes at next renewal. */
|
|
2177
|
+
renewalPreview?: RenewalPreview;
|
|
2178
|
+
}
|
|
2179
|
+
/** Summary of a subscription's state, used in change previews. */
|
|
2180
|
+
interface SubscriptionChangeSummary {
|
|
2181
|
+
/** Product ID */
|
|
2182
|
+
productId?: string;
|
|
2183
|
+
/** Product name */
|
|
2184
|
+
productName?: string;
|
|
2185
|
+
/** Billing cycle duration */
|
|
2186
|
+
cycle?: Duration;
|
|
2187
|
+
/** Number of units */
|
|
2188
|
+
quantity?: number;
|
|
2189
|
+
/**
|
|
2190
|
+
* Price per unit
|
|
2191
|
+
* @format DECIMAL_VALUE
|
|
2192
|
+
*/
|
|
2193
|
+
pricePerUnit?: string;
|
|
2194
|
+
/**
|
|
2195
|
+
* Total price (price_per_unit * quantity)
|
|
2196
|
+
* @format DECIMAL_VALUE
|
|
2197
|
+
*/
|
|
2198
|
+
totalPrice?: string;
|
|
2199
|
+
/**
|
|
2200
|
+
* Currency code (ISO 4217)
|
|
2201
|
+
* @format CURRENCY
|
|
2202
|
+
*/
|
|
2203
|
+
currency?: string;
|
|
2204
|
+
/** Current billing period start */
|
|
2205
|
+
periodStart?: Date | null;
|
|
2206
|
+
/** Current billing period end */
|
|
2207
|
+
periodEnd?: Date | null;
|
|
2208
|
+
}
|
|
2209
|
+
/** Preview of proration amounts for a proposed subscription change. */
|
|
2210
|
+
interface ProrationPreview {
|
|
2211
|
+
/**
|
|
2212
|
+
* Credit amount for unused time on the current plan
|
|
2213
|
+
* @format DECIMAL_VALUE
|
|
2214
|
+
*/
|
|
2215
|
+
creditAmount?: string;
|
|
2216
|
+
/**
|
|
2217
|
+
* Charge amount for the new plan's prorated price
|
|
2218
|
+
* @format DECIMAL_VALUE
|
|
2219
|
+
*/
|
|
2220
|
+
chargeAmount?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
* Net amount (charge minus credit)
|
|
2223
|
+
* @format DECIMAL_VALUE
|
|
2224
|
+
*/
|
|
2225
|
+
netAmount?: string;
|
|
2226
|
+
/**
|
|
2227
|
+
* Tax amount on the net proration
|
|
2228
|
+
* @format DECIMAL_VALUE
|
|
2229
|
+
*/
|
|
2230
|
+
taxAmount?: string;
|
|
2231
|
+
/**
|
|
2232
|
+
* Total amount including tax
|
|
2233
|
+
* @format DECIMAL_VALUE
|
|
2234
|
+
*/
|
|
2235
|
+
totalAmount?: string;
|
|
2236
|
+
/** Remaining seconds in the current billing period */
|
|
2237
|
+
remainingSeconds?: string;
|
|
2238
|
+
/** Total seconds in the current billing cycle */
|
|
2239
|
+
totalCycleSeconds?: string;
|
|
2240
|
+
/** New period end date. Present when proration_behavior is PRORATE_AND_EXTEND. */
|
|
2241
|
+
newPeriodEnd?: Date | null;
|
|
2242
|
+
/** Number of days added to the billing period. Present when proration_behavior is PRORATE_AND_EXTEND. */
|
|
2243
|
+
daysAdded?: number;
|
|
2244
|
+
/** The proration action that would be taken */
|
|
2245
|
+
action?: ProrationActionWithLiterals;
|
|
2246
|
+
}
|
|
2247
|
+
declare enum ProrationAction {
|
|
2248
|
+
UNKNOWN = "UNKNOWN",
|
|
2249
|
+
/** Net charge to customer */
|
|
2250
|
+
CHARGE = "CHARGE",
|
|
2251
|
+
/** Net refund to customer */
|
|
2252
|
+
REFUND = "REFUND",
|
|
2253
|
+
/** Extend billing period instead of refund */
|
|
2254
|
+
EXTEND_PERIOD = "EXTEND_PERIOD",
|
|
2255
|
+
/** No financial change needed */
|
|
2256
|
+
NO_CHANGE = "NO_CHANGE"
|
|
2257
|
+
}
|
|
2258
|
+
/** @enumType */
|
|
2259
|
+
type ProrationActionWithLiterals = ProrationAction | 'UNKNOWN' | 'CHARGE' | 'REFUND' | 'EXTEND_PERIOD' | 'NO_CHANGE';
|
|
2260
|
+
/** Preview of what the next renewal will look like after a change. */
|
|
2261
|
+
interface RenewalPreview {
|
|
2262
|
+
/**
|
|
2263
|
+
* New price per unit at next renewal
|
|
2264
|
+
* @format DECIMAL_VALUE
|
|
2265
|
+
*/
|
|
2266
|
+
newPrice?: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* New total at next renewal (price * quantity)
|
|
2269
|
+
* @format DECIMAL_VALUE
|
|
2270
|
+
*/
|
|
2271
|
+
newTotal?: string;
|
|
2272
|
+
/** Date of the next renewal */
|
|
2273
|
+
nextRenewalDate?: Date | null;
|
|
2274
|
+
}
|
|
2275
|
+
interface CustomerCancelPendingChangeRequest {
|
|
2276
|
+
/** @format GUID */
|
|
2277
|
+
subscriptionId: string;
|
|
2278
|
+
}
|
|
2279
|
+
interface CustomerCancelPendingChangeResponse {
|
|
2280
|
+
subscription?: Subscription;
|
|
2281
|
+
}
|
|
2064
2282
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2065
2283
|
createdEvent?: EntityCreatedEvent;
|
|
2066
2284
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -2090,7 +2308,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2090
2308
|
/** If present, indicates the action that triggered the event. */
|
|
2091
2309
|
originatedFrom?: string | null;
|
|
2092
2310
|
/**
|
|
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
|
|
2311
|
+
* 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
2312
|
* 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
2313
|
*/
|
|
2096
2314
|
entityEventSequence?: string | null;
|
|
@@ -2216,12 +2434,64 @@ interface AccountInfo {
|
|
|
2216
2434
|
*/
|
|
2217
2435
|
siteId?: string | null;
|
|
2218
2436
|
}
|
|
2219
|
-
interface
|
|
2220
|
-
|
|
2437
|
+
interface SetIsMigratedEvent {
|
|
2438
|
+
/** @format GUID */
|
|
2439
|
+
subscriptionId?: string;
|
|
2440
|
+
}
|
|
2441
|
+
interface SubscriptionDelayedSyncEvent {
|
|
2442
|
+
/** @format GUID */
|
|
2443
|
+
subscriptionId?: string;
|
|
2444
|
+
}
|
|
2445
|
+
interface InvoiceAction extends InvoiceActionActionTypeOneOf {
|
|
2446
|
+
payRecurring?: PayRecurringInvoice;
|
|
2221
2447
|
}
|
|
2222
2448
|
/** @oneof */
|
|
2223
|
-
interface
|
|
2224
|
-
|
|
2449
|
+
interface InvoiceActionActionTypeOneOf {
|
|
2450
|
+
payRecurring?: PayRecurringInvoice;
|
|
2451
|
+
}
|
|
2452
|
+
interface PayRecurringInvoice {
|
|
2453
|
+
/** @format GUID */
|
|
2454
|
+
invoiceId?: string;
|
|
2455
|
+
}
|
|
2456
|
+
/**
|
|
2457
|
+
* Sent each time a subscription status has been set to Active
|
|
2458
|
+
* Active shows that a subscription is live and operational.
|
|
2459
|
+
* For example:
|
|
2460
|
+
* * For subscription with free trial, free trial start date is also the activation date.
|
|
2461
|
+
* * For a subscription with future start date, the start date is also the activation date.
|
|
2462
|
+
* * When a subscription is resumed from a pause status, the resume date is also the activation date.
|
|
2463
|
+
*/
|
|
2464
|
+
interface SubscriptionActivated {
|
|
2465
|
+
subscription?: Subscription;
|
|
2466
|
+
}
|
|
2467
|
+
/**
|
|
2468
|
+
* Sent each time a subscription status has been set to Ended
|
|
2469
|
+
* Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
|
|
2470
|
+
* This is different from a Canceled subscription which ends the subscription before a designated end date.
|
|
2471
|
+
* Therefore, Ended and Canceled are mutually exclusive.
|
|
2472
|
+
*/
|
|
2473
|
+
interface SubscriptionEnded {
|
|
2474
|
+
subscription?: Subscription;
|
|
2475
|
+
}
|
|
2476
|
+
interface SubscriptionInitialPurchaseCompleted {
|
|
2477
|
+
subscription?: Subscription;
|
|
2478
|
+
actionDetails?: ActionDetails;
|
|
2479
|
+
/** @format GUID */
|
|
2480
|
+
paymentTransactionId?: string | null;
|
|
2481
|
+
}
|
|
2482
|
+
interface SubscriptionCycleReadyToPay {
|
|
2483
|
+
subscription?: Subscription;
|
|
2484
|
+
}
|
|
2485
|
+
interface SubscriptionBillingCycleStarted {
|
|
2486
|
+
subscription?: Subscription;
|
|
2487
|
+
/**
|
|
2488
|
+
* Wix Pay transaction id, optional. Exists if event was triggered by a payment.
|
|
2489
|
+
* @format GUID
|
|
2490
|
+
*/
|
|
2491
|
+
paymentTransactionId?: string | null;
|
|
2492
|
+
}
|
|
2493
|
+
interface SubscriptionRevived {
|
|
2494
|
+
subscription?: Subscription;
|
|
2225
2495
|
}
|
|
2226
2496
|
interface CreateSubscriptionRequest {
|
|
2227
2497
|
subscription?: Subscription;
|
|
@@ -2241,2148 +2511,2083 @@ interface OriginOverride {
|
|
|
2241
2511
|
/** @format GUID */
|
|
2242
2512
|
instanceId?: string;
|
|
2243
2513
|
}
|
|
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;
|
|
2514
|
+
interface CreateSubscriptionResponse {
|
|
2268
2515
|
subscription?: Subscription;
|
|
2516
|
+
/**
|
|
2517
|
+
* Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions.
|
|
2518
|
+
* @format GUID
|
|
2519
|
+
*/
|
|
2520
|
+
paymentOrderId?: string | null;
|
|
2269
2521
|
}
|
|
2270
|
-
interface
|
|
2271
|
-
/**
|
|
2272
|
-
id?: string;
|
|
2273
|
-
}
|
|
2274
|
-
interface GetFullSubscriptionDataResponse {
|
|
2522
|
+
interface UpdateSubscriptionRequest {
|
|
2523
|
+
/** Revision is validated if Subscription.revision is set */
|
|
2275
2524
|
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[];
|
|
2525
|
+
/** Supported fields: customer, metadata */
|
|
2526
|
+
fieldMask?: string[];
|
|
2288
2527
|
}
|
|
2289
|
-
interface
|
|
2290
|
-
|
|
2291
|
-
originSystem?: string;
|
|
2292
|
-
/** date when the Subscription started to be managed in BASS */
|
|
2293
|
-
shiftManagementDate?: Date | null;
|
|
2528
|
+
interface UpdateSubscriptionResponse {
|
|
2529
|
+
subscription?: Subscription;
|
|
2294
2530
|
}
|
|
2295
|
-
interface
|
|
2531
|
+
interface UpdateSubscriptionStartDateRequest {
|
|
2532
|
+
/**
|
|
2533
|
+
* Subscription ID
|
|
2534
|
+
* @format GUID
|
|
2535
|
+
*/
|
|
2536
|
+
id?: string;
|
|
2537
|
+
/**
|
|
2538
|
+
* Can be updated only if Subscription is in Draft state
|
|
2539
|
+
* By setting start_date in the future, end_date will be recalculated for termed Subscriptions
|
|
2540
|
+
* cycles_to_pay_on_creation will be set to 1 if no free trial is set
|
|
2541
|
+
*/
|
|
2296
2542
|
startDate?: Date | null;
|
|
2297
|
-
endDate?: Date | null;
|
|
2298
|
-
}
|
|
2299
|
-
interface GetSubscriptionAndInternalDataRequest {
|
|
2300
|
-
/** @format GUID */
|
|
2301
|
-
subscriptionId?: string;
|
|
2302
|
-
/** @format GUID */
|
|
2303
|
-
tenantId?: string;
|
|
2304
2543
|
}
|
|
2305
|
-
interface
|
|
2544
|
+
interface UpdateSubscriptionStartDateResponse {
|
|
2306
2545
|
subscription?: Subscription;
|
|
2307
|
-
internalSubscriptionData?: InternalSubscriptionData;
|
|
2308
2546
|
}
|
|
2309
|
-
interface
|
|
2310
|
-
/**
|
|
2547
|
+
interface BassToSapiPaypalMigrationRequest {
|
|
2548
|
+
/**
|
|
2549
|
+
* Subscription ID
|
|
2550
|
+
* @format GUID
|
|
2551
|
+
*/
|
|
2311
2552
|
id?: string;
|
|
2312
|
-
|
|
2313
|
-
tenantId?: string;
|
|
2553
|
+
collectionMethod?: CollectionMethodEnumCollectionMethodWithLiterals;
|
|
2314
2554
|
}
|
|
2315
|
-
interface
|
|
2555
|
+
interface BassToSapiPaypalMigrationResponse {
|
|
2316
2556
|
subscription?: Subscription;
|
|
2317
2557
|
}
|
|
2318
|
-
interface
|
|
2319
|
-
/** @format GUID */
|
|
2320
|
-
subscriptionId?: string;
|
|
2558
|
+
interface UpdateSubscriptionPoliciesRequest {
|
|
2321
2559
|
/**
|
|
2322
|
-
*
|
|
2323
|
-
* @
|
|
2560
|
+
* Subscription ID
|
|
2561
|
+
* @format GUID
|
|
2324
2562
|
*/
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
tenantId?: string;
|
|
2563
|
+
id?: string;
|
|
2564
|
+
cancellableByCustomer?: boolean | null;
|
|
2328
2565
|
}
|
|
2329
|
-
interface
|
|
2566
|
+
interface UpdateSubscriptionPoliciesResponse {
|
|
2567
|
+
/** Updated policies of the subscription */
|
|
2568
|
+
policies?: SubscriptionPolicies;
|
|
2330
2569
|
}
|
|
2331
|
-
interface
|
|
2332
|
-
/**
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2570
|
+
interface UpdateSubscriptionBillingDateRequest {
|
|
2571
|
+
/**
|
|
2572
|
+
* ID of the subscription to update the billing date for.
|
|
2573
|
+
* @format GUID
|
|
2574
|
+
*/
|
|
2575
|
+
id: string;
|
|
2576
|
+
/** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
|
|
2577
|
+
billingDate: Date | null;
|
|
2578
|
+
/**
|
|
2579
|
+
* Information about how BASS adjusts the total of the next invoice. Extending
|
|
2580
|
+
* the current billing cycle results in a higher payment, while shortening it
|
|
2581
|
+
* leads to a lower payment. BASS offers automatic calculation of the proration
|
|
2582
|
+
* amount based on the number of days added to or removed from the current billing
|
|
2583
|
+
* cycle. Alternatively, you can use your own custom method to calculate the
|
|
2584
|
+
* proration amount. The custom proration amount can't exceed the total of the
|
|
2585
|
+
* current billing cycle.
|
|
2586
|
+
*/
|
|
2587
|
+
proration?: Proration;
|
|
2337
2588
|
}
|
|
2338
|
-
interface
|
|
2589
|
+
interface UpdateSubscriptionBillingDateResponse {
|
|
2590
|
+
/** Updated subscription. */
|
|
2339
2591
|
subscription?: Subscription;
|
|
2340
2592
|
}
|
|
2341
|
-
interface
|
|
2342
|
-
/** @format GUID */
|
|
2343
|
-
subscriptionId?: string;
|
|
2344
|
-
/** @format GUID */
|
|
2345
|
-
tenantId?: string;
|
|
2346
|
-
paymentStatus?: PaymentStatusWithLiterals;
|
|
2347
|
-
}
|
|
2348
|
-
interface UpdatePaymentStatusResponse {
|
|
2593
|
+
interface SubscriptionBillingDateUpdated {
|
|
2349
2594
|
subscription?: Subscription;
|
|
2595
|
+
billingDate?: Date | null;
|
|
2596
|
+
proration?: Proration;
|
|
2350
2597
|
}
|
|
2351
|
-
interface
|
|
2352
|
-
/**
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2598
|
+
interface UpdateSubscriptionOriginRequest {
|
|
2599
|
+
/**
|
|
2600
|
+
* ID of the subscription to update origin.
|
|
2601
|
+
* @format GUID
|
|
2602
|
+
*/
|
|
2603
|
+
id?: string;
|
|
2604
|
+
/**
|
|
2605
|
+
* Origin entity ID of the subscription to update.
|
|
2606
|
+
* @format GUID
|
|
2607
|
+
*/
|
|
2608
|
+
entityId?: string;
|
|
2356
2609
|
}
|
|
2357
|
-
interface
|
|
2610
|
+
interface UpdateSubscriptionOriginResponse {
|
|
2611
|
+
/** Updated subscription. */
|
|
2358
2612
|
subscription?: Subscription;
|
|
2359
2613
|
}
|
|
2360
|
-
interface
|
|
2361
|
-
/**
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2614
|
+
interface ReviseSubscriptionRequest {
|
|
2615
|
+
/**
|
|
2616
|
+
* Subscription ID
|
|
2617
|
+
* @format GUID
|
|
2618
|
+
*/
|
|
2619
|
+
id: string;
|
|
2620
|
+
/**
|
|
2621
|
+
* 0 for no revision, maxSize is 100
|
|
2622
|
+
* @maxSize 100
|
|
2623
|
+
*/
|
|
2624
|
+
items?: Item[];
|
|
2365
2625
|
}
|
|
2366
|
-
interface
|
|
2626
|
+
interface ReviseSubscriptionResponse {
|
|
2367
2627
|
subscription?: Subscription;
|
|
2368
2628
|
}
|
|
2369
|
-
interface
|
|
2370
|
-
/**
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2629
|
+
interface UpdateSubscriptionItemsRequest {
|
|
2630
|
+
/**
|
|
2631
|
+
* Subscription ID
|
|
2632
|
+
* @format GUID
|
|
2633
|
+
*/
|
|
2634
|
+
id?: string;
|
|
2635
|
+
/** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
|
|
2636
|
+
updateAction?: UpdateActionWithLiterals;
|
|
2637
|
+
/** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
|
|
2638
|
+
scheduleAdditionalInfo?: ScheduleAdditionalInfo;
|
|
2639
|
+
/**
|
|
2640
|
+
* Existing items to update
|
|
2641
|
+
* @maxSize 100
|
|
2642
|
+
*/
|
|
2643
|
+
itemsToUpdate?: ItemChange[];
|
|
2644
|
+
/**
|
|
2645
|
+
* Items to add
|
|
2646
|
+
* @maxSize 99
|
|
2647
|
+
*/
|
|
2648
|
+
itemsToAdd?: Item[];
|
|
2649
|
+
/**
|
|
2650
|
+
* Existing items to delete
|
|
2651
|
+
* @format GUID
|
|
2652
|
+
* @maxSize 99
|
|
2653
|
+
*/
|
|
2654
|
+
itemsToDelete?: string[] | null;
|
|
2376
2655
|
}
|
|
2377
|
-
declare enum
|
|
2378
|
-
|
|
2379
|
-
|
|
2656
|
+
declare enum UpdateAction {
|
|
2657
|
+
NONE = "NONE",
|
|
2658
|
+
/** Update subscription immediately, please note proration for updates changing price are not yet supported */
|
|
2659
|
+
IMMEDIATELY = "IMMEDIATELY",
|
|
2660
|
+
/** Request updates that will take affect only at the start of the next billing cycle. */
|
|
2661
|
+
NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
|
|
2662
|
+
/** Reset all pending updates */
|
|
2663
|
+
RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
|
|
2664
|
+
/** Request updates that will take affect only at a specific date. */
|
|
2665
|
+
SPECIFIC_DATE = "SPECIFIC_DATE"
|
|
2380
2666
|
}
|
|
2381
2667
|
/** @enumType */
|
|
2382
|
-
type
|
|
2383
|
-
interface
|
|
2384
|
-
subscription?: Subscription;
|
|
2385
|
-
}
|
|
2386
|
-
interface ConvertSapiRequest {
|
|
2387
|
-
/** @format GUID */
|
|
2388
|
-
subscriptionId?: string;
|
|
2389
|
-
}
|
|
2390
|
-
interface ConvertSapiResponse {
|
|
2668
|
+
type UpdateActionWithLiterals = UpdateAction | 'NONE' | 'IMMEDIATELY' | 'NEXT_BILLING_CYCLE' | 'RESET_PENDING_UPDATES' | 'SPECIFIC_DATE';
|
|
2669
|
+
interface UpdateSubscriptionItemsResponse {
|
|
2391
2670
|
subscription?: Subscription;
|
|
2392
2671
|
}
|
|
2393
|
-
interface
|
|
2394
|
-
/**
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
}
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
|
|
2672
|
+
interface BulkUpdateSubscriptionItemsByFilterRequest {
|
|
2673
|
+
/**
|
|
2674
|
+
* Filter to identify the subscriptions for which items are updated. For
|
|
2675
|
+
* supported fields see
|
|
2676
|
+
* [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).
|
|
2677
|
+
* Sending an empty subscription filter results in a validation error.
|
|
2678
|
+
* In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
|
|
2679
|
+
* `subscriptionId` field inside this filter. Passing any other filter results
|
|
2680
|
+
* in a failed validation error.
|
|
2681
|
+
*/
|
|
2682
|
+
subscriptionFilter?: Record<string, any> | null;
|
|
2683
|
+
/**
|
|
2684
|
+
* Filter to specify which subscription items are updated. Make sure to use
|
|
2685
|
+
* the catalog item ID and not the item's unique ID. All subscription items
|
|
2686
|
+
* with matching `items.catalogReference.catalogItemId` are updated.
|
|
2687
|
+
*
|
|
2688
|
+
* Max: `100` reference catalog item IDs
|
|
2689
|
+
* @format GUID
|
|
2690
|
+
* @maxSize 100
|
|
2691
|
+
*/
|
|
2692
|
+
catalogReferenceIds?: string[] | null;
|
|
2693
|
+
/**
|
|
2694
|
+
* Information about the update timing and update type.
|
|
2695
|
+
*
|
|
2696
|
+
* + `"IMMEDIATELY"`: The updates become effective immediately.
|
|
2697
|
+
* + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
|
|
2698
|
+
* + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
|
|
2699
|
+
* + `"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.
|
|
2700
|
+
*/
|
|
2701
|
+
updateAction?: UpdateActionWithLiterals;
|
|
2702
|
+
/**
|
|
2703
|
+
* Additional information for updates. Currently, only supported for
|
|
2704
|
+
* `{"updateAction": "SPECIFIC_DATE"}`.
|
|
2705
|
+
*/
|
|
2706
|
+
scheduleAdditionalInfo?: ScheduleAdditionalInfo;
|
|
2707
|
+
/**
|
|
2708
|
+
* Update details for the susbcription items that match the filtering.
|
|
2709
|
+
* Currently, you can update only the item price, quantity, and tax. Note
|
|
2710
|
+
* that all item properties are updated to the same values. In case you want set
|
|
2711
|
+
* different values for individual items, you must call
|
|
2712
|
+
* _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
|
|
2713
|
+
*/
|
|
2714
|
+
bulkItemUpdateData?: BulkItemChange;
|
|
2715
|
+
/**
|
|
2716
|
+
* __Not implemented yet__. Items to add to the subscriptions matching the filtering.
|
|
2717
|
+
* @maxSize 99
|
|
2718
|
+
*/
|
|
2719
|
+
itemsToAdd?: Item[];
|
|
2414
2720
|
}
|
|
2415
|
-
interface
|
|
2416
|
-
/**
|
|
2417
|
-
|
|
2418
|
-
/**
|
|
2419
|
-
|
|
2721
|
+
interface BulkItemChange {
|
|
2722
|
+
/** Information about the new item price. */
|
|
2723
|
+
pricingModel?: PricingModel;
|
|
2724
|
+
/**
|
|
2725
|
+
* New item quantity.
|
|
2726
|
+
*
|
|
2727
|
+
* Min: `1`
|
|
2728
|
+
* @min 1
|
|
2729
|
+
*/
|
|
2730
|
+
quantity?: number | null;
|
|
2731
|
+
/** Information about the new item tax. */
|
|
2732
|
+
tax?: Tax;
|
|
2420
2733
|
}
|
|
2421
|
-
interface
|
|
2734
|
+
interface BulkUpdateSubscriptionItemsByFilterResponse {
|
|
2735
|
+
/**
|
|
2736
|
+
* ID of your bulk job. You can use
|
|
2737
|
+
* [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)
|
|
2738
|
+
* to retrieve information about the job status.
|
|
2739
|
+
*/
|
|
2740
|
+
jobId?: string;
|
|
2422
2741
|
}
|
|
2423
|
-
interface
|
|
2424
|
-
/** @format GUID */
|
|
2425
|
-
tenantId?: string;
|
|
2742
|
+
interface DeleteSubscriptionRequest {
|
|
2426
2743
|
/** @format GUID */
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
|
-
taskType?: string;
|
|
2744
|
+
id?: string;
|
|
2745
|
+
revision?: string;
|
|
2430
2746
|
}
|
|
2431
|
-
interface
|
|
2747
|
+
interface DeleteSubscriptionResponse {
|
|
2432
2748
|
}
|
|
2433
|
-
interface
|
|
2434
|
-
/** @format GUID */
|
|
2435
|
-
subscriptionId?: string;
|
|
2436
|
-
/** @minLength 1 */
|
|
2437
|
-
taskType?: string;
|
|
2438
|
-
executionTime?: Date | null;
|
|
2749
|
+
interface CancelSubscriptionRequest {
|
|
2439
2750
|
/** @format GUID */
|
|
2440
|
-
|
|
2751
|
+
id: string;
|
|
2752
|
+
actionContext: ActionContext;
|
|
2441
2753
|
}
|
|
2442
|
-
interface
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
subscriptionId?: string;
|
|
2447
|
-
/** @minLength 1 */
|
|
2448
|
-
taskType?: string;
|
|
2754
|
+
interface ActionContext {
|
|
2755
|
+
initiator?: ActionInitiatorWithLiterals;
|
|
2756
|
+
/** Optional action reason message */
|
|
2757
|
+
reason?: string | null;
|
|
2449
2758
|
}
|
|
2450
|
-
|
|
2759
|
+
declare enum ActionInitiator {
|
|
2760
|
+
UNDEFINED = "UNDEFINED",
|
|
2761
|
+
BUSINESS = "BUSINESS",
|
|
2762
|
+
CUSTOMER = "CUSTOMER",
|
|
2763
|
+
SYSTEM = "SYSTEM"
|
|
2764
|
+
}
|
|
2765
|
+
/** @enumType */
|
|
2766
|
+
type ActionInitiatorWithLiterals = ActionInitiator | 'UNDEFINED' | 'BUSINESS' | 'CUSTOMER' | 'SYSTEM';
|
|
2767
|
+
interface CancelSubscriptionResponse {
|
|
2768
|
+
subscription?: Subscription;
|
|
2769
|
+
}
|
|
2770
|
+
interface PauseSubscriptionRequest {
|
|
2451
2771
|
/** @format GUID */
|
|
2452
|
-
|
|
2772
|
+
id: string;
|
|
2773
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
2774
|
+
pauseAt?: PauseAtWithLiterals;
|
|
2775
|
+
/** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
|
|
2776
|
+
pauseAtSchedule?: ScheduleAdditionalInfo;
|
|
2777
|
+
/** contains additional scheduling information for certain auto_resume_at either specific date */
|
|
2778
|
+
autoResumeAtSchedule?: ScheduleAdditionalInfo;
|
|
2779
|
+
actionContext: ActionContext;
|
|
2780
|
+
}
|
|
2781
|
+
interface PauseSubscriptionResponse {
|
|
2453
2782
|
subscription?: Subscription;
|
|
2454
2783
|
}
|
|
2455
|
-
interface
|
|
2784
|
+
interface SubscriptionPaused {
|
|
2456
2785
|
subscription?: Subscription;
|
|
2786
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
2787
|
+
actionDetails?: ActionDetails;
|
|
2457
2788
|
}
|
|
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 */
|
|
2789
|
+
interface PauseSubscriptionRequested {
|
|
2470
2790
|
subscription?: Subscription;
|
|
2471
|
-
|
|
2472
|
-
|
|
2791
|
+
pauseAt?: PauseAtWithLiterals;
|
|
2792
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
2793
|
+
actionDetails?: ActionDetails;
|
|
2473
2794
|
}
|
|
2474
|
-
interface
|
|
2475
|
-
/** The updated subscription */
|
|
2795
|
+
interface ScheduledPauseCanceled {
|
|
2476
2796
|
subscription?: Subscription;
|
|
2797
|
+
actionDetails?: ActionDetails;
|
|
2477
2798
|
}
|
|
2478
|
-
interface
|
|
2479
|
-
/** @format GUID */
|
|
2480
|
-
subscriptionId?: string;
|
|
2481
|
-
/** @format GUID */
|
|
2482
|
-
tenantId?: string;
|
|
2799
|
+
interface ResumeSubscriptionRequest {
|
|
2483
2800
|
/** @format GUID */
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
|
|
2801
|
+
id: string;
|
|
2802
|
+
resumeAt?: ResumeAtWithLiterals;
|
|
2803
|
+
/** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
|
|
2804
|
+
resumeAtSchedule?: ScheduleAdditionalInfo;
|
|
2805
|
+
actionContext: ActionContext;
|
|
2806
|
+
/** Strategy for resuming a migrated paused subscription when the previous billing date is missing. */
|
|
2807
|
+
missingPreviousBillingDateResumeStrategy?: MissingPreviousBillingDateResumeStrategyWithLiterals;
|
|
2489
2808
|
}
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
pauseEndDate?: Date | null;
|
|
2809
|
+
declare enum MissingPreviousBillingDateResumeStrategy {
|
|
2810
|
+
UNKNOWN = "UNKNOWN",
|
|
2811
|
+
/** Use a fallback that makes the next billing date resolve to now. */
|
|
2812
|
+
START_BILLING_IMMEDIATELY = "START_BILLING_IMMEDIATELY",
|
|
2813
|
+
/** Use a fallback that makes the next billing date resolve to one full cycle from now. */
|
|
2814
|
+
START_BILLING_AFTER_ONE_FULL_CYCLE = "START_BILLING_AFTER_ONE_FULL_CYCLE"
|
|
2497
2815
|
}
|
|
2498
|
-
|
|
2816
|
+
/** @enumType */
|
|
2817
|
+
type MissingPreviousBillingDateResumeStrategyWithLiterals = MissingPreviousBillingDateResumeStrategy | 'UNKNOWN' | 'START_BILLING_IMMEDIATELY' | 'START_BILLING_AFTER_ONE_FULL_CYCLE';
|
|
2818
|
+
interface ResumeSubscriptionResponse {
|
|
2499
2819
|
subscription?: Subscription;
|
|
2500
2820
|
}
|
|
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;
|
|
2821
|
+
interface SubscriptionResumed {
|
|
2822
|
+
subscription?: Subscription;
|
|
2823
|
+
actionDetails?: ActionDetails;
|
|
2824
|
+
pauseInfo?: PauseInfo;
|
|
2519
2825
|
}
|
|
2520
|
-
interface
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2524
|
-
tenantId?: string;
|
|
2525
|
-
isBassManaged?: boolean;
|
|
2526
|
-
shiftManagementDate?: Date | null;
|
|
2826
|
+
interface ResumeSubscriptionRequested {
|
|
2827
|
+
subscription?: Subscription;
|
|
2828
|
+
resumeAt?: ResumeAtWithLiterals;
|
|
2829
|
+
actionDetails?: ActionDetails;
|
|
2527
2830
|
}
|
|
2528
|
-
interface
|
|
2831
|
+
interface ScheduledResumeCanceled {
|
|
2529
2832
|
subscription?: Subscription;
|
|
2833
|
+
actionDetails?: ActionDetails;
|
|
2530
2834
|
}
|
|
2531
|
-
interface
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
|
-
/**
|
|
2535
|
-
|
|
2536
|
-
/**
|
|
2537
|
-
|
|
2835
|
+
interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
|
|
2836
|
+
/** Limit number of results and enable to skip rows. The default limit is 25. */
|
|
2837
|
+
paging?: Paging;
|
|
2838
|
+
/** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
|
|
2839
|
+
cursor?: CursorPaging;
|
|
2840
|
+
/** A filter object */
|
|
2841
|
+
filter?: any;
|
|
2842
|
+
/** A Sorting option by field name and order. */
|
|
2843
|
+
sorting?: SortingClauses;
|
|
2538
2844
|
}
|
|
2539
2845
|
/** @oneof */
|
|
2540
|
-
interface
|
|
2541
|
-
|
|
2542
|
-
|
|
2846
|
+
interface SearchSubscriptionsRequestPagingMethodOneOf {
|
|
2847
|
+
/** Limit number of results and enable to skip rows. The default limit is 25. */
|
|
2848
|
+
paging?: Paging;
|
|
2849
|
+
/** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
|
|
2850
|
+
cursor?: CursorPaging;
|
|
2543
2851
|
}
|
|
2544
|
-
interface
|
|
2545
|
-
|
|
2546
|
-
invoiceId?: string;
|
|
2852
|
+
interface SortingClauses {
|
|
2853
|
+
sorting?: Sorting[];
|
|
2547
2854
|
}
|
|
2548
|
-
interface
|
|
2549
|
-
|
|
2550
|
-
|
|
2855
|
+
interface SearchSubscriptionsResponse {
|
|
2856
|
+
subscriptions?: Subscription[];
|
|
2857
|
+
cursor?: CursorPaging;
|
|
2858
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
2551
2859
|
}
|
|
2552
|
-
interface
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
interface RestoreDraftSubscriptionRequest {
|
|
2556
|
-
/** @format GUID */
|
|
2557
|
-
tenantId?: string;
|
|
2558
|
-
/** @format GUID */
|
|
2559
|
-
subscriptionId?: string;
|
|
2560
|
-
}
|
|
2561
|
-
interface RestoreDraftSubscriptionResponse {
|
|
2562
|
-
subscription?: Subscription;
|
|
2860
|
+
interface CursorPagingMetadata {
|
|
2861
|
+
/** Total number of items matching the filter. Available only on the first page of *Search* */
|
|
2862
|
+
total?: number | null;
|
|
2563
2863
|
}
|
|
2564
|
-
interface
|
|
2565
|
-
/** @format GUID */
|
|
2566
|
-
tenantId?: string;
|
|
2864
|
+
interface TurnOnSubscriptionAutoRenewalRequest {
|
|
2567
2865
|
/** @format GUID */
|
|
2568
|
-
|
|
2866
|
+
id: string;
|
|
2867
|
+
actionContext: ActionContext;
|
|
2569
2868
|
}
|
|
2570
|
-
interface
|
|
2869
|
+
interface TurnOnSubscriptionAutoRenewalResponse {
|
|
2571
2870
|
subscription?: Subscription;
|
|
2572
2871
|
}
|
|
2573
|
-
interface
|
|
2574
|
-
/** @format GUID */
|
|
2575
|
-
tenantId?: string;
|
|
2576
|
-
/** @format GUID */
|
|
2577
|
-
subscriptionId?: string;
|
|
2578
|
-
}
|
|
2579
|
-
interface DeleteSubscriptionBOResponse {
|
|
2872
|
+
interface SubscriptionAutoRenewalTurnedOn {
|
|
2580
2873
|
subscription?: Subscription;
|
|
2874
|
+
actionDetails?: ActionDetails;
|
|
2581
2875
|
}
|
|
2582
|
-
interface
|
|
2583
|
-
/** @format GUID */
|
|
2584
|
-
tenantId?: string;
|
|
2876
|
+
interface TurnOffSubscriptionAutoRenewalRequest {
|
|
2585
2877
|
/** @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"
|
|
2878
|
+
id: string;
|
|
2879
|
+
actionContext: ActionContext;
|
|
2595
2880
|
}
|
|
2596
|
-
|
|
2597
|
-
type ActionInitiatorWithLiterals = ActionInitiator | 'UNDEFINED' | 'BUSINESS' | 'CUSTOMER' | 'SYSTEM';
|
|
2598
|
-
interface CancelSubscriptionBOResponse {
|
|
2881
|
+
interface TurnOffSubscriptionAutoRenewalResponse {
|
|
2599
2882
|
subscription?: Subscription;
|
|
2600
2883
|
}
|
|
2601
|
-
interface
|
|
2602
|
-
/** @format GUID */
|
|
2603
|
-
tenantId?: string;
|
|
2604
|
-
/** @format GUID */
|
|
2605
|
-
subscriptionId?: string;
|
|
2606
|
-
/** @format GUID */
|
|
2607
|
-
paymentMethodId?: string;
|
|
2608
|
-
}
|
|
2609
|
-
interface UpdatePaymentMethodBOResponse {
|
|
2884
|
+
interface SubscriptionAutoRenewalTurnedOff {
|
|
2610
2885
|
subscription?: Subscription;
|
|
2886
|
+
actionDetails?: ActionDetails;
|
|
2611
2887
|
}
|
|
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;
|
|
2888
|
+
interface MarkLatestInvoiceAsPaidRequest {
|
|
2625
2889
|
/**
|
|
2626
|
-
*
|
|
2890
|
+
* The ID of the offline subscription to mark as paid its latest invoice
|
|
2627
2891
|
* @format GUID
|
|
2628
2892
|
*/
|
|
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;
|
|
2893
|
+
subscriptionId: string;
|
|
2650
2894
|
}
|
|
2651
|
-
interface
|
|
2895
|
+
interface MarkLatestInvoiceAsPaidResponse {
|
|
2652
2896
|
subscription?: Subscription;
|
|
2653
2897
|
}
|
|
2654
|
-
interface
|
|
2655
|
-
|
|
2656
|
-
tenantId?: string;
|
|
2657
|
-
/** @format GUID */
|
|
2658
|
-
subscriptionId?: string;
|
|
2659
|
-
}
|
|
2660
|
-
interface FixSubscriptionInvoicesConsistencyResponse {
|
|
2898
|
+
interface LatestInvoiceMarkedAsPaid {
|
|
2899
|
+
subscription?: Subscription;
|
|
2661
2900
|
}
|
|
2662
|
-
interface
|
|
2901
|
+
interface MultipleSubscriptionsOnOrdersInvoice {
|
|
2663
2902
|
/**
|
|
2664
|
-
*
|
|
2903
|
+
* the invoice id of the affected subscription
|
|
2665
2904
|
* @format GUID
|
|
2666
2905
|
*/
|
|
2667
|
-
|
|
2906
|
+
invoiceId?: string;
|
|
2668
2907
|
/**
|
|
2669
|
-
*
|
|
2908
|
+
* the order id of the affected subscription
|
|
2670
2909
|
* @format GUID
|
|
2671
2910
|
*/
|
|
2672
|
-
|
|
2911
|
+
orderId?: string;
|
|
2912
|
+
}
|
|
2913
|
+
interface MarkBillingCycleAsPaidRequest {
|
|
2673
2914
|
/**
|
|
2674
|
-
*
|
|
2675
|
-
* @format
|
|
2915
|
+
* The ID of the subscription to mark as paid its invoice.
|
|
2916
|
+
* @format GUID
|
|
2676
2917
|
*/
|
|
2677
|
-
|
|
2918
|
+
subscriptionId: string;
|
|
2678
2919
|
/**
|
|
2679
|
-
*
|
|
2680
|
-
*
|
|
2920
|
+
* The subscription cycle for which the invoice is to be marked as paid.
|
|
2921
|
+
* If left empty, the most recent cycle will be selected.
|
|
2922
|
+
* @min 1
|
|
2681
2923
|
*/
|
|
2682
|
-
|
|
2924
|
+
paidCycle?: number | null;
|
|
2683
2925
|
}
|
|
2684
|
-
interface
|
|
2685
|
-
/** The updated subscription with new currency and converted amounts */
|
|
2926
|
+
interface MarkBillingCycleAsPaidResponse {
|
|
2686
2927
|
subscription?: Subscription;
|
|
2687
2928
|
}
|
|
2688
|
-
interface
|
|
2929
|
+
interface GetSubscriptionsStatsRequest {
|
|
2930
|
+
}
|
|
2931
|
+
interface GetSubscriptionsStatsResponse {
|
|
2932
|
+
amountByStatuses?: AmountByStatus[];
|
|
2933
|
+
total?: number;
|
|
2934
|
+
}
|
|
2935
|
+
interface AmountByStatus {
|
|
2936
|
+
status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
|
|
2937
|
+
amount?: number;
|
|
2938
|
+
}
|
|
2939
|
+
interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
|
|
2940
|
+
/** User won't be charged for additional period added on top of subscription end date. */
|
|
2941
|
+
extensionPeriod?: Duration;
|
|
2689
2942
|
/**
|
|
2690
|
-
*
|
|
2691
|
-
* @
|
|
2943
|
+
* user will be charged for billing cycles added
|
|
2944
|
+
* @min 1
|
|
2692
2945
|
*/
|
|
2693
|
-
|
|
2946
|
+
extensionBillingCycles?: number;
|
|
2694
2947
|
/**
|
|
2695
|
-
*
|
|
2948
|
+
* The ID of the subscription to be extended
|
|
2696
2949
|
* @format GUID
|
|
2697
2950
|
*/
|
|
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;
|
|
2951
|
+
id: string;
|
|
2952
|
+
actionContext: ActionContext;
|
|
2716
2953
|
}
|
|
2717
2954
|
/** @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;
|
|
2955
|
+
interface ExtendSubscriptionRequestExtendPolicyOneOf {
|
|
2956
|
+
/** User won't be charged for additional period added on top of subscription end date. */
|
|
2957
|
+
extensionPeriod?: Duration;
|
|
2958
|
+
/**
|
|
2959
|
+
* user will be charged for billing cycles added
|
|
2960
|
+
* @min 1
|
|
2961
|
+
*/
|
|
2962
|
+
extensionBillingCycles?: number;
|
|
2735
2963
|
}
|
|
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 {
|
|
2964
|
+
interface ExtendSubscriptionResponse {
|
|
2965
|
+
/** The now extended subscription */
|
|
2743
2966
|
subscription?: Subscription;
|
|
2744
2967
|
}
|
|
2745
|
-
interface
|
|
2746
|
-
subscription?: Subscription;
|
|
2747
|
-
actionDetails?: ActionDetails;
|
|
2968
|
+
interface AllowedActionsRequest {
|
|
2748
2969
|
/** @format GUID */
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
|
|
2970
|
+
id: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* List of additional fields to be included in the response.
|
|
2973
|
+
* @maxSize 1
|
|
2974
|
+
*/
|
|
2975
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2753
2976
|
}
|
|
2754
|
-
|
|
2755
|
-
|
|
2977
|
+
declare enum RequestedFields {
|
|
2978
|
+
/** Include unsupported action list, including the reasons for the lack of support */
|
|
2979
|
+
UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
|
|
2756
2980
|
}
|
|
2757
|
-
|
|
2758
|
-
|
|
2981
|
+
/** @enumType */
|
|
2982
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNSUPPORTED_ACTION';
|
|
2983
|
+
interface AllowedActionsResponse {
|
|
2984
|
+
/** List of actions that are allowed. */
|
|
2985
|
+
actions?: Action[];
|
|
2759
2986
|
/**
|
|
2760
|
-
*
|
|
2761
|
-
* @
|
|
2987
|
+
* List of actions that are not supported, included only if requested. Provides reasons for each unsupported action.
|
|
2988
|
+
* @maxSize 20
|
|
2762
2989
|
*/
|
|
2763
|
-
|
|
2990
|
+
unsupportedActions?: UnsupportedAction[];
|
|
2764
2991
|
}
|
|
2765
|
-
interface
|
|
2766
|
-
|
|
2767
|
-
subscription?: Subscription;
|
|
2992
|
+
interface UnsupportedAction {
|
|
2993
|
+
actionType?: ActionTypeWithLiterals;
|
|
2768
2994
|
/**
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2995
|
+
* Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed.
|
|
2996
|
+
* @maxSize 20
|
|
2771
2997
|
*/
|
|
2772
|
-
|
|
2998
|
+
reasons?: UnsupportedReason[];
|
|
2773
2999
|
}
|
|
2774
|
-
interface
|
|
2775
|
-
|
|
3000
|
+
interface UnsupportedReason {
|
|
3001
|
+
code?: string;
|
|
3002
|
+
description?: string | null;
|
|
2776
3003
|
}
|
|
2777
|
-
interface
|
|
3004
|
+
interface ListUpcomingChargesRequest {
|
|
2778
3005
|
/**
|
|
2779
|
-
* Subscription
|
|
3006
|
+
* Subscription id charges to be previewed for
|
|
2780
3007
|
* @format GUID
|
|
2781
3008
|
*/
|
|
2782
|
-
|
|
3009
|
+
subscriptionId: string;
|
|
3010
|
+
/** Period of time to provide charged for. If not provided,then only next charge will be returned. */
|
|
3011
|
+
customDuration?: Duration;
|
|
2783
3012
|
/**
|
|
2784
|
-
*
|
|
2785
|
-
*
|
|
2786
|
-
* cycles_to_pay_on_creation will be set to 1 if no free trial is set
|
|
3013
|
+
* Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
|
|
3014
|
+
* If not provided, the upcoming charges will be calculated according to the existing next billing date.
|
|
2787
3015
|
*/
|
|
2788
|
-
|
|
3016
|
+
nextBillingDate?: Date | null;
|
|
2789
3017
|
}
|
|
2790
|
-
interface
|
|
2791
|
-
|
|
3018
|
+
interface ListUpcomingChargesResponse {
|
|
3019
|
+
upcomingCharges?: SubscriptionCharge[];
|
|
2792
3020
|
}
|
|
2793
|
-
interface
|
|
2794
|
-
/**
|
|
2795
|
-
|
|
2796
|
-
* @format GUID
|
|
2797
|
-
*/
|
|
2798
|
-
id?: string;
|
|
2799
|
-
collectionMethod?: CollectionMethodEnumCollectionMethodWithLiterals;
|
|
3021
|
+
interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
|
|
3022
|
+
/** Information about a non-existing subscription. */
|
|
3023
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
2800
3024
|
}
|
|
2801
|
-
|
|
2802
|
-
|
|
3025
|
+
/** @oneof */
|
|
3026
|
+
interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
|
|
3027
|
+
/** Information about a non-existing subscription. */
|
|
3028
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
2803
3029
|
}
|
|
2804
|
-
|
|
3030
|
+
/** Subscription information to use for calculating the preview of charges for a subscription. */
|
|
3031
|
+
interface SubscriptionInfo {
|
|
3032
|
+
billingSettings?: BillingSettings;
|
|
3033
|
+
items?: Item[];
|
|
3034
|
+
startDate?: Date | null;
|
|
2805
3035
|
/**
|
|
2806
|
-
*
|
|
2807
|
-
*
|
|
3036
|
+
* Customer the subscription belongs to. When provided, used for accurate tax calculation.
|
|
3037
|
+
* Optional for backward compatibility; if omitted, a synthetic id is used (legacy behavior)
|
|
3038
|
+
* and customer-specific tax rules (VAT exemptions, tax IDs) will not apply.
|
|
2808
3039
|
*/
|
|
2809
|
-
|
|
2810
|
-
cancellableByCustomer?: boolean | null;
|
|
3040
|
+
customer?: Customer;
|
|
2811
3041
|
}
|
|
2812
|
-
interface
|
|
2813
|
-
/**
|
|
2814
|
-
|
|
3042
|
+
interface PreviewSubscriptionChargesResponse {
|
|
3043
|
+
/** Charges for subscription. */
|
|
3044
|
+
charges?: Charge[];
|
|
2815
3045
|
}
|
|
2816
|
-
|
|
3046
|
+
/** Represents a charge applicable to a subscription. */
|
|
3047
|
+
interface Charge {
|
|
3048
|
+
/** The cycle number from which the charge starts. */
|
|
3049
|
+
cycleFrom?: number;
|
|
3050
|
+
/** The number of cycles for which the charge is applicable. */
|
|
3051
|
+
cycleCount?: number | null;
|
|
3052
|
+
/** The breakdown of the charge */
|
|
3053
|
+
totals?: Totals;
|
|
3054
|
+
/** The billing date from which the charge starts */
|
|
3055
|
+
cycleBillingDate?: Date | null;
|
|
3056
|
+
}
|
|
3057
|
+
interface PreviewSubscriptionsChargesRequest {
|
|
2817
3058
|
/**
|
|
2818
|
-
*
|
|
2819
|
-
* @
|
|
3059
|
+
* Information required to calculate the preview charges for the subscriptions, including an identifier.
|
|
3060
|
+
* @minSize 1
|
|
3061
|
+
* @maxSize 10
|
|
2820
3062
|
*/
|
|
2821
|
-
|
|
2822
|
-
/** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
|
|
2823
|
-
billingDate: Date | null;
|
|
3063
|
+
subscriptionsBillingDetails?: SubscriptionBillingDetails[];
|
|
2824
3064
|
/**
|
|
2825
|
-
*
|
|
2826
|
-
*
|
|
2827
|
-
*
|
|
2828
|
-
*
|
|
2829
|
-
*
|
|
2830
|
-
*
|
|
2831
|
-
*
|
|
3065
|
+
* Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
|
|
3066
|
+
* For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
|
|
3067
|
+
* $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
|
|
3068
|
+
* - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
|
|
3069
|
+
* - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
|
|
3070
|
+
* - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
|
|
3071
|
+
* If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
|
|
3072
|
+
* in this case, charges for cycle 1 through 3.
|
|
3073
|
+
* If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
|
|
3074
|
+
* then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
|
|
3075
|
+
* @min 1
|
|
3076
|
+
* @max 10
|
|
2832
3077
|
*/
|
|
2833
|
-
|
|
2834
|
-
}
|
|
2835
|
-
interface UpdateSubscriptionBillingDateResponse {
|
|
2836
|
-
/** Updated subscription. */
|
|
2837
|
-
subscription?: Subscription;
|
|
2838
|
-
}
|
|
2839
|
-
interface SubscriptionBillingDateUpdated {
|
|
2840
|
-
subscription?: Subscription;
|
|
2841
|
-
billingDate?: Date | null;
|
|
2842
|
-
proration?: Proration;
|
|
3078
|
+
numberOfNextRecurringCharges?: number | null;
|
|
2843
3079
|
}
|
|
2844
|
-
interface
|
|
3080
|
+
interface SubscriptionBillingDetails {
|
|
2845
3081
|
/**
|
|
2846
|
-
*
|
|
3082
|
+
* External identifier of the subscription
|
|
2847
3083
|
* @format GUID
|
|
2848
3084
|
*/
|
|
2849
|
-
|
|
3085
|
+
externalId?: string | null;
|
|
3086
|
+
/** Billing details parameters including schedule, currency, etc. */
|
|
3087
|
+
billingSettings?: BillingSettings;
|
|
2850
3088
|
/**
|
|
2851
|
-
*
|
|
2852
|
-
* @
|
|
3089
|
+
* Items, minSize is 1, maxSize is 100
|
|
3090
|
+
* @minSize 1
|
|
3091
|
+
* @maxSize 100
|
|
2853
3092
|
*/
|
|
2854
|
-
|
|
3093
|
+
items?: Item[];
|
|
3094
|
+
/** Subscription start date, now if not set */
|
|
3095
|
+
startDate?: Date | null;
|
|
3096
|
+
/** Shipping address associated with subscription. At the moment used only for payments. Optional. */
|
|
3097
|
+
shippingAddress?: FullAddressDetails;
|
|
3098
|
+
/**
|
|
3099
|
+
* Customer the subscription belongs to. When provided, used for accurate tax calculation.
|
|
3100
|
+
* Optional for backward compatibility; if omitted, a synthetic id is used (legacy behavior).
|
|
3101
|
+
*/
|
|
3102
|
+
customer?: Customer;
|
|
2855
3103
|
}
|
|
2856
|
-
interface
|
|
2857
|
-
/**
|
|
2858
|
-
|
|
3104
|
+
interface PreviewSubscriptionsChargesResponse {
|
|
3105
|
+
/** Charges for the subscriptions, including an identifier. */
|
|
3106
|
+
subscriptionsCharges?: SubscriptionCharges[];
|
|
2859
3107
|
}
|
|
2860
|
-
interface
|
|
3108
|
+
interface SubscriptionCharges {
|
|
2861
3109
|
/**
|
|
2862
|
-
*
|
|
3110
|
+
* External identifier of the subscription
|
|
2863
3111
|
* @format GUID
|
|
2864
3112
|
*/
|
|
2865
|
-
|
|
3113
|
+
externalId?: string | null;
|
|
3114
|
+
/** Charges for subscription. */
|
|
3115
|
+
charges?: Charge[];
|
|
3116
|
+
}
|
|
3117
|
+
interface CreateSubscriptionForOrderRequest {
|
|
3118
|
+
/** Subscription needs to be created */
|
|
3119
|
+
subscription?: Subscription;
|
|
2866
3120
|
/**
|
|
2867
|
-
*
|
|
2868
|
-
* @
|
|
3121
|
+
* Optional unique identifier for this request in order to prevent subscription duplications
|
|
3122
|
+
* @format GUID
|
|
2869
3123
|
*/
|
|
2870
|
-
|
|
3124
|
+
idempotencyKey?: string | null;
|
|
2871
3125
|
}
|
|
2872
|
-
interface
|
|
3126
|
+
interface CreateSubscriptionForOrderResponse {
|
|
3127
|
+
/** Created subscription */
|
|
2873
3128
|
subscription?: Subscription;
|
|
3129
|
+
/** Non-persistent invoice */
|
|
3130
|
+
invoice?: Invoice;
|
|
2874
3131
|
}
|
|
2875
|
-
|
|
3132
|
+
/** An invoice includes information about the subscription and the customer. */
|
|
3133
|
+
interface Invoice {
|
|
2876
3134
|
/**
|
|
2877
|
-
*
|
|
3135
|
+
* Invoice ID.
|
|
2878
3136
|
* @format GUID
|
|
3137
|
+
* @readonly
|
|
2879
3138
|
*/
|
|
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;
|
|
2885
|
-
/**
|
|
2886
|
-
* Existing items to update
|
|
2887
|
-
* @maxSize 100
|
|
2888
|
-
*/
|
|
2889
|
-
itemsToUpdate?: ItemChange[];
|
|
2890
|
-
/**
|
|
2891
|
-
* Items to add
|
|
2892
|
-
* @maxSize 99
|
|
2893
|
-
*/
|
|
2894
|
-
itemsToAdd?: Item[];
|
|
3139
|
+
id?: string | null;
|
|
2895
3140
|
/**
|
|
2896
|
-
*
|
|
2897
|
-
* @
|
|
2898
|
-
* @maxSize 99
|
|
3141
|
+
* Date and time the invoice was created.
|
|
3142
|
+
* @readonly
|
|
2899
3143
|
*/
|
|
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"
|
|
2912
|
-
}
|
|
2913
|
-
/** @enumType */
|
|
2914
|
-
type UpdateActionWithLiterals = UpdateAction | 'NONE' | 'IMMEDIATELY' | 'NEXT_BILLING_CYCLE' | 'RESET_PENDING_UPDATES' | 'SPECIFIC_DATE';
|
|
2915
|
-
interface UpdateSubscriptionItemsResponse {
|
|
2916
|
-
subscription?: Subscription;
|
|
2917
|
-
}
|
|
2918
|
-
interface BulkUpdateSubscriptionItemsByFilterRequest {
|
|
3144
|
+
createdDate?: Date | null;
|
|
2919
3145
|
/**
|
|
2920
|
-
*
|
|
2921
|
-
*
|
|
2922
|
-
* [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).
|
|
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.
|
|
3146
|
+
* Date and time the invoice was last updated.
|
|
3147
|
+
* @readonly
|
|
2927
3148
|
*/
|
|
2928
|
-
|
|
3149
|
+
updatedDate?: Date | null;
|
|
2929
3150
|
/**
|
|
2930
|
-
*
|
|
2931
|
-
*
|
|
2932
|
-
*
|
|
3151
|
+
* Revision number, which increments by 1 each time the invoice is updated.
|
|
3152
|
+
* To prevent conflicting changes,
|
|
3153
|
+
* the current revision must be passed when updating the invoice.
|
|
2933
3154
|
*
|
|
2934
|
-
*
|
|
2935
|
-
* @
|
|
2936
|
-
* @maxSize 100
|
|
3155
|
+
* Ignored when creating a invoice.
|
|
3156
|
+
* @readonly
|
|
2937
3157
|
*/
|
|
2938
|
-
|
|
3158
|
+
revision?: string | null;
|
|
3159
|
+
/** Information about the invoice origin. */
|
|
3160
|
+
origin?: BusinessOriginData;
|
|
2939
3161
|
/**
|
|
2940
|
-
*
|
|
3162
|
+
* Invoice status.
|
|
2941
3163
|
*
|
|
2942
|
-
* + `"
|
|
2943
|
-
* + `"
|
|
2944
|
-
* + `"
|
|
2945
|
-
* + `"
|
|
3164
|
+
* + `"UNKNOWN"`: There is no information about the invoice status.
|
|
3165
|
+
* + `"OPEN"`: BASS has created the invoice but hasn't initiated the payment process.
|
|
3166
|
+
* + `"PAID"`: The customer has successfully paid for the invoice.
|
|
3167
|
+
* + `"ATTEMPT_FAILED"`: The payment process has started and there has been at least one unsuccessful payment attempt.
|
|
3168
|
+
* + `"FAILED"`: The payment process has failed and there are no more retries.
|
|
3169
|
+
* + `"CANCELED"`: The payment process has been stopped because the related subscription has been canceled.
|
|
3170
|
+
* @readonly
|
|
2946
3171
|
*/
|
|
2947
|
-
|
|
3172
|
+
status?: InvoiceStatusWithLiterals;
|
|
2948
3173
|
/**
|
|
2949
|
-
*
|
|
2950
|
-
*
|
|
3174
|
+
* 3-letter currency code of the invoice in
|
|
3175
|
+
* [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3176
|
+
* @format CURRENCY
|
|
2951
3177
|
*/
|
|
2952
|
-
|
|
3178
|
+
currency?: string;
|
|
3179
|
+
/** Information about the customer. */
|
|
3180
|
+
customer?: Customer;
|
|
2953
3181
|
/**
|
|
2954
|
-
*
|
|
2955
|
-
*
|
|
2956
|
-
*
|
|
2957
|
-
*
|
|
2958
|
-
*
|
|
3182
|
+
* Whether the payment is processed through Wix and whether the customer must provide some input.
|
|
3183
|
+
*
|
|
3184
|
+
* + `"UNKNOWN"`: There is no information about the collection method.
|
|
3185
|
+
* + `"AUTO_CHARGE"`: The customer pays automatically through Wix.
|
|
3186
|
+
* + `"SEND_INVOICE"`: The customer pays through Wix, but some manual input is required.
|
|
3187
|
+
* + `"OFFLINE"`: The customer pays outside of Wix.
|
|
2959
3188
|
*/
|
|
2960
|
-
|
|
3189
|
+
collectionMethod?: CollectionMethodWithLiterals;
|
|
2961
3190
|
/**
|
|
2962
|
-
*
|
|
2963
|
-
*
|
|
3191
|
+
* ID of the
|
|
3192
|
+
* [payment method](https://bo.wix.com/wix-docs/rest/wix-cashier/settings/payment-method-type/payment-method-type-object).
|
|
3193
|
+
* Not available for the first payment of a subscription and all offline
|
|
3194
|
+
* payments.
|
|
3195
|
+
* @format GUID
|
|
2964
3196
|
*/
|
|
2965
|
-
|
|
2966
|
-
}
|
|
2967
|
-
interface BulkItemChange {
|
|
2968
|
-
/** Information about the new item price. */
|
|
2969
|
-
pricingModel?: PricingModel;
|
|
3197
|
+
paymentMethodId?: string | null;
|
|
2970
3198
|
/**
|
|
2971
|
-
*
|
|
3199
|
+
* Cashier [Order ID](https://dev.wix.com/docs/rest/payments/wix-cashier/pay/order#order-object)
|
|
3200
|
+
* for the corresponding payment.
|
|
3201
|
+
* @format GUID
|
|
3202
|
+
* @readonly
|
|
3203
|
+
*/
|
|
3204
|
+
paymentOrderId?: string | null;
|
|
3205
|
+
/** Information about a discount. Available only for invoices that include a discount. */
|
|
3206
|
+
discount?: InvoiceDiscount;
|
|
3207
|
+
/** Billing address. */
|
|
3208
|
+
billingAddress?: FullAddressDetails;
|
|
3209
|
+
/** Shipping address. Available only for `"PHYSICAL"` line items. */
|
|
3210
|
+
shippingAddress?: FullAddressDetails;
|
|
3211
|
+
/**
|
|
3212
|
+
* Shipping fee in `0.00` format.
|
|
3213
|
+
* @format DECIMAL_VALUE
|
|
3214
|
+
*/
|
|
3215
|
+
shippingFee?: string | null;
|
|
3216
|
+
/**
|
|
3217
|
+
* Information about the invoice's totals.
|
|
3218
|
+
* @readonly
|
|
3219
|
+
*/
|
|
3220
|
+
totals?: Totals;
|
|
3221
|
+
/** Line items belonging to the invoice. */
|
|
3222
|
+
invoiceItems?: InvoiceItem[];
|
|
3223
|
+
/**
|
|
3224
|
+
* Whether the invoice is used to validate payment details.
|
|
2972
3225
|
*
|
|
2973
|
-
*
|
|
2974
|
-
*
|
|
3226
|
+
* + `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.
|
|
3227
|
+
* + `false`: Standard invoice.
|
|
2975
3228
|
*/
|
|
2976
|
-
|
|
2977
|
-
/**
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
3229
|
+
isAuthorization?: boolean | null;
|
|
3230
|
+
/** Whether the invoice's `totals.totalPrice` includes tax. */
|
|
3231
|
+
isTaxInclusive?: boolean | null;
|
|
3232
|
+
/** Details of the latest payment attempt. */
|
|
3233
|
+
latestPaymentAttempt?: LatestPaymentAttempt;
|
|
3234
|
+
/** List of charges and credits that adjust the invoice's `totals.totalPrice`. */
|
|
3235
|
+
adjustments?: PriceAdjustment[];
|
|
2981
3236
|
/**
|
|
2982
|
-
*
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
3237
|
+
* Invoice Number.
|
|
3238
|
+
* @maxLength 10
|
|
3239
|
+
* @readonly
|
|
2985
3240
|
*/
|
|
2986
|
-
|
|
2987
|
-
}
|
|
2988
|
-
interface DeleteSubscriptionRequest {
|
|
2989
|
-
/** @format GUID */
|
|
2990
|
-
id?: string;
|
|
2991
|
-
revision?: string;
|
|
2992
|
-
}
|
|
2993
|
-
interface DeleteSubscriptionResponse {
|
|
2994
|
-
}
|
|
2995
|
-
interface CancelSubscriptionRequest {
|
|
2996
|
-
/** @format GUID */
|
|
2997
|
-
id: string;
|
|
2998
|
-
actionContext: ActionContext;
|
|
2999
|
-
}
|
|
3000
|
-
interface ActionContext {
|
|
3001
|
-
initiator?: ActionInitiatorWithLiterals;
|
|
3002
|
-
/** Optional action reason message */
|
|
3003
|
-
reason?: string | null;
|
|
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;
|
|
3107
|
-
}
|
|
3108
|
-
interface TurnOffSubscriptionAutoRenewalResponse {
|
|
3109
|
-
subscription?: Subscription;
|
|
3110
|
-
}
|
|
3111
|
-
interface SubscriptionAutoRenewalTurnedOff {
|
|
3112
|
-
subscription?: Subscription;
|
|
3113
|
-
actionDetails?: ActionDetails;
|
|
3114
|
-
}
|
|
3115
|
-
interface MarkLatestInvoiceAsPaidRequest {
|
|
3241
|
+
invoiceNumber?: string | null;
|
|
3116
3242
|
/**
|
|
3117
|
-
*
|
|
3118
|
-
*
|
|
3243
|
+
* Shipping charges for the invoice.
|
|
3244
|
+
* Supports only one discount without cycles.
|
|
3245
|
+
* Discounts with cycles (repeated discounts across different billing cycles) are not supported for shipping
|
|
3119
3246
|
*/
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
interface LatestInvoiceMarkedAsPaid {
|
|
3126
|
-
subscription?: Subscription;
|
|
3127
|
-
}
|
|
3128
|
-
interface MultipleSubscriptionsOnOrdersInvoice {
|
|
3247
|
+
shippingCharges?: InvoiceShippingCharges;
|
|
3248
|
+
/** Information about the invoice tax */
|
|
3249
|
+
taxData?: TaxData;
|
|
3250
|
+
/** Business address. */
|
|
3251
|
+
businessAddress?: Address;
|
|
3129
3252
|
/**
|
|
3130
|
-
* the
|
|
3253
|
+
* ID of the billing order that created this invoice.
|
|
3131
3254
|
* @format GUID
|
|
3132
3255
|
*/
|
|
3133
|
-
|
|
3256
|
+
orderId?: string | null;
|
|
3134
3257
|
/**
|
|
3135
|
-
*
|
|
3258
|
+
* Platform origin the invoice is originated from.
|
|
3136
3259
|
* @format GUID
|
|
3137
3260
|
*/
|
|
3138
|
-
|
|
3261
|
+
platformOriginAppId?: string | null;
|
|
3262
|
+
/**
|
|
3263
|
+
* Refund information, provided that there are refunds for this invoice.
|
|
3264
|
+
* @readonly
|
|
3265
|
+
*/
|
|
3266
|
+
refundInfo?: RefundInfo;
|
|
3139
3267
|
}
|
|
3140
|
-
interface
|
|
3268
|
+
interface BusinessOriginData {
|
|
3141
3269
|
/**
|
|
3142
|
-
*
|
|
3270
|
+
* ID of the app for which BASS has created the invoice. For example,
|
|
3271
|
+
* `"1380b703-ce81-ff05-f115-39571d94dfcd"` for the Wix eCommerce app.
|
|
3143
3272
|
* @format GUID
|
|
3144
3273
|
*/
|
|
3145
|
-
|
|
3274
|
+
appId?: string;
|
|
3146
3275
|
/**
|
|
3147
|
-
*
|
|
3148
|
-
*
|
|
3149
|
-
* @
|
|
3276
|
+
* [Instance ID](https://dev.wix.com/api/rest/app-management/apps/app-instance/get-app-instance)
|
|
3277
|
+
* of the app for which BASS has created the invoice.
|
|
3278
|
+
* @format GUID
|
|
3150
3279
|
*/
|
|
3151
|
-
|
|
3152
|
-
}
|
|
3153
|
-
interface MarkBillingCycleAsPaidResponse {
|
|
3154
|
-
subscription?: Subscription;
|
|
3155
|
-
}
|
|
3156
|
-
interface GetSubscriptionsStatsRequest {
|
|
3157
|
-
}
|
|
3158
|
-
interface GetSubscriptionsStatsResponse {
|
|
3159
|
-
amountByStatuses?: AmountByStatus[];
|
|
3160
|
-
total?: number;
|
|
3161
|
-
}
|
|
3162
|
-
interface AmountByStatus {
|
|
3163
|
-
status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
|
|
3164
|
-
amount?: number;
|
|
3165
|
-
}
|
|
3166
|
-
interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
|
|
3167
|
-
/** User won't be charged for additional period added on top of subscription end date. */
|
|
3168
|
-
extensionPeriod?: Duration;
|
|
3169
|
-
/**
|
|
3170
|
-
* user will be charged for billing cycles added
|
|
3171
|
-
* @min 1
|
|
3172
|
-
*/
|
|
3173
|
-
extensionBillingCycles?: number;
|
|
3280
|
+
instanceId?: string;
|
|
3174
3281
|
/**
|
|
3175
|
-
*
|
|
3282
|
+
* ID of the entity that triggered the invoice creation. For example, the ID of a
|
|
3283
|
+
* [pricing plan](https://dev.wix.com/docs/rest/payments/pricing-plans/pricing-plans/plan#plan-object).
|
|
3176
3284
|
* @format GUID
|
|
3177
3285
|
*/
|
|
3178
|
-
|
|
3179
|
-
actionContext: ActionContext;
|
|
3180
|
-
}
|
|
3181
|
-
/** @oneof */
|
|
3182
|
-
interface ExtendSubscriptionRequestExtendPolicyOneOf {
|
|
3183
|
-
/** User won't be charged for additional period added on top of subscription end date. */
|
|
3184
|
-
extensionPeriod?: Duration;
|
|
3185
|
-
/**
|
|
3186
|
-
* user will be charged for billing cycles added
|
|
3187
|
-
* @min 1
|
|
3188
|
-
*/
|
|
3189
|
-
extensionBillingCycles?: number;
|
|
3286
|
+
entityId?: string;
|
|
3190
3287
|
}
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3288
|
+
declare enum InvoiceStatus {
|
|
3289
|
+
UNKNOWN = "UNKNOWN",
|
|
3290
|
+
OPEN = "OPEN",
|
|
3291
|
+
PAID = "PAID",
|
|
3292
|
+
FAILED = "FAILED",
|
|
3293
|
+
ATTEMPT_FAILED = "ATTEMPT_FAILED",
|
|
3294
|
+
CANCELED = "CANCELED",
|
|
3295
|
+
REFUNDED = "REFUNDED",
|
|
3296
|
+
CHARGEBACKED = "CHARGEBACKED"
|
|
3194
3297
|
}
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
|
|
3202
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
3298
|
+
/** @enumType */
|
|
3299
|
+
type InvoiceStatusWithLiterals = InvoiceStatus | 'UNKNOWN' | 'OPEN' | 'PAID' | 'FAILED' | 'ATTEMPT_FAILED' | 'CANCELED' | 'REFUNDED' | 'CHARGEBACKED';
|
|
3300
|
+
declare enum CollectionMethod {
|
|
3301
|
+
UNKNOWN = "UNKNOWN",
|
|
3302
|
+
AUTO_CHARGE = "AUTO_CHARGE",
|
|
3303
|
+
OFFLINE = "OFFLINE",
|
|
3304
|
+
SEND_INVOICE = "SEND_INVOICE"
|
|
3203
3305
|
}
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3306
|
+
/** @enumType */
|
|
3307
|
+
type CollectionMethodWithLiterals = CollectionMethod | 'UNKNOWN' | 'AUTO_CHARGE' | 'OFFLINE' | 'SEND_INVOICE';
|
|
3308
|
+
declare enum CreationMode {
|
|
3309
|
+
UNKNOWN = "UNKNOWN",
|
|
3310
|
+
SYSTEM = "SYSTEM",
|
|
3311
|
+
MANUAL = "MANUAL"
|
|
3207
3312
|
}
|
|
3208
3313
|
/** @enumType */
|
|
3209
|
-
type
|
|
3210
|
-
interface
|
|
3211
|
-
/** List of actions that are allowed. */
|
|
3212
|
-
actions?: Action[];
|
|
3314
|
+
type CreationModeWithLiterals = CreationMode | 'UNKNOWN' | 'SYSTEM' | 'MANUAL';
|
|
3315
|
+
interface LatestPaymentAttempt {
|
|
3213
3316
|
/**
|
|
3214
|
-
*
|
|
3215
|
-
* @
|
|
3317
|
+
* ID of the latest payment attempt.
|
|
3318
|
+
* @format GUID
|
|
3319
|
+
* @readonly
|
|
3216
3320
|
*/
|
|
3217
|
-
|
|
3218
|
-
}
|
|
3219
|
-
interface UnsupportedAction {
|
|
3220
|
-
actionType?: ActionTypeWithLiterals;
|
|
3321
|
+
paymentAttemptId?: string;
|
|
3221
3322
|
/**
|
|
3222
|
-
*
|
|
3223
|
-
* @
|
|
3323
|
+
* Date and time of the latest payment attempt in `YYYY-MM-DDThh:mm.sssZ` format.
|
|
3324
|
+
* @readonly
|
|
3224
3325
|
*/
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
code?: string;
|
|
3229
|
-
description?: string | null;
|
|
3230
|
-
}
|
|
3231
|
-
interface ListUpcomingChargesRequest {
|
|
3326
|
+
dateAttempt?: Date | null;
|
|
3327
|
+
/** Number of the latest payment attempt. */
|
|
3328
|
+
attemptNumber?: number;
|
|
3232
3329
|
/**
|
|
3233
|
-
*
|
|
3234
|
-
*
|
|
3330
|
+
* Status of the latest payment attempt.
|
|
3331
|
+
*
|
|
3332
|
+
* + `"UNKNOWN"`: There is no information about the status of the latest payment attempt.
|
|
3333
|
+
* + `"SCHEDULED"`: The latest payment attempt is scheduled but hasn't started yet.
|
|
3334
|
+
* + `"IN_PROGRESS"`: The latest payment attempt is in progress.
|
|
3335
|
+
* + `"PAID"`: The latest payment attempt resulted in a successful payment.
|
|
3336
|
+
* + `"DECLINED"`: The latest payment attempt has been declined.
|
|
3337
|
+
* + `"TECHNICAL_FAILURE"`: The latest payment attempt couldn't be process due to a technical failure.
|
|
3338
|
+
* + `"CANCELED"`: The latest payment attempt has been canceled by BASS.
|
|
3339
|
+
* @readonly
|
|
3235
3340
|
*/
|
|
3236
|
-
|
|
3237
|
-
/** Period of time to provide charged for. If not provided,then only next charge will be returned. */
|
|
3238
|
-
customDuration?: Duration;
|
|
3341
|
+
status?: PaymentAttemptStatusWithLiterals;
|
|
3239
3342
|
/**
|
|
3240
|
-
*
|
|
3241
|
-
*
|
|
3343
|
+
* Whether BASS tries to collect the payment another time. Available only when
|
|
3344
|
+
* `latestPaymentAttempt.status` is set to `"DECLINED"`.
|
|
3242
3345
|
*/
|
|
3243
|
-
|
|
3346
|
+
retryable?: boolean;
|
|
3347
|
+
/**
|
|
3348
|
+
* Platform fee that was collected on this transaction.
|
|
3349
|
+
* @format DECIMAL_VALUE
|
|
3350
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3351
|
+
* @readonly
|
|
3352
|
+
*/
|
|
3353
|
+
appliedPlatformFee?: string | null;
|
|
3244
3354
|
}
|
|
3245
|
-
|
|
3246
|
-
|
|
3355
|
+
declare enum PaymentAttemptStatus {
|
|
3356
|
+
UNKNOWN = "UNKNOWN",
|
|
3357
|
+
SCHEDULED = "SCHEDULED",
|
|
3358
|
+
IN_PROGRESS = "IN_PROGRESS",
|
|
3359
|
+
PAID = "PAID",
|
|
3360
|
+
DECLINED = "DECLINED",
|
|
3361
|
+
TECHNICAL_FAILURE = "TECHNICAL_FAILURE",
|
|
3362
|
+
CANCELED = "CANCELED",
|
|
3363
|
+
PENDING = "PENDING",
|
|
3364
|
+
REFUNDED = "REFUNDED",
|
|
3365
|
+
CHARGEBACKED = "CHARGEBACKED"
|
|
3247
3366
|
}
|
|
3248
|
-
|
|
3249
|
-
|
|
3250
|
-
|
|
3367
|
+
/** @enumType */
|
|
3368
|
+
type PaymentAttemptStatusWithLiterals = PaymentAttemptStatus | 'UNKNOWN' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAID' | 'DECLINED' | 'TECHNICAL_FAILURE' | 'CANCELED' | 'PENDING' | 'REFUNDED' | 'CHARGEBACKED';
|
|
3369
|
+
interface PriceAdjustment extends PriceAdjustmentAdjustmentTypeOneOf {
|
|
3370
|
+
/** Adjustment that increases the price. */
|
|
3371
|
+
charge?: PriceAdjustmentValue;
|
|
3372
|
+
/** Adjustment that lowers the price. */
|
|
3373
|
+
credit?: PriceAdjustmentValue;
|
|
3374
|
+
/** Reason for this price adjustment. Used to categorize proration adjustments. */
|
|
3375
|
+
reason?: PriceAdjustmentReasonWithLiterals;
|
|
3251
3376
|
}
|
|
3252
3377
|
/** @oneof */
|
|
3253
|
-
interface
|
|
3254
|
-
/**
|
|
3255
|
-
|
|
3256
|
-
|
|
3257
|
-
|
|
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;
|
|
3378
|
+
interface PriceAdjustmentAdjustmentTypeOneOf {
|
|
3379
|
+
/** Adjustment that increases the price. */
|
|
3380
|
+
charge?: PriceAdjustmentValue;
|
|
3381
|
+
/** Adjustment that lowers the price. */
|
|
3382
|
+
credit?: PriceAdjustmentValue;
|
|
3277
3383
|
}
|
|
3278
|
-
interface
|
|
3384
|
+
interface PriceAdjustmentValue extends PriceAdjustmentValueAdjustmentValueTypeOneOf {
|
|
3279
3385
|
/**
|
|
3280
|
-
*
|
|
3281
|
-
*
|
|
3282
|
-
*
|
|
3386
|
+
* Absolute amount that adjusts the price.
|
|
3387
|
+
*
|
|
3388
|
+
* Min: `0.01`
|
|
3389
|
+
* @decimalValue options { gt:0.00 }
|
|
3283
3390
|
*/
|
|
3284
|
-
|
|
3391
|
+
amount?: string;
|
|
3285
3392
|
/**
|
|
3286
|
-
*
|
|
3287
|
-
*
|
|
3288
|
-
*
|
|
3289
|
-
* -
|
|
3290
|
-
* -
|
|
3291
|
-
*
|
|
3292
|
-
*
|
|
3293
|
-
*
|
|
3294
|
-
*
|
|
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
|
|
3393
|
+
* Relative factor that adjusts the price. For example, setting
|
|
3394
|
+
* `multiplier` to:
|
|
3395
|
+
* - `0.50` results in a price adjustment of 50% of the original value.
|
|
3396
|
+
* - `0.75` results in a price adjustment of 75% of the original value.
|
|
3397
|
+
* - `1.00` results in a price adjustment of 100% of the original value.
|
|
3398
|
+
*
|
|
3399
|
+
* Min: `0.01`
|
|
3400
|
+
* Max: `1.00`
|
|
3401
|
+
* @decimalValue options { gt:0.00, lte:1 }
|
|
3298
3402
|
*/
|
|
3299
|
-
|
|
3403
|
+
multiplier?: string;
|
|
3300
3404
|
}
|
|
3301
|
-
|
|
3405
|
+
/** @oneof */
|
|
3406
|
+
interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
|
|
3302
3407
|
/**
|
|
3303
|
-
*
|
|
3304
|
-
*
|
|
3408
|
+
* Absolute amount that adjusts the price.
|
|
3409
|
+
*
|
|
3410
|
+
* Min: `0.01`
|
|
3411
|
+
* @decimalValue options { gt:0.00 }
|
|
3305
3412
|
*/
|
|
3306
|
-
|
|
3307
|
-
/** Billing details parameters including schedule, currency, etc. */
|
|
3308
|
-
billingSettings?: BillingSettings;
|
|
3413
|
+
amount?: string;
|
|
3309
3414
|
/**
|
|
3310
|
-
*
|
|
3311
|
-
*
|
|
3312
|
-
*
|
|
3415
|
+
* Relative factor that adjusts the price. For example, setting
|
|
3416
|
+
* `multiplier` to:
|
|
3417
|
+
* - `0.50` results in a price adjustment of 50% of the original value.
|
|
3418
|
+
* - `0.75` results in a price adjustment of 75% of the original value.
|
|
3419
|
+
* - `1.00` results in a price adjustment of 100% of the original value.
|
|
3420
|
+
*
|
|
3421
|
+
* Min: `0.01`
|
|
3422
|
+
* Max: `1.00`
|
|
3423
|
+
* @decimalValue options { gt:0.00, lte:1 }
|
|
3313
3424
|
*/
|
|
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[];
|
|
3425
|
+
multiplier?: string;
|
|
3323
3426
|
}
|
|
3324
|
-
|
|
3325
|
-
|
|
3326
|
-
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
/**
|
|
3331
|
-
|
|
3427
|
+
/** Reason for a price adjustment. Categorizes different types of proration adjustments. */
|
|
3428
|
+
declare enum PriceAdjustmentReason {
|
|
3429
|
+
/** Default value. Used for adjustments without a specific categorization. */
|
|
3430
|
+
PRICE_ADJUSTMENT_REASON_UNSPECIFIED = "PRICE_ADJUSTMENT_REASON_UNSPECIFIED",
|
|
3431
|
+
/** Adjustment due to a billing date change. */
|
|
3432
|
+
BILLING_DATE_CHANGE = "BILLING_DATE_CHANGE",
|
|
3433
|
+
/** Proration adjustment from changing the subscription plan. */
|
|
3434
|
+
PLAN_CHANGE_PRORATION = "PLAN_CHANGE_PRORATION",
|
|
3435
|
+
/** Proration adjustment from changing the billing cycle (e.g., monthly to yearly). */
|
|
3436
|
+
CYCLE_CHANGE_PRORATION = "CYCLE_CHANGE_PRORATION",
|
|
3437
|
+
/** Proration adjustment from changing the subscription quantity. */
|
|
3438
|
+
QUANTITY_CHANGE_PRORATION = "QUANTITY_CHANGE_PRORATION",
|
|
3439
|
+
/** Custom adjustment provided by the caller. */
|
|
3440
|
+
CUSTOM_PRICE_ADJUSTMENT = "CUSTOM_PRICE_ADJUSTMENT"
|
|
3332
3441
|
}
|
|
3333
|
-
|
|
3334
|
-
|
|
3335
|
-
|
|
3442
|
+
/** @enumType */
|
|
3443
|
+
type PriceAdjustmentReasonWithLiterals = PriceAdjustmentReason | 'PRICE_ADJUSTMENT_REASON_UNSPECIFIED' | 'BILLING_DATE_CHANGE' | 'PLAN_CHANGE_PRORATION' | 'CYCLE_CHANGE_PRORATION' | 'QUANTITY_CHANGE_PRORATION' | 'CUSTOM_PRICE_ADJUSTMENT';
|
|
3444
|
+
interface InvoiceShippingCharges {
|
|
3336
3445
|
/**
|
|
3337
|
-
*
|
|
3338
|
-
*
|
|
3446
|
+
* Amount of the shipping fee in `0.00` format.
|
|
3447
|
+
*
|
|
3448
|
+
* Min: `0.01`
|
|
3449
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3339
3450
|
*/
|
|
3340
|
-
|
|
3451
|
+
amount?: string;
|
|
3452
|
+
/** Tax of the shipping fee */
|
|
3453
|
+
tax?: Tax;
|
|
3454
|
+
/** Information about the shipping charges tax data */
|
|
3455
|
+
taxData?: ItemTaxData;
|
|
3456
|
+
discount?: Discount;
|
|
3341
3457
|
}
|
|
3342
|
-
|
|
3343
|
-
|
|
3344
|
-
|
|
3345
|
-
|
|
3346
|
-
invoice?: Invoice;
|
|
3458
|
+
/** Tax data from all items */
|
|
3459
|
+
interface TaxData {
|
|
3460
|
+
/** Aggregated tax data from all items */
|
|
3461
|
+
taxSummary?: TaxSummary;
|
|
3347
3462
|
}
|
|
3348
|
-
|
|
3349
|
-
interface Invoice {
|
|
3350
|
-
/**
|
|
3351
|
-
* Invoice ID.
|
|
3352
|
-
* @format GUID
|
|
3353
|
-
* @readonly
|
|
3354
|
-
*/
|
|
3355
|
-
id?: string | null;
|
|
3463
|
+
interface TaxSummary {
|
|
3356
3464
|
/**
|
|
3357
|
-
*
|
|
3358
|
-
* @
|
|
3465
|
+
* Aggregated from tax_breakdowns with exemptions excluded from amount
|
|
3466
|
+
* @format DECIMAL_VALUE
|
|
3359
3467
|
*/
|
|
3360
|
-
|
|
3468
|
+
aggregatedTaxAmount?: string;
|
|
3361
3469
|
/**
|
|
3362
|
-
*
|
|
3363
|
-
* @
|
|
3470
|
+
* Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`.
|
|
3471
|
+
* @maxSize 50
|
|
3364
3472
|
*/
|
|
3365
|
-
|
|
3473
|
+
aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
|
|
3366
3474
|
/**
|
|
3367
|
-
*
|
|
3368
|
-
*
|
|
3369
|
-
*
|
|
3370
|
-
*
|
|
3371
|
-
* Ignored when creating a invoice.
|
|
3372
|
-
* @readonly
|
|
3475
|
+
* 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.
|
|
3476
|
+
* @format DECIMAL_VALUE
|
|
3477
|
+
* @decimalValue options { maxScale:4 }
|
|
3373
3478
|
*/
|
|
3374
|
-
|
|
3375
|
-
|
|
3376
|
-
|
|
3479
|
+
exemptAmount?: string | null;
|
|
3480
|
+
}
|
|
3481
|
+
interface AggregatedTaxBreakdown {
|
|
3377
3482
|
/**
|
|
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
|
|
3483
|
+
* Name of the tax that was calculated.
|
|
3484
|
+
* @maxLength 200
|
|
3387
3485
|
*/
|
|
3388
|
-
|
|
3486
|
+
taxName?: string;
|
|
3389
3487
|
/**
|
|
3390
|
-
*
|
|
3391
|
-
*
|
|
3392
|
-
* @format CURRENCY
|
|
3488
|
+
* Type of tax that was calculated.
|
|
3489
|
+
* @maxLength 200
|
|
3393
3490
|
*/
|
|
3394
|
-
|
|
3395
|
-
/** Information about the customer. */
|
|
3396
|
-
customer?: Customer;
|
|
3491
|
+
taxType?: string;
|
|
3397
3492
|
/**
|
|
3398
|
-
*
|
|
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.
|
|
3493
|
+
* Jurisdiction that taxes were calculated for.
|
|
3494
|
+
* @maxLength 200
|
|
3404
3495
|
*/
|
|
3405
|
-
|
|
3496
|
+
jurisdiction?: string;
|
|
3497
|
+
/** Type of jurisdiction that taxes were calculated for. */
|
|
3498
|
+
jurisdictionType?: string;
|
|
3406
3499
|
/**
|
|
3407
|
-
*
|
|
3408
|
-
*
|
|
3409
|
-
* Not available for the first payment of a subscription and all offline
|
|
3410
|
-
* payments.
|
|
3411
|
-
* @format GUID
|
|
3500
|
+
* Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`.
|
|
3501
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
3412
3502
|
*/
|
|
3413
|
-
|
|
3503
|
+
rate?: string;
|
|
3414
3504
|
/**
|
|
3415
|
-
*
|
|
3416
|
-
*
|
|
3417
|
-
* @
|
|
3418
|
-
* @readonly
|
|
3505
|
+
* Total amount of this tax for this jurisdiction.
|
|
3506
|
+
* @format DECIMAL_VALUE
|
|
3507
|
+
* @decimalValue options { maxScale:4 }
|
|
3419
3508
|
*/
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
-
/** Billing address. */
|
|
3424
|
-
billingAddress?: FullAddressDetails;
|
|
3425
|
-
/** Shipping address. Available only for `"PHYSICAL"` line items. */
|
|
3426
|
-
shippingAddress?: FullAddressDetails;
|
|
3509
|
+
aggregatedTaxAmount?: string;
|
|
3510
|
+
}
|
|
3511
|
+
interface RefundInfo {
|
|
3427
3512
|
/**
|
|
3428
|
-
*
|
|
3513
|
+
* If refunds are present, this will include the total amount refunded.
|
|
3429
3514
|
* @format DECIMAL_VALUE
|
|
3515
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3430
3516
|
*/
|
|
3431
|
-
|
|
3517
|
+
totalRefundAmount?: string | null;
|
|
3432
3518
|
/**
|
|
3433
|
-
*
|
|
3434
|
-
* @
|
|
3519
|
+
* The refunds that have been applied to this invoice
|
|
3520
|
+
* @maxSize 20
|
|
3435
3521
|
*/
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3522
|
+
refunds?: Refund[];
|
|
3523
|
+
}
|
|
3524
|
+
interface Refund {
|
|
3439
3525
|
/**
|
|
3440
|
-
*
|
|
3441
|
-
*
|
|
3442
|
-
*
|
|
3443
|
-
* + `false`: Standard invoice.
|
|
3526
|
+
* refund amount
|
|
3527
|
+
* @format DECIMAL_VALUE
|
|
3528
|
+
* @decimalValue options { gt:0.00, maxScale:2 }
|
|
3444
3529
|
*/
|
|
3445
|
-
|
|
3446
|
-
/**
|
|
3447
|
-
|
|
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[];
|
|
3530
|
+
amount?: string;
|
|
3531
|
+
/** the date of the refund transaction */
|
|
3532
|
+
transactionDate?: Date | null;
|
|
3452
3533
|
/**
|
|
3453
|
-
*
|
|
3454
|
-
* @
|
|
3455
|
-
* @readonly
|
|
3534
|
+
* the transaction id associated with this refund
|
|
3535
|
+
* @format GUID
|
|
3456
3536
|
*/
|
|
3457
|
-
|
|
3537
|
+
transactionId?: string;
|
|
3538
|
+
/** a reason for the refund */
|
|
3539
|
+
reason?: RefundReasonWithLiterals;
|
|
3458
3540
|
/**
|
|
3459
|
-
*
|
|
3460
|
-
*
|
|
3461
|
-
* Discounts with cycles (repeated discounts across different billing cycles) are not supported for shipping
|
|
3541
|
+
* a description of the refund - this is a free text field for the initiator
|
|
3542
|
+
* @maxLength 255
|
|
3462
3543
|
*/
|
|
3463
|
-
|
|
3464
|
-
|
|
3465
|
-
|
|
3466
|
-
|
|
3467
|
-
|
|
3544
|
+
description?: string | null;
|
|
3545
|
+
}
|
|
3546
|
+
declare enum RefundReason {
|
|
3547
|
+
DUPLICATE_CHARGE = "DUPLICATE_CHARGE",
|
|
3548
|
+
FRAUDULENT = "FRAUDULENT",
|
|
3549
|
+
CUSTOMER_REQUEST = "CUSTOMER_REQUEST",
|
|
3550
|
+
PROVISION_FAILED = "PROVISION_FAILED",
|
|
3551
|
+
OTHER = "OTHER"
|
|
3552
|
+
}
|
|
3553
|
+
/** @enumType */
|
|
3554
|
+
type RefundReasonWithLiterals = RefundReason | 'DUPLICATE_CHARGE' | 'FRAUDULENT' | 'CUSTOMER_REQUEST' | 'PROVISION_FAILED' | 'OTHER';
|
|
3555
|
+
interface ChangeSubscriptionRequest {
|
|
3468
3556
|
/**
|
|
3469
|
-
* ID of the
|
|
3557
|
+
* ID of the subscription to change
|
|
3470
3558
|
* @format GUID
|
|
3471
3559
|
*/
|
|
3472
|
-
|
|
3560
|
+
subscriptionId?: string;
|
|
3473
3561
|
/**
|
|
3474
|
-
*
|
|
3475
|
-
*
|
|
3562
|
+
* Item-level changes. Each entry targets one existing item by ID.
|
|
3563
|
+
* Caller passes CONCRETE new values (price, quantity, name) — BASS does not resolve pricing.
|
|
3564
|
+
* BASS uses these for proration: old values (from subscription) vs new values (from here).
|
|
3476
3565
|
*/
|
|
3477
|
-
|
|
3566
|
+
itemChanges?: SubscriptionItemChange[];
|
|
3478
3567
|
/**
|
|
3479
|
-
*
|
|
3480
|
-
*
|
|
3568
|
+
* Subscription-level: new billing cycle (e.g., monthly to yearly).
|
|
3569
|
+
* Affects the billing period for ALL items.
|
|
3570
|
+
* When changing cycle, caller MUST also pass new prices in item_changes.
|
|
3481
3571
|
*/
|
|
3482
|
-
|
|
3572
|
+
newCycle?: Duration;
|
|
3573
|
+
/** When the change takes effect. */
|
|
3574
|
+
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
3575
|
+
/** How to handle proration for immediate changes. Ignored for AT_NEXT_RENEWAL. */
|
|
3576
|
+
prorationBehavior?: ProrationBehaviorEnumProrationBehaviorWithLiterals;
|
|
3577
|
+
/** Payment context for immediate changes without checkout flow. */
|
|
3578
|
+
paymentContext?: ChangePaymentContext;
|
|
3483
3579
|
}
|
|
3484
|
-
|
|
3580
|
+
declare enum ProrationBehaviorEnumProrationBehavior {
|
|
3581
|
+
UNKNOWN = "UNKNOWN",
|
|
3582
|
+
/** Credit unused time + charge new prorated price (default for upgrades) */
|
|
3583
|
+
PRORATE_AND_CHARGE = "PRORATE_AND_CHARGE",
|
|
3584
|
+
/** Credit unused time + refund to payment method (downgrades) */
|
|
3585
|
+
PRORATE_AND_REFUND = "PRORATE_AND_REFUND",
|
|
3586
|
+
/** Convert unused value to extra days, no financial transaction */
|
|
3587
|
+
PRORATE_AND_EXTEND = "PRORATE_AND_EXTEND",
|
|
3588
|
+
/** Immediate switch with no financial adjustment */
|
|
3589
|
+
NO_PRORATION = "NO_PRORATION"
|
|
3590
|
+
}
|
|
3591
|
+
/** @enumType */
|
|
3592
|
+
type ProrationBehaviorEnumProrationBehaviorWithLiterals = ProrationBehaviorEnumProrationBehavior | 'UNKNOWN' | 'PRORATE_AND_CHARGE' | 'PRORATE_AND_REFUND' | 'PRORATE_AND_EXTEND' | 'NO_PRORATION';
|
|
3593
|
+
/** Payment context for immediate subscription changes without the checkout flow. */
|
|
3594
|
+
interface ChangePaymentContext {
|
|
3595
|
+
/** Payment settings override for this change */
|
|
3596
|
+
paymentSettings?: PaymentSettings;
|
|
3597
|
+
}
|
|
3598
|
+
interface ChangeSubscriptionResponse {
|
|
3599
|
+
/** Updated subscription */
|
|
3600
|
+
subscription?: Subscription;
|
|
3601
|
+
/** Proration calculation result. Present for immediate changes with proration. */
|
|
3602
|
+
prorationResult?: V1ProrationResult;
|
|
3485
3603
|
/**
|
|
3486
|
-
* ID of the
|
|
3487
|
-
* `"1380b703-ce81-ff05-f115-39571d94dfcd"` for the Wix eCommerce app.
|
|
3604
|
+
* ID of the adjustment invoice created for the proration charge or refund.
|
|
3488
3605
|
* @format GUID
|
|
3489
3606
|
*/
|
|
3490
|
-
|
|
3607
|
+
adjustmentInvoiceId?: string | null;
|
|
3608
|
+
}
|
|
3609
|
+
/** Result of a proration calculation applied during a subscription change. */
|
|
3610
|
+
interface V1ProrationResult {
|
|
3491
3611
|
/**
|
|
3492
|
-
*
|
|
3493
|
-
*
|
|
3494
|
-
* @format GUID
|
|
3612
|
+
* Credit amount for unused time on the current plan
|
|
3613
|
+
* @format DECIMAL_VALUE
|
|
3495
3614
|
*/
|
|
3496
|
-
|
|
3615
|
+
creditAmount?: string;
|
|
3497
3616
|
/**
|
|
3498
|
-
*
|
|
3499
|
-
*
|
|
3617
|
+
* Charge amount for the new plan's prorated price
|
|
3618
|
+
* @format DECIMAL_VALUE
|
|
3619
|
+
*/
|
|
3620
|
+
chargeAmount?: string;
|
|
3621
|
+
/**
|
|
3622
|
+
* Net amount (charge minus credit). Positive means customer pays, negative means refund.
|
|
3623
|
+
* @format DECIMAL_VALUE
|
|
3624
|
+
*/
|
|
3625
|
+
netAmount?: string;
|
|
3626
|
+
/** Date when the proration was calculated */
|
|
3627
|
+
prorationDate?: Date | null;
|
|
3628
|
+
/** Remaining seconds in the current billing period at time of change */
|
|
3629
|
+
remainingSeconds?: string;
|
|
3630
|
+
/** Total seconds in the current billing cycle */
|
|
3631
|
+
totalCycleSeconds?: string;
|
|
3632
|
+
}
|
|
3633
|
+
interface PreviewChangeSubscriptionRequest {
|
|
3634
|
+
/**
|
|
3635
|
+
* ID of the subscription to preview the change for
|
|
3500
3636
|
* @format GUID
|
|
3501
3637
|
*/
|
|
3502
|
-
|
|
3638
|
+
subscriptionId?: string;
|
|
3639
|
+
/** Item-level changes to preview. Same structure as ChangeSubscriptionRequest. */
|
|
3640
|
+
itemChanges?: SubscriptionItemChange[];
|
|
3641
|
+
/** Subscription-level: preview a cycle change. */
|
|
3642
|
+
newCycle?: Duration;
|
|
3643
|
+
/** When the change would take effect. */
|
|
3644
|
+
effectiveTime?: ChangeEffectiveTimeWithLiterals;
|
|
3645
|
+
/** How proration would be handled for immediate changes. */
|
|
3646
|
+
prorationBehavior?: ProrationBehaviorEnumProrationBehaviorWithLiterals;
|
|
3503
3647
|
}
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
CANCELED = "CANCELED",
|
|
3511
|
-
REFUNDED = "REFUNDED",
|
|
3512
|
-
CHARGEBACKED = "CHARGEBACKED"
|
|
3648
|
+
interface CancelPendingChangeRequest {
|
|
3649
|
+
/**
|
|
3650
|
+
* ID of the subscription to cancel the pending change for
|
|
3651
|
+
* @format GUID
|
|
3652
|
+
*/
|
|
3653
|
+
subscriptionId?: string;
|
|
3513
3654
|
}
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
UNKNOWN = "UNKNOWN",
|
|
3518
|
-
AUTO_CHARGE = "AUTO_CHARGE",
|
|
3519
|
-
OFFLINE = "OFFLINE",
|
|
3520
|
-
SEND_INVOICE = "SEND_INVOICE"
|
|
3655
|
+
interface CancelPendingChangeResponse {
|
|
3656
|
+
/** Updated subscription with cleared pending data */
|
|
3657
|
+
subscription?: Subscription;
|
|
3521
3658
|
}
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
MANUAL = "MANUAL"
|
|
3659
|
+
interface ChangeSubscriptionForOrderRequest {
|
|
3660
|
+
/** The new subscription definition from the order (items, billing settings). */
|
|
3661
|
+
subscription?: Subscription;
|
|
3662
|
+
/** Context of the change: source subscription, change type, proration behavior. */
|
|
3663
|
+
changeContext?: ChangeContext;
|
|
3528
3664
|
}
|
|
3529
|
-
/**
|
|
3530
|
-
|
|
3531
|
-
|
|
3665
|
+
/**
|
|
3666
|
+
* Context for subscription changes within the order/checkout flow.
|
|
3667
|
+
* Carries the source subscription reference and change parameters.
|
|
3668
|
+
* Present on an OrderSubscription when it represents a modification of an
|
|
3669
|
+
* existing subscription rather than a new purchase.
|
|
3670
|
+
*/
|
|
3671
|
+
interface ChangeContext {
|
|
3532
3672
|
/**
|
|
3533
|
-
* ID of the
|
|
3673
|
+
* ID of the existing subscription being changed.
|
|
3534
3674
|
* @format GUID
|
|
3535
|
-
* @readonly
|
|
3536
3675
|
*/
|
|
3537
|
-
|
|
3676
|
+
sourceSubscriptionId?: string;
|
|
3677
|
+
/** Type of change being performed. */
|
|
3678
|
+
changeType?: ChangeTypeWithLiterals;
|
|
3679
|
+
/** How proration should be handled. */
|
|
3680
|
+
prorationBehavior?: ProrationBehaviorWithLiterals;
|
|
3538
3681
|
/**
|
|
3539
|
-
*
|
|
3540
|
-
*
|
|
3682
|
+
* System-populated: proration result after calculation.
|
|
3683
|
+
* Populated by billing-subscriptions during order processing.
|
|
3541
3684
|
*/
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
|
|
3685
|
+
prorationResult?: ProrationResult;
|
|
3686
|
+
}
|
|
3687
|
+
declare enum ChangeType {
|
|
3688
|
+
CHANGE_TYPE_UNKNOWN = "CHANGE_TYPE_UNKNOWN",
|
|
3689
|
+
UPGRADE = "UPGRADE",
|
|
3690
|
+
DOWNGRADE = "DOWNGRADE",
|
|
3691
|
+
CYCLE_CHANGE = "CYCLE_CHANGE",
|
|
3692
|
+
QUANTITY_CHANGE = "QUANTITY_CHANGE"
|
|
3693
|
+
}
|
|
3694
|
+
/** @enumType */
|
|
3695
|
+
type ChangeTypeWithLiterals = ChangeType | 'CHANGE_TYPE_UNKNOWN' | 'UPGRADE' | 'DOWNGRADE' | 'CYCLE_CHANGE' | 'QUANTITY_CHANGE';
|
|
3696
|
+
declare enum ProrationBehavior {
|
|
3697
|
+
PRORATION_BEHAVIOR_UNKNOWN = "PRORATION_BEHAVIOR_UNKNOWN",
|
|
3698
|
+
/** Credit unused time + charge new prorated price (default for upgrades) */
|
|
3699
|
+
PRORATE_AND_CHARGE = "PRORATE_AND_CHARGE",
|
|
3700
|
+
/** Credit unused time + refund to payment method (downgrades) */
|
|
3701
|
+
PRORATE_AND_REFUND = "PRORATE_AND_REFUND",
|
|
3702
|
+
/** Convert unused value to extra days, no financial transaction */
|
|
3703
|
+
PRORATE_AND_EXTEND = "PRORATE_AND_EXTEND",
|
|
3704
|
+
/** Immediate switch with no financial adjustment */
|
|
3705
|
+
NO_PRORATION = "NO_PRORATION"
|
|
3706
|
+
}
|
|
3707
|
+
/** @enumType */
|
|
3708
|
+
type ProrationBehaviorWithLiterals = ProrationBehavior | 'PRORATION_BEHAVIOR_UNKNOWN' | 'PRORATE_AND_CHARGE' | 'PRORATE_AND_REFUND' | 'PRORATE_AND_EXTEND' | 'NO_PRORATION';
|
|
3709
|
+
/**
|
|
3710
|
+
* Result of a proration calculation. Contains the credit, charge, and net amounts
|
|
3711
|
+
* computed during a subscription change.
|
|
3712
|
+
*/
|
|
3713
|
+
interface ProrationResult {
|
|
3545
3714
|
/**
|
|
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
|
|
3715
|
+
* Credit amount for unused time on the current plan
|
|
3716
|
+
* @format DECIMAL_VALUE
|
|
3556
3717
|
*/
|
|
3557
|
-
|
|
3718
|
+
creditAmount?: string;
|
|
3558
3719
|
/**
|
|
3559
|
-
*
|
|
3560
|
-
*
|
|
3720
|
+
* Charge amount for the new plan's prorated price
|
|
3721
|
+
* @format DECIMAL_VALUE
|
|
3561
3722
|
*/
|
|
3562
|
-
|
|
3723
|
+
chargeAmount?: string;
|
|
3563
3724
|
/**
|
|
3564
|
-
*
|
|
3725
|
+
* Net amount (charge minus credit). Positive means customer pays, negative means refund.
|
|
3565
3726
|
* @format DECIMAL_VALUE
|
|
3566
|
-
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3567
|
-
* @readonly
|
|
3568
3727
|
*/
|
|
3569
|
-
|
|
3728
|
+
netAmount?: string;
|
|
3729
|
+
/** Date when the proration was calculated */
|
|
3730
|
+
prorationDate?: Date | null;
|
|
3731
|
+
/** Remaining seconds in the current billing period at time of change */
|
|
3732
|
+
remainingSeconds?: string;
|
|
3733
|
+
/** Total seconds in the current billing cycle */
|
|
3734
|
+
totalCycleSeconds?: string;
|
|
3570
3735
|
}
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
|
|
3578
|
-
CANCELED = "CANCELED",
|
|
3579
|
-
PENDING = "PENDING",
|
|
3580
|
-
REFUNDED = "REFUNDED",
|
|
3581
|
-
CHARGEBACKED = "CHARGEBACKED"
|
|
3736
|
+
interface ChangeSubscriptionForOrderResponse {
|
|
3737
|
+
/** The source subscription (unchanged, for reference). */
|
|
3738
|
+
subscription?: Subscription;
|
|
3739
|
+
/** Non-persistent invoice with proration adjustments. */
|
|
3740
|
+
invoice?: Invoice;
|
|
3741
|
+
/** Calculated proration result. */
|
|
3742
|
+
prorationResult?: ProrationResult;
|
|
3582
3743
|
}
|
|
3583
|
-
|
|
3584
|
-
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
|
|
3591
|
-
|
|
3744
|
+
interface Task {
|
|
3745
|
+
key?: TaskKey;
|
|
3746
|
+
executeAt?: Date | null;
|
|
3747
|
+
payload?: string | null;
|
|
3748
|
+
}
|
|
3749
|
+
interface TaskKey {
|
|
3750
|
+
appId?: string;
|
|
3751
|
+
instanceId?: string;
|
|
3752
|
+
subjectId?: string | null;
|
|
3753
|
+
}
|
|
3754
|
+
interface TaskAction extends TaskActionActionOneOf {
|
|
3755
|
+
complete?: Complete;
|
|
3756
|
+
cancel?: Cancel;
|
|
3757
|
+
reschedule?: Reschedule;
|
|
3592
3758
|
}
|
|
3593
3759
|
/** @oneof */
|
|
3594
|
-
interface
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
|
-
credit?: PriceAdjustmentValue;
|
|
3760
|
+
interface TaskActionActionOneOf {
|
|
3761
|
+
complete?: Complete;
|
|
3762
|
+
cancel?: Cancel;
|
|
3763
|
+
reschedule?: Reschedule;
|
|
3599
3764
|
}
|
|
3600
|
-
interface
|
|
3765
|
+
interface Complete {
|
|
3766
|
+
}
|
|
3767
|
+
interface Cancel {
|
|
3768
|
+
}
|
|
3769
|
+
interface Reschedule {
|
|
3770
|
+
executeAt?: Date | null;
|
|
3771
|
+
payload?: string | null;
|
|
3772
|
+
}
|
|
3773
|
+
interface Empty {
|
|
3774
|
+
}
|
|
3775
|
+
interface V1SubscriptionEvent extends V1SubscriptionEventEventOneOf {
|
|
3776
|
+
/** A subscriptions was created */
|
|
3777
|
+
created?: V1SubscriptionCreated;
|
|
3778
|
+
/** Subscription is considered active and will be visible to site owners and members */
|
|
3779
|
+
activated?: V1SubscriptionActivated;
|
|
3601
3780
|
/**
|
|
3602
|
-
*
|
|
3603
|
-
*
|
|
3604
|
-
* Min: `0.01`
|
|
3605
|
-
* @decimalValue options { gt:0.00 }
|
|
3781
|
+
* Subscription was canceled either by cancellation request with requested expiration date NOW or by payment provider.
|
|
3782
|
+
* If cancelled by payment provider subscription will be valid until the date calculated depending on how many cycles it was already paid for.
|
|
3606
3783
|
*/
|
|
3607
|
-
|
|
3784
|
+
canceled?: V1SubscriptionCanceled;
|
|
3785
|
+
/** Subscription was updated. Currently the only possible change is valid_until date */
|
|
3786
|
+
updated?: V1SubscriptionUpdated;
|
|
3787
|
+
/** Subscription cycle has started. Currently the cycle starts when a payment is received. */
|
|
3788
|
+
cycleTriggered?: SubscriptionCycleTriggered;
|
|
3789
|
+
/** Offline subscription was marked as paid */
|
|
3790
|
+
markedAsPaid?: SubscriptionMarkedAsPaid;
|
|
3608
3791
|
/**
|
|
3609
|
-
*
|
|
3610
|
-
*
|
|
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 }
|
|
3792
|
+
* Subscription cancellation for the future date was requested.
|
|
3793
|
+
* Subscription will stay in pending cancellation status until the date calculated depending on free trial and the next payment date.
|
|
3618
3794
|
*/
|
|
3619
|
-
|
|
3795
|
+
cancellationRequested?: SubscriptionCancellationRequested;
|
|
3796
|
+
/** Subscription and it's payment schedule (for recurring) was suspended */
|
|
3797
|
+
suspended?: SubscriptionSuspended;
|
|
3798
|
+
/** Previously suspended subscription and it's payment schedule (for recurring) was resumed */
|
|
3799
|
+
resumed?: V1SubscriptionResumed;
|
|
3800
|
+
/** Subscription expired according to valid_until expiration date. */
|
|
3801
|
+
expired?: SubscriptionExpired;
|
|
3802
|
+
/** Subscription initial purchase completed */
|
|
3803
|
+
initialPurchaseCompleted?: V1SubscriptionInitialPurchaseCompleted;
|
|
3620
3804
|
}
|
|
3621
3805
|
/** @oneof */
|
|
3622
|
-
interface
|
|
3806
|
+
interface V1SubscriptionEventEventOneOf {
|
|
3807
|
+
/** A subscriptions was created */
|
|
3808
|
+
created?: V1SubscriptionCreated;
|
|
3809
|
+
/** Subscription is considered active and will be visible to site owners and members */
|
|
3810
|
+
activated?: V1SubscriptionActivated;
|
|
3623
3811
|
/**
|
|
3624
|
-
*
|
|
3625
|
-
*
|
|
3626
|
-
* Min: `0.01`
|
|
3627
|
-
* @decimalValue options { gt:0.00 }
|
|
3812
|
+
* Subscription was canceled either by cancellation request with requested expiration date NOW or by payment provider.
|
|
3813
|
+
* If cancelled by payment provider subscription will be valid until the date calculated depending on how many cycles it was already paid for.
|
|
3628
3814
|
*/
|
|
3629
|
-
|
|
3815
|
+
canceled?: V1SubscriptionCanceled;
|
|
3816
|
+
/** Subscription was updated. Currently the only possible change is valid_until date */
|
|
3817
|
+
updated?: V1SubscriptionUpdated;
|
|
3818
|
+
/** Subscription cycle has started. Currently the cycle starts when a payment is received. */
|
|
3819
|
+
cycleTriggered?: SubscriptionCycleTriggered;
|
|
3820
|
+
/** Offline subscription was marked as paid */
|
|
3821
|
+
markedAsPaid?: SubscriptionMarkedAsPaid;
|
|
3630
3822
|
/**
|
|
3631
|
-
*
|
|
3632
|
-
*
|
|
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"
|
|
3657
|
-
}
|
|
3658
|
-
/** @enumType */
|
|
3659
|
-
type PriceAdjustmentReasonWithLiterals = PriceAdjustmentReason | 'PRICE_ADJUSTMENT_REASON_UNSPECIFIED' | 'BILLING_DATE_CHANGE' | 'PLAN_CHANGE_PRORATION' | 'CYCLE_CHANGE_PRORATION' | 'QUANTITY_CHANGE_PRORATION' | 'CUSTOM_PRICE_ADJUSTMENT';
|
|
3660
|
-
interface InvoiceShippingCharges {
|
|
3661
|
-
/**
|
|
3662
|
-
* Amount of the shipping fee in `0.00` format.
|
|
3663
|
-
*
|
|
3664
|
-
* Min: `0.01`
|
|
3665
|
-
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3823
|
+
* Subscription cancellation for the future date was requested.
|
|
3824
|
+
* Subscription will stay in pending cancellation status until the date calculated depending on free trial and the next payment date.
|
|
3666
3825
|
*/
|
|
3667
|
-
|
|
3668
|
-
/**
|
|
3669
|
-
|
|
3670
|
-
/**
|
|
3671
|
-
|
|
3672
|
-
|
|
3826
|
+
cancellationRequested?: SubscriptionCancellationRequested;
|
|
3827
|
+
/** Subscription and it's payment schedule (for recurring) was suspended */
|
|
3828
|
+
suspended?: SubscriptionSuspended;
|
|
3829
|
+
/** Previously suspended subscription and it's payment schedule (for recurring) was resumed */
|
|
3830
|
+
resumed?: V1SubscriptionResumed;
|
|
3831
|
+
/** Subscription expired according to valid_until expiration date. */
|
|
3832
|
+
expired?: SubscriptionExpired;
|
|
3833
|
+
/** Subscription initial purchase completed */
|
|
3834
|
+
initialPurchaseCompleted?: V1SubscriptionInitialPurchaseCompleted;
|
|
3673
3835
|
}
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
/** Aggregated tax data from all items */
|
|
3677
|
-
taxSummary?: TaxSummary;
|
|
3836
|
+
interface V1SubscriptionCreated {
|
|
3837
|
+
subscription?: V1Subscription;
|
|
3678
3838
|
}
|
|
3679
|
-
interface
|
|
3839
|
+
interface V1Subscription {
|
|
3680
3840
|
/**
|
|
3681
|
-
*
|
|
3682
|
-
* @format
|
|
3841
|
+
* ID of the subscription
|
|
3842
|
+
* @format GUID
|
|
3843
|
+
* @readonly
|
|
3683
3844
|
*/
|
|
3684
|
-
|
|
3845
|
+
id?: string;
|
|
3685
3846
|
/**
|
|
3686
|
-
*
|
|
3687
|
-
* @
|
|
3847
|
+
* ID of the app which created the subscription
|
|
3848
|
+
* @format GUID
|
|
3688
3849
|
*/
|
|
3689
|
-
|
|
3690
|
-
}
|
|
3691
|
-
interface AggregatedTaxBreakdown {
|
|
3850
|
+
wixAppId?: string;
|
|
3692
3851
|
/**
|
|
3693
|
-
*
|
|
3694
|
-
* @
|
|
3852
|
+
* Instance ID of the Subscriptions app
|
|
3853
|
+
* @format GUID
|
|
3695
3854
|
*/
|
|
3696
|
-
|
|
3855
|
+
tenantId?: string;
|
|
3697
3856
|
/**
|
|
3698
|
-
*
|
|
3699
|
-
* @
|
|
3857
|
+
* ID of entity in app (e.g. a cart in stores/order in paid plans)
|
|
3858
|
+
* @format GUID
|
|
3700
3859
|
*/
|
|
3701
|
-
|
|
3860
|
+
originEntityId?: string;
|
|
3861
|
+
/** Site member or a contact who bought the subscription */
|
|
3862
|
+
subscriber?: Subscriber;
|
|
3702
3863
|
/**
|
|
3703
|
-
*
|
|
3704
|
-
* @
|
|
3864
|
+
* Wix Pay order ID, is empty for free subscriptions
|
|
3865
|
+
* @format GUID
|
|
3705
3866
|
*/
|
|
3706
|
-
|
|
3707
|
-
/** Type of jurisdiction that taxes were calculated for. */
|
|
3708
|
-
jurisdictionType?: string;
|
|
3867
|
+
wixPayOrderId?: string | null;
|
|
3709
3868
|
/**
|
|
3710
|
-
*
|
|
3711
|
-
* @
|
|
3869
|
+
* Subscription name (e.g. a product or subscription package name)
|
|
3870
|
+
* @maxLength 150
|
|
3712
3871
|
*/
|
|
3713
|
-
|
|
3872
|
+
name?: string;
|
|
3714
3873
|
/**
|
|
3715
|
-
*
|
|
3716
|
-
* @
|
|
3717
|
-
* @decimalValue options { maxScale:4 }
|
|
3874
|
+
* Optional additional subscription description
|
|
3875
|
+
* @maxLength 500
|
|
3718
3876
|
*/
|
|
3719
|
-
|
|
3877
|
+
description?: string;
|
|
3878
|
+
/** Amount to be paid for a single scheduled payment */
|
|
3879
|
+
price?: Money;
|
|
3880
|
+
/** True if the subscription is recurring, false for a single payment subscription */
|
|
3881
|
+
recurring?: boolean;
|
|
3882
|
+
/** Online (paid by subscriber using wix pay) or offline (need to manually mark as paid) */
|
|
3883
|
+
subscriptionType?: SubscriptionTypeWithLiterals;
|
|
3884
|
+
/** Active, expired, canceled, etc. */
|
|
3885
|
+
subscriptionStatus?: V1SubscriptionStatusEnumSubscriptionStatusWithLiterals;
|
|
3886
|
+
/** Subscription start date (may differ from creation date) */
|
|
3887
|
+
validFrom?: Date | null;
|
|
3888
|
+
/** Subscription expiration date */
|
|
3889
|
+
validUntil?: Date | null;
|
|
3890
|
+
/** Status of last payment associated with this subscription */
|
|
3891
|
+
lastPaymentStatus?: PaymentStatusEnumPaymentStatusWithLiterals;
|
|
3892
|
+
/** Payment schedule in the wix pay format. Exists for recurring subscriptions only. */
|
|
3893
|
+
billingProfile?: V2Subscription;
|
|
3894
|
+
/** Owner, member, etc. - present if subscription is canceled */
|
|
3895
|
+
cancellationInitiator?: CancellationInitiatorWithLiterals;
|
|
3896
|
+
/** Optional, present if subscription is canceled */
|
|
3897
|
+
cancellationReason?: string | null;
|
|
3898
|
+
/** Can be used for arbitrary app-specific map<string, string> data */
|
|
3899
|
+
externalData?: Record<string, string>;
|
|
3900
|
+
/** Date when subscription was created (not related to payment dates) */
|
|
3901
|
+
dateCreated?: Date | null;
|
|
3902
|
+
/** Restrictions on possible subscription actions. Default policy has all restrictions enabled. */
|
|
3903
|
+
policy?: SubscriptionPolicy;
|
|
3904
|
+
/** List of subscription suspension periods */
|
|
3905
|
+
suspensions?: Suspension[];
|
|
3906
|
+
/** Initial subscription expiration date that was calculated on the subscription purchase plus duration of suspensions */
|
|
3907
|
+
validUntilDateWithSuspensions?: Date | null;
|
|
3908
|
+
/** Duration of single payment subscription (instead of billing_profile) */
|
|
3909
|
+
singlePaymentDuration?: V1Duration;
|
|
3910
|
+
/** @format GUID */
|
|
3911
|
+
originInstanceId?: string | null;
|
|
3720
3912
|
}
|
|
3721
|
-
interface
|
|
3722
|
-
/**
|
|
3723
|
-
* If refunds are present, this will include the total amount refunded.
|
|
3724
|
-
* @format DECIMAL_VALUE
|
|
3725
|
-
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
3726
|
-
*/
|
|
3727
|
-
totalRefundAmount?: string | null;
|
|
3913
|
+
interface Subscriber {
|
|
3728
3914
|
/**
|
|
3729
|
-
*
|
|
3730
|
-
* @
|
|
3915
|
+
* Member or contact ID
|
|
3916
|
+
* @format GUID
|
|
3731
3917
|
*/
|
|
3732
|
-
|
|
3918
|
+
id?: string;
|
|
3919
|
+
/** Member or contact */
|
|
3920
|
+
identityType?: IdentityTypeWithLiterals;
|
|
3733
3921
|
}
|
|
3734
|
-
|
|
3922
|
+
declare enum IdentityType {
|
|
3923
|
+
/** Identity type undefined */
|
|
3924
|
+
UNDEFINED = "UNDEFINED",
|
|
3925
|
+
/** Subscription is associated with a member ID */
|
|
3926
|
+
MEMBER = "MEMBER",
|
|
3927
|
+
/** Subscriptions is associated with a contact ID */
|
|
3928
|
+
CONTACT = "CONTACT"
|
|
3929
|
+
}
|
|
3930
|
+
/** @enumType */
|
|
3931
|
+
type IdentityTypeWithLiterals = IdentityType | 'UNDEFINED' | 'MEMBER' | 'CONTACT';
|
|
3932
|
+
/** Price of a payment. Includes amount and currency. */
|
|
3933
|
+
interface Money {
|
|
3735
3934
|
/**
|
|
3736
|
-
*
|
|
3935
|
+
* Monetary amount i.e. 3.99.
|
|
3737
3936
|
* @format DECIMAL_VALUE
|
|
3738
|
-
* @decimalValue options { gt:0.00, maxScale:2 }
|
|
3739
3937
|
*/
|
|
3740
3938
|
amount?: string;
|
|
3741
|
-
/** the date of the refund transaction */
|
|
3742
|
-
transactionDate?: Date | null;
|
|
3743
|
-
/**
|
|
3744
|
-
* the transaction id associated with this refund
|
|
3745
|
-
* @format GUID
|
|
3746
|
-
*/
|
|
3747
|
-
transactionId?: string;
|
|
3748
|
-
/** a reason for the refund */
|
|
3749
|
-
reason?: RefundReasonWithLiterals;
|
|
3750
3939
|
/**
|
|
3751
|
-
*
|
|
3752
|
-
* @
|
|
3940
|
+
* Currency in ISO 4217 format i.e. USD.
|
|
3941
|
+
* @minLength 3
|
|
3942
|
+
* @maxLength 3
|
|
3753
3943
|
*/
|
|
3754
|
-
|
|
3944
|
+
currency?: string;
|
|
3755
3945
|
}
|
|
3756
|
-
declare enum
|
|
3757
|
-
|
|
3758
|
-
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
|
|
3946
|
+
declare enum SubscriptionType {
|
|
3947
|
+
UNDEFINED = "UNDEFINED",
|
|
3948
|
+
/** Payments made by the subscriber */
|
|
3949
|
+
ONLINE = "ONLINE",
|
|
3950
|
+
/** Payments managed manually by the site owner */
|
|
3951
|
+
OFFLINE = "OFFLINE"
|
|
3762
3952
|
}
|
|
3763
3953
|
/** @enumType */
|
|
3764
|
-
type
|
|
3765
|
-
|
|
3766
|
-
/**
|
|
3767
|
-
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
|
|
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;
|
|
3954
|
+
type SubscriptionTypeWithLiterals = SubscriptionType | 'UNDEFINED' | 'ONLINE' | 'OFFLINE';
|
|
3955
|
+
declare enum V1SubscriptionStatusEnumSubscriptionStatus {
|
|
3956
|
+
/** Subscription status undefined */
|
|
3957
|
+
UNDEFINED = "UNDEFINED",
|
|
3958
|
+
/** Subscription created, but hasn't been paid for yet. This status if filtered out in ListSubscriptions response by default. */
|
|
3959
|
+
DRAFT = "DRAFT",
|
|
3960
|
+
/** Subscription has been paid for, but the start date is in the future */
|
|
3961
|
+
PENDING = "PENDING",
|
|
3962
|
+
/** Subscription is active */
|
|
3963
|
+
ACTIVE = "ACTIVE",
|
|
3964
|
+
/** Subscription has expired */
|
|
3965
|
+
EXPIRED = "EXPIRED",
|
|
3966
|
+
/** Subscription has been canceled */
|
|
3967
|
+
CANCELED = "CANCELED",
|
|
3968
|
+
/** Subscription has been set to be canceled at a future date */
|
|
3969
|
+
PENDING_CANCELLATION = "PENDING_CANCELLATION",
|
|
3970
|
+
/** Subscription is suspended */
|
|
3971
|
+
SUSPENDED = "SUSPENDED"
|
|
3789
3972
|
}
|
|
3790
|
-
/**
|
|
3791
|
-
|
|
3792
|
-
|
|
3793
|
-
*/
|
|
3794
|
-
|
|
3795
|
-
/**
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
|
|
3810
|
-
|
|
3973
|
+
/** @enumType */
|
|
3974
|
+
type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals = V1SubscriptionStatusEnumSubscriptionStatus | 'UNDEFINED' | 'DRAFT' | 'PENDING' | 'ACTIVE' | 'EXPIRED' | 'CANCELED' | 'PENDING_CANCELLATION' | 'SUSPENDED';
|
|
3975
|
+
declare enum PaymentStatusEnumPaymentStatus {
|
|
3976
|
+
/** Payment status undefined */
|
|
3977
|
+
UNDEFINED = "UNDEFINED",
|
|
3978
|
+
/** Payment has been paid */
|
|
3979
|
+
PAID = "PAID",
|
|
3980
|
+
/** Payment has been refunded */
|
|
3981
|
+
REFUNDED = "REFUNDED",
|
|
3982
|
+
/** Recurring payment has failed */
|
|
3983
|
+
FAILED = "FAILED",
|
|
3984
|
+
/** Payment has not been paid */
|
|
3985
|
+
UNPAID = "UNPAID",
|
|
3986
|
+
/** Billing has been initialized, but actual charge is yet to be made. Can happen for free trial and PayPal */
|
|
3987
|
+
PENDING = "PENDING"
|
|
3988
|
+
}
|
|
3989
|
+
/** @enumType */
|
|
3990
|
+
type PaymentStatusEnumPaymentStatusWithLiterals = PaymentStatusEnumPaymentStatus | 'UNDEFINED' | 'PAID' | 'REFUNDED' | 'FAILED' | 'UNPAID' | 'PENDING';
|
|
3991
|
+
/**
|
|
3992
|
+
* Recurring payment is described by `frequency` (day, week, month) and `interval`.
|
|
3993
|
+
*
|
|
3994
|
+
* For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.
|
|
3995
|
+
*
|
|
3996
|
+
* In some cases there should be a trial period for the order, after which payments start to occur.
|
|
3997
|
+
* Trial period is also defined as `frequency` and `interval` pair.
|
|
3998
|
+
*
|
|
3999
|
+
* So one can define a monthly 'subscription' with a 14 days trial period.
|
|
4000
|
+
*/
|
|
4001
|
+
interface V2Subscription {
|
|
4002
|
+
/** frequency of recurring payment (required) */
|
|
4003
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
4004
|
+
/** interval of recurring payment (required) */
|
|
4005
|
+
interval?: number;
|
|
4006
|
+
/** trial period for recurring payment (optional) */
|
|
4007
|
+
trial?: SubscriptionTrialPeriod;
|
|
3811
4008
|
/**
|
|
3812
|
-
*
|
|
3813
|
-
*
|
|
4009
|
+
* how many billing cycles should be done before subscription finishes
|
|
4010
|
+
* (optional, 0 by default means endless subscription)
|
|
3814
4011
|
*/
|
|
3815
|
-
|
|
4012
|
+
billingCycles?: number;
|
|
3816
4013
|
/**
|
|
3817
|
-
*
|
|
3818
|
-
*
|
|
4014
|
+
* date in the future or in the past when the first billing cycle begins
|
|
4015
|
+
* (the first off-session payment is performed when it ends)
|
|
3819
4016
|
*/
|
|
3820
|
-
|
|
4017
|
+
firstCycleStartDate?: Date | null;
|
|
3821
4018
|
}
|
|
3822
|
-
|
|
3823
|
-
|
|
3824
|
-
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
|
|
4019
|
+
/** Frequency unit of recurring payment */
|
|
4020
|
+
declare enum SubscriptionFrequency {
|
|
4021
|
+
UNDEFINED = "UNDEFINED",
|
|
4022
|
+
DAY = "DAY",
|
|
4023
|
+
WEEK = "WEEK",
|
|
4024
|
+
MONTH = "MONTH",
|
|
4025
|
+
YEAR = "YEAR"
|
|
3828
4026
|
}
|
|
3829
4027
|
/** @enumType */
|
|
3830
|
-
type
|
|
3831
|
-
|
|
3832
|
-
|
|
3833
|
-
/**
|
|
3834
|
-
|
|
3835
|
-
/**
|
|
3836
|
-
|
|
3837
|
-
|
|
3838
|
-
|
|
3839
|
-
/**
|
|
3840
|
-
|
|
4028
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
4029
|
+
/** Trial period of subscription */
|
|
4030
|
+
interface SubscriptionTrialPeriod {
|
|
4031
|
+
/** trial period in units (required) */
|
|
4032
|
+
period?: number;
|
|
4033
|
+
/** units in which trial period is described (optional, default DAY) */
|
|
4034
|
+
unit?: SubscriptionFrequencyWithLiterals;
|
|
4035
|
+
}
|
|
4036
|
+
declare enum CancellationInitiator {
|
|
4037
|
+
/** Cancellation initiator undefined */
|
|
4038
|
+
UNDEFINED = "UNDEFINED",
|
|
4039
|
+
/** Subscription was canceled by site owner (default if canceled by user or service identity) */
|
|
4040
|
+
OWNER = "OWNER",
|
|
4041
|
+
/** Subscription was canceled by member (default if canceled by member identity) */
|
|
4042
|
+
MEMBER = "MEMBER",
|
|
4043
|
+
/** Subscription was canceled because of payment failure */
|
|
4044
|
+
PAYMENT_FAILURE = "PAYMENT_FAILURE",
|
|
4045
|
+
/** Subscription was canceled because of payment setup failure */
|
|
4046
|
+
SETUP_FAILURE = "SETUP_FAILURE"
|
|
3841
4047
|
}
|
|
3842
4048
|
/** @enumType */
|
|
3843
|
-
type
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
|
|
3847
|
-
|
|
4049
|
+
type CancellationInitiatorWithLiterals = CancellationInitiator | 'UNDEFINED' | 'OWNER' | 'MEMBER' | 'PAYMENT_FAILURE' | 'SETUP_FAILURE';
|
|
4050
|
+
interface SubscriptionPolicy {
|
|
4051
|
+
/** Subscription expiration date can be updated */
|
|
4052
|
+
expiryDateChangeable?: boolean;
|
|
4053
|
+
/** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
|
|
4054
|
+
cancellableByMember?: boolean;
|
|
4055
|
+
/** Subscription expiration date on cancellation can be set to next payment date */
|
|
4056
|
+
cancellableAtNextPaymentCycle?: boolean;
|
|
3848
4057
|
}
|
|
3849
|
-
interface
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
|
-
|
|
3853
|
-
|
|
3854
|
-
|
|
3855
|
-
* ID of the adjustment invoice created for the proration charge or refund.
|
|
3856
|
-
* @format GUID
|
|
3857
|
-
*/
|
|
3858
|
-
adjustmentInvoiceId?: string | null;
|
|
4058
|
+
interface Suspension {
|
|
4059
|
+
status?: StatusWithLiterals;
|
|
4060
|
+
/** Beginning of the suspended period */
|
|
4061
|
+
startsAt?: Date | null;
|
|
4062
|
+
/** End of the suspended period */
|
|
4063
|
+
endsAt?: Date | null;
|
|
3859
4064
|
}
|
|
3860
|
-
|
|
3861
|
-
|
|
3862
|
-
|
|
3863
|
-
|
|
3864
|
-
* @format DECIMAL_VALUE
|
|
3865
|
-
*/
|
|
3866
|
-
creditAmount?: string;
|
|
3867
|
-
/**
|
|
3868
|
-
* Charge amount for the new plan's prorated price
|
|
3869
|
-
* @format DECIMAL_VALUE
|
|
3870
|
-
*/
|
|
3871
|
-
chargeAmount?: string;
|
|
3872
|
-
/**
|
|
3873
|
-
* Net amount (charge minus credit). Positive means customer pays, negative means refund.
|
|
3874
|
-
* @format DECIMAL_VALUE
|
|
3875
|
-
*/
|
|
3876
|
-
netAmount?: string;
|
|
3877
|
-
/** Date when the proration was calculated */
|
|
3878
|
-
prorationDate?: Date | null;
|
|
3879
|
-
/** Remaining seconds in the current billing period at time of change */
|
|
3880
|
-
remainingSeconds?: string;
|
|
3881
|
-
/** Total seconds in the current billing cycle */
|
|
3882
|
-
totalCycleSeconds?: string;
|
|
4065
|
+
declare enum Status {
|
|
4066
|
+
UNDEFINED = "UNDEFINED",
|
|
4067
|
+
ACTIVE = "ACTIVE",
|
|
4068
|
+
ENDED = "ENDED"
|
|
3883
4069
|
}
|
|
3884
|
-
|
|
4070
|
+
/** @enumType */
|
|
4071
|
+
type StatusWithLiterals = Status | 'UNDEFINED' | 'ACTIVE' | 'ENDED';
|
|
4072
|
+
/** A duration expressed in amount of time units. */
|
|
4073
|
+
interface V1Duration {
|
|
4074
|
+
/** Amount of the unit */
|
|
4075
|
+
amount?: number;
|
|
4076
|
+
/** Day, Week, Month, Year. */
|
|
4077
|
+
unit?: SubscriptionFrequencyWithLiterals;
|
|
4078
|
+
}
|
|
4079
|
+
interface V1SubscriptionActivated {
|
|
4080
|
+
subscription?: V1Subscription;
|
|
4081
|
+
}
|
|
4082
|
+
interface V1SubscriptionCanceled {
|
|
4083
|
+
subscription?: V1Subscription;
|
|
4084
|
+
}
|
|
4085
|
+
interface V1SubscriptionUpdated {
|
|
4086
|
+
subscription?: V1Subscription;
|
|
4087
|
+
}
|
|
4088
|
+
interface SubscriptionCycleTriggered {
|
|
4089
|
+
subscription?: V1Subscription;
|
|
4090
|
+
billingCycle?: number;
|
|
3885
4091
|
/**
|
|
3886
|
-
*
|
|
4092
|
+
* Wix Pay transaction id, optional. Exists if event was triggered by a payment.
|
|
3887
4093
|
* @format GUID
|
|
3888
4094
|
*/
|
|
3889
|
-
|
|
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;
|
|
4095
|
+
transactionId?: string | null;
|
|
3898
4096
|
}
|
|
3899
|
-
interface
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
|
|
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;
|
|
4097
|
+
interface SubscriptionMarkedAsPaid {
|
|
4098
|
+
subscription?: V1Subscription;
|
|
4099
|
+
/** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
|
|
4100
|
+
billingCycle?: number | null;
|
|
3908
4101
|
}
|
|
3909
|
-
|
|
3910
|
-
|
|
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;
|
|
4102
|
+
interface SubscriptionCancellationRequested {
|
|
4103
|
+
subscription?: V1Subscription;
|
|
3938
4104
|
}
|
|
3939
|
-
|
|
3940
|
-
|
|
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;
|
|
4105
|
+
interface SubscriptionSuspended {
|
|
4106
|
+
subscription?: V1Subscription;
|
|
3976
4107
|
}
|
|
3977
|
-
|
|
3978
|
-
|
|
3979
|
-
|
|
3980
|
-
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
|
|
4108
|
+
interface V1SubscriptionResumed {
|
|
4109
|
+
subscription?: V1Subscription;
|
|
4110
|
+
}
|
|
4111
|
+
interface SubscriptionExpired {
|
|
4112
|
+
subscription?: V1Subscription;
|
|
4113
|
+
}
|
|
4114
|
+
interface V1SubscriptionInitialPurchaseCompleted {
|
|
4115
|
+
subscription?: V1Subscription;
|
|
4116
|
+
}
|
|
4117
|
+
interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
|
|
4118
|
+
activeSubscription?: CreateSubscriptionRequest;
|
|
4119
|
+
}
|
|
4120
|
+
/** @oneof */
|
|
4121
|
+
interface CreateSubscriptionInStateRequestModeOneOf {
|
|
4122
|
+
activeSubscription?: CreateSubscriptionRequest;
|
|
4123
|
+
}
|
|
4124
|
+
interface CreateSubscriptionInStateResponse {
|
|
4125
|
+
/** @format GUID */
|
|
4126
|
+
subscriptionId?: string;
|
|
4127
|
+
}
|
|
4128
|
+
interface PayCycleRequest {
|
|
4129
|
+
/** @format GUID */
|
|
4130
|
+
subscriptionId?: string;
|
|
4131
|
+
paymentTestMode?: PaymentTestModeWithLiterals;
|
|
4132
|
+
/** @format GUID */
|
|
4133
|
+
tenantId?: string;
|
|
4134
|
+
}
|
|
4135
|
+
declare enum PaymentTestMode {
|
|
4136
|
+
REGULAR = "REGULAR",
|
|
4137
|
+
FAIL_TECHNICAL = "FAIL_TECHNICAL",
|
|
4138
|
+
FAIL_DECLINE = "FAIL_DECLINE",
|
|
4139
|
+
FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
|
|
3987
4140
|
}
|
|
3988
4141
|
/** @enumType */
|
|
3989
|
-
type
|
|
3990
|
-
|
|
3991
|
-
|
|
4142
|
+
type PaymentTestModeWithLiterals = PaymentTestMode | 'REGULAR' | 'FAIL_TECHNICAL' | 'FAIL_DECLINE' | 'FAIL_RETRYABLE_DECLINE';
|
|
4143
|
+
interface PayCycleResponse {
|
|
4144
|
+
/** @format GUID */
|
|
4145
|
+
invoiceId?: string;
|
|
4146
|
+
/** @format GUID */
|
|
4147
|
+
paymentOrderId?: string | null;
|
|
4148
|
+
subscription?: Subscription;
|
|
4149
|
+
}
|
|
4150
|
+
interface GetFullSubscriptionDataRequest {
|
|
4151
|
+
/** @format GUID */
|
|
4152
|
+
id?: string;
|
|
4153
|
+
}
|
|
4154
|
+
interface GetFullSubscriptionDataResponse {
|
|
4155
|
+
subscription?: Subscription;
|
|
4156
|
+
internalSubscriptionData?: InternalSubscriptionData;
|
|
4157
|
+
}
|
|
4158
|
+
interface InternalSubscriptionData {
|
|
4159
|
+
/** @format GUID */
|
|
4160
|
+
originInstanceId?: string;
|
|
4161
|
+
source?: string | null;
|
|
4162
|
+
billingType?: string;
|
|
4163
|
+
isOneTime?: boolean;
|
|
4164
|
+
migrationDetails?: MigrationDetails;
|
|
4165
|
+
pausePaidDuration?: string | null;
|
|
4166
|
+
authorizationPaymentData?: PaymentData;
|
|
4167
|
+
currentCyclePausePeriods?: PausePeriod[];
|
|
4168
|
+
}
|
|
4169
|
+
interface MigrationDetails {
|
|
4170
|
+
/** system (application) where the Subscription has been created */
|
|
4171
|
+
originSystem?: string;
|
|
4172
|
+
/** date when the Subscription started to be managed in BASS */
|
|
4173
|
+
shiftManagementDate?: Date | null;
|
|
4174
|
+
}
|
|
4175
|
+
interface PausePeriod {
|
|
4176
|
+
startDate?: Date | null;
|
|
4177
|
+
endDate?: Date | null;
|
|
4178
|
+
}
|
|
4179
|
+
interface GetSubscriptionAndInternalDataRequest {
|
|
4180
|
+
/** @format GUID */
|
|
4181
|
+
subscriptionId?: string;
|
|
4182
|
+
/** @format GUID */
|
|
4183
|
+
tenantId?: string;
|
|
4184
|
+
}
|
|
4185
|
+
interface GetSubscriptionAndInternalDataResponse {
|
|
4186
|
+
subscription?: Subscription;
|
|
4187
|
+
internalSubscriptionData?: InternalSubscriptionData;
|
|
4188
|
+
}
|
|
4189
|
+
interface SearchSubscriptionRequest {
|
|
4190
|
+
/** @format GUID */
|
|
4191
|
+
id?: string;
|
|
4192
|
+
/** @format GUID */
|
|
4193
|
+
tenantId?: string;
|
|
4194
|
+
}
|
|
4195
|
+
interface SearchSubscriptionResponse {
|
|
4196
|
+
subscription?: Subscription;
|
|
4197
|
+
}
|
|
4198
|
+
interface UpdatePausePaidDurationRequest {
|
|
4199
|
+
/** @format GUID */
|
|
4200
|
+
subscriptionId?: string;
|
|
3992
4201
|
/**
|
|
3993
|
-
*
|
|
3994
|
-
* @
|
|
4202
|
+
* @min 1
|
|
4203
|
+
* @max 10000000
|
|
3995
4204
|
*/
|
|
3996
|
-
|
|
4205
|
+
pausePaidDurationSeconds?: string;
|
|
4206
|
+
/** @format GUID */
|
|
4207
|
+
tenantId?: string;
|
|
4208
|
+
}
|
|
4209
|
+
interface UpdatePausePaidDurationResponse {
|
|
4210
|
+
}
|
|
4211
|
+
interface UpdateStatusRequest {
|
|
4212
|
+
/** @format GUID */
|
|
4213
|
+
subscriptionId?: string;
|
|
4214
|
+
/** @format GUID */
|
|
4215
|
+
tenantId?: string;
|
|
4216
|
+
status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
|
|
4217
|
+
}
|
|
4218
|
+
interface UpdateStatusResponse {
|
|
4219
|
+
subscription?: Subscription;
|
|
4220
|
+
}
|
|
4221
|
+
interface UpdatePaymentStatusRequest {
|
|
4222
|
+
/** @format GUID */
|
|
4223
|
+
subscriptionId?: string;
|
|
4224
|
+
/** @format GUID */
|
|
4225
|
+
tenantId?: string;
|
|
4226
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
4227
|
+
}
|
|
4228
|
+
interface UpdatePaymentStatusResponse {
|
|
4229
|
+
subscription?: Subscription;
|
|
4230
|
+
}
|
|
4231
|
+
interface RemoveCancellationInfoRequest {
|
|
4232
|
+
/** @format GUID */
|
|
4233
|
+
subscriptionId?: string;
|
|
4234
|
+
/** @format GUID */
|
|
4235
|
+
tenantId?: string;
|
|
4236
|
+
}
|
|
4237
|
+
interface RemoveCancellationInfoResponse {
|
|
4238
|
+
subscription?: Subscription;
|
|
4239
|
+
}
|
|
4240
|
+
interface RemovePauseInfoRequest {
|
|
4241
|
+
/** @format GUID */
|
|
4242
|
+
subscriptionId?: string;
|
|
4243
|
+
/** @format GUID */
|
|
4244
|
+
tenantId?: string;
|
|
4245
|
+
}
|
|
4246
|
+
interface RemovePauseInfoResponse {
|
|
4247
|
+
subscription?: Subscription;
|
|
4248
|
+
}
|
|
4249
|
+
interface ReviveSubscriptionRequest {
|
|
4250
|
+
/** @format GUID */
|
|
4251
|
+
tenantId?: string;
|
|
4252
|
+
/** @format GUID */
|
|
4253
|
+
subscriptionId?: string;
|
|
4254
|
+
revivePolicy?: RevivePolicyWithLiterals;
|
|
4255
|
+
isTestRun?: boolean;
|
|
4256
|
+
}
|
|
4257
|
+
declare enum RevivePolicy {
|
|
4258
|
+
SIMPLE = "SIMPLE",
|
|
4259
|
+
RESUME = "RESUME"
|
|
4260
|
+
}
|
|
4261
|
+
/** @enumType */
|
|
4262
|
+
type RevivePolicyWithLiterals = RevivePolicy | 'SIMPLE' | 'RESUME';
|
|
4263
|
+
interface ReviveSubscriptionResponse {
|
|
4264
|
+
subscription?: Subscription;
|
|
4265
|
+
}
|
|
4266
|
+
interface ConvertSapiRequest {
|
|
4267
|
+
/** @format GUID */
|
|
4268
|
+
subscriptionId?: string;
|
|
4269
|
+
}
|
|
4270
|
+
interface ConvertSapiResponse {
|
|
4271
|
+
subscription?: Subscription;
|
|
4272
|
+
}
|
|
4273
|
+
interface GetSubscriptionInvoicesRequest {
|
|
4274
|
+
/** @format GUID */
|
|
4275
|
+
id?: string;
|
|
4276
|
+
}
|
|
4277
|
+
interface GetSubscriptionInvoicesResponse {
|
|
4278
|
+
invoices?: SubscriptionInvoice[];
|
|
4279
|
+
}
|
|
4280
|
+
interface SubscriptionInvoice {
|
|
4281
|
+
/** @format GUID */
|
|
4282
|
+
id?: string;
|
|
4283
|
+
subscriptionCycle?: number;
|
|
4284
|
+
createdDate?: Date | null;
|
|
4285
|
+
}
|
|
4286
|
+
interface FinishFreeTrialNowRequest {
|
|
4287
|
+
/** @format GUID */
|
|
4288
|
+
subscriptionId?: string;
|
|
4289
|
+
/** @format GUID */
|
|
4290
|
+
tenantId?: string;
|
|
4291
|
+
}
|
|
4292
|
+
interface FinishFreeTrialNowResponse {
|
|
4293
|
+
subscription?: Subscription;
|
|
4294
|
+
}
|
|
4295
|
+
interface FixSubscriptionTimeCapsuleTasksRequest {
|
|
4296
|
+
/** @format GUID */
|
|
4297
|
+
subscriptionId?: string;
|
|
4298
|
+
/** @format GUID */
|
|
4299
|
+
tenantId?: string;
|
|
4300
|
+
}
|
|
4301
|
+
interface FixSubscriptionTimeCapsuleTasksResponse {
|
|
4302
|
+
}
|
|
4303
|
+
interface SendTimeCapsuleTaskCanceledBIRequest {
|
|
4304
|
+
/** @format GUID */
|
|
4305
|
+
tenantId?: string;
|
|
4306
|
+
/** @format GUID */
|
|
4307
|
+
subscriptionId?: string;
|
|
4308
|
+
/** @minLength 1 */
|
|
4309
|
+
taskType?: string;
|
|
4310
|
+
}
|
|
4311
|
+
interface ScheduleTimeCapsuleTaskRequest {
|
|
4312
|
+
/** @format GUID */
|
|
4313
|
+
subscriptionId?: string;
|
|
4314
|
+
/** @minLength 1 */
|
|
4315
|
+
taskType?: string;
|
|
4316
|
+
executionTime?: Date | null;
|
|
4317
|
+
/** @format GUID */
|
|
4318
|
+
tenantId?: string;
|
|
4319
|
+
}
|
|
4320
|
+
interface CancelTimeCapsuleTaskRequest {
|
|
4321
|
+
/** @format GUID */
|
|
4322
|
+
tenantId?: string;
|
|
4323
|
+
/** @format GUID */
|
|
4324
|
+
subscriptionId?: string;
|
|
4325
|
+
/** @minLength 1 */
|
|
4326
|
+
taskType?: string;
|
|
4327
|
+
}
|
|
4328
|
+
interface UpdateFullSubscriptionRequest {
|
|
4329
|
+
/** @format GUID */
|
|
4330
|
+
tenantId?: string;
|
|
4331
|
+
subscription?: Subscription;
|
|
4332
|
+
}
|
|
4333
|
+
interface UpdateFullSubscriptionResponse {
|
|
4334
|
+
subscription?: Subscription;
|
|
4335
|
+
}
|
|
4336
|
+
interface PatchSubscriptionRequest {
|
|
3997
4337
|
/**
|
|
3998
|
-
*
|
|
3999
|
-
* @format
|
|
4338
|
+
* Tenant ID (instance ID) of the subscription
|
|
4339
|
+
* @format GUID
|
|
4000
4340
|
*/
|
|
4001
|
-
|
|
4002
|
-
/**
|
|
4003
|
-
|
|
4341
|
+
tenantId?: string;
|
|
4342
|
+
/**
|
|
4343
|
+
* Subscription ID to patch
|
|
4344
|
+
* @format GUID
|
|
4345
|
+
*/
|
|
4346
|
+
subscriptionId?: string;
|
|
4347
|
+
/** Partial subscription with updated values */
|
|
4348
|
+
subscription?: Subscription;
|
|
4349
|
+
/** Fields to update (e.g., "name", "billing_settings.collection_method") */
|
|
4350
|
+
fieldMask?: string[];
|
|
4351
|
+
}
|
|
4352
|
+
interface PatchSubscriptionResponse {
|
|
4353
|
+
/** The updated subscription */
|
|
4354
|
+
subscription?: Subscription;
|
|
4355
|
+
}
|
|
4356
|
+
interface UpdateSubscriptionInvoiceCycleRequest {
|
|
4357
|
+
/** @format GUID */
|
|
4358
|
+
subscriptionId?: string;
|
|
4359
|
+
/** @format GUID */
|
|
4360
|
+
tenantId?: string;
|
|
4361
|
+
/** @format GUID */
|
|
4362
|
+
invoiceId?: string;
|
|
4363
|
+
subscriptionCycle?: number;
|
|
4364
|
+
}
|
|
4365
|
+
interface UpdateSubscriptionInvoiceCycleResponse {
|
|
4366
|
+
subscriptionInvoice?: SubscriptionInvoice;
|
|
4367
|
+
}
|
|
4368
|
+
interface AddPausePeriodRequest {
|
|
4369
|
+
/** @format GUID */
|
|
4370
|
+
tenantId?: string;
|
|
4371
|
+
/** @format GUID */
|
|
4372
|
+
subscriptionId?: string;
|
|
4373
|
+
pauseStartDate?: Date | null;
|
|
4374
|
+
pauseEndDate?: Date | null;
|
|
4375
|
+
}
|
|
4376
|
+
interface AddPausePeriodResponse {
|
|
4377
|
+
subscription?: Subscription;
|
|
4378
|
+
}
|
|
4379
|
+
interface RunTimeCapsuleTaskNowRequest {
|
|
4380
|
+
/** @format GUID */
|
|
4381
|
+
tenantId?: string;
|
|
4382
|
+
/** @format GUID */
|
|
4383
|
+
subscriptionId?: string;
|
|
4384
|
+
/** @minLength 1 */
|
|
4385
|
+
taskType?: string;
|
|
4004
4386
|
}
|
|
4005
|
-
interface
|
|
4006
|
-
/**
|
|
4007
|
-
* ID of the subscription to cancel the pending change for
|
|
4008
|
-
* @format GUID
|
|
4009
|
-
*/
|
|
4387
|
+
interface CreateRecurringInvoiceBORequest {
|
|
4388
|
+
/** @format GUID */
|
|
4010
4389
|
subscriptionId?: string;
|
|
4390
|
+
/** @format GUID */
|
|
4391
|
+
tenantId?: string;
|
|
4392
|
+
/** @min 2 */
|
|
4393
|
+
cycleNumber?: number;
|
|
4011
4394
|
}
|
|
4012
|
-
interface
|
|
4013
|
-
|
|
4014
|
-
subscription?: Subscription;
|
|
4395
|
+
interface CreateRecurringInvoiceBOResponse {
|
|
4396
|
+
invoiceId?: string;
|
|
4015
4397
|
}
|
|
4016
|
-
interface
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
|
|
4398
|
+
interface SetShiftingDataRequest {
|
|
4399
|
+
/** @format GUID */
|
|
4400
|
+
subscriptionId?: string;
|
|
4401
|
+
/** @format GUID */
|
|
4402
|
+
tenantId?: string;
|
|
4403
|
+
isBassManaged?: boolean;
|
|
4404
|
+
shiftManagementDate?: Date | null;
|
|
4020
4405
|
}
|
|
4021
|
-
interface
|
|
4022
|
-
|
|
4023
|
-
instanceId?: string;
|
|
4024
|
-
subjectId?: string | null;
|
|
4406
|
+
interface SetShiftingDataResponse {
|
|
4407
|
+
subscription?: Subscription;
|
|
4025
4408
|
}
|
|
4026
|
-
interface
|
|
4027
|
-
|
|
4028
|
-
|
|
4029
|
-
|
|
4409
|
+
interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
|
|
4410
|
+
attachInvoice?: AttachInvoice;
|
|
4411
|
+
detachInvoice?: DetachInvoice;
|
|
4412
|
+
/** @format GUID */
|
|
4413
|
+
tenantId?: string;
|
|
4414
|
+
/** @format GUID */
|
|
4415
|
+
subscriptionId?: string;
|
|
4030
4416
|
}
|
|
4031
4417
|
/** @oneof */
|
|
4032
|
-
interface
|
|
4033
|
-
|
|
4034
|
-
|
|
4035
|
-
reschedule?: Reschedule;
|
|
4036
|
-
}
|
|
4037
|
-
interface Complete {
|
|
4418
|
+
interface FixSubscriptionInvoicesRequestModeOneOf {
|
|
4419
|
+
attachInvoice?: AttachInvoice;
|
|
4420
|
+
detachInvoice?: DetachInvoice;
|
|
4038
4421
|
}
|
|
4039
|
-
interface
|
|
4422
|
+
interface AttachInvoice {
|
|
4423
|
+
/** @format GUID */
|
|
4424
|
+
invoiceId?: string;
|
|
4040
4425
|
}
|
|
4041
|
-
interface
|
|
4042
|
-
|
|
4043
|
-
|
|
4426
|
+
interface DetachInvoice {
|
|
4427
|
+
/** @format GUID */
|
|
4428
|
+
invoiceId?: string;
|
|
4044
4429
|
}
|
|
4045
|
-
interface
|
|
4046
|
-
|
|
4047
|
-
created?: V1SubscriptionCreated;
|
|
4048
|
-
/** Subscription is considered active and will be visible to site owners and members */
|
|
4049
|
-
activated?: V1SubscriptionActivated;
|
|
4050
|
-
/**
|
|
4051
|
-
* Subscription was canceled either by cancellation request with requested expiration date NOW or by payment provider.
|
|
4052
|
-
* If cancelled by payment provider subscription will be valid until the date calculated depending on how many cycles it was already paid for.
|
|
4053
|
-
*/
|
|
4054
|
-
canceled?: V1SubscriptionCanceled;
|
|
4055
|
-
/** Subscription was updated. Currently the only possible change is valid_until date */
|
|
4056
|
-
updated?: V1SubscriptionUpdated;
|
|
4057
|
-
/** Subscription cycle has started. Currently the cycle starts when a payment is received. */
|
|
4058
|
-
cycleTriggered?: SubscriptionCycleTriggered;
|
|
4059
|
-
/** Offline subscription was marked as paid */
|
|
4060
|
-
markedAsPaid?: SubscriptionMarkedAsPaid;
|
|
4061
|
-
/**
|
|
4062
|
-
* Subscription cancellation for the future date was requested.
|
|
4063
|
-
* Subscription will stay in pending cancellation status until the date calculated depending on free trial and the next payment date.
|
|
4064
|
-
*/
|
|
4065
|
-
cancellationRequested?: SubscriptionCancellationRequested;
|
|
4066
|
-
/** Subscription and it's payment schedule (for recurring) was suspended */
|
|
4067
|
-
suspended?: SubscriptionSuspended;
|
|
4068
|
-
/** Previously suspended subscription and it's payment schedule (for recurring) was resumed */
|
|
4069
|
-
resumed?: V1SubscriptionResumed;
|
|
4070
|
-
/** Subscription expired according to valid_until expiration date. */
|
|
4071
|
-
expired?: SubscriptionExpired;
|
|
4072
|
-
/** Subscription initial purchase completed */
|
|
4073
|
-
initialPurchaseCompleted?: V1SubscriptionInitialPurchaseCompleted;
|
|
4430
|
+
interface FixSubscriptionInvoicesResponse {
|
|
4431
|
+
invoices?: SubscriptionInvoice[];
|
|
4074
4432
|
}
|
|
4075
|
-
|
|
4076
|
-
|
|
4077
|
-
|
|
4078
|
-
|
|
4079
|
-
|
|
4080
|
-
activated?: V1SubscriptionActivated;
|
|
4081
|
-
/**
|
|
4082
|
-
* Subscription was canceled either by cancellation request with requested expiration date NOW or by payment provider.
|
|
4083
|
-
* If cancelled by payment provider subscription will be valid until the date calculated depending on how many cycles it was already paid for.
|
|
4084
|
-
*/
|
|
4085
|
-
canceled?: V1SubscriptionCanceled;
|
|
4086
|
-
/** Subscription was updated. Currently the only possible change is valid_until date */
|
|
4087
|
-
updated?: V1SubscriptionUpdated;
|
|
4088
|
-
/** Subscription cycle has started. Currently the cycle starts when a payment is received. */
|
|
4089
|
-
cycleTriggered?: SubscriptionCycleTriggered;
|
|
4090
|
-
/** Offline subscription was marked as paid */
|
|
4091
|
-
markedAsPaid?: SubscriptionMarkedAsPaid;
|
|
4092
|
-
/**
|
|
4093
|
-
* Subscription cancellation for the future date was requested.
|
|
4094
|
-
* Subscription will stay in pending cancellation status until the date calculated depending on free trial and the next payment date.
|
|
4095
|
-
*/
|
|
4096
|
-
cancellationRequested?: SubscriptionCancellationRequested;
|
|
4097
|
-
/** Subscription and it's payment schedule (for recurring) was suspended */
|
|
4098
|
-
suspended?: SubscriptionSuspended;
|
|
4099
|
-
/** Previously suspended subscription and it's payment schedule (for recurring) was resumed */
|
|
4100
|
-
resumed?: V1SubscriptionResumed;
|
|
4101
|
-
/** Subscription expired according to valid_until expiration date. */
|
|
4102
|
-
expired?: SubscriptionExpired;
|
|
4103
|
-
/** Subscription initial purchase completed */
|
|
4104
|
-
initialPurchaseCompleted?: V1SubscriptionInitialPurchaseCompleted;
|
|
4433
|
+
interface RestoreDraftSubscriptionRequest {
|
|
4434
|
+
/** @format GUID */
|
|
4435
|
+
tenantId?: string;
|
|
4436
|
+
/** @format GUID */
|
|
4437
|
+
subscriptionId?: string;
|
|
4105
4438
|
}
|
|
4106
|
-
interface
|
|
4107
|
-
subscription?:
|
|
4439
|
+
interface RestoreDraftSubscriptionResponse {
|
|
4440
|
+
subscription?: Subscription;
|
|
4108
4441
|
}
|
|
4109
|
-
interface
|
|
4110
|
-
/**
|
|
4111
|
-
* ID of the subscription
|
|
4112
|
-
* @format GUID
|
|
4113
|
-
* @readonly
|
|
4114
|
-
*/
|
|
4115
|
-
id?: string;
|
|
4116
|
-
/**
|
|
4117
|
-
* ID of the app which created the subscription
|
|
4118
|
-
* @format GUID
|
|
4119
|
-
*/
|
|
4120
|
-
wixAppId?: string;
|
|
4121
|
-
/**
|
|
4122
|
-
* Instance ID of the Subscriptions app
|
|
4123
|
-
* @format GUID
|
|
4124
|
-
*/
|
|
4442
|
+
interface DeleteDraftSubscriptionRequest {
|
|
4443
|
+
/** @format GUID */
|
|
4125
4444
|
tenantId?: string;
|
|
4126
|
-
/**
|
|
4127
|
-
* ID of entity in app (e.g. a cart in stores/order in paid plans)
|
|
4128
|
-
* @format GUID
|
|
4129
|
-
*/
|
|
4130
|
-
originEntityId?: string;
|
|
4131
|
-
/** Site member or a contact who bought the subscription */
|
|
4132
|
-
subscriber?: Subscriber;
|
|
4133
|
-
/**
|
|
4134
|
-
* Wix Pay order ID, is empty for free subscriptions
|
|
4135
|
-
* @format GUID
|
|
4136
|
-
*/
|
|
4137
|
-
wixPayOrderId?: string | null;
|
|
4138
|
-
/**
|
|
4139
|
-
* Subscription name (e.g. a product or subscription package name)
|
|
4140
|
-
* @maxLength 150
|
|
4141
|
-
*/
|
|
4142
|
-
name?: string;
|
|
4143
|
-
/**
|
|
4144
|
-
* Optional additional subscription description
|
|
4145
|
-
* @maxLength 500
|
|
4146
|
-
*/
|
|
4147
|
-
description?: string;
|
|
4148
|
-
/** Amount to be paid for a single scheduled payment */
|
|
4149
|
-
price?: Money;
|
|
4150
|
-
/** True if the subscription is recurring, false for a single payment subscription */
|
|
4151
|
-
recurring?: boolean;
|
|
4152
|
-
/** Online (paid by subscriber using wix pay) or offline (need to manually mark as paid) */
|
|
4153
|
-
subscriptionType?: SubscriptionTypeWithLiterals;
|
|
4154
|
-
/** Active, expired, canceled, etc. */
|
|
4155
|
-
subscriptionStatus?: V1SubscriptionStatusEnumSubscriptionStatusWithLiterals;
|
|
4156
|
-
/** Subscription start date (may differ from creation date) */
|
|
4157
|
-
validFrom?: Date | null;
|
|
4158
|
-
/** Subscription expiration date */
|
|
4159
|
-
validUntil?: Date | null;
|
|
4160
|
-
/** Status of last payment associated with this subscription */
|
|
4161
|
-
lastPaymentStatus?: PaymentStatusEnumPaymentStatusWithLiterals;
|
|
4162
|
-
/** Payment schedule in the wix pay format. Exists for recurring subscriptions only. */
|
|
4163
|
-
billingProfile?: V2Subscription;
|
|
4164
|
-
/** Owner, member, etc. - present if subscription is canceled */
|
|
4165
|
-
cancellationInitiator?: CancellationInitiatorWithLiterals;
|
|
4166
|
-
/** Optional, present if subscription is canceled */
|
|
4167
|
-
cancellationReason?: string | null;
|
|
4168
|
-
/** Can be used for arbitrary app-specific map<string, string> data */
|
|
4169
|
-
externalData?: Record<string, string>;
|
|
4170
|
-
/** Date when subscription was created (not related to payment dates) */
|
|
4171
|
-
dateCreated?: Date | null;
|
|
4172
|
-
/** Restrictions on possible subscription actions. Default policy has all restrictions enabled. */
|
|
4173
|
-
policy?: SubscriptionPolicy;
|
|
4174
|
-
/** List of subscription suspension periods */
|
|
4175
|
-
suspensions?: Suspension[];
|
|
4176
|
-
/** Initial subscription expiration date that was calculated on the subscription purchase plus duration of suspensions */
|
|
4177
|
-
validUntilDateWithSuspensions?: Date | null;
|
|
4178
|
-
/** Duration of single payment subscription (instead of billing_profile) */
|
|
4179
|
-
singlePaymentDuration?: V1Duration;
|
|
4180
4445
|
/** @format GUID */
|
|
4181
|
-
|
|
4446
|
+
subscriptionId?: string;
|
|
4182
4447
|
}
|
|
4183
|
-
interface
|
|
4184
|
-
|
|
4185
|
-
* Member or contact ID
|
|
4186
|
-
* @format GUID
|
|
4187
|
-
*/
|
|
4188
|
-
id?: string;
|
|
4189
|
-
/** Member or contact */
|
|
4190
|
-
identityType?: IdentityTypeWithLiterals;
|
|
4448
|
+
interface DeleteDraftSubscriptionResponse {
|
|
4449
|
+
subscription?: Subscription;
|
|
4191
4450
|
}
|
|
4192
|
-
|
|
4193
|
-
/**
|
|
4194
|
-
|
|
4195
|
-
/**
|
|
4196
|
-
|
|
4197
|
-
/** Subscriptions is associated with a contact ID */
|
|
4198
|
-
CONTACT = "CONTACT"
|
|
4451
|
+
interface DeleteSubscriptionBORequest {
|
|
4452
|
+
/** @format GUID */
|
|
4453
|
+
tenantId?: string;
|
|
4454
|
+
/** @format GUID */
|
|
4455
|
+
subscriptionId?: string;
|
|
4199
4456
|
}
|
|
4200
|
-
|
|
4201
|
-
|
|
4202
|
-
/** Price of a payment. Includes amount and currency. */
|
|
4203
|
-
interface Money {
|
|
4204
|
-
/**
|
|
4205
|
-
* Monetary amount i.e. 3.99.
|
|
4206
|
-
* @format DECIMAL_VALUE
|
|
4207
|
-
*/
|
|
4208
|
-
amount?: string;
|
|
4209
|
-
/**
|
|
4210
|
-
* Currency in ISO 4217 format i.e. USD.
|
|
4211
|
-
* @minLength 3
|
|
4212
|
-
* @maxLength 3
|
|
4213
|
-
*/
|
|
4214
|
-
currency?: string;
|
|
4457
|
+
interface DeleteSubscriptionBOResponse {
|
|
4458
|
+
subscription?: Subscription;
|
|
4215
4459
|
}
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
|
|
4221
|
-
|
|
4460
|
+
interface CancelSubscriptionBORequest {
|
|
4461
|
+
/** @format GUID */
|
|
4462
|
+
tenantId?: string;
|
|
4463
|
+
/** @format GUID */
|
|
4464
|
+
subscriptionId?: string;
|
|
4465
|
+
initiator?: ActionInitiatorWithLiterals;
|
|
4466
|
+
reason?: string | null;
|
|
4222
4467
|
}
|
|
4223
|
-
|
|
4224
|
-
|
|
4225
|
-
declare enum V1SubscriptionStatusEnumSubscriptionStatus {
|
|
4226
|
-
/** Subscription status undefined */
|
|
4227
|
-
UNDEFINED = "UNDEFINED",
|
|
4228
|
-
/** Subscription created, but hasn't been paid for yet. This status if filtered out in ListSubscriptions response by default. */
|
|
4229
|
-
DRAFT = "DRAFT",
|
|
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"
|
|
4468
|
+
interface CancelSubscriptionBOResponse {
|
|
4469
|
+
subscription?: Subscription;
|
|
4242
4470
|
}
|
|
4243
|
-
|
|
4244
|
-
|
|
4245
|
-
|
|
4246
|
-
/**
|
|
4247
|
-
|
|
4248
|
-
/**
|
|
4249
|
-
|
|
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"
|
|
4471
|
+
interface UpdatePaymentMethodBORequest {
|
|
4472
|
+
/** @format GUID */
|
|
4473
|
+
tenantId?: string;
|
|
4474
|
+
/** @format GUID */
|
|
4475
|
+
subscriptionId?: string;
|
|
4476
|
+
/** @format GUID */
|
|
4477
|
+
paymentMethodId?: string;
|
|
4258
4478
|
}
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
/**
|
|
4262
|
-
* Recurring payment is described by `frequency` (day, week, month) and `interval`.
|
|
4263
|
-
*
|
|
4264
|
-
* For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.
|
|
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;
|
|
4479
|
+
interface UpdatePaymentMethodBOResponse {
|
|
4480
|
+
subscription?: Subscription;
|
|
4288
4481
|
}
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
|
|
4294
|
-
|
|
4295
|
-
YEAR = "YEAR"
|
|
4482
|
+
interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
|
|
4483
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
4484
|
+
/** @format GUID */
|
|
4485
|
+
tenantId?: string;
|
|
4486
|
+
/** @format GUID */
|
|
4487
|
+
subscriptionId?: string;
|
|
4296
4488
|
}
|
|
4297
|
-
/** @
|
|
4298
|
-
|
|
4299
|
-
|
|
4300
|
-
interface SubscriptionTrialPeriod {
|
|
4301
|
-
/** trial period in units (required) */
|
|
4302
|
-
period?: number;
|
|
4303
|
-
/** units in which trial period is described (optional, default DAY) */
|
|
4304
|
-
unit?: SubscriptionFrequencyWithLiterals;
|
|
4489
|
+
/** @oneof */
|
|
4490
|
+
interface SendSubscriptionActionEventBORequestEventOneOf {
|
|
4491
|
+
billingCycleStarted?: SubscriptionBillingCycleStarted;
|
|
4305
4492
|
}
|
|
4306
|
-
|
|
4307
|
-
/** Cancellation initiator undefined */
|
|
4308
|
-
UNDEFINED = "UNDEFINED",
|
|
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"
|
|
4493
|
+
interface SendSubscriptionActionEventResponse {
|
|
4317
4494
|
}
|
|
4318
|
-
|
|
4319
|
-
|
|
4320
|
-
|
|
4321
|
-
/**
|
|
4322
|
-
|
|
4323
|
-
|
|
4324
|
-
cancellableByMember?: boolean;
|
|
4325
|
-
/** Subscription expiration date on cancellation can be set to next payment date */
|
|
4326
|
-
cancellableAtNextPaymentCycle?: boolean;
|
|
4495
|
+
interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
|
|
4496
|
+
/** @format GUID */
|
|
4497
|
+
tenantId?: string;
|
|
4498
|
+
/** @format GUID */
|
|
4499
|
+
subscriptionId?: string;
|
|
4500
|
+
transactionId?: string;
|
|
4327
4501
|
}
|
|
4328
|
-
interface
|
|
4329
|
-
|
|
4330
|
-
|
|
4331
|
-
|
|
4332
|
-
|
|
4333
|
-
|
|
4502
|
+
interface PauseSubscriptionBORequest {
|
|
4503
|
+
/** @format GUID */
|
|
4504
|
+
tenantId?: string;
|
|
4505
|
+
/** @format GUID */
|
|
4506
|
+
subscriptionId?: string;
|
|
4507
|
+
pausePolicy?: PausePolicyWithLiterals;
|
|
4508
|
+
pauseAt?: PauseAtWithLiterals;
|
|
4509
|
+
initiator?: ActionInitiatorWithLiterals;
|
|
4510
|
+
/** @maxLength 500 */
|
|
4511
|
+
reason?: string | null;
|
|
4334
4512
|
}
|
|
4335
|
-
|
|
4336
|
-
|
|
4337
|
-
ACTIVE = "ACTIVE",
|
|
4338
|
-
ENDED = "ENDED"
|
|
4513
|
+
interface PauseSubscriptionBOResponse {
|
|
4514
|
+
subscription?: Subscription;
|
|
4339
4515
|
}
|
|
4340
|
-
|
|
4341
|
-
|
|
4342
|
-
|
|
4343
|
-
|
|
4344
|
-
|
|
4345
|
-
amount?: number;
|
|
4346
|
-
/** Day, Week, Month, Year. */
|
|
4347
|
-
unit?: SubscriptionFrequencyWithLiterals;
|
|
4516
|
+
interface FixSubscriptionInvoicesConsistencyRequest {
|
|
4517
|
+
/** @format GUID */
|
|
4518
|
+
tenantId?: string;
|
|
4519
|
+
/** @format GUID */
|
|
4520
|
+
subscriptionId?: string;
|
|
4348
4521
|
}
|
|
4349
|
-
interface
|
|
4350
|
-
subscription?: V1Subscription;
|
|
4522
|
+
interface FixSubscriptionInvoicesConsistencyResponse {
|
|
4351
4523
|
}
|
|
4352
|
-
interface
|
|
4353
|
-
|
|
4524
|
+
interface FixSubscriptionPaymentStatusRequest {
|
|
4525
|
+
/** @format GUID */
|
|
4526
|
+
tenantId?: string;
|
|
4527
|
+
/** @format GUID */
|
|
4528
|
+
subscriptionId?: string;
|
|
4529
|
+
/** When true, verify and report the would-be fix without mutating anything. */
|
|
4530
|
+
dryRun?: boolean;
|
|
4354
4531
|
}
|
|
4355
|
-
interface
|
|
4356
|
-
subscription
|
|
4532
|
+
interface FixSubscriptionPaymentStatusResponse {
|
|
4533
|
+
/** The invoice is PAID but the (DRAFT) subscription never processed the paid event. */
|
|
4534
|
+
mismatchDetected?: boolean;
|
|
4535
|
+
/** A real mismatch was found and the invoice-paid activation was re-driven (always false in dry-run). */
|
|
4536
|
+
fixed?: boolean;
|
|
4537
|
+
/**
|
|
4538
|
+
* Subscription status after the re-drive (ACTIVE / PENDING); in dry-run, the predicted status; "" when no fix ran.
|
|
4539
|
+
* @maxLength 50
|
|
4540
|
+
*/
|
|
4541
|
+
resultingStatus?: string;
|
|
4542
|
+
/**
|
|
4543
|
+
* Human-readable summary of the decision and action.
|
|
4544
|
+
* @maxLength 500
|
|
4545
|
+
*/
|
|
4546
|
+
detail?: string;
|
|
4357
4547
|
}
|
|
4358
|
-
interface
|
|
4359
|
-
subscription?: V1Subscription;
|
|
4360
|
-
billingCycle?: number;
|
|
4548
|
+
interface UpdateSubscriptionCurrencyRequest {
|
|
4361
4549
|
/**
|
|
4362
|
-
*
|
|
4550
|
+
* Tenant ID (instance ID) of the subscription
|
|
4363
4551
|
* @format GUID
|
|
4364
4552
|
*/
|
|
4365
|
-
|
|
4366
|
-
|
|
4367
|
-
|
|
4368
|
-
|
|
4369
|
-
|
|
4370
|
-
|
|
4371
|
-
|
|
4372
|
-
|
|
4373
|
-
|
|
4374
|
-
|
|
4375
|
-
|
|
4376
|
-
|
|
4553
|
+
tenantId?: string;
|
|
4554
|
+
/**
|
|
4555
|
+
* Subscription ID to update currency for
|
|
4556
|
+
* @format GUID
|
|
4557
|
+
*/
|
|
4558
|
+
subscriptionId?: string;
|
|
4559
|
+
/**
|
|
4560
|
+
* New currency code (e.g., "USD", "EUR") - ISO 4217 format
|
|
4561
|
+
* @format CURRENCY
|
|
4562
|
+
*/
|
|
4563
|
+
newCurrency?: string;
|
|
4564
|
+
/**
|
|
4565
|
+
* Exchange rate from current currency to new currency (newAmount = oldAmount * exchangeRate)
|
|
4566
|
+
* @decimalValue options { gt:0.00, maxScale:6 }
|
|
4567
|
+
*/
|
|
4568
|
+
exchangeRate?: string;
|
|
4377
4569
|
}
|
|
4378
|
-
interface
|
|
4379
|
-
subscription
|
|
4570
|
+
interface UpdateSubscriptionCurrencyResponse {
|
|
4571
|
+
/** The updated subscription with new currency and converted amounts */
|
|
4572
|
+
subscription?: Subscription;
|
|
4380
4573
|
}
|
|
4381
|
-
interface
|
|
4382
|
-
|
|
4574
|
+
interface UpdateSubscriptionPlatformOriginRequest {
|
|
4575
|
+
/**
|
|
4576
|
+
* Subscription ID to update platform origin for
|
|
4577
|
+
* @format GUID
|
|
4578
|
+
*/
|
|
4579
|
+
subscriptionId?: string;
|
|
4580
|
+
/**
|
|
4581
|
+
* Tenant ID (instance ID) of the subscription
|
|
4582
|
+
* @format GUID
|
|
4583
|
+
*/
|
|
4584
|
+
tenantId?: string;
|
|
4585
|
+
/** New platform origin (appId and entityId) */
|
|
4586
|
+
platformOrigin?: PlatformOrigin;
|
|
4383
4587
|
}
|
|
4384
|
-
interface
|
|
4385
|
-
subscription
|
|
4588
|
+
interface UpdateSubscriptionPlatformOriginResponse {
|
|
4589
|
+
/** The updated subscription with new platform origin */
|
|
4590
|
+
subscription?: Subscription;
|
|
4386
4591
|
}
|
|
4387
4592
|
interface ListSubscriptionHistoryRequest {
|
|
4388
4593
|
/** @format GUID */
|
|
@@ -4449,6 +4654,8 @@ interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
|
|
|
4449
4654
|
billingCyclePaid?: SubscriptionBillingCyclePaid;
|
|
4450
4655
|
initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
|
|
4451
4656
|
futurePriceUpdatesRequested?: FuturePriceUpdatesRequested;
|
|
4657
|
+
/** Fired once when an offline subscription purchase is completed (BILL-534). */
|
|
4658
|
+
offlinePurchaseCompleted?: SubscriptionOfflinePurchaseCompleted;
|
|
4452
4659
|
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
4453
4660
|
unknown?: UnknownSubscriptionEvent;
|
|
4454
4661
|
}
|
|
@@ -4487,6 +4694,8 @@ interface SubscriptionEventPayloadOneOf {
|
|
|
4487
4694
|
billingCyclePaid?: SubscriptionBillingCyclePaid;
|
|
4488
4695
|
initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
|
|
4489
4696
|
futurePriceUpdatesRequested?: FuturePriceUpdatesRequested;
|
|
4697
|
+
/** Fired once when an offline subscription purchase is completed (BILL-534). */
|
|
4698
|
+
offlinePurchaseCompleted?: SubscriptionOfflinePurchaseCompleted;
|
|
4490
4699
|
subscriptionBoAction?: SubscriptionBackOfficeAction;
|
|
4491
4700
|
unknown?: UnknownSubscriptionEvent;
|
|
4492
4701
|
}
|
|
@@ -4560,6 +4769,10 @@ interface FuturePriceUpdatesRequested {
|
|
|
4560
4769
|
subscription?: Subscription;
|
|
4561
4770
|
requestedUpdateData?: SubscriptionUpdateData;
|
|
4562
4771
|
}
|
|
4772
|
+
interface SubscriptionOfflinePurchaseCompleted {
|
|
4773
|
+
subscription?: Subscription;
|
|
4774
|
+
actionDetails?: ActionDetails;
|
|
4775
|
+
}
|
|
4563
4776
|
interface SubscriptionBackOfficeAction {
|
|
4564
4777
|
subscription?: Subscription;
|
|
4565
4778
|
/** The backoffice method name */
|
|
@@ -4680,6 +4893,16 @@ type CustomerUpdateBillingDateApplicationErrors = {
|
|
|
4680
4893
|
data?: Record<string, any>;
|
|
4681
4894
|
};
|
|
4682
4895
|
/** @docsIgnore */
|
|
4896
|
+
type CustomerChangeSubscriptionApplicationErrors = {
|
|
4897
|
+
code?: 'CUSTOMER_ACTION_NOT_ENABLED';
|
|
4898
|
+
description?: string;
|
|
4899
|
+
data?: Record<string, any>;
|
|
4900
|
+
} | {
|
|
4901
|
+
code?: 'CUSTOMER_TIMING_RESTRICTION';
|
|
4902
|
+
description?: string;
|
|
4903
|
+
data?: Record<string, any>;
|
|
4904
|
+
};
|
|
4905
|
+
/** @docsIgnore */
|
|
4683
4906
|
type UpdateSubscriptionBillingDateApplicationErrors = {
|
|
4684
4907
|
code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
|
|
4685
4908
|
description?: string;
|
|
@@ -4806,9 +5029,15 @@ declare function customerCancelScheduledPause(): __PublicMethodMetaInfo<'POST',
|
|
|
4806
5029
|
declare function customerUpdateBillingDate(): __PublicMethodMetaInfo<'POST', {
|
|
4807
5030
|
id: string;
|
|
4808
5031
|
}, CustomerUpdateBillingDateRequest$1, CustomerUpdateBillingDateRequest, CustomerUpdateBillingDateResponse$1, CustomerUpdateBillingDateResponse>;
|
|
4809
|
-
declare function
|
|
5032
|
+
declare function customerChangeSubscription(): __PublicMethodMetaInfo<'POST', {
|
|
5033
|
+
subscriptionId: string;
|
|
5034
|
+
}, CustomerChangeSubscriptionRequest$1, CustomerChangeSubscriptionRequest, CustomerChangeSubscriptionResponse$1, CustomerChangeSubscriptionResponse>;
|
|
5035
|
+
declare function customerPreviewChangeSubscription(): __PublicMethodMetaInfo<'POST', {
|
|
5036
|
+
subscriptionId: string;
|
|
5037
|
+
}, CustomerPreviewChangeSubscriptionRequest$1, CustomerPreviewChangeSubscriptionRequest, CustomerPreviewChangeSubscriptionResponse$1, CustomerPreviewChangeSubscriptionResponse>;
|
|
5038
|
+
declare function customerCancelPendingChange(): __PublicMethodMetaInfo<'POST', {
|
|
4810
5039
|
subscriptionId: string;
|
|
4811
|
-
},
|
|
5040
|
+
}, CustomerCancelPendingChangeRequest$1, CustomerCancelPendingChangeRequest, CustomerCancelPendingChangeResponse$1, CustomerCancelPendingChangeResponse>;
|
|
4812
5041
|
declare function getSubscription(): __PublicMethodMetaInfo<'GET', {
|
|
4813
5042
|
id: string;
|
|
4814
5043
|
}, GetSubscriptionRequest$1, GetSubscriptionRequest, GetSubscriptionResponse$1, GetSubscriptionResponse>;
|
|
@@ -4864,4 +5093,4 @@ declare function listSubscriptionHistory(): __PublicMethodMetaInfo<'GET', {
|
|
|
4864
5093
|
subscriptionId: string;
|
|
4865
5094
|
}, ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryRequest, ListSubscriptionHistoryResponse$1, ListSubscriptionHistoryResponse>;
|
|
4866
5095
|
|
|
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 };
|
|
5096
|
+
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 CustomerCancelPendingChangeRequest as CustomerCancelPendingChangeRequestOriginal, type CustomerCancelPendingChangeResponse as CustomerCancelPendingChangeResponseOriginal, 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 CustomerChangeSubscriptionApplicationErrors as CustomerChangeSubscriptionApplicationErrorsOriginal, type CustomerChangeSubscriptionRequest as CustomerChangeSubscriptionRequestOriginal, type CustomerChangeSubscriptionResponse as CustomerChangeSubscriptionResponseOriginal, 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 CustomerPreviewChangeSubscriptionRequest as CustomerPreviewChangeSubscriptionRequestOriginal, type CustomerPreviewChangeSubscriptionResponse as CustomerPreviewChangeSubscriptionResponseOriginal, 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, customerCancelPendingChange, customerCancelScheduledPause, customerCancelScheduledSkip, customerCancelSubscription, customerChangeSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerPauseSubscription, customerPreviewChangeSubscription, 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 };
|