@stigg/typescript 0.1.0-alpha.14 → 0.1.0-alpha.15
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/CHANGELOG.md +14 -0
- package/package.json +1 -1
- package/resources/v1/addons/addons.d.mts +3 -0
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +3 -0
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +3 -0
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +3 -0
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +3 -0
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +3 -0
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +3 -0
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +3 -0
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +3 -0
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +3 -0
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +3 -0
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +3 -0
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +3 -0
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +3 -0
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +3 -0
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +3 -0
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/events.d.mts +3 -0
- package/resources/v1/events.d.mts.map +1 -1
- package/resources/v1/events.d.ts +3 -0
- package/resources/v1/events.d.ts.map +1 -1
- package/resources/v1/events.js +3 -0
- package/resources/v1/events.js.map +1 -1
- package/resources/v1/events.mjs +3 -0
- package/resources/v1/events.mjs.map +1 -1
- package/resources/v1/features.d.mts +3 -0
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +3 -0
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +3 -0
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +3 -0
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +3 -0
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +3 -0
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +3 -0
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +3 -0
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +3 -0
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +3 -0
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +3 -0
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +3 -0
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +3 -0
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +3 -0
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +3 -0
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +3 -0
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +3 -0
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +3 -0
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +3 -0
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +3 -0
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +801 -125
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +801 -125
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +2 -2
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +3 -0
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +3 -0
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +3 -0
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +3 -0
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/usage.d.mts +3 -0
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +3 -0
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +3 -0
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +3 -0
- package/resources/v1/usage.mjs.map +1 -1
- package/src/resources/v1/addons/addons.ts +3 -0
- package/src/resources/v1/coupons.ts +3 -0
- package/src/resources/v1/customers/payment-method.ts +3 -0
- package/src/resources/v1/customers/promotional-entitlements.ts +3 -0
- package/src/resources/v1/events.ts +3 -0
- package/src/resources/v1/features.ts +3 -0
- package/src/resources/v1/plans/plans.ts +3 -0
- package/src/resources/v1/products.ts +3 -0
- package/src/resources/v1/subscriptions/future-update.ts +3 -0
- package/src/resources/v1/subscriptions/invoice.ts +3 -0
- package/src/resources/v1/subscriptions/subscriptions.ts +3754 -1512
- package/src/resources/v1/subscriptions/usage.ts +3 -0
- package/src/resources/v1/usage.ts +3 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.mjs";
|
|
2
2
|
import * as FutureUpdateAPI from "./future-update.mjs";
|
|
3
|
-
import { CancelSubscription, FutureUpdate } from "./future-update.mjs";
|
|
3
|
+
import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate } from "./future-update.mjs";
|
|
4
4
|
import * as InvoiceAPI from "./invoice.mjs";
|
|
5
5
|
import { Invoice, InvoiceMarkAsPaidResponse } from "./invoice.mjs";
|
|
6
6
|
import * as UsageAPI from "./usage.mjs";
|
|
@@ -115,6 +115,14 @@ export declare namespace Subscription {
|
|
|
115
115
|
*/
|
|
116
116
|
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
117
117
|
addons?: Array<Data.Addon>;
|
|
118
|
+
/**
|
|
119
|
+
* Billing cycle anchor date
|
|
120
|
+
*/
|
|
121
|
+
billingCycleAnchor?: string | null;
|
|
122
|
+
/**
|
|
123
|
+
* Budget configuration
|
|
124
|
+
*/
|
|
125
|
+
budget?: Data.Budget | null;
|
|
118
126
|
/**
|
|
119
127
|
* Subscription cancellation date
|
|
120
128
|
*/
|
|
@@ -123,6 +131,10 @@ export declare namespace Subscription {
|
|
|
123
131
|
* Subscription cancel reason
|
|
124
132
|
*/
|
|
125
133
|
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
134
|
+
/**
|
|
135
|
+
* Coupons applied to the subscription
|
|
136
|
+
*/
|
|
137
|
+
coupons?: Array<Data.Coupon>;
|
|
126
138
|
/**
|
|
127
139
|
* End of the current billing period
|
|
128
140
|
*/
|
|
@@ -139,12 +151,24 @@ export declare namespace Subscription {
|
|
|
139
151
|
* Subscription end date
|
|
140
152
|
*/
|
|
141
153
|
endDate?: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* Scheduled future updates for the subscription
|
|
156
|
+
*/
|
|
157
|
+
futureUpdates?: Array<Data.FutureUpdate>;
|
|
158
|
+
/**
|
|
159
|
+
* Latest invoice for the subscription
|
|
160
|
+
*/
|
|
161
|
+
latestInvoice?: Data.LatestInvoice | null;
|
|
142
162
|
/**
|
|
143
163
|
* Additional metadata for the subscription
|
|
144
164
|
*/
|
|
145
165
|
metadata?: {
|
|
146
166
|
[key: string]: string;
|
|
147
167
|
};
|
|
168
|
+
/**
|
|
169
|
+
* Minimum spend configuration
|
|
170
|
+
*/
|
|
171
|
+
minimumSpend?: Data.MinimumSpend | null;
|
|
148
172
|
/**
|
|
149
173
|
* Paying customer ID for delegated billing
|
|
150
174
|
*/
|
|
@@ -158,6 +182,14 @@ export declare namespace Subscription {
|
|
|
158
182
|
* Resource ID
|
|
159
183
|
*/
|
|
160
184
|
resourceId?: string | null;
|
|
185
|
+
/**
|
|
186
|
+
* Entitlements associated with the subscription
|
|
187
|
+
*/
|
|
188
|
+
subscriptionEntitlements?: Array<Data.SubscriptionEntitlement>;
|
|
189
|
+
/**
|
|
190
|
+
* Trial configuration
|
|
191
|
+
*/
|
|
192
|
+
trial?: Data.Trial | null;
|
|
161
193
|
/**
|
|
162
194
|
* Subscription trial end date
|
|
163
195
|
*/
|
|
@@ -177,20 +209,241 @@ export declare namespace Subscription {
|
|
|
177
209
|
*/
|
|
178
210
|
quantity: number;
|
|
179
211
|
}
|
|
180
|
-
|
|
212
|
+
/**
|
|
213
|
+
* Budget configuration
|
|
214
|
+
*/
|
|
215
|
+
interface Budget {
|
|
216
|
+
/**
|
|
217
|
+
* Whether the budget is a soft limit
|
|
218
|
+
*/
|
|
219
|
+
hasSoftLimit: boolean;
|
|
181
220
|
/**
|
|
182
|
-
*
|
|
221
|
+
* Maximum spending limit
|
|
222
|
+
*/
|
|
223
|
+
limit: number;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Coupon applied to a subscription
|
|
227
|
+
*/
|
|
228
|
+
interface Coupon {
|
|
229
|
+
/**
|
|
230
|
+
* Coupon ID
|
|
183
231
|
*/
|
|
184
232
|
id: string;
|
|
185
233
|
/**
|
|
186
|
-
*
|
|
234
|
+
* Coupon name
|
|
235
|
+
*/
|
|
236
|
+
name: string;
|
|
237
|
+
/**
|
|
238
|
+
* Coupon status
|
|
239
|
+
*/
|
|
240
|
+
status: 'ACTIVE' | 'EXPIRED' | 'REMOVED';
|
|
241
|
+
/**
|
|
242
|
+
* Fixed amount discounts by currency
|
|
243
|
+
*/
|
|
244
|
+
amountsOff?: Array<Coupon.AmountsOff> | null;
|
|
245
|
+
/**
|
|
246
|
+
* Percentage discount
|
|
247
|
+
*/
|
|
248
|
+
percentOff?: number | null;
|
|
249
|
+
}
|
|
250
|
+
namespace Coupon {
|
|
251
|
+
interface AmountsOff {
|
|
252
|
+
/**
|
|
253
|
+
* The price amount
|
|
254
|
+
*/
|
|
255
|
+
amount?: number;
|
|
256
|
+
/**
|
|
257
|
+
* The price currency
|
|
258
|
+
*/
|
|
259
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Scheduled subscription update
|
|
264
|
+
*/
|
|
265
|
+
interface FutureUpdate {
|
|
266
|
+
/**
|
|
267
|
+
* Scheduled execution time
|
|
268
|
+
*/
|
|
269
|
+
scheduledExecutionTime: string;
|
|
270
|
+
/**
|
|
271
|
+
* Status of the scheduled update
|
|
272
|
+
*/
|
|
273
|
+
scheduleStatus: 'PENDING_PAYMENT' | 'SCHEDULED' | 'CANCELED' | 'DONE' | 'FAILED';
|
|
274
|
+
/**
|
|
275
|
+
* Type of scheduled change
|
|
276
|
+
*/
|
|
277
|
+
subscriptionScheduleType: 'DOWNGRADE' | 'PLAN' | 'BILLING_PERIOD' | 'UNIT_AMOUNT' | 'RECURRING_CREDITS' | 'PRICE_OVERRIDE' | 'ADDON' | 'COUPON' | 'MIGRATE_TO_LATEST' | 'ADDITIONAL_META_DATA' | 'BILLING_INFO_METADATA';
|
|
278
|
+
/**
|
|
279
|
+
* Target package for the update
|
|
280
|
+
*/
|
|
281
|
+
targetPackage?: FutureUpdate.TargetPackage | null;
|
|
282
|
+
}
|
|
283
|
+
namespace FutureUpdate {
|
|
284
|
+
/**
|
|
285
|
+
* Target package for the update
|
|
286
|
+
*/
|
|
287
|
+
interface TargetPackage {
|
|
288
|
+
/**
|
|
289
|
+
* Target package for the update
|
|
290
|
+
*/
|
|
291
|
+
id: string;
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* Latest invoice for the subscription
|
|
296
|
+
*/
|
|
297
|
+
interface LatestInvoice {
|
|
298
|
+
/**
|
|
299
|
+
* Invoice billing ID
|
|
300
|
+
*/
|
|
301
|
+
billingId: string;
|
|
302
|
+
/**
|
|
303
|
+
* Invoice creation date
|
|
187
304
|
*/
|
|
188
305
|
createdAt: string;
|
|
189
306
|
/**
|
|
190
|
-
*
|
|
307
|
+
* Whether payment requires action
|
|
308
|
+
*/
|
|
309
|
+
requiresAction: boolean;
|
|
310
|
+
/**
|
|
311
|
+
* Invoice status
|
|
312
|
+
*/
|
|
313
|
+
status: 'OPEN' | 'CANCELED' | 'PAID';
|
|
314
|
+
/**
|
|
315
|
+
* Amount due
|
|
316
|
+
*/
|
|
317
|
+
amountDue?: number | null;
|
|
318
|
+
/**
|
|
319
|
+
* Billing reason
|
|
320
|
+
*/
|
|
321
|
+
billingReason?: 'BILLING_CYCLE' | 'SUBSCRIPTION_CREATION' | 'SUBSCRIPTION_UPDATE' | 'MANUAL' | 'MINIMUM_INVOICE_AMOUNT_EXCEEDED' | 'OTHER' | null;
|
|
322
|
+
/**
|
|
323
|
+
* Invoice currency
|
|
324
|
+
*/
|
|
325
|
+
currency?: string | null;
|
|
326
|
+
/**
|
|
327
|
+
* Invoice PDF URL
|
|
328
|
+
*/
|
|
329
|
+
pdfUrl?: string | null;
|
|
330
|
+
/**
|
|
331
|
+
* Total amount
|
|
332
|
+
*/
|
|
333
|
+
total?: number | null;
|
|
334
|
+
}
|
|
335
|
+
/**
|
|
336
|
+
* Minimum spend configuration
|
|
337
|
+
*/
|
|
338
|
+
interface MinimumSpend {
|
|
339
|
+
/**
|
|
340
|
+
* The price amount
|
|
341
|
+
*/
|
|
342
|
+
amount?: number;
|
|
343
|
+
/**
|
|
344
|
+
* The price currency
|
|
345
|
+
*/
|
|
346
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
347
|
+
}
|
|
348
|
+
interface Price {
|
|
349
|
+
/**
|
|
350
|
+
* Addon identifier for the price override
|
|
351
|
+
*/
|
|
352
|
+
addonId?: string | null;
|
|
353
|
+
/**
|
|
354
|
+
* The price amount
|
|
355
|
+
*/
|
|
356
|
+
amount?: number;
|
|
357
|
+
/**
|
|
358
|
+
* Whether this is a base charge override
|
|
359
|
+
*/
|
|
360
|
+
baseCharge?: boolean;
|
|
361
|
+
/**
|
|
362
|
+
* The billing country code of the price
|
|
363
|
+
*/
|
|
364
|
+
billingCountryCode?: string;
|
|
365
|
+
/**
|
|
366
|
+
* Block size for pricing
|
|
191
367
|
*/
|
|
192
|
-
|
|
193
|
-
|
|
368
|
+
blockSize?: number;
|
|
369
|
+
/**
|
|
370
|
+
* The price currency
|
|
371
|
+
*/
|
|
372
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
373
|
+
/**
|
|
374
|
+
* Feature identifier for the price override
|
|
375
|
+
*/
|
|
376
|
+
featureId?: string | null;
|
|
377
|
+
/**
|
|
378
|
+
* Pricing tiers configuration
|
|
379
|
+
*/
|
|
380
|
+
tiers?: Array<Price.Tier>;
|
|
381
|
+
}
|
|
382
|
+
namespace Price {
|
|
383
|
+
interface Tier {
|
|
384
|
+
/**
|
|
385
|
+
* The flat fee price of the price tier
|
|
386
|
+
*/
|
|
387
|
+
flatPrice?: Tier.FlatPrice;
|
|
388
|
+
/**
|
|
389
|
+
* The unit price of the price tier
|
|
390
|
+
*/
|
|
391
|
+
unitPrice?: Tier.UnitPrice;
|
|
392
|
+
/**
|
|
393
|
+
* The up to quantity of the price tier
|
|
394
|
+
*/
|
|
395
|
+
upTo?: number;
|
|
396
|
+
}
|
|
397
|
+
namespace Tier {
|
|
398
|
+
/**
|
|
399
|
+
* The flat fee price of the price tier
|
|
400
|
+
*/
|
|
401
|
+
interface FlatPrice {
|
|
402
|
+
/**
|
|
403
|
+
* The price amount
|
|
404
|
+
*/
|
|
405
|
+
amount: number;
|
|
406
|
+
/**
|
|
407
|
+
* The price currency
|
|
408
|
+
*/
|
|
409
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* The unit price of the price tier
|
|
413
|
+
*/
|
|
414
|
+
interface UnitPrice {
|
|
415
|
+
/**
|
|
416
|
+
* The price amount
|
|
417
|
+
*/
|
|
418
|
+
amount: number;
|
|
419
|
+
/**
|
|
420
|
+
* The price currency
|
|
421
|
+
*/
|
|
422
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
423
|
+
}
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* Subscription entitlement reference
|
|
428
|
+
*/
|
|
429
|
+
interface SubscriptionEntitlement {
|
|
430
|
+
/**
|
|
431
|
+
* Feature ID or currency ID
|
|
432
|
+
*/
|
|
433
|
+
id: string;
|
|
434
|
+
/**
|
|
435
|
+
* Entitlement type (FEATURE or CREDIT)
|
|
436
|
+
*/
|
|
437
|
+
type: 'FEATURE' | 'CREDIT';
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* Trial configuration
|
|
441
|
+
*/
|
|
442
|
+
interface Trial {
|
|
443
|
+
/**
|
|
444
|
+
* Behavior when the trial ends
|
|
445
|
+
*/
|
|
446
|
+
trialEndBehavior: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
194
447
|
}
|
|
195
448
|
}
|
|
196
449
|
}
|
|
@@ -235,6 +488,14 @@ export interface SubscriptionListResponse {
|
|
|
235
488
|
*/
|
|
236
489
|
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
237
490
|
addons?: Array<SubscriptionListResponse.Addon>;
|
|
491
|
+
/**
|
|
492
|
+
* Billing cycle anchor date
|
|
493
|
+
*/
|
|
494
|
+
billingCycleAnchor?: string | null;
|
|
495
|
+
/**
|
|
496
|
+
* Budget configuration
|
|
497
|
+
*/
|
|
498
|
+
budget?: SubscriptionListResponse.Budget | null;
|
|
238
499
|
/**
|
|
239
500
|
* Subscription cancellation date
|
|
240
501
|
*/
|
|
@@ -243,6 +504,10 @@ export interface SubscriptionListResponse {
|
|
|
243
504
|
* Subscription cancel reason
|
|
244
505
|
*/
|
|
245
506
|
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
507
|
+
/**
|
|
508
|
+
* Coupons applied to the subscription
|
|
509
|
+
*/
|
|
510
|
+
coupons?: Array<SubscriptionListResponse.Coupon>;
|
|
246
511
|
/**
|
|
247
512
|
* End of the current billing period
|
|
248
513
|
*/
|
|
@@ -259,12 +524,24 @@ export interface SubscriptionListResponse {
|
|
|
259
524
|
* Subscription end date
|
|
260
525
|
*/
|
|
261
526
|
endDate?: string | null;
|
|
527
|
+
/**
|
|
528
|
+
* Scheduled future updates for the subscription
|
|
529
|
+
*/
|
|
530
|
+
futureUpdates?: Array<SubscriptionListResponse.FutureUpdate>;
|
|
531
|
+
/**
|
|
532
|
+
* Latest invoice for the subscription
|
|
533
|
+
*/
|
|
534
|
+
latestInvoice?: SubscriptionListResponse.LatestInvoice | null;
|
|
262
535
|
/**
|
|
263
536
|
* Additional metadata for the subscription
|
|
264
537
|
*/
|
|
265
538
|
metadata?: {
|
|
266
539
|
[key: string]: string;
|
|
267
540
|
};
|
|
541
|
+
/**
|
|
542
|
+
* Minimum spend configuration
|
|
543
|
+
*/
|
|
544
|
+
minimumSpend?: SubscriptionListResponse.MinimumSpend | null;
|
|
268
545
|
/**
|
|
269
546
|
* Paying customer ID for delegated billing
|
|
270
547
|
*/
|
|
@@ -278,6 +555,14 @@ export interface SubscriptionListResponse {
|
|
|
278
555
|
* Resource ID
|
|
279
556
|
*/
|
|
280
557
|
resourceId?: string | null;
|
|
558
|
+
/**
|
|
559
|
+
* Entitlements associated with the subscription
|
|
560
|
+
*/
|
|
561
|
+
subscriptionEntitlements?: Array<SubscriptionListResponse.SubscriptionEntitlement>;
|
|
562
|
+
/**
|
|
563
|
+
* Trial configuration
|
|
564
|
+
*/
|
|
565
|
+
trial?: SubscriptionListResponse.Trial | null;
|
|
281
566
|
/**
|
|
282
567
|
* Subscription trial end date
|
|
283
568
|
*/
|
|
@@ -285,32 +570,253 @@ export interface SubscriptionListResponse {
|
|
|
285
570
|
}
|
|
286
571
|
export declare namespace SubscriptionListResponse {
|
|
287
572
|
/**
|
|
288
|
-
* Addon configuration
|
|
573
|
+
* Addon configuration
|
|
574
|
+
*/
|
|
575
|
+
interface Addon {
|
|
576
|
+
/**
|
|
577
|
+
* Addon ID
|
|
578
|
+
*/
|
|
579
|
+
id: string;
|
|
580
|
+
/**
|
|
581
|
+
* Number of addon instances
|
|
582
|
+
*/
|
|
583
|
+
quantity: number;
|
|
584
|
+
}
|
|
585
|
+
/**
|
|
586
|
+
* Budget configuration
|
|
587
|
+
*/
|
|
588
|
+
interface Budget {
|
|
589
|
+
/**
|
|
590
|
+
* Whether the budget is a soft limit
|
|
591
|
+
*/
|
|
592
|
+
hasSoftLimit: boolean;
|
|
593
|
+
/**
|
|
594
|
+
* Maximum spending limit
|
|
595
|
+
*/
|
|
596
|
+
limit: number;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* Coupon applied to a subscription
|
|
600
|
+
*/
|
|
601
|
+
interface Coupon {
|
|
602
|
+
/**
|
|
603
|
+
* Coupon ID
|
|
604
|
+
*/
|
|
605
|
+
id: string;
|
|
606
|
+
/**
|
|
607
|
+
* Coupon name
|
|
608
|
+
*/
|
|
609
|
+
name: string;
|
|
610
|
+
/**
|
|
611
|
+
* Coupon status
|
|
612
|
+
*/
|
|
613
|
+
status: 'ACTIVE' | 'EXPIRED' | 'REMOVED';
|
|
614
|
+
/**
|
|
615
|
+
* Fixed amount discounts by currency
|
|
616
|
+
*/
|
|
617
|
+
amountsOff?: Array<Coupon.AmountsOff> | null;
|
|
618
|
+
/**
|
|
619
|
+
* Percentage discount
|
|
620
|
+
*/
|
|
621
|
+
percentOff?: number | null;
|
|
622
|
+
}
|
|
623
|
+
namespace Coupon {
|
|
624
|
+
interface AmountsOff {
|
|
625
|
+
/**
|
|
626
|
+
* The price amount
|
|
627
|
+
*/
|
|
628
|
+
amount?: number;
|
|
629
|
+
/**
|
|
630
|
+
* The price currency
|
|
631
|
+
*/
|
|
632
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
633
|
+
}
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* Scheduled subscription update
|
|
637
|
+
*/
|
|
638
|
+
interface FutureUpdate {
|
|
639
|
+
/**
|
|
640
|
+
* Scheduled execution time
|
|
641
|
+
*/
|
|
642
|
+
scheduledExecutionTime: string;
|
|
643
|
+
/**
|
|
644
|
+
* Status of the scheduled update
|
|
645
|
+
*/
|
|
646
|
+
scheduleStatus: 'PENDING_PAYMENT' | 'SCHEDULED' | 'CANCELED' | 'DONE' | 'FAILED';
|
|
647
|
+
/**
|
|
648
|
+
* Type of scheduled change
|
|
649
|
+
*/
|
|
650
|
+
subscriptionScheduleType: 'DOWNGRADE' | 'PLAN' | 'BILLING_PERIOD' | 'UNIT_AMOUNT' | 'RECURRING_CREDITS' | 'PRICE_OVERRIDE' | 'ADDON' | 'COUPON' | 'MIGRATE_TO_LATEST' | 'ADDITIONAL_META_DATA' | 'BILLING_INFO_METADATA';
|
|
651
|
+
/**
|
|
652
|
+
* Target package for the update
|
|
653
|
+
*/
|
|
654
|
+
targetPackage?: FutureUpdate.TargetPackage | null;
|
|
655
|
+
}
|
|
656
|
+
namespace FutureUpdate {
|
|
657
|
+
/**
|
|
658
|
+
* Target package for the update
|
|
659
|
+
*/
|
|
660
|
+
interface TargetPackage {
|
|
661
|
+
/**
|
|
662
|
+
* Target package for the update
|
|
663
|
+
*/
|
|
664
|
+
id: string;
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* Latest invoice for the subscription
|
|
669
|
+
*/
|
|
670
|
+
interface LatestInvoice {
|
|
671
|
+
/**
|
|
672
|
+
* Invoice billing ID
|
|
673
|
+
*/
|
|
674
|
+
billingId: string;
|
|
675
|
+
/**
|
|
676
|
+
* Invoice creation date
|
|
677
|
+
*/
|
|
678
|
+
createdAt: string;
|
|
679
|
+
/**
|
|
680
|
+
* Whether payment requires action
|
|
681
|
+
*/
|
|
682
|
+
requiresAction: boolean;
|
|
683
|
+
/**
|
|
684
|
+
* Invoice status
|
|
685
|
+
*/
|
|
686
|
+
status: 'OPEN' | 'CANCELED' | 'PAID';
|
|
687
|
+
/**
|
|
688
|
+
* Amount due
|
|
689
|
+
*/
|
|
690
|
+
amountDue?: number | null;
|
|
691
|
+
/**
|
|
692
|
+
* Billing reason
|
|
693
|
+
*/
|
|
694
|
+
billingReason?: 'BILLING_CYCLE' | 'SUBSCRIPTION_CREATION' | 'SUBSCRIPTION_UPDATE' | 'MANUAL' | 'MINIMUM_INVOICE_AMOUNT_EXCEEDED' | 'OTHER' | null;
|
|
695
|
+
/**
|
|
696
|
+
* Invoice currency
|
|
697
|
+
*/
|
|
698
|
+
currency?: string | null;
|
|
699
|
+
/**
|
|
700
|
+
* Invoice PDF URL
|
|
701
|
+
*/
|
|
702
|
+
pdfUrl?: string | null;
|
|
703
|
+
/**
|
|
704
|
+
* Total amount
|
|
705
|
+
*/
|
|
706
|
+
total?: number | null;
|
|
707
|
+
}
|
|
708
|
+
/**
|
|
709
|
+
* Minimum spend configuration
|
|
710
|
+
*/
|
|
711
|
+
interface MinimumSpend {
|
|
712
|
+
/**
|
|
713
|
+
* The price amount
|
|
714
|
+
*/
|
|
715
|
+
amount?: number;
|
|
716
|
+
/**
|
|
717
|
+
* The price currency
|
|
718
|
+
*/
|
|
719
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
720
|
+
}
|
|
721
|
+
interface Price {
|
|
722
|
+
/**
|
|
723
|
+
* Addon identifier for the price override
|
|
724
|
+
*/
|
|
725
|
+
addonId?: string | null;
|
|
726
|
+
/**
|
|
727
|
+
* The price amount
|
|
728
|
+
*/
|
|
729
|
+
amount?: number;
|
|
730
|
+
/**
|
|
731
|
+
* Whether this is a base charge override
|
|
732
|
+
*/
|
|
733
|
+
baseCharge?: boolean;
|
|
734
|
+
/**
|
|
735
|
+
* The billing country code of the price
|
|
736
|
+
*/
|
|
737
|
+
billingCountryCode?: string;
|
|
738
|
+
/**
|
|
739
|
+
* Block size for pricing
|
|
740
|
+
*/
|
|
741
|
+
blockSize?: number;
|
|
742
|
+
/**
|
|
743
|
+
* The price currency
|
|
744
|
+
*/
|
|
745
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
746
|
+
/**
|
|
747
|
+
* Feature identifier for the price override
|
|
748
|
+
*/
|
|
749
|
+
featureId?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* Pricing tiers configuration
|
|
752
|
+
*/
|
|
753
|
+
tiers?: Array<Price.Tier>;
|
|
754
|
+
}
|
|
755
|
+
namespace Price {
|
|
756
|
+
interface Tier {
|
|
757
|
+
/**
|
|
758
|
+
* The flat fee price of the price tier
|
|
759
|
+
*/
|
|
760
|
+
flatPrice?: Tier.FlatPrice;
|
|
761
|
+
/**
|
|
762
|
+
* The unit price of the price tier
|
|
763
|
+
*/
|
|
764
|
+
unitPrice?: Tier.UnitPrice;
|
|
765
|
+
/**
|
|
766
|
+
* The up to quantity of the price tier
|
|
767
|
+
*/
|
|
768
|
+
upTo?: number;
|
|
769
|
+
}
|
|
770
|
+
namespace Tier {
|
|
771
|
+
/**
|
|
772
|
+
* The flat fee price of the price tier
|
|
773
|
+
*/
|
|
774
|
+
interface FlatPrice {
|
|
775
|
+
/**
|
|
776
|
+
* The price amount
|
|
777
|
+
*/
|
|
778
|
+
amount: number;
|
|
779
|
+
/**
|
|
780
|
+
* The price currency
|
|
781
|
+
*/
|
|
782
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
783
|
+
}
|
|
784
|
+
/**
|
|
785
|
+
* The unit price of the price tier
|
|
786
|
+
*/
|
|
787
|
+
interface UnitPrice {
|
|
788
|
+
/**
|
|
789
|
+
* The price amount
|
|
790
|
+
*/
|
|
791
|
+
amount: number;
|
|
792
|
+
/**
|
|
793
|
+
* The price currency
|
|
794
|
+
*/
|
|
795
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* Subscription entitlement reference
|
|
289
801
|
*/
|
|
290
|
-
interface
|
|
802
|
+
interface SubscriptionEntitlement {
|
|
291
803
|
/**
|
|
292
|
-
*
|
|
804
|
+
* Feature ID or currency ID
|
|
293
805
|
*/
|
|
294
806
|
id: string;
|
|
295
807
|
/**
|
|
296
|
-
*
|
|
808
|
+
* Entitlement type (FEATURE or CREDIT)
|
|
297
809
|
*/
|
|
298
|
-
|
|
810
|
+
type: 'FEATURE' | 'CREDIT';
|
|
299
811
|
}
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
id: string;
|
|
305
|
-
/**
|
|
306
|
-
* Creation timestamp
|
|
307
|
-
*/
|
|
308
|
-
createdAt: string;
|
|
812
|
+
/**
|
|
813
|
+
* Trial configuration
|
|
814
|
+
*/
|
|
815
|
+
interface Trial {
|
|
309
816
|
/**
|
|
310
|
-
*
|
|
817
|
+
* Behavior when the trial ends
|
|
311
818
|
*/
|
|
312
|
-
|
|
313
|
-
[k: string]: unknown;
|
|
819
|
+
trialEndBehavior: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
314
820
|
}
|
|
315
821
|
}
|
|
316
822
|
/**
|
|
@@ -818,6 +1324,14 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
818
1324
|
*/
|
|
819
1325
|
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
820
1326
|
addons?: Array<Subscription.Addon>;
|
|
1327
|
+
/**
|
|
1328
|
+
* Billing cycle anchor date
|
|
1329
|
+
*/
|
|
1330
|
+
billingCycleAnchor?: string | null;
|
|
1331
|
+
/**
|
|
1332
|
+
* Budget configuration
|
|
1333
|
+
*/
|
|
1334
|
+
budget?: Subscription.Budget | null;
|
|
821
1335
|
/**
|
|
822
1336
|
* Subscription cancellation date
|
|
823
1337
|
*/
|
|
@@ -826,6 +1340,10 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
826
1340
|
* Subscription cancel reason
|
|
827
1341
|
*/
|
|
828
1342
|
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
1343
|
+
/**
|
|
1344
|
+
* Coupons applied to the subscription
|
|
1345
|
+
*/
|
|
1346
|
+
coupons?: Array<Subscription.Coupon>;
|
|
829
1347
|
/**
|
|
830
1348
|
* End of the current billing period
|
|
831
1349
|
*/
|
|
@@ -842,12 +1360,24 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
842
1360
|
* Subscription end date
|
|
843
1361
|
*/
|
|
844
1362
|
endDate?: string | null;
|
|
1363
|
+
/**
|
|
1364
|
+
* Scheduled future updates for the subscription
|
|
1365
|
+
*/
|
|
1366
|
+
futureUpdates?: Array<Subscription.FutureUpdate>;
|
|
1367
|
+
/**
|
|
1368
|
+
* Latest invoice for the subscription
|
|
1369
|
+
*/
|
|
1370
|
+
latestInvoice?: Subscription.LatestInvoice | null;
|
|
845
1371
|
/**
|
|
846
1372
|
* Additional metadata for the subscription
|
|
847
1373
|
*/
|
|
848
1374
|
metadata?: {
|
|
849
1375
|
[key: string]: string;
|
|
850
1376
|
};
|
|
1377
|
+
/**
|
|
1378
|
+
* Minimum spend configuration
|
|
1379
|
+
*/
|
|
1380
|
+
minimumSpend?: Subscription.MinimumSpend | null;
|
|
851
1381
|
/**
|
|
852
1382
|
* Paying customer ID for delegated billing
|
|
853
1383
|
*/
|
|
@@ -861,6 +1391,14 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
861
1391
|
* Resource ID
|
|
862
1392
|
*/
|
|
863
1393
|
resourceId?: string | null;
|
|
1394
|
+
/**
|
|
1395
|
+
* Entitlements associated with the subscription
|
|
1396
|
+
*/
|
|
1397
|
+
subscriptionEntitlements?: Array<Subscription.SubscriptionEntitlement>;
|
|
1398
|
+
/**
|
|
1399
|
+
* Trial configuration
|
|
1400
|
+
*/
|
|
1401
|
+
trial?: Subscription.Trial | null;
|
|
864
1402
|
/**
|
|
865
1403
|
* Subscription trial end date
|
|
866
1404
|
*/
|
|
@@ -880,50 +1418,177 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
880
1418
|
*/
|
|
881
1419
|
quantity: number;
|
|
882
1420
|
}
|
|
883
|
-
|
|
1421
|
+
/**
|
|
1422
|
+
* Budget configuration
|
|
1423
|
+
*/
|
|
1424
|
+
interface Budget {
|
|
884
1425
|
/**
|
|
885
|
-
*
|
|
1426
|
+
* Whether the budget is a soft limit
|
|
886
1427
|
*/
|
|
887
|
-
|
|
1428
|
+
hasSoftLimit: boolean;
|
|
888
1429
|
/**
|
|
889
|
-
*
|
|
1430
|
+
* Maximum spending limit
|
|
890
1431
|
*/
|
|
891
|
-
|
|
1432
|
+
limit: number;
|
|
1433
|
+
}
|
|
1434
|
+
/**
|
|
1435
|
+
* Coupon applied to a subscription
|
|
1436
|
+
*/
|
|
1437
|
+
interface Coupon {
|
|
892
1438
|
/**
|
|
893
|
-
*
|
|
1439
|
+
* Coupon ID
|
|
894
1440
|
*/
|
|
895
|
-
|
|
1441
|
+
id: string;
|
|
896
1442
|
/**
|
|
897
|
-
*
|
|
1443
|
+
* Coupon name
|
|
898
1444
|
*/
|
|
899
|
-
|
|
1445
|
+
name: string;
|
|
900
1446
|
/**
|
|
901
|
-
*
|
|
1447
|
+
* Coupon status
|
|
902
1448
|
*/
|
|
903
|
-
|
|
1449
|
+
status: 'ACTIVE' | 'EXPIRED' | 'REMOVED';
|
|
904
1450
|
/**
|
|
905
|
-
*
|
|
1451
|
+
* Fixed amount discounts by currency
|
|
906
1452
|
*/
|
|
907
|
-
|
|
908
|
-
}
|
|
909
|
-
namespace Price {
|
|
1453
|
+
amountsOff?: Array<Coupon.AmountsOff> | null;
|
|
910
1454
|
/**
|
|
911
|
-
*
|
|
1455
|
+
* Percentage discount
|
|
912
1456
|
*/
|
|
913
|
-
|
|
1457
|
+
percentOff?: number | null;
|
|
1458
|
+
}
|
|
1459
|
+
namespace Coupon {
|
|
1460
|
+
interface AmountsOff {
|
|
914
1461
|
/**
|
|
915
1462
|
* The price amount
|
|
916
1463
|
*/
|
|
917
1464
|
amount?: number;
|
|
918
|
-
/**
|
|
919
|
-
* The billing country code of the price
|
|
920
|
-
*/
|
|
921
|
-
billingCountryCode?: string | null;
|
|
922
1465
|
/**
|
|
923
1466
|
* The price currency
|
|
924
1467
|
*/
|
|
925
1468
|
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
926
1469
|
}
|
|
1470
|
+
}
|
|
1471
|
+
/**
|
|
1472
|
+
* Scheduled subscription update
|
|
1473
|
+
*/
|
|
1474
|
+
interface FutureUpdate {
|
|
1475
|
+
/**
|
|
1476
|
+
* Scheduled execution time
|
|
1477
|
+
*/
|
|
1478
|
+
scheduledExecutionTime: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* Status of the scheduled update
|
|
1481
|
+
*/
|
|
1482
|
+
scheduleStatus: 'PENDING_PAYMENT' | 'SCHEDULED' | 'CANCELED' | 'DONE' | 'FAILED';
|
|
1483
|
+
/**
|
|
1484
|
+
* Type of scheduled change
|
|
1485
|
+
*/
|
|
1486
|
+
subscriptionScheduleType: 'DOWNGRADE' | 'PLAN' | 'BILLING_PERIOD' | 'UNIT_AMOUNT' | 'RECURRING_CREDITS' | 'PRICE_OVERRIDE' | 'ADDON' | 'COUPON' | 'MIGRATE_TO_LATEST' | 'ADDITIONAL_META_DATA' | 'BILLING_INFO_METADATA';
|
|
1487
|
+
/**
|
|
1488
|
+
* Target package for the update
|
|
1489
|
+
*/
|
|
1490
|
+
targetPackage?: FutureUpdate.TargetPackage | null;
|
|
1491
|
+
}
|
|
1492
|
+
namespace FutureUpdate {
|
|
1493
|
+
/**
|
|
1494
|
+
* Target package for the update
|
|
1495
|
+
*/
|
|
1496
|
+
interface TargetPackage {
|
|
1497
|
+
/**
|
|
1498
|
+
* Target package for the update
|
|
1499
|
+
*/
|
|
1500
|
+
id: string;
|
|
1501
|
+
}
|
|
1502
|
+
}
|
|
1503
|
+
/**
|
|
1504
|
+
* Latest invoice for the subscription
|
|
1505
|
+
*/
|
|
1506
|
+
interface LatestInvoice {
|
|
1507
|
+
/**
|
|
1508
|
+
* Invoice billing ID
|
|
1509
|
+
*/
|
|
1510
|
+
billingId: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* Invoice creation date
|
|
1513
|
+
*/
|
|
1514
|
+
createdAt: string;
|
|
1515
|
+
/**
|
|
1516
|
+
* Whether payment requires action
|
|
1517
|
+
*/
|
|
1518
|
+
requiresAction: boolean;
|
|
1519
|
+
/**
|
|
1520
|
+
* Invoice status
|
|
1521
|
+
*/
|
|
1522
|
+
status: 'OPEN' | 'CANCELED' | 'PAID';
|
|
1523
|
+
/**
|
|
1524
|
+
* Amount due
|
|
1525
|
+
*/
|
|
1526
|
+
amountDue?: number | null;
|
|
1527
|
+
/**
|
|
1528
|
+
* Billing reason
|
|
1529
|
+
*/
|
|
1530
|
+
billingReason?: 'BILLING_CYCLE' | 'SUBSCRIPTION_CREATION' | 'SUBSCRIPTION_UPDATE' | 'MANUAL' | 'MINIMUM_INVOICE_AMOUNT_EXCEEDED' | 'OTHER' | null;
|
|
1531
|
+
/**
|
|
1532
|
+
* Invoice currency
|
|
1533
|
+
*/
|
|
1534
|
+
currency?: string | null;
|
|
1535
|
+
/**
|
|
1536
|
+
* Invoice PDF URL
|
|
1537
|
+
*/
|
|
1538
|
+
pdfUrl?: string | null;
|
|
1539
|
+
/**
|
|
1540
|
+
* Total amount
|
|
1541
|
+
*/
|
|
1542
|
+
total?: number | null;
|
|
1543
|
+
}
|
|
1544
|
+
/**
|
|
1545
|
+
* Minimum spend configuration
|
|
1546
|
+
*/
|
|
1547
|
+
interface MinimumSpend {
|
|
1548
|
+
/**
|
|
1549
|
+
* The price amount
|
|
1550
|
+
*/
|
|
1551
|
+
amount?: number;
|
|
1552
|
+
/**
|
|
1553
|
+
* The price currency
|
|
1554
|
+
*/
|
|
1555
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1556
|
+
}
|
|
1557
|
+
interface Price {
|
|
1558
|
+
/**
|
|
1559
|
+
* Addon identifier for the price override
|
|
1560
|
+
*/
|
|
1561
|
+
addonId?: string | null;
|
|
1562
|
+
/**
|
|
1563
|
+
* The price amount
|
|
1564
|
+
*/
|
|
1565
|
+
amount?: number;
|
|
1566
|
+
/**
|
|
1567
|
+
* Whether this is a base charge override
|
|
1568
|
+
*/
|
|
1569
|
+
baseCharge?: boolean;
|
|
1570
|
+
/**
|
|
1571
|
+
* The billing country code of the price
|
|
1572
|
+
*/
|
|
1573
|
+
billingCountryCode?: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* Block size for pricing
|
|
1576
|
+
*/
|
|
1577
|
+
blockSize?: number;
|
|
1578
|
+
/**
|
|
1579
|
+
* The price currency
|
|
1580
|
+
*/
|
|
1581
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1582
|
+
/**
|
|
1583
|
+
* Feature identifier for the price override
|
|
1584
|
+
*/
|
|
1585
|
+
featureId?: string | null;
|
|
1586
|
+
/**
|
|
1587
|
+
* Pricing tiers configuration
|
|
1588
|
+
*/
|
|
1589
|
+
tiers?: Array<Price.Tier>;
|
|
1590
|
+
}
|
|
1591
|
+
namespace Price {
|
|
927
1592
|
interface Tier {
|
|
928
1593
|
/**
|
|
929
1594
|
* The flat fee price of the price tier
|
|
@@ -946,15 +1611,11 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
946
1611
|
/**
|
|
947
1612
|
* The price amount
|
|
948
1613
|
*/
|
|
949
|
-
amount
|
|
950
|
-
/**
|
|
951
|
-
* The billing country code of the price
|
|
952
|
-
*/
|
|
953
|
-
billingCountryCode?: string | null;
|
|
1614
|
+
amount: number;
|
|
954
1615
|
/**
|
|
955
1616
|
* The price currency
|
|
956
1617
|
*/
|
|
957
|
-
currency
|
|
1618
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
958
1619
|
}
|
|
959
1620
|
/**
|
|
960
1621
|
* The unit price of the price tier
|
|
@@ -963,18 +1624,36 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
963
1624
|
/**
|
|
964
1625
|
* The price amount
|
|
965
1626
|
*/
|
|
966
|
-
amount
|
|
967
|
-
/**
|
|
968
|
-
* The billing country code of the price
|
|
969
|
-
*/
|
|
970
|
-
billingCountryCode?: string | null;
|
|
1627
|
+
amount: number;
|
|
971
1628
|
/**
|
|
972
1629
|
* The price currency
|
|
973
1630
|
*/
|
|
974
|
-
currency
|
|
1631
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
975
1632
|
}
|
|
976
1633
|
}
|
|
977
1634
|
}
|
|
1635
|
+
/**
|
|
1636
|
+
* Subscription entitlement reference
|
|
1637
|
+
*/
|
|
1638
|
+
interface SubscriptionEntitlement {
|
|
1639
|
+
/**
|
|
1640
|
+
* Feature ID or currency ID
|
|
1641
|
+
*/
|
|
1642
|
+
id: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* Entitlement type (FEATURE or CREDIT)
|
|
1645
|
+
*/
|
|
1646
|
+
type: 'FEATURE' | 'CREDIT';
|
|
1647
|
+
}
|
|
1648
|
+
/**
|
|
1649
|
+
* Trial configuration
|
|
1650
|
+
*/
|
|
1651
|
+
interface Trial {
|
|
1652
|
+
/**
|
|
1653
|
+
* Behavior when the trial ends
|
|
1654
|
+
*/
|
|
1655
|
+
trialEndBehavior: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
1656
|
+
}
|
|
978
1657
|
}
|
|
979
1658
|
}
|
|
980
1659
|
}
|
|
@@ -993,6 +1672,9 @@ export interface SubscriptionUpdateParams {
|
|
|
993
1672
|
metadata?: {
|
|
994
1673
|
[key: string]: string;
|
|
995
1674
|
};
|
|
1675
|
+
/**
|
|
1676
|
+
* Minimum spend amount
|
|
1677
|
+
*/
|
|
996
1678
|
minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
|
|
997
1679
|
priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
|
|
998
1680
|
promotionCode?: string;
|
|
@@ -1039,9 +1721,18 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
1039
1721
|
percentOff?: number;
|
|
1040
1722
|
}
|
|
1041
1723
|
namespace Discount {
|
|
1724
|
+
/**
|
|
1725
|
+
* Monetary amount with currency
|
|
1726
|
+
*/
|
|
1042
1727
|
interface AmountsOff {
|
|
1728
|
+
/**
|
|
1729
|
+
* The price amount
|
|
1730
|
+
*/
|
|
1043
1731
|
amount: number;
|
|
1044
|
-
|
|
1732
|
+
/**
|
|
1733
|
+
* The price currency
|
|
1734
|
+
*/
|
|
1735
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1045
1736
|
}
|
|
1046
1737
|
}
|
|
1047
1738
|
}
|
|
@@ -1103,7 +1794,13 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
1103
1794
|
}
|
|
1104
1795
|
}
|
|
1105
1796
|
interface Budget {
|
|
1797
|
+
/**
|
|
1798
|
+
* Whether the budget is a soft limit
|
|
1799
|
+
*/
|
|
1106
1800
|
hasSoftLimit: boolean;
|
|
1801
|
+
/**
|
|
1802
|
+
* Maximum spending limit
|
|
1803
|
+
*/
|
|
1107
1804
|
limit: number;
|
|
1108
1805
|
}
|
|
1109
1806
|
interface Charge {
|
|
@@ -1114,24 +1811,36 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
1114
1811
|
quantity: number;
|
|
1115
1812
|
type: 'FEATURE' | 'CREDIT';
|
|
1116
1813
|
}
|
|
1814
|
+
/**
|
|
1815
|
+
* Minimum spend amount
|
|
1816
|
+
*/
|
|
1117
1817
|
interface MinimumSpend {
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1818
|
+
/**
|
|
1819
|
+
* The price amount
|
|
1820
|
+
*/
|
|
1821
|
+
amount?: number;
|
|
1822
|
+
/**
|
|
1823
|
+
* The price currency
|
|
1824
|
+
*/
|
|
1825
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1125
1826
|
}
|
|
1126
1827
|
interface PriceOverride {
|
|
1127
1828
|
/**
|
|
1128
1829
|
* Addon ID
|
|
1129
1830
|
*/
|
|
1130
1831
|
addonId?: string;
|
|
1832
|
+
/**
|
|
1833
|
+
* The price amount
|
|
1834
|
+
*/
|
|
1835
|
+
amount?: number;
|
|
1131
1836
|
/**
|
|
1132
1837
|
* Whether this is a base charge override
|
|
1133
1838
|
*/
|
|
1134
1839
|
baseCharge?: boolean;
|
|
1840
|
+
/**
|
|
1841
|
+
* The price currency
|
|
1842
|
+
*/
|
|
1843
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1135
1844
|
/**
|
|
1136
1845
|
* The corresponding custom currency id of the recurring credits price
|
|
1137
1846
|
*/
|
|
@@ -1140,13 +1849,6 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
1140
1849
|
* Feature ID
|
|
1141
1850
|
*/
|
|
1142
1851
|
featureId?: string;
|
|
1143
|
-
price?: PriceOverride.Price;
|
|
1144
|
-
}
|
|
1145
|
-
namespace PriceOverride {
|
|
1146
|
-
interface Price {
|
|
1147
|
-
amount: number;
|
|
1148
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1149
|
-
}
|
|
1150
1852
|
}
|
|
1151
1853
|
interface SubscriptionEntitlement {
|
|
1152
1854
|
id?: string;
|
|
@@ -1666,6 +2368,9 @@ export interface SubscriptionProvisionParams {
|
|
|
1666
2368
|
metadata?: {
|
|
1667
2369
|
[key: string]: string;
|
|
1668
2370
|
};
|
|
2371
|
+
/**
|
|
2372
|
+
* Minimum spend amount
|
|
2373
|
+
*/
|
|
1669
2374
|
minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
|
|
1670
2375
|
/**
|
|
1671
2376
|
* Optional paying customer ID for split billing scenarios
|
|
@@ -1917,40 +2622,36 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1917
2622
|
*/
|
|
1918
2623
|
referenceId?: string | null;
|
|
1919
2624
|
}
|
|
2625
|
+
/**
|
|
2626
|
+
* Minimum spend amount
|
|
2627
|
+
*/
|
|
1920
2628
|
interface MinimumSpend {
|
|
1921
2629
|
/**
|
|
1922
|
-
*
|
|
2630
|
+
* The price amount
|
|
1923
2631
|
*/
|
|
1924
|
-
|
|
1925
|
-
}
|
|
1926
|
-
namespace MinimumSpend {
|
|
2632
|
+
amount?: number;
|
|
1927
2633
|
/**
|
|
1928
|
-
*
|
|
2634
|
+
* The price currency
|
|
1929
2635
|
*/
|
|
1930
|
-
|
|
1931
|
-
/**
|
|
1932
|
-
* The price amount
|
|
1933
|
-
*/
|
|
1934
|
-
amount?: number;
|
|
1935
|
-
/**
|
|
1936
|
-
* The billing country code of the price
|
|
1937
|
-
*/
|
|
1938
|
-
billingCountryCode?: string | null;
|
|
1939
|
-
/**
|
|
1940
|
-
* The price currency
|
|
1941
|
-
*/
|
|
1942
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1943
|
-
}
|
|
2636
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1944
2637
|
}
|
|
1945
2638
|
interface PriceOverride {
|
|
1946
2639
|
/**
|
|
1947
2640
|
* Addon identifier for the price override
|
|
1948
2641
|
*/
|
|
1949
2642
|
addonId?: string | null;
|
|
2643
|
+
/**
|
|
2644
|
+
* The price amount
|
|
2645
|
+
*/
|
|
2646
|
+
amount?: number;
|
|
1950
2647
|
/**
|
|
1951
2648
|
* Whether this is a base charge override
|
|
1952
2649
|
*/
|
|
1953
2650
|
baseCharge?: boolean;
|
|
2651
|
+
/**
|
|
2652
|
+
* The billing country code of the price
|
|
2653
|
+
*/
|
|
2654
|
+
billingCountryCode?: string;
|
|
1954
2655
|
/**
|
|
1955
2656
|
* Block size for pricing
|
|
1956
2657
|
*/
|
|
@@ -1958,13 +2659,13 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1958
2659
|
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
1959
2660
|
creditRate?: PriceOverride.CreditRate;
|
|
1960
2661
|
/**
|
|
1961
|
-
*
|
|
2662
|
+
* The price currency
|
|
1962
2663
|
*/
|
|
1963
|
-
|
|
2664
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1964
2665
|
/**
|
|
1965
|
-
*
|
|
2666
|
+
* Feature identifier for the price override
|
|
1966
2667
|
*/
|
|
1967
|
-
|
|
2668
|
+
featureId?: string | null;
|
|
1968
2669
|
/**
|
|
1969
2670
|
* Pricing tiers configuration
|
|
1970
2671
|
*/
|
|
@@ -1985,23 +2686,6 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1985
2686
|
*/
|
|
1986
2687
|
costFormula?: string | null;
|
|
1987
2688
|
}
|
|
1988
|
-
/**
|
|
1989
|
-
* Override price amount
|
|
1990
|
-
*/
|
|
1991
|
-
interface Price {
|
|
1992
|
-
/**
|
|
1993
|
-
* The price amount
|
|
1994
|
-
*/
|
|
1995
|
-
amount?: number;
|
|
1996
|
-
/**
|
|
1997
|
-
* The billing country code of the price
|
|
1998
|
-
*/
|
|
1999
|
-
billingCountryCode?: string | null;
|
|
2000
|
-
/**
|
|
2001
|
-
* The price currency
|
|
2002
|
-
*/
|
|
2003
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
2004
|
-
}
|
|
2005
2689
|
interface Tier {
|
|
2006
2690
|
/**
|
|
2007
2691
|
* The flat fee price of the price tier
|
|
@@ -2024,15 +2708,11 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
2024
2708
|
/**
|
|
2025
2709
|
* The price amount
|
|
2026
2710
|
*/
|
|
2027
|
-
amount
|
|
2028
|
-
/**
|
|
2029
|
-
* The billing country code of the price
|
|
2030
|
-
*/
|
|
2031
|
-
billingCountryCode?: string | null;
|
|
2711
|
+
amount: number;
|
|
2032
2712
|
/**
|
|
2033
2713
|
* The price currency
|
|
2034
2714
|
*/
|
|
2035
|
-
currency
|
|
2715
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
2036
2716
|
}
|
|
2037
2717
|
/**
|
|
2038
2718
|
* The unit price of the price tier
|
|
@@ -2041,15 +2721,11 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
2041
2721
|
/**
|
|
2042
2722
|
* The price amount
|
|
2043
2723
|
*/
|
|
2044
|
-
amount
|
|
2045
|
-
/**
|
|
2046
|
-
* The billing country code of the price
|
|
2047
|
-
*/
|
|
2048
|
-
billingCountryCode?: string | null;
|
|
2724
|
+
amount: number;
|
|
2049
2725
|
/**
|
|
2050
2726
|
* The price currency
|
|
2051
2727
|
*/
|
|
2052
|
-
currency
|
|
2728
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
2053
2729
|
}
|
|
2054
2730
|
}
|
|
2055
2731
|
}
|
|
@@ -2087,7 +2763,7 @@ export interface SubscriptionTransferParams {
|
|
|
2087
2763
|
}
|
|
2088
2764
|
export declare namespace Subscriptions {
|
|
2089
2765
|
export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
|
|
2090
|
-
export {
|
|
2766
|
+
export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription };
|
|
2091
2767
|
export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, };
|
|
2092
2768
|
export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
|
|
2093
2769
|
}
|