@stigg/typescript 0.1.0-alpha.21 → 0.1.0-alpha.23

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.
Files changed (112) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/package.json +1 -1
  3. package/resources/v1/addons/addons.d.mts +493 -970
  4. package/resources/v1/addons/addons.d.mts.map +1 -1
  5. package/resources/v1/addons/addons.d.ts +493 -970
  6. package/resources/v1/addons/addons.d.ts.map +1 -1
  7. package/resources/v1/addons/addons.js +0 -6
  8. package/resources/v1/addons/addons.js.map +1 -1
  9. package/resources/v1/addons/addons.mjs +0 -6
  10. package/resources/v1/addons/addons.mjs.map +1 -1
  11. package/resources/v1/addons/entitlements.d.mts +28 -0
  12. package/resources/v1/addons/entitlements.d.mts.map +1 -1
  13. package/resources/v1/addons/entitlements.d.ts +28 -0
  14. package/resources/v1/addons/entitlements.d.ts.map +1 -1
  15. package/resources/v1/addons/index.d.mts +1 -1
  16. package/resources/v1/addons/index.d.mts.map +1 -1
  17. package/resources/v1/addons/index.d.ts +1 -1
  18. package/resources/v1/addons/index.d.ts.map +1 -1
  19. package/resources/v1/addons/index.js.map +1 -1
  20. package/resources/v1/addons/index.mjs.map +1 -1
  21. package/resources/v1/coupons.d.mts +3 -3
  22. package/resources/v1/coupons.d.ts +3 -3
  23. package/resources/v1/customers/customers.d.mts +935 -5
  24. package/resources/v1/customers/customers.d.mts.map +1 -1
  25. package/resources/v1/customers/customers.d.ts +935 -5
  26. package/resources/v1/customers/customers.d.ts.map +1 -1
  27. package/resources/v1/customers/customers.js +7 -0
  28. package/resources/v1/customers/customers.js.map +1 -1
  29. package/resources/v1/customers/customers.mjs +7 -0
  30. package/resources/v1/customers/customers.mjs.map +1 -1
  31. package/resources/v1/customers/index.d.mts +1 -1
  32. package/resources/v1/customers/index.d.mts.map +1 -1
  33. package/resources/v1/customers/index.d.ts +1 -1
  34. package/resources/v1/customers/index.d.ts.map +1 -1
  35. package/resources/v1/customers/index.js.map +1 -1
  36. package/resources/v1/customers/index.mjs.map +1 -1
  37. package/resources/v1/events/credits/credits.d.mts +1 -1
  38. package/resources/v1/events/credits/credits.d.mts.map +1 -1
  39. package/resources/v1/events/credits/credits.d.ts +1 -1
  40. package/resources/v1/events/credits/credits.d.ts.map +1 -1
  41. package/resources/v1/events/credits/credits.js.map +1 -1
  42. package/resources/v1/events/credits/credits.mjs.map +1 -1
  43. package/resources/v1/events/credits/grants.d.mts +1 -1
  44. package/resources/v1/events/credits/grants.d.ts +1 -1
  45. package/resources/v1/features.d.mts +9 -0
  46. package/resources/v1/features.d.mts.map +1 -1
  47. package/resources/v1/features.d.ts +9 -0
  48. package/resources/v1/features.d.ts.map +1 -1
  49. package/resources/v1/index.d.mts +3 -3
  50. package/resources/v1/index.d.mts.map +1 -1
  51. package/resources/v1/index.d.ts +3 -3
  52. package/resources/v1/index.d.ts.map +1 -1
  53. package/resources/v1/index.js.map +1 -1
  54. package/resources/v1/index.mjs.map +1 -1
  55. package/resources/v1/plans/entitlements.d.mts +28 -0
  56. package/resources/v1/plans/entitlements.d.mts.map +1 -1
  57. package/resources/v1/plans/entitlements.d.ts +28 -0
  58. package/resources/v1/plans/entitlements.d.ts.map +1 -1
  59. package/resources/v1/plans/index.d.mts +1 -1
  60. package/resources/v1/plans/index.d.mts.map +1 -1
  61. package/resources/v1/plans/index.d.ts +1 -1
  62. package/resources/v1/plans/index.d.ts.map +1 -1
  63. package/resources/v1/plans/index.js.map +1 -1
  64. package/resources/v1/plans/index.mjs.map +1 -1
  65. package/resources/v1/plans/plans.d.mts +392 -391
  66. package/resources/v1/plans/plans.d.mts.map +1 -1
  67. package/resources/v1/plans/plans.d.ts +392 -391
  68. package/resources/v1/plans/plans.d.ts.map +1 -1
  69. package/resources/v1/plans/plans.js +0 -7
  70. package/resources/v1/plans/plans.js.map +1 -1
  71. package/resources/v1/plans/plans.mjs +0 -7
  72. package/resources/v1/plans/plans.mjs.map +1 -1
  73. package/resources/v1/products.d.mts +9 -5
  74. package/resources/v1/products.d.mts.map +1 -1
  75. package/resources/v1/products.d.ts +9 -5
  76. package/resources/v1/products.d.ts.map +1 -1
  77. package/resources/v1/subscriptions/subscriptions.d.mts +31 -21
  78. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  79. package/resources/v1/subscriptions/subscriptions.d.ts +31 -21
  80. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  81. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  82. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  83. package/resources/v1/usage.d.mts +1 -1
  84. package/resources/v1/usage.d.ts +1 -1
  85. package/resources/v1/v1.d.mts +6 -6
  86. package/resources/v1/v1.d.mts.map +1 -1
  87. package/resources/v1/v1.d.ts +6 -6
  88. package/resources/v1/v1.d.ts.map +1 -1
  89. package/resources/v1/v1.js.map +1 -1
  90. package/resources/v1/v1.mjs.map +1 -1
  91. package/src/resources/v1/addons/addons.ts +1111 -2508
  92. package/src/resources/v1/addons/entitlements.ts +33 -0
  93. package/src/resources/v1/addons/index.ts +0 -3
  94. package/src/resources/v1/coupons.ts +3 -3
  95. package/src/resources/v1/customers/customers.ts +2064 -4
  96. package/src/resources/v1/customers/index.ts +2 -0
  97. package/src/resources/v1/events/credits/credits.ts +3 -1
  98. package/src/resources/v1/events/credits/grants.ts +1 -1
  99. package/src/resources/v1/features.ts +9 -0
  100. package/src/resources/v1/index.ts +2 -4
  101. package/src/resources/v1/plans/entitlements.ts +33 -0
  102. package/src/resources/v1/plans/index.ts +0 -1
  103. package/src/resources/v1/plans/plans.ts +924 -930
  104. package/src/resources/v1/products.ts +9 -5
  105. package/src/resources/v1/subscriptions/subscriptions.ts +28 -22
  106. package/src/resources/v1/usage.ts +1 -1
  107. package/src/resources/v1/v1.ts +4 -8
  108. package/src/version.ts +1 -1
  109. package/version.d.mts +1 -1
  110. package/version.d.ts +1 -1
  111. package/version.js +1 -1
  112. package/version.mjs +1 -1
@@ -85,17 +85,6 @@ export class Addons extends APIResource {
85
85
  removeDraft(id: string, options?: RequestOptions): APIPromise<AddonRemoveDraftResponse> {
86
86
  return this._client.delete(path`/api/v1/addons/${id}/draft`, options);
87
87
  }
88
-
89
- /**
90
- * Sets the pricing configuration for an addon.
91
- */
92
- setPricing(
93
- id: string,
94
- body: AddonSetPricingParams,
95
- options?: RequestOptions,
96
- ): APIPromise<SetPackagePricingResponse> {
97
- return this._client.put(path`/api/v1/addons/${id}/charges`, { body, ...options });
98
- }
99
88
  }
100
89
 
101
90
  export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
@@ -207,290 +196,277 @@ export namespace Addon {
207
196
  }
208
197
 
209
198
  /**
210
- * Request to set the pricing configuration for a plan or addon.
199
+ * Addon configuration object
211
200
  */
212
- export interface SetPackagePricing {
201
+ export interface AddonListResponse {
202
+ /**
203
+ * The unique identifier for the entity
204
+ */
205
+ id: string;
206
+
207
+ /**
208
+ * The unique identifier for the entity in the billing provider
209
+ */
210
+ billingId: string | null;
211
+
212
+ /**
213
+ * Timestamp of when the record was created
214
+ */
215
+ createdAt: string;
216
+
217
+ /**
218
+ * List of addons the addon is dependant on
219
+ */
220
+ dependencies: Array<string> | null;
221
+
222
+ /**
223
+ * The description of the package
224
+ */
225
+ description: string | null;
226
+
213
227
  /**
214
- * The pricing type (FREE, PAID, or CUSTOM)
228
+ * The display name of the package
229
+ */
230
+ displayName: string;
231
+
232
+ /**
233
+ * List of entitlements of the package
234
+ */
235
+ entitlements: Array<AddonListResponse.Entitlement>;
236
+
237
+ /**
238
+ * Indicates if the package is the latest version
239
+ */
240
+ isLatest: boolean | null;
241
+
242
+ /**
243
+ * The maximum quantity of this addon that can be added to a subscription
215
244
  */
216
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
245
+ maxQuantity: number | null;
246
+
247
+ /**
248
+ * Metadata associated with the entity
249
+ */
250
+ metadata: { [key: string]: string };
217
251
 
218
252
  /**
219
- * Deprecated: billing integration ID
253
+ * The pricing type of the package
220
254
  */
221
- billingId?: string;
255
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
222
256
 
223
257
  /**
224
- * Minimum spend configuration per billing period
258
+ * The product id of the package
225
259
  */
226
- minimumSpend?: Array<SetPackagePricing.MinimumSpend> | null;
260
+ productId: string;
227
261
 
228
262
  /**
229
- * When overage charges are billed
263
+ * The status of the package
230
264
  */
231
- overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
265
+ status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
232
266
 
233
267
  /**
234
- * Array of overage pricing model configurations
268
+ * Timestamp of when the record was last updated
235
269
  */
236
- overagePricingModels?: Array<SetPackagePricing.OveragePricingModel>;
270
+ updatedAt: string;
237
271
 
238
272
  /**
239
- * Array of pricing model configurations
273
+ * The version number of the package
240
274
  */
241
- pricingModels?: Array<SetPackagePricing.PricingModel>;
275
+ versionNumber: number;
242
276
  }
243
277
 
244
- export namespace SetPackagePricing {
278
+ export namespace AddonListResponse {
245
279
  /**
246
- * Minimum spend configuration for a billing period.
280
+ * Entitlement reference with type and identifier
247
281
  */
248
- export interface MinimumSpend {
282
+ export interface Entitlement {
249
283
  /**
250
- * The billing period
284
+ * The unique identifier for the entity
251
285
  */
252
- billingPeriod: 'MONTHLY' | 'ANNUALLY';
286
+ id: string;
287
+
288
+ type: 'FEATURE' | 'CREDIT';
289
+ }
290
+ }
291
+
292
+ /**
293
+ * Response containing task ID for publish operation
294
+ */
295
+ export interface AddonPublishResponse {
296
+ data: AddonPublishResponse.Data;
297
+ }
253
298
 
299
+ export namespace AddonPublishResponse {
300
+ export interface Data {
254
301
  /**
255
- * The minimum spend amount
302
+ * Task ID for tracking the async publish operation
256
303
  */
257
- minimum: MinimumSpend.Minimum;
304
+ taskId: string | null;
258
305
  }
306
+ }
307
+
308
+ /**
309
+ * Response confirming the addon draft was removed.
310
+ */
311
+ export interface AddonRemoveDraftResponse {
312
+ data: AddonRemoveDraftResponse.Data;
313
+ }
259
314
 
260
- export namespace MinimumSpend {
315
+ export namespace AddonRemoveDraftResponse {
316
+ export interface Data {
261
317
  /**
262
- * The minimum spend amount
318
+ * The unique identifier for the entity
263
319
  */
264
- export interface Minimum {
265
- /**
266
- * The price amount
267
- */
268
- amount: number;
269
-
270
- /**
271
- * The price currency
272
- */
273
- currency?:
274
- | 'usd'
275
- | 'aed'
276
- | 'all'
277
- | 'amd'
278
- | 'ang'
279
- | 'aud'
280
- | 'awg'
281
- | 'azn'
282
- | 'bam'
283
- | 'bbd'
284
- | 'bdt'
285
- | 'bgn'
286
- | 'bif'
287
- | 'bmd'
288
- | 'bnd'
289
- | 'bsd'
290
- | 'bwp'
291
- | 'byn'
292
- | 'bzd'
293
- | 'brl'
294
- | 'cad'
295
- | 'cdf'
296
- | 'chf'
297
- | 'cny'
298
- | 'czk'
299
- | 'dkk'
300
- | 'dop'
301
- | 'dzd'
302
- | 'egp'
303
- | 'etb'
304
- | 'eur'
305
- | 'fjd'
306
- | 'gbp'
307
- | 'gel'
308
- | 'gip'
309
- | 'gmd'
310
- | 'gyd'
311
- | 'hkd'
312
- | 'hrk'
313
- | 'htg'
314
- | 'idr'
315
- | 'ils'
316
- | 'inr'
317
- | 'isk'
318
- | 'jmd'
319
- | 'jpy'
320
- | 'kes'
321
- | 'kgs'
322
- | 'khr'
323
- | 'kmf'
324
- | 'krw'
325
- | 'kyd'
326
- | 'kzt'
327
- | 'lbp'
328
- | 'lkr'
329
- | 'lrd'
330
- | 'lsl'
331
- | 'mad'
332
- | 'mdl'
333
- | 'mga'
334
- | 'mkd'
335
- | 'mmk'
336
- | 'mnt'
337
- | 'mop'
338
- | 'mro'
339
- | 'mvr'
340
- | 'mwk'
341
- | 'mxn'
342
- | 'myr'
343
- | 'mzn'
344
- | 'nad'
345
- | 'ngn'
346
- | 'nok'
347
- | 'npr'
348
- | 'nzd'
349
- | 'pgk'
350
- | 'php'
351
- | 'pkr'
352
- | 'pln'
353
- | 'qar'
354
- | 'ron'
355
- | 'rsd'
356
- | 'rub'
357
- | 'rwf'
358
- | 'sar'
359
- | 'sbd'
360
- | 'scr'
361
- | 'sek'
362
- | 'sgd'
363
- | 'sle'
364
- | 'sll'
365
- | 'sos'
366
- | 'szl'
367
- | 'thb'
368
- | 'tjs'
369
- | 'top'
370
- | 'try'
371
- | 'ttd'
372
- | 'tzs'
373
- | 'uah'
374
- | 'uzs'
375
- | 'vnd'
376
- | 'vuv'
377
- | 'wst'
378
- | 'xaf'
379
- | 'xcd'
380
- | 'yer'
381
- | 'zar'
382
- | 'zmw'
383
- | 'clp'
384
- | 'djf'
385
- | 'gnf'
386
- | 'ugx'
387
- | 'pyg'
388
- | 'xof'
389
- | 'xpf';
390
- }
320
+ id: string;
391
321
  }
322
+ }
323
+
324
+ export interface AddonCreateParams {
325
+ /**
326
+ * The unique identifier for the entity
327
+ */
328
+ id: string;
329
+
330
+ /**
331
+ * The display name of the package
332
+ */
333
+ displayName: string;
334
+
335
+ /**
336
+ * The product id of the package
337
+ */
338
+ productId: string;
339
+
340
+ /**
341
+ * The unique identifier for the entity in the billing provider
342
+ */
343
+ billingId?: string | null;
344
+
345
+ /**
346
+ * The description of the package
347
+ */
348
+ description?: string | null;
349
+
350
+ /**
351
+ * The maximum quantity of this addon that can be added to a subscription
352
+ */
353
+ maxQuantity?: number | null;
354
+
355
+ /**
356
+ * Metadata associated with the entity
357
+ */
358
+ metadata?: { [key: string]: string };
359
+
360
+ /**
361
+ * The pricing type of the package
362
+ */
363
+ pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
364
+
365
+ /**
366
+ * The status of the package
367
+ */
368
+ status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
369
+ }
370
+
371
+ export interface AddonUpdateParams {
372
+ /**
373
+ * The unique identifier for the entity in the billing provider
374
+ */
375
+ billingId?: string | null;
376
+
377
+ /**
378
+ * Pricing configuration to set on the addon draft
379
+ */
380
+ charges?: AddonUpdateParams.Charges;
381
+
382
+ /**
383
+ * List of addons the addon is dependant on
384
+ */
385
+ dependencies?: Array<string> | null;
386
+
387
+ /**
388
+ * The description of the package
389
+ */
390
+ description?: string | null;
391
+
392
+ /**
393
+ * The display name of the package
394
+ */
395
+ displayName?: string;
396
+
397
+ /**
398
+ * The maximum quantity of this addon that can be added to a subscription
399
+ */
400
+ maxQuantity?: number | null;
401
+
402
+ /**
403
+ * Metadata associated with the entity
404
+ */
405
+ metadata?: { [key: string]: string };
392
406
 
393
407
  /**
394
- * Overage pricing model configuration.
408
+ * The status of the package
409
+ */
410
+ status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
411
+ }
412
+
413
+ export namespace AddonUpdateParams {
414
+ /**
415
+ * Pricing configuration to set on the addon draft
395
416
  */
396
- export interface OveragePricingModel {
417
+ export interface Charges {
397
418
  /**
398
- * The billing model for overages
419
+ * The pricing type (FREE, PAID, or CUSTOM)
399
420
  */
400
- billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
421
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
401
422
 
402
423
  /**
403
- * Price periods for overage pricing
424
+ * Deprecated: billing integration ID
404
425
  */
405
- pricePeriods: Array<OveragePricingModel.PricePeriod>;
426
+ billingId?: string;
406
427
 
407
428
  /**
408
- * The billing cadence for overages
429
+ * Minimum spend configuration per billing period
409
430
  */
410
- billingCadence?: 'RECURRING' | 'ONE_OFF';
431
+ minimumSpend?: Array<Charges.MinimumSpend> | null;
411
432
 
412
433
  /**
413
- * Entitlement configuration for the overage feature
434
+ * When overage charges are billed
414
435
  */
415
- entitlement?: OveragePricingModel.Entitlement;
436
+ overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
416
437
 
417
438
  /**
418
- * The feature ID for overage pricing
439
+ * Array of overage pricing model configurations
419
440
  */
420
- featureId?: string;
441
+ overagePricingModels?: Array<Charges.OveragePricingModel>;
421
442
 
422
443
  /**
423
- * Custom currency ID for overage top-up
444
+ * Array of pricing model configurations
424
445
  */
425
- topUpCustomCurrencyId?: string;
446
+ pricingModels?: Array<Charges.PricingModel>;
426
447
  }
427
448
 
428
- export namespace OveragePricingModel {
449
+ export namespace Charges {
429
450
  /**
430
- * Price configuration for a specific billing period.
451
+ * Minimum spend configuration for a billing period.
431
452
  */
432
- export interface PricePeriod {
453
+ export interface MinimumSpend {
433
454
  /**
434
- * The billing period (MONTHLY or ANNUALLY)
455
+ * The billing period
435
456
  */
436
457
  billingPeriod: 'MONTHLY' | 'ANNUALLY';
437
458
 
438
459
  /**
439
- * ISO country code for localized pricing
440
- */
441
- billingCountryCode?: string;
442
-
443
- /**
444
- * Block size for usage-based pricing
445
- */
446
- blockSize?: number;
447
-
448
- /**
449
- * When credits are granted
450
- */
451
- creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
452
-
453
- /**
454
- * Credit rate configuration for credit-based pricing
460
+ * The minimum spend amount
455
461
  */
456
- creditRate?: PricePeriod.CreditRate;
457
-
458
- /**
459
- * The price amount and currency
460
- */
461
- price?: PricePeriod.Price;
462
-
463
- /**
464
- * Tiered pricing configuration
465
- */
466
- tiers?: Array<PricePeriod.Tier>;
462
+ minimum: MinimumSpend.Minimum;
467
463
  }
468
464
 
469
- export namespace PricePeriod {
470
- /**
471
- * Credit rate configuration for credit-based pricing
472
- */
473
- export interface CreditRate {
474
- /**
475
- * The credit rate amount
476
- */
477
- amount: number;
478
-
479
- /**
480
- * The custom currency ID
481
- */
482
- currencyId: string;
483
-
484
- /**
485
- * Optional cost formula expression
486
- */
487
- costFormula?: string;
488
- }
489
-
465
+ export namespace MinimumSpend {
490
466
  /**
491
- * The price amount and currency
467
+ * The minimum spend amount
492
468
  */
493
- export interface Price {
469
+ export interface Minimum {
494
470
  /**
495
471
  * The price amount
496
472
  */
@@ -617,41 +593,118 @@ export namespace SetPackagePricing {
617
593
  | 'xof'
618
594
  | 'xpf';
619
595
  }
596
+ }
597
+
598
+ /**
599
+ * Overage pricing model configuration.
600
+ */
601
+ export interface OveragePricingModel {
602
+ /**
603
+ * The billing model for overages
604
+ */
605
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
606
+
607
+ /**
608
+ * Price periods for overage pricing
609
+ */
610
+ pricePeriods: Array<OveragePricingModel.PricePeriod>;
611
+
612
+ /**
613
+ * The billing cadence for overages
614
+ */
615
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
616
+
617
+ /**
618
+ * Entitlement configuration for the overage feature
619
+ */
620
+ entitlement?: OveragePricingModel.Entitlement;
621
+
622
+ /**
623
+ * The feature ID for overage pricing
624
+ */
625
+ featureId?: string;
626
+
627
+ /**
628
+ * Custom currency ID for overage top-up
629
+ */
630
+ topUpCustomCurrencyId?: string;
631
+ }
620
632
 
633
+ export namespace OveragePricingModel {
621
634
  /**
622
- * A tier in tiered pricing.
635
+ * Price configuration for a specific billing period.
623
636
  */
624
- export interface Tier {
637
+ export interface PricePeriod {
638
+ /**
639
+ * The billing period (MONTHLY or ANNUALLY)
640
+ */
641
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
642
+
643
+ /**
644
+ * ISO country code for localized pricing
645
+ */
646
+ billingCountryCode?: string;
647
+
648
+ /**
649
+ * Block size for usage-based pricing
650
+ */
651
+ blockSize?: number;
652
+
653
+ /**
654
+ * When credits are granted
655
+ */
656
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
657
+
625
658
  /**
626
- * Flat price for this tier
659
+ * Credit rate configuration for credit-based pricing
627
660
  */
628
- flatPrice?: Tier.FlatPrice;
661
+ creditRate?: PricePeriod.CreditRate;
629
662
 
630
663
  /**
631
- * Per-unit price in this tier
664
+ * The price amount and currency
632
665
  */
633
- unitPrice?: Tier.UnitPrice;
666
+ price?: PricePeriod.Price;
634
667
 
635
668
  /**
636
- * Upper bound of this tier (null for unlimited)
669
+ * Tiered pricing configuration
637
670
  */
638
- upTo?: number;
671
+ tiers?: Array<PricePeriod.Tier>;
639
672
  }
640
673
 
641
- export namespace Tier {
674
+ export namespace PricePeriod {
642
675
  /**
643
- * Flat price for this tier
676
+ * Credit rate configuration for credit-based pricing
644
677
  */
645
- export interface FlatPrice {
678
+ export interface CreditRate {
646
679
  /**
647
- * The price amount
680
+ * The credit rate amount
648
681
  */
649
682
  amount: number;
650
683
 
651
684
  /**
652
- * The price currency
685
+ * The custom currency ID
653
686
  */
654
- currency?:
687
+ currencyId: string;
688
+
689
+ /**
690
+ * Optional cost formula expression
691
+ */
692
+ costFormula?: string;
693
+ }
694
+
695
+ /**
696
+ * The price amount and currency
697
+ */
698
+ export interface Price {
699
+ /**
700
+ * The price amount
701
+ */
702
+ amount: number;
703
+
704
+ /**
705
+ * The price currency
706
+ */
707
+ currency?:
655
708
  | 'usd'
656
709
  | 'aed'
657
710
  | 'all'
@@ -771,9 +824,507 @@ export namespace SetPackagePricing {
771
824
  }
772
825
 
773
826
  /**
774
- * Per-unit price in this tier
827
+ * A tier in tiered pricing.
828
+ */
829
+ export interface Tier {
830
+ /**
831
+ * Flat price for this tier
832
+ */
833
+ flatPrice?: Tier.FlatPrice;
834
+
835
+ /**
836
+ * Per-unit price in this tier
837
+ */
838
+ unitPrice?: Tier.UnitPrice;
839
+
840
+ /**
841
+ * Upper bound of this tier (null for unlimited)
842
+ */
843
+ upTo?: number;
844
+ }
845
+
846
+ export namespace Tier {
847
+ /**
848
+ * Flat price for this tier
849
+ */
850
+ export interface FlatPrice {
851
+ /**
852
+ * The price amount
853
+ */
854
+ amount: number;
855
+
856
+ /**
857
+ * The price currency
858
+ */
859
+ currency?:
860
+ | 'usd'
861
+ | 'aed'
862
+ | 'all'
863
+ | 'amd'
864
+ | 'ang'
865
+ | 'aud'
866
+ | 'awg'
867
+ | 'azn'
868
+ | 'bam'
869
+ | 'bbd'
870
+ | 'bdt'
871
+ | 'bgn'
872
+ | 'bif'
873
+ | 'bmd'
874
+ | 'bnd'
875
+ | 'bsd'
876
+ | 'bwp'
877
+ | 'byn'
878
+ | 'bzd'
879
+ | 'brl'
880
+ | 'cad'
881
+ | 'cdf'
882
+ | 'chf'
883
+ | 'cny'
884
+ | 'czk'
885
+ | 'dkk'
886
+ | 'dop'
887
+ | 'dzd'
888
+ | 'egp'
889
+ | 'etb'
890
+ | 'eur'
891
+ | 'fjd'
892
+ | 'gbp'
893
+ | 'gel'
894
+ | 'gip'
895
+ | 'gmd'
896
+ | 'gyd'
897
+ | 'hkd'
898
+ | 'hrk'
899
+ | 'htg'
900
+ | 'idr'
901
+ | 'ils'
902
+ | 'inr'
903
+ | 'isk'
904
+ | 'jmd'
905
+ | 'jpy'
906
+ | 'kes'
907
+ | 'kgs'
908
+ | 'khr'
909
+ | 'kmf'
910
+ | 'krw'
911
+ | 'kyd'
912
+ | 'kzt'
913
+ | 'lbp'
914
+ | 'lkr'
915
+ | 'lrd'
916
+ | 'lsl'
917
+ | 'mad'
918
+ | 'mdl'
919
+ | 'mga'
920
+ | 'mkd'
921
+ | 'mmk'
922
+ | 'mnt'
923
+ | 'mop'
924
+ | 'mro'
925
+ | 'mvr'
926
+ | 'mwk'
927
+ | 'mxn'
928
+ | 'myr'
929
+ | 'mzn'
930
+ | 'nad'
931
+ | 'ngn'
932
+ | 'nok'
933
+ | 'npr'
934
+ | 'nzd'
935
+ | 'pgk'
936
+ | 'php'
937
+ | 'pkr'
938
+ | 'pln'
939
+ | 'qar'
940
+ | 'ron'
941
+ | 'rsd'
942
+ | 'rub'
943
+ | 'rwf'
944
+ | 'sar'
945
+ | 'sbd'
946
+ | 'scr'
947
+ | 'sek'
948
+ | 'sgd'
949
+ | 'sle'
950
+ | 'sll'
951
+ | 'sos'
952
+ | 'szl'
953
+ | 'thb'
954
+ | 'tjs'
955
+ | 'top'
956
+ | 'try'
957
+ | 'ttd'
958
+ | 'tzs'
959
+ | 'uah'
960
+ | 'uzs'
961
+ | 'vnd'
962
+ | 'vuv'
963
+ | 'wst'
964
+ | 'xaf'
965
+ | 'xcd'
966
+ | 'yer'
967
+ | 'zar'
968
+ | 'zmw'
969
+ | 'clp'
970
+ | 'djf'
971
+ | 'gnf'
972
+ | 'ugx'
973
+ | 'pyg'
974
+ | 'xof'
975
+ | 'xpf';
976
+ }
977
+
978
+ /**
979
+ * Per-unit price in this tier
980
+ */
981
+ export interface UnitPrice {
982
+ /**
983
+ * The price amount
984
+ */
985
+ amount: number;
986
+
987
+ /**
988
+ * The price currency
989
+ */
990
+ currency?:
991
+ | 'usd'
992
+ | 'aed'
993
+ | 'all'
994
+ | 'amd'
995
+ | 'ang'
996
+ | 'aud'
997
+ | 'awg'
998
+ | 'azn'
999
+ | 'bam'
1000
+ | 'bbd'
1001
+ | 'bdt'
1002
+ | 'bgn'
1003
+ | 'bif'
1004
+ | 'bmd'
1005
+ | 'bnd'
1006
+ | 'bsd'
1007
+ | 'bwp'
1008
+ | 'byn'
1009
+ | 'bzd'
1010
+ | 'brl'
1011
+ | 'cad'
1012
+ | 'cdf'
1013
+ | 'chf'
1014
+ | 'cny'
1015
+ | 'czk'
1016
+ | 'dkk'
1017
+ | 'dop'
1018
+ | 'dzd'
1019
+ | 'egp'
1020
+ | 'etb'
1021
+ | 'eur'
1022
+ | 'fjd'
1023
+ | 'gbp'
1024
+ | 'gel'
1025
+ | 'gip'
1026
+ | 'gmd'
1027
+ | 'gyd'
1028
+ | 'hkd'
1029
+ | 'hrk'
1030
+ | 'htg'
1031
+ | 'idr'
1032
+ | 'ils'
1033
+ | 'inr'
1034
+ | 'isk'
1035
+ | 'jmd'
1036
+ | 'jpy'
1037
+ | 'kes'
1038
+ | 'kgs'
1039
+ | 'khr'
1040
+ | 'kmf'
1041
+ | 'krw'
1042
+ | 'kyd'
1043
+ | 'kzt'
1044
+ | 'lbp'
1045
+ | 'lkr'
1046
+ | 'lrd'
1047
+ | 'lsl'
1048
+ | 'mad'
1049
+ | 'mdl'
1050
+ | 'mga'
1051
+ | 'mkd'
1052
+ | 'mmk'
1053
+ | 'mnt'
1054
+ | 'mop'
1055
+ | 'mro'
1056
+ | 'mvr'
1057
+ | 'mwk'
1058
+ | 'mxn'
1059
+ | 'myr'
1060
+ | 'mzn'
1061
+ | 'nad'
1062
+ | 'ngn'
1063
+ | 'nok'
1064
+ | 'npr'
1065
+ | 'nzd'
1066
+ | 'pgk'
1067
+ | 'php'
1068
+ | 'pkr'
1069
+ | 'pln'
1070
+ | 'qar'
1071
+ | 'ron'
1072
+ | 'rsd'
1073
+ | 'rub'
1074
+ | 'rwf'
1075
+ | 'sar'
1076
+ | 'sbd'
1077
+ | 'scr'
1078
+ | 'sek'
1079
+ | 'sgd'
1080
+ | 'sle'
1081
+ | 'sll'
1082
+ | 'sos'
1083
+ | 'szl'
1084
+ | 'thb'
1085
+ | 'tjs'
1086
+ | 'top'
1087
+ | 'try'
1088
+ | 'ttd'
1089
+ | 'tzs'
1090
+ | 'uah'
1091
+ | 'uzs'
1092
+ | 'vnd'
1093
+ | 'vuv'
1094
+ | 'wst'
1095
+ | 'xaf'
1096
+ | 'xcd'
1097
+ | 'yer'
1098
+ | 'zar'
1099
+ | 'zmw'
1100
+ | 'clp'
1101
+ | 'djf'
1102
+ | 'gnf'
1103
+ | 'ugx'
1104
+ | 'pyg'
1105
+ | 'xof'
1106
+ | 'xpf';
1107
+ }
1108
+ }
1109
+ }
1110
+
1111
+ /**
1112
+ * Entitlement configuration for the overage feature
1113
+ */
1114
+ export interface Entitlement {
1115
+ /**
1116
+ * The feature ID for the entitlement
1117
+ */
1118
+ featureId: string;
1119
+
1120
+ /**
1121
+ * Whether the limit is soft (allows overage)
1122
+ */
1123
+ hasSoftLimit?: boolean;
1124
+
1125
+ /**
1126
+ * Whether usage is unlimited
1127
+ */
1128
+ hasUnlimitedUsage?: boolean;
1129
+
1130
+ /**
1131
+ * Monthly reset configuration
1132
+ */
1133
+ monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
1134
+
1135
+ /**
1136
+ * The usage reset period
1137
+ */
1138
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1139
+
1140
+ /**
1141
+ * The usage limit before overage kicks in
1142
+ */
1143
+ usageLimit?: number;
1144
+
1145
+ /**
1146
+ * Weekly reset configuration
1147
+ */
1148
+ weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
1149
+
1150
+ /**
1151
+ * Yearly reset configuration
1152
+ */
1153
+ yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
1154
+ }
1155
+
1156
+ export namespace Entitlement {
1157
+ /**
1158
+ * Monthly reset configuration
1159
+ */
1160
+ export interface MonthlyResetPeriodConfiguration {
1161
+ /**
1162
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
1163
+ */
1164
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1165
+ }
1166
+
1167
+ /**
1168
+ * Weekly reset configuration
1169
+ */
1170
+ export interface WeeklyResetPeriodConfiguration {
1171
+ /**
1172
+ * Reset anchor (SubscriptionStart or specific day)
1173
+ */
1174
+ accordingTo:
1175
+ | 'SubscriptionStart'
1176
+ | 'EverySunday'
1177
+ | 'EveryMonday'
1178
+ | 'EveryTuesday'
1179
+ | 'EveryWednesday'
1180
+ | 'EveryThursday'
1181
+ | 'EveryFriday'
1182
+ | 'EverySaturday';
1183
+ }
1184
+
1185
+ /**
1186
+ * Yearly reset configuration
1187
+ */
1188
+ export interface YearlyResetPeriodConfiguration {
1189
+ /**
1190
+ * Reset anchor (SubscriptionStart)
1191
+ */
1192
+ accordingTo: 'SubscriptionStart';
1193
+ }
1194
+ }
1195
+ }
1196
+
1197
+ /**
1198
+ * A pricing model configuration with billing details and price periods.
1199
+ */
1200
+ export interface PricingModel {
1201
+ /**
1202
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
1203
+ */
1204
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
1205
+
1206
+ /**
1207
+ * Array of price period configurations (at least one required)
1208
+ */
1209
+ pricePeriods: Array<PricingModel.PricePeriod>;
1210
+
1211
+ /**
1212
+ * The billing cadence (RECURRING or ONE_OFF)
1213
+ */
1214
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
1215
+
1216
+ /**
1217
+ * The feature ID this pricing model is associated with
1218
+ */
1219
+ featureId?: string;
1220
+
1221
+ /**
1222
+ * Maximum number of units (max 999999)
1223
+ */
1224
+ maxUnitQuantity?: number;
1225
+
1226
+ /**
1227
+ * Minimum number of units
1228
+ */
1229
+ minUnitQuantity?: number;
1230
+
1231
+ /**
1232
+ * Monthly reset period configuration
1233
+ */
1234
+ monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
1235
+
1236
+ /**
1237
+ * The usage reset period
1238
+ */
1239
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1240
+
1241
+ /**
1242
+ * The tiered pricing mode (VOLUME or GRADUATED)
1243
+ */
1244
+ tiersMode?: 'VOLUME' | 'GRADUATED';
1245
+
1246
+ /**
1247
+ * The custom currency ID for top-up pricing
1248
+ */
1249
+ topUpCustomCurrencyId?: string;
1250
+
1251
+ /**
1252
+ * Weekly reset period configuration
1253
+ */
1254
+ weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
1255
+
1256
+ /**
1257
+ * Yearly reset period configuration
1258
+ */
1259
+ yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
1260
+ }
1261
+
1262
+ export namespace PricingModel {
1263
+ /**
1264
+ * Price configuration for a specific billing period.
1265
+ */
1266
+ export interface PricePeriod {
1267
+ /**
1268
+ * The billing period (MONTHLY or ANNUALLY)
1269
+ */
1270
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
1271
+
1272
+ /**
1273
+ * ISO country code for localized pricing
1274
+ */
1275
+ billingCountryCode?: string;
1276
+
1277
+ /**
1278
+ * Block size for usage-based pricing
1279
+ */
1280
+ blockSize?: number;
1281
+
1282
+ /**
1283
+ * When credits are granted
1284
+ */
1285
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1286
+
1287
+ /**
1288
+ * Credit rate configuration for credit-based pricing
1289
+ */
1290
+ creditRate?: PricePeriod.CreditRate;
1291
+
1292
+ /**
1293
+ * The price amount and currency
1294
+ */
1295
+ price?: PricePeriod.Price;
1296
+
1297
+ /**
1298
+ * Tiered pricing configuration
1299
+ */
1300
+ tiers?: Array<PricePeriod.Tier>;
1301
+ }
1302
+
1303
+ export namespace PricePeriod {
1304
+ /**
1305
+ * Credit rate configuration for credit-based pricing
1306
+ */
1307
+ export interface CreditRate {
1308
+ /**
1309
+ * The credit rate amount
1310
+ */
1311
+ amount: number;
1312
+
1313
+ /**
1314
+ * The custom currency ID
1315
+ */
1316
+ currencyId: string;
1317
+
1318
+ /**
1319
+ * Optional cost formula expression
1320
+ */
1321
+ costFormula?: string;
1322
+ }
1323
+
1324
+ /**
1325
+ * The price amount and currency
775
1326
  */
776
- export interface UnitPrice {
1327
+ export interface Price {
777
1328
  /**
778
1329
  * The price amount
779
1330
  */
@@ -900,57 +1451,294 @@ export namespace SetPackagePricing {
900
1451
  | 'xof'
901
1452
  | 'xpf';
902
1453
  }
903
- }
904
- }
905
-
906
- /**
907
- * Entitlement configuration for the overage feature
908
- */
909
- export interface Entitlement {
910
- /**
911
- * The feature ID for the entitlement
912
- */
913
- featureId: string;
914
-
915
- /**
916
- * Whether the limit is soft (allows overage)
917
- */
918
- hasSoftLimit?: boolean;
919
1454
 
920
- /**
921
- * Whether usage is unlimited
922
- */
923
- hasUnlimitedUsage?: boolean;
924
-
925
- /**
926
- * Monthly reset configuration
927
- */
928
- monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
1455
+ /**
1456
+ * A tier in tiered pricing.
1457
+ */
1458
+ export interface Tier {
1459
+ /**
1460
+ * Flat price for this tier
1461
+ */
1462
+ flatPrice?: Tier.FlatPrice;
929
1463
 
930
- /**
931
- * The usage reset period
932
- */
933
- resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1464
+ /**
1465
+ * Per-unit price in this tier
1466
+ */
1467
+ unitPrice?: Tier.UnitPrice;
934
1468
 
935
- /**
936
- * The usage limit before overage kicks in
937
- */
938
- usageLimit?: number;
1469
+ /**
1470
+ * Upper bound of this tier (null for unlimited)
1471
+ */
1472
+ upTo?: number;
1473
+ }
939
1474
 
940
- /**
941
- * Weekly reset configuration
942
- */
943
- weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
1475
+ export namespace Tier {
1476
+ /**
1477
+ * Flat price for this tier
1478
+ */
1479
+ export interface FlatPrice {
1480
+ /**
1481
+ * The price amount
1482
+ */
1483
+ amount: number;
1484
+
1485
+ /**
1486
+ * The price currency
1487
+ */
1488
+ currency?:
1489
+ | 'usd'
1490
+ | 'aed'
1491
+ | 'all'
1492
+ | 'amd'
1493
+ | 'ang'
1494
+ | 'aud'
1495
+ | 'awg'
1496
+ | 'azn'
1497
+ | 'bam'
1498
+ | 'bbd'
1499
+ | 'bdt'
1500
+ | 'bgn'
1501
+ | 'bif'
1502
+ | 'bmd'
1503
+ | 'bnd'
1504
+ | 'bsd'
1505
+ | 'bwp'
1506
+ | 'byn'
1507
+ | 'bzd'
1508
+ | 'brl'
1509
+ | 'cad'
1510
+ | 'cdf'
1511
+ | 'chf'
1512
+ | 'cny'
1513
+ | 'czk'
1514
+ | 'dkk'
1515
+ | 'dop'
1516
+ | 'dzd'
1517
+ | 'egp'
1518
+ | 'etb'
1519
+ | 'eur'
1520
+ | 'fjd'
1521
+ | 'gbp'
1522
+ | 'gel'
1523
+ | 'gip'
1524
+ | 'gmd'
1525
+ | 'gyd'
1526
+ | 'hkd'
1527
+ | 'hrk'
1528
+ | 'htg'
1529
+ | 'idr'
1530
+ | 'ils'
1531
+ | 'inr'
1532
+ | 'isk'
1533
+ | 'jmd'
1534
+ | 'jpy'
1535
+ | 'kes'
1536
+ | 'kgs'
1537
+ | 'khr'
1538
+ | 'kmf'
1539
+ | 'krw'
1540
+ | 'kyd'
1541
+ | 'kzt'
1542
+ | 'lbp'
1543
+ | 'lkr'
1544
+ | 'lrd'
1545
+ | 'lsl'
1546
+ | 'mad'
1547
+ | 'mdl'
1548
+ | 'mga'
1549
+ | 'mkd'
1550
+ | 'mmk'
1551
+ | 'mnt'
1552
+ | 'mop'
1553
+ | 'mro'
1554
+ | 'mvr'
1555
+ | 'mwk'
1556
+ | 'mxn'
1557
+ | 'myr'
1558
+ | 'mzn'
1559
+ | 'nad'
1560
+ | 'ngn'
1561
+ | 'nok'
1562
+ | 'npr'
1563
+ | 'nzd'
1564
+ | 'pgk'
1565
+ | 'php'
1566
+ | 'pkr'
1567
+ | 'pln'
1568
+ | 'qar'
1569
+ | 'ron'
1570
+ | 'rsd'
1571
+ | 'rub'
1572
+ | 'rwf'
1573
+ | 'sar'
1574
+ | 'sbd'
1575
+ | 'scr'
1576
+ | 'sek'
1577
+ | 'sgd'
1578
+ | 'sle'
1579
+ | 'sll'
1580
+ | 'sos'
1581
+ | 'szl'
1582
+ | 'thb'
1583
+ | 'tjs'
1584
+ | 'top'
1585
+ | 'try'
1586
+ | 'ttd'
1587
+ | 'tzs'
1588
+ | 'uah'
1589
+ | 'uzs'
1590
+ | 'vnd'
1591
+ | 'vuv'
1592
+ | 'wst'
1593
+ | 'xaf'
1594
+ | 'xcd'
1595
+ | 'yer'
1596
+ | 'zar'
1597
+ | 'zmw'
1598
+ | 'clp'
1599
+ | 'djf'
1600
+ | 'gnf'
1601
+ | 'ugx'
1602
+ | 'pyg'
1603
+ | 'xof'
1604
+ | 'xpf';
1605
+ }
944
1606
 
945
- /**
946
- * Yearly reset configuration
947
- */
948
- yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
949
- }
1607
+ /**
1608
+ * Per-unit price in this tier
1609
+ */
1610
+ export interface UnitPrice {
1611
+ /**
1612
+ * The price amount
1613
+ */
1614
+ amount: number;
1615
+
1616
+ /**
1617
+ * The price currency
1618
+ */
1619
+ currency?:
1620
+ | 'usd'
1621
+ | 'aed'
1622
+ | 'all'
1623
+ | 'amd'
1624
+ | 'ang'
1625
+ | 'aud'
1626
+ | 'awg'
1627
+ | 'azn'
1628
+ | 'bam'
1629
+ | 'bbd'
1630
+ | 'bdt'
1631
+ | 'bgn'
1632
+ | 'bif'
1633
+ | 'bmd'
1634
+ | 'bnd'
1635
+ | 'bsd'
1636
+ | 'bwp'
1637
+ | 'byn'
1638
+ | 'bzd'
1639
+ | 'brl'
1640
+ | 'cad'
1641
+ | 'cdf'
1642
+ | 'chf'
1643
+ | 'cny'
1644
+ | 'czk'
1645
+ | 'dkk'
1646
+ | 'dop'
1647
+ | 'dzd'
1648
+ | 'egp'
1649
+ | 'etb'
1650
+ | 'eur'
1651
+ | 'fjd'
1652
+ | 'gbp'
1653
+ | 'gel'
1654
+ | 'gip'
1655
+ | 'gmd'
1656
+ | 'gyd'
1657
+ | 'hkd'
1658
+ | 'hrk'
1659
+ | 'htg'
1660
+ | 'idr'
1661
+ | 'ils'
1662
+ | 'inr'
1663
+ | 'isk'
1664
+ | 'jmd'
1665
+ | 'jpy'
1666
+ | 'kes'
1667
+ | 'kgs'
1668
+ | 'khr'
1669
+ | 'kmf'
1670
+ | 'krw'
1671
+ | 'kyd'
1672
+ | 'kzt'
1673
+ | 'lbp'
1674
+ | 'lkr'
1675
+ | 'lrd'
1676
+ | 'lsl'
1677
+ | 'mad'
1678
+ | 'mdl'
1679
+ | 'mga'
1680
+ | 'mkd'
1681
+ | 'mmk'
1682
+ | 'mnt'
1683
+ | 'mop'
1684
+ | 'mro'
1685
+ | 'mvr'
1686
+ | 'mwk'
1687
+ | 'mxn'
1688
+ | 'myr'
1689
+ | 'mzn'
1690
+ | 'nad'
1691
+ | 'ngn'
1692
+ | 'nok'
1693
+ | 'npr'
1694
+ | 'nzd'
1695
+ | 'pgk'
1696
+ | 'php'
1697
+ | 'pkr'
1698
+ | 'pln'
1699
+ | 'qar'
1700
+ | 'ron'
1701
+ | 'rsd'
1702
+ | 'rub'
1703
+ | 'rwf'
1704
+ | 'sar'
1705
+ | 'sbd'
1706
+ | 'scr'
1707
+ | 'sek'
1708
+ | 'sgd'
1709
+ | 'sle'
1710
+ | 'sll'
1711
+ | 'sos'
1712
+ | 'szl'
1713
+ | 'thb'
1714
+ | 'tjs'
1715
+ | 'top'
1716
+ | 'try'
1717
+ | 'ttd'
1718
+ | 'tzs'
1719
+ | 'uah'
1720
+ | 'uzs'
1721
+ | 'vnd'
1722
+ | 'vuv'
1723
+ | 'wst'
1724
+ | 'xaf'
1725
+ | 'xcd'
1726
+ | 'yer'
1727
+ | 'zar'
1728
+ | 'zmw'
1729
+ | 'clp'
1730
+ | 'djf'
1731
+ | 'gnf'
1732
+ | 'ugx'
1733
+ | 'pyg'
1734
+ | 'xof'
1735
+ | 'xpf';
1736
+ }
1737
+ }
1738
+ }
950
1739
 
951
- export namespace Entitlement {
952
1740
  /**
953
- * Monthly reset configuration
1741
+ * Monthly reset period configuration
954
1742
  */
955
1743
  export interface MonthlyResetPeriodConfiguration {
956
1744
  /**
@@ -960,7 +1748,7 @@ export namespace SetPackagePricing {
960
1748
  }
961
1749
 
962
1750
  /**
963
- * Weekly reset configuration
1751
+ * Weekly reset period configuration
964
1752
  */
965
1753
  export interface WeeklyResetPeriodConfiguration {
966
1754
  /**
@@ -978,7 +1766,7 @@ export namespace SetPackagePricing {
978
1766
  }
979
1767
 
980
1768
  /**
981
- * Yearly reset configuration
1769
+ * Yearly reset period configuration
982
1770
  */
983
1771
  export interface YearlyResetPeriodConfiguration {
984
1772
  /**
@@ -988,2239 +1776,57 @@ export namespace SetPackagePricing {
988
1776
  }
989
1777
  }
990
1778
  }
1779
+ }
991
1780
 
1781
+ export interface AddonListParams extends MyCursorIDPageParams {
992
1782
  /**
993
- * A pricing model configuration with billing details and price periods.
1783
+ * Filter by creation date using range operators: gt, gte, lt, lte
994
1784
  */
995
- export interface PricingModel {
996
- /**
997
- * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
998
- */
999
- billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
1000
-
1001
- /**
1002
- * Array of price period configurations (at least one required)
1003
- */
1004
- pricePeriods: Array<PricingModel.PricePeriod>;
1005
-
1006
- /**
1007
- * The billing cadence (RECURRING or ONE_OFF)
1008
- */
1009
- billingCadence?: 'RECURRING' | 'ONE_OFF';
1010
-
1011
- /**
1012
- * The feature ID this pricing model is associated with
1013
- */
1014
- featureId?: string;
1015
-
1016
- /**
1017
- * Maximum number of units (max 999999)
1018
- */
1019
- maxUnitQuantity?: number;
1020
-
1021
- /**
1022
- * Minimum number of units
1023
- */
1024
- minUnitQuantity?: number;
1785
+ createdAt?: AddonListParams.CreatedAt;
1025
1786
 
1026
- /**
1027
- * Monthly reset period configuration
1028
- */
1029
- monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
1787
+ /**
1788
+ * Filter by product ID
1789
+ */
1790
+ productId?: string;
1030
1791
 
1031
- /**
1032
- * The usage reset period
1033
- */
1034
- resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1792
+ /**
1793
+ * Filter by status. Supports comma-separated values for multiple statuses
1794
+ */
1795
+ status?: string;
1796
+ }
1035
1797
 
1798
+ export namespace AddonListParams {
1799
+ /**
1800
+ * Filter by creation date using range operators: gt, gte, lt, lte
1801
+ */
1802
+ export interface CreatedAt {
1036
1803
  /**
1037
- * The tiered pricing mode (VOLUME or GRADUATED)
1804
+ * Greater than the specified createdAt value
1038
1805
  */
1039
- tiersMode?: 'VOLUME' | 'GRADUATED';
1806
+ gt?: string;
1040
1807
 
1041
1808
  /**
1042
- * The custom currency ID for top-up pricing
1809
+ * Greater than or equal to the specified createdAt value
1043
1810
  */
1044
- topUpCustomCurrencyId?: string;
1811
+ gte?: string;
1045
1812
 
1046
1813
  /**
1047
- * Weekly reset period configuration
1814
+ * Less than the specified createdAt value
1048
1815
  */
1049
- weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
1816
+ lt?: string;
1050
1817
 
1051
1818
  /**
1052
- * Yearly reset period configuration
1819
+ * Less than or equal to the specified createdAt value
1053
1820
  */
1054
- yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
1821
+ lte?: string;
1055
1822
  }
1823
+ }
1056
1824
 
1057
- export namespace PricingModel {
1058
- /**
1059
- * Price configuration for a specific billing period.
1060
- */
1061
- export interface PricePeriod {
1062
- /**
1063
- * The billing period (MONTHLY or ANNUALLY)
1064
- */
1065
- billingPeriod: 'MONTHLY' | 'ANNUALLY';
1066
-
1067
- /**
1068
- * ISO country code for localized pricing
1069
- */
1070
- billingCountryCode?: string;
1071
-
1072
- /**
1073
- * Block size for usage-based pricing
1074
- */
1075
- blockSize?: number;
1076
-
1077
- /**
1078
- * When credits are granted
1079
- */
1080
- creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1081
-
1082
- /**
1083
- * Credit rate configuration for credit-based pricing
1084
- */
1085
- creditRate?: PricePeriod.CreditRate;
1086
-
1087
- /**
1088
- * The price amount and currency
1089
- */
1090
- price?: PricePeriod.Price;
1091
-
1092
- /**
1093
- * Tiered pricing configuration
1094
- */
1095
- tiers?: Array<PricePeriod.Tier>;
1096
- }
1097
-
1098
- export namespace PricePeriod {
1099
- /**
1100
- * Credit rate configuration for credit-based pricing
1101
- */
1102
- export interface CreditRate {
1103
- /**
1104
- * The credit rate amount
1105
- */
1106
- amount: number;
1107
-
1108
- /**
1109
- * The custom currency ID
1110
- */
1111
- currencyId: string;
1112
-
1113
- /**
1114
- * Optional cost formula expression
1115
- */
1116
- costFormula?: string;
1117
- }
1118
-
1119
- /**
1120
- * The price amount and currency
1121
- */
1122
- export interface Price {
1123
- /**
1124
- * The price amount
1125
- */
1126
- amount: number;
1127
-
1128
- /**
1129
- * The price currency
1130
- */
1131
- currency?:
1132
- | 'usd'
1133
- | 'aed'
1134
- | 'all'
1135
- | 'amd'
1136
- | 'ang'
1137
- | 'aud'
1138
- | 'awg'
1139
- | 'azn'
1140
- | 'bam'
1141
- | 'bbd'
1142
- | 'bdt'
1143
- | 'bgn'
1144
- | 'bif'
1145
- | 'bmd'
1146
- | 'bnd'
1147
- | 'bsd'
1148
- | 'bwp'
1149
- | 'byn'
1150
- | 'bzd'
1151
- | 'brl'
1152
- | 'cad'
1153
- | 'cdf'
1154
- | 'chf'
1155
- | 'cny'
1156
- | 'czk'
1157
- | 'dkk'
1158
- | 'dop'
1159
- | 'dzd'
1160
- | 'egp'
1161
- | 'etb'
1162
- | 'eur'
1163
- | 'fjd'
1164
- | 'gbp'
1165
- | 'gel'
1166
- | 'gip'
1167
- | 'gmd'
1168
- | 'gyd'
1169
- | 'hkd'
1170
- | 'hrk'
1171
- | 'htg'
1172
- | 'idr'
1173
- | 'ils'
1174
- | 'inr'
1175
- | 'isk'
1176
- | 'jmd'
1177
- | 'jpy'
1178
- | 'kes'
1179
- | 'kgs'
1180
- | 'khr'
1181
- | 'kmf'
1182
- | 'krw'
1183
- | 'kyd'
1184
- | 'kzt'
1185
- | 'lbp'
1186
- | 'lkr'
1187
- | 'lrd'
1188
- | 'lsl'
1189
- | 'mad'
1190
- | 'mdl'
1191
- | 'mga'
1192
- | 'mkd'
1193
- | 'mmk'
1194
- | 'mnt'
1195
- | 'mop'
1196
- | 'mro'
1197
- | 'mvr'
1198
- | 'mwk'
1199
- | 'mxn'
1200
- | 'myr'
1201
- | 'mzn'
1202
- | 'nad'
1203
- | 'ngn'
1204
- | 'nok'
1205
- | 'npr'
1206
- | 'nzd'
1207
- | 'pgk'
1208
- | 'php'
1209
- | 'pkr'
1210
- | 'pln'
1211
- | 'qar'
1212
- | 'ron'
1213
- | 'rsd'
1214
- | 'rub'
1215
- | 'rwf'
1216
- | 'sar'
1217
- | 'sbd'
1218
- | 'scr'
1219
- | 'sek'
1220
- | 'sgd'
1221
- | 'sle'
1222
- | 'sll'
1223
- | 'sos'
1224
- | 'szl'
1225
- | 'thb'
1226
- | 'tjs'
1227
- | 'top'
1228
- | 'try'
1229
- | 'ttd'
1230
- | 'tzs'
1231
- | 'uah'
1232
- | 'uzs'
1233
- | 'vnd'
1234
- | 'vuv'
1235
- | 'wst'
1236
- | 'xaf'
1237
- | 'xcd'
1238
- | 'yer'
1239
- | 'zar'
1240
- | 'zmw'
1241
- | 'clp'
1242
- | 'djf'
1243
- | 'gnf'
1244
- | 'ugx'
1245
- | 'pyg'
1246
- | 'xof'
1247
- | 'xpf';
1248
- }
1249
-
1250
- /**
1251
- * A tier in tiered pricing.
1252
- */
1253
- export interface Tier {
1254
- /**
1255
- * Flat price for this tier
1256
- */
1257
- flatPrice?: Tier.FlatPrice;
1258
-
1259
- /**
1260
- * Per-unit price in this tier
1261
- */
1262
- unitPrice?: Tier.UnitPrice;
1263
-
1264
- /**
1265
- * Upper bound of this tier (null for unlimited)
1266
- */
1267
- upTo?: number;
1268
- }
1269
-
1270
- export namespace Tier {
1271
- /**
1272
- * Flat price for this tier
1273
- */
1274
- export interface FlatPrice {
1275
- /**
1276
- * The price amount
1277
- */
1278
- amount: number;
1279
-
1280
- /**
1281
- * The price currency
1282
- */
1283
- currency?:
1284
- | 'usd'
1285
- | 'aed'
1286
- | 'all'
1287
- | 'amd'
1288
- | 'ang'
1289
- | 'aud'
1290
- | 'awg'
1291
- | 'azn'
1292
- | 'bam'
1293
- | 'bbd'
1294
- | 'bdt'
1295
- | 'bgn'
1296
- | 'bif'
1297
- | 'bmd'
1298
- | 'bnd'
1299
- | 'bsd'
1300
- | 'bwp'
1301
- | 'byn'
1302
- | 'bzd'
1303
- | 'brl'
1304
- | 'cad'
1305
- | 'cdf'
1306
- | 'chf'
1307
- | 'cny'
1308
- | 'czk'
1309
- | 'dkk'
1310
- | 'dop'
1311
- | 'dzd'
1312
- | 'egp'
1313
- | 'etb'
1314
- | 'eur'
1315
- | 'fjd'
1316
- | 'gbp'
1317
- | 'gel'
1318
- | 'gip'
1319
- | 'gmd'
1320
- | 'gyd'
1321
- | 'hkd'
1322
- | 'hrk'
1323
- | 'htg'
1324
- | 'idr'
1325
- | 'ils'
1326
- | 'inr'
1327
- | 'isk'
1328
- | 'jmd'
1329
- | 'jpy'
1330
- | 'kes'
1331
- | 'kgs'
1332
- | 'khr'
1333
- | 'kmf'
1334
- | 'krw'
1335
- | 'kyd'
1336
- | 'kzt'
1337
- | 'lbp'
1338
- | 'lkr'
1339
- | 'lrd'
1340
- | 'lsl'
1341
- | 'mad'
1342
- | 'mdl'
1343
- | 'mga'
1344
- | 'mkd'
1345
- | 'mmk'
1346
- | 'mnt'
1347
- | 'mop'
1348
- | 'mro'
1349
- | 'mvr'
1350
- | 'mwk'
1351
- | 'mxn'
1352
- | 'myr'
1353
- | 'mzn'
1354
- | 'nad'
1355
- | 'ngn'
1356
- | 'nok'
1357
- | 'npr'
1358
- | 'nzd'
1359
- | 'pgk'
1360
- | 'php'
1361
- | 'pkr'
1362
- | 'pln'
1363
- | 'qar'
1364
- | 'ron'
1365
- | 'rsd'
1366
- | 'rub'
1367
- | 'rwf'
1368
- | 'sar'
1369
- | 'sbd'
1370
- | 'scr'
1371
- | 'sek'
1372
- | 'sgd'
1373
- | 'sle'
1374
- | 'sll'
1375
- | 'sos'
1376
- | 'szl'
1377
- | 'thb'
1378
- | 'tjs'
1379
- | 'top'
1380
- | 'try'
1381
- | 'ttd'
1382
- | 'tzs'
1383
- | 'uah'
1384
- | 'uzs'
1385
- | 'vnd'
1386
- | 'vuv'
1387
- | 'wst'
1388
- | 'xaf'
1389
- | 'xcd'
1390
- | 'yer'
1391
- | 'zar'
1392
- | 'zmw'
1393
- | 'clp'
1394
- | 'djf'
1395
- | 'gnf'
1396
- | 'ugx'
1397
- | 'pyg'
1398
- | 'xof'
1399
- | 'xpf';
1400
- }
1401
-
1402
- /**
1403
- * Per-unit price in this tier
1404
- */
1405
- export interface UnitPrice {
1406
- /**
1407
- * The price amount
1408
- */
1409
- amount: number;
1410
-
1411
- /**
1412
- * The price currency
1413
- */
1414
- currency?:
1415
- | 'usd'
1416
- | 'aed'
1417
- | 'all'
1418
- | 'amd'
1419
- | 'ang'
1420
- | 'aud'
1421
- | 'awg'
1422
- | 'azn'
1423
- | 'bam'
1424
- | 'bbd'
1425
- | 'bdt'
1426
- | 'bgn'
1427
- | 'bif'
1428
- | 'bmd'
1429
- | 'bnd'
1430
- | 'bsd'
1431
- | 'bwp'
1432
- | 'byn'
1433
- | 'bzd'
1434
- | 'brl'
1435
- | 'cad'
1436
- | 'cdf'
1437
- | 'chf'
1438
- | 'cny'
1439
- | 'czk'
1440
- | 'dkk'
1441
- | 'dop'
1442
- | 'dzd'
1443
- | 'egp'
1444
- | 'etb'
1445
- | 'eur'
1446
- | 'fjd'
1447
- | 'gbp'
1448
- | 'gel'
1449
- | 'gip'
1450
- | 'gmd'
1451
- | 'gyd'
1452
- | 'hkd'
1453
- | 'hrk'
1454
- | 'htg'
1455
- | 'idr'
1456
- | 'ils'
1457
- | 'inr'
1458
- | 'isk'
1459
- | 'jmd'
1460
- | 'jpy'
1461
- | 'kes'
1462
- | 'kgs'
1463
- | 'khr'
1464
- | 'kmf'
1465
- | 'krw'
1466
- | 'kyd'
1467
- | 'kzt'
1468
- | 'lbp'
1469
- | 'lkr'
1470
- | 'lrd'
1471
- | 'lsl'
1472
- | 'mad'
1473
- | 'mdl'
1474
- | 'mga'
1475
- | 'mkd'
1476
- | 'mmk'
1477
- | 'mnt'
1478
- | 'mop'
1479
- | 'mro'
1480
- | 'mvr'
1481
- | 'mwk'
1482
- | 'mxn'
1483
- | 'myr'
1484
- | 'mzn'
1485
- | 'nad'
1486
- | 'ngn'
1487
- | 'nok'
1488
- | 'npr'
1489
- | 'nzd'
1490
- | 'pgk'
1491
- | 'php'
1492
- | 'pkr'
1493
- | 'pln'
1494
- | 'qar'
1495
- | 'ron'
1496
- | 'rsd'
1497
- | 'rub'
1498
- | 'rwf'
1499
- | 'sar'
1500
- | 'sbd'
1501
- | 'scr'
1502
- | 'sek'
1503
- | 'sgd'
1504
- | 'sle'
1505
- | 'sll'
1506
- | 'sos'
1507
- | 'szl'
1508
- | 'thb'
1509
- | 'tjs'
1510
- | 'top'
1511
- | 'try'
1512
- | 'ttd'
1513
- | 'tzs'
1514
- | 'uah'
1515
- | 'uzs'
1516
- | 'vnd'
1517
- | 'vuv'
1518
- | 'wst'
1519
- | 'xaf'
1520
- | 'xcd'
1521
- | 'yer'
1522
- | 'zar'
1523
- | 'zmw'
1524
- | 'clp'
1525
- | 'djf'
1526
- | 'gnf'
1527
- | 'ugx'
1528
- | 'pyg'
1529
- | 'xof'
1530
- | 'xpf';
1531
- }
1532
- }
1533
- }
1534
-
1535
- /**
1536
- * Monthly reset period configuration
1537
- */
1538
- export interface MonthlyResetPeriodConfiguration {
1539
- /**
1540
- * Reset anchor (SubscriptionStart or StartOfTheMonth)
1541
- */
1542
- accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1543
- }
1544
-
1545
- /**
1546
- * Weekly reset period configuration
1547
- */
1548
- export interface WeeklyResetPeriodConfiguration {
1549
- /**
1550
- * Reset anchor (SubscriptionStart or specific day)
1551
- */
1552
- accordingTo:
1553
- | 'SubscriptionStart'
1554
- | 'EverySunday'
1555
- | 'EveryMonday'
1556
- | 'EveryTuesday'
1557
- | 'EveryWednesday'
1558
- | 'EveryThursday'
1559
- | 'EveryFriday'
1560
- | 'EverySaturday';
1561
- }
1562
-
1563
- /**
1564
- * Yearly reset period configuration
1565
- */
1566
- export interface YearlyResetPeriodConfiguration {
1567
- /**
1568
- * Reset anchor (SubscriptionStart)
1569
- */
1570
- accordingTo: 'SubscriptionStart';
1571
- }
1572
- }
1573
- }
1574
-
1575
- /**
1576
- * Response object
1577
- */
1578
- export interface SetPackagePricingResponse {
1579
- /**
1580
- * Result of setting package pricing.
1581
- */
1582
- data: SetPackagePricingResponse.Data;
1583
- }
1584
-
1585
- export namespace SetPackagePricingResponse {
1586
- /**
1587
- * Result of setting package pricing.
1588
- */
1589
- export interface Data {
1590
- /**
1591
- * The package identifier (refId)
1592
- */
1593
- id: string;
1594
-
1595
- /**
1596
- * The pricing type that was set
1597
- */
1598
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
1599
- }
1600
- }
1601
-
1602
- /**
1603
- * Addon configuration object
1604
- */
1605
- export interface AddonListResponse {
1606
- /**
1607
- * The unique identifier for the entity
1608
- */
1609
- id: string;
1610
-
1611
- /**
1612
- * The unique identifier for the entity in the billing provider
1613
- */
1614
- billingId: string | null;
1615
-
1616
- /**
1617
- * Timestamp of when the record was created
1618
- */
1619
- createdAt: string;
1620
-
1621
- /**
1622
- * List of addons the addon is dependant on
1623
- */
1624
- dependencies: Array<string> | null;
1625
-
1626
- /**
1627
- * The description of the package
1628
- */
1629
- description: string | null;
1630
-
1631
- /**
1632
- * The display name of the package
1633
- */
1634
- displayName: string;
1635
-
1636
- /**
1637
- * List of entitlements of the package
1638
- */
1639
- entitlements: Array<AddonListResponse.Entitlement>;
1640
-
1641
- /**
1642
- * Indicates if the package is the latest version
1643
- */
1644
- isLatest: boolean | null;
1645
-
1646
- /**
1647
- * The maximum quantity of this addon that can be added to a subscription
1648
- */
1649
- maxQuantity: number | null;
1650
-
1651
- /**
1652
- * Metadata associated with the entity
1653
- */
1654
- metadata: { [key: string]: string };
1655
-
1656
- /**
1657
- * The pricing type of the package
1658
- */
1659
- pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
1660
-
1661
- /**
1662
- * The product id of the package
1663
- */
1664
- productId: string;
1665
-
1666
- /**
1667
- * The status of the package
1668
- */
1669
- status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
1670
-
1671
- /**
1672
- * Timestamp of when the record was last updated
1673
- */
1674
- updatedAt: string;
1675
-
1676
- /**
1677
- * The version number of the package
1678
- */
1679
- versionNumber: number;
1680
- }
1681
-
1682
- export namespace AddonListResponse {
1683
- /**
1684
- * Entitlement reference with type and identifier
1685
- */
1686
- export interface Entitlement {
1687
- /**
1688
- * The unique identifier for the entity
1689
- */
1690
- id: string;
1691
-
1692
- type: 'FEATURE' | 'CREDIT';
1693
- }
1694
- }
1695
-
1696
- /**
1697
- * Response containing task ID for publish operation
1698
- */
1699
- export interface AddonPublishResponse {
1700
- data: AddonPublishResponse.Data;
1701
- }
1702
-
1703
- export namespace AddonPublishResponse {
1704
- export interface Data {
1705
- /**
1706
- * Task ID for tracking the async publish operation
1707
- */
1708
- taskId: string | null;
1709
- }
1710
- }
1711
-
1712
- /**
1713
- * Response confirming the addon draft was removed.
1714
- */
1715
- export interface AddonRemoveDraftResponse {
1716
- data: AddonRemoveDraftResponse.Data;
1717
- }
1718
-
1719
- export namespace AddonRemoveDraftResponse {
1720
- export interface Data {
1721
- /**
1722
- * The unique identifier for the entity
1723
- */
1724
- id: string;
1725
- }
1726
- }
1727
-
1728
- export interface AddonCreateParams {
1729
- /**
1730
- * The unique identifier for the entity
1731
- */
1732
- id: string;
1733
-
1734
- /**
1735
- * The display name of the package
1736
- */
1737
- displayName: string;
1738
-
1739
- /**
1740
- * The product id of the package
1741
- */
1742
- productId: string;
1743
-
1744
- /**
1745
- * The unique identifier for the entity in the billing provider
1746
- */
1747
- billingId?: string | null;
1748
-
1749
- /**
1750
- * The description of the package
1751
- */
1752
- description?: string | null;
1753
-
1754
- /**
1755
- * The maximum quantity of this addon that can be added to a subscription
1756
- */
1757
- maxQuantity?: number | null;
1758
-
1759
- /**
1760
- * Metadata associated with the entity
1761
- */
1762
- metadata?: { [key: string]: string };
1763
-
1764
- /**
1765
- * The pricing type of the package
1766
- */
1767
- pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
1768
-
1769
- /**
1770
- * The status of the package
1771
- */
1772
- status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
1773
- }
1774
-
1775
- export interface AddonUpdateParams {
1776
- /**
1777
- * The unique identifier for the entity in the billing provider
1778
- */
1779
- billingId?: string | null;
1780
-
1781
- /**
1782
- * List of addons the addon is dependant on
1783
- */
1784
- dependencies?: Array<string> | null;
1785
-
1786
- /**
1787
- * The description of the package
1788
- */
1789
- description?: string | null;
1790
-
1791
- /**
1792
- * The display name of the package
1793
- */
1794
- displayName?: string;
1795
-
1796
- /**
1797
- * The maximum quantity of this addon that can be added to a subscription
1798
- */
1799
- maxQuantity?: number | null;
1800
-
1801
- /**
1802
- * Metadata associated with the entity
1803
- */
1804
- metadata?: { [key: string]: string };
1805
-
1806
- /**
1807
- * The status of the package
1808
- */
1809
- status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
1810
- }
1811
-
1812
- export interface AddonListParams extends MyCursorIDPageParams {
1813
- /**
1814
- * Filter by creation date using range operators: gt, gte, lt, lte
1815
- */
1816
- createdAt?: AddonListParams.CreatedAt;
1817
-
1818
- /**
1819
- * Filter by product ID
1820
- */
1821
- productId?: string;
1822
-
1823
- /**
1824
- * Filter by status. Supports comma-separated values for multiple statuses
1825
- */
1826
- status?: string;
1827
- }
1828
-
1829
- export namespace AddonListParams {
1830
- /**
1831
- * Filter by creation date using range operators: gt, gte, lt, lte
1832
- */
1833
- export interface CreatedAt {
1834
- /**
1835
- * Greater than the specified createdAt value
1836
- */
1837
- gt?: string;
1838
-
1839
- /**
1840
- * Greater than or equal to the specified createdAt value
1841
- */
1842
- gte?: string;
1843
-
1844
- /**
1845
- * Less than the specified createdAt value
1846
- */
1847
- lt?: string;
1848
-
1849
- /**
1850
- * Less than or equal to the specified createdAt value
1851
- */
1852
- lte?: string;
1853
- }
1854
- }
1855
-
1856
- export interface AddonPublishParams {
1857
- /**
1858
- * The migration type of the package
1859
- */
1860
- migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
1861
- }
1862
-
1863
- export interface AddonSetPricingParams {
1864
- /**
1865
- * The pricing type (FREE, PAID, or CUSTOM)
1866
- */
1867
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
1868
-
1869
- /**
1870
- * Deprecated: billing integration ID
1871
- */
1872
- billingId?: string;
1873
-
1874
- /**
1875
- * Minimum spend configuration per billing period
1876
- */
1877
- minimumSpend?: Array<AddonSetPricingParams.MinimumSpend> | null;
1878
-
1879
- /**
1880
- * When overage charges are billed
1881
- */
1882
- overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
1883
-
1884
- /**
1885
- * Array of overage pricing model configurations
1886
- */
1887
- overagePricingModels?: Array<AddonSetPricingParams.OveragePricingModel>;
1888
-
1889
- /**
1890
- * Array of pricing model configurations
1891
- */
1892
- pricingModels?: Array<AddonSetPricingParams.PricingModel>;
1893
- }
1894
-
1895
- export namespace AddonSetPricingParams {
1896
- /**
1897
- * Minimum spend configuration for a billing period.
1898
- */
1899
- export interface MinimumSpend {
1900
- /**
1901
- * The billing period
1902
- */
1903
- billingPeriod: 'MONTHLY' | 'ANNUALLY';
1904
-
1905
- /**
1906
- * The minimum spend amount
1907
- */
1908
- minimum: MinimumSpend.Minimum;
1909
- }
1910
-
1911
- export namespace MinimumSpend {
1912
- /**
1913
- * The minimum spend amount
1914
- */
1915
- export interface Minimum {
1916
- /**
1917
- * The price amount
1918
- */
1919
- amount: number;
1920
-
1921
- /**
1922
- * The price currency
1923
- */
1924
- currency?:
1925
- | 'usd'
1926
- | 'aed'
1927
- | 'all'
1928
- | 'amd'
1929
- | 'ang'
1930
- | 'aud'
1931
- | 'awg'
1932
- | 'azn'
1933
- | 'bam'
1934
- | 'bbd'
1935
- | 'bdt'
1936
- | 'bgn'
1937
- | 'bif'
1938
- | 'bmd'
1939
- | 'bnd'
1940
- | 'bsd'
1941
- | 'bwp'
1942
- | 'byn'
1943
- | 'bzd'
1944
- | 'brl'
1945
- | 'cad'
1946
- | 'cdf'
1947
- | 'chf'
1948
- | 'cny'
1949
- | 'czk'
1950
- | 'dkk'
1951
- | 'dop'
1952
- | 'dzd'
1953
- | 'egp'
1954
- | 'etb'
1955
- | 'eur'
1956
- | 'fjd'
1957
- | 'gbp'
1958
- | 'gel'
1959
- | 'gip'
1960
- | 'gmd'
1961
- | 'gyd'
1962
- | 'hkd'
1963
- | 'hrk'
1964
- | 'htg'
1965
- | 'idr'
1966
- | 'ils'
1967
- | 'inr'
1968
- | 'isk'
1969
- | 'jmd'
1970
- | 'jpy'
1971
- | 'kes'
1972
- | 'kgs'
1973
- | 'khr'
1974
- | 'kmf'
1975
- | 'krw'
1976
- | 'kyd'
1977
- | 'kzt'
1978
- | 'lbp'
1979
- | 'lkr'
1980
- | 'lrd'
1981
- | 'lsl'
1982
- | 'mad'
1983
- | 'mdl'
1984
- | 'mga'
1985
- | 'mkd'
1986
- | 'mmk'
1987
- | 'mnt'
1988
- | 'mop'
1989
- | 'mro'
1990
- | 'mvr'
1991
- | 'mwk'
1992
- | 'mxn'
1993
- | 'myr'
1994
- | 'mzn'
1995
- | 'nad'
1996
- | 'ngn'
1997
- | 'nok'
1998
- | 'npr'
1999
- | 'nzd'
2000
- | 'pgk'
2001
- | 'php'
2002
- | 'pkr'
2003
- | 'pln'
2004
- | 'qar'
2005
- | 'ron'
2006
- | 'rsd'
2007
- | 'rub'
2008
- | 'rwf'
2009
- | 'sar'
2010
- | 'sbd'
2011
- | 'scr'
2012
- | 'sek'
2013
- | 'sgd'
2014
- | 'sle'
2015
- | 'sll'
2016
- | 'sos'
2017
- | 'szl'
2018
- | 'thb'
2019
- | 'tjs'
2020
- | 'top'
2021
- | 'try'
2022
- | 'ttd'
2023
- | 'tzs'
2024
- | 'uah'
2025
- | 'uzs'
2026
- | 'vnd'
2027
- | 'vuv'
2028
- | 'wst'
2029
- | 'xaf'
2030
- | 'xcd'
2031
- | 'yer'
2032
- | 'zar'
2033
- | 'zmw'
2034
- | 'clp'
2035
- | 'djf'
2036
- | 'gnf'
2037
- | 'ugx'
2038
- | 'pyg'
2039
- | 'xof'
2040
- | 'xpf';
2041
- }
2042
- }
2043
-
2044
- /**
2045
- * Overage pricing model configuration.
2046
- */
2047
- export interface OveragePricingModel {
2048
- /**
2049
- * The billing model for overages
2050
- */
2051
- billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
2052
-
2053
- /**
2054
- * Price periods for overage pricing
2055
- */
2056
- pricePeriods: Array<OveragePricingModel.PricePeriod>;
2057
-
2058
- /**
2059
- * The billing cadence for overages
2060
- */
2061
- billingCadence?: 'RECURRING' | 'ONE_OFF';
2062
-
2063
- /**
2064
- * Entitlement configuration for the overage feature
2065
- */
2066
- entitlement?: OveragePricingModel.Entitlement;
2067
-
2068
- /**
2069
- * The feature ID for overage pricing
2070
- */
2071
- featureId?: string;
2072
-
2073
- /**
2074
- * Custom currency ID for overage top-up
2075
- */
2076
- topUpCustomCurrencyId?: string;
2077
- }
2078
-
2079
- export namespace OveragePricingModel {
2080
- /**
2081
- * Price configuration for a specific billing period.
2082
- */
2083
- export interface PricePeriod {
2084
- /**
2085
- * The billing period (MONTHLY or ANNUALLY)
2086
- */
2087
- billingPeriod: 'MONTHLY' | 'ANNUALLY';
2088
-
2089
- /**
2090
- * ISO country code for localized pricing
2091
- */
2092
- billingCountryCode?: string;
2093
-
2094
- /**
2095
- * Block size for usage-based pricing
2096
- */
2097
- blockSize?: number;
2098
-
2099
- /**
2100
- * When credits are granted
2101
- */
2102
- creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
2103
-
2104
- /**
2105
- * Credit rate configuration for credit-based pricing
2106
- */
2107
- creditRate?: PricePeriod.CreditRate;
2108
-
2109
- /**
2110
- * The price amount and currency
2111
- */
2112
- price?: PricePeriod.Price;
2113
-
2114
- /**
2115
- * Tiered pricing configuration
2116
- */
2117
- tiers?: Array<PricePeriod.Tier>;
2118
- }
2119
-
2120
- export namespace PricePeriod {
2121
- /**
2122
- * Credit rate configuration for credit-based pricing
2123
- */
2124
- export interface CreditRate {
2125
- /**
2126
- * The credit rate amount
2127
- */
2128
- amount: number;
2129
-
2130
- /**
2131
- * The custom currency ID
2132
- */
2133
- currencyId: string;
2134
-
2135
- /**
2136
- * Optional cost formula expression
2137
- */
2138
- costFormula?: string;
2139
- }
2140
-
2141
- /**
2142
- * The price amount and currency
2143
- */
2144
- export interface Price {
2145
- /**
2146
- * The price amount
2147
- */
2148
- amount: number;
2149
-
2150
- /**
2151
- * The price currency
2152
- */
2153
- currency?:
2154
- | 'usd'
2155
- | 'aed'
2156
- | 'all'
2157
- | 'amd'
2158
- | 'ang'
2159
- | 'aud'
2160
- | 'awg'
2161
- | 'azn'
2162
- | 'bam'
2163
- | 'bbd'
2164
- | 'bdt'
2165
- | 'bgn'
2166
- | 'bif'
2167
- | 'bmd'
2168
- | 'bnd'
2169
- | 'bsd'
2170
- | 'bwp'
2171
- | 'byn'
2172
- | 'bzd'
2173
- | 'brl'
2174
- | 'cad'
2175
- | 'cdf'
2176
- | 'chf'
2177
- | 'cny'
2178
- | 'czk'
2179
- | 'dkk'
2180
- | 'dop'
2181
- | 'dzd'
2182
- | 'egp'
2183
- | 'etb'
2184
- | 'eur'
2185
- | 'fjd'
2186
- | 'gbp'
2187
- | 'gel'
2188
- | 'gip'
2189
- | 'gmd'
2190
- | 'gyd'
2191
- | 'hkd'
2192
- | 'hrk'
2193
- | 'htg'
2194
- | 'idr'
2195
- | 'ils'
2196
- | 'inr'
2197
- | 'isk'
2198
- | 'jmd'
2199
- | 'jpy'
2200
- | 'kes'
2201
- | 'kgs'
2202
- | 'khr'
2203
- | 'kmf'
2204
- | 'krw'
2205
- | 'kyd'
2206
- | 'kzt'
2207
- | 'lbp'
2208
- | 'lkr'
2209
- | 'lrd'
2210
- | 'lsl'
2211
- | 'mad'
2212
- | 'mdl'
2213
- | 'mga'
2214
- | 'mkd'
2215
- | 'mmk'
2216
- | 'mnt'
2217
- | 'mop'
2218
- | 'mro'
2219
- | 'mvr'
2220
- | 'mwk'
2221
- | 'mxn'
2222
- | 'myr'
2223
- | 'mzn'
2224
- | 'nad'
2225
- | 'ngn'
2226
- | 'nok'
2227
- | 'npr'
2228
- | 'nzd'
2229
- | 'pgk'
2230
- | 'php'
2231
- | 'pkr'
2232
- | 'pln'
2233
- | 'qar'
2234
- | 'ron'
2235
- | 'rsd'
2236
- | 'rub'
2237
- | 'rwf'
2238
- | 'sar'
2239
- | 'sbd'
2240
- | 'scr'
2241
- | 'sek'
2242
- | 'sgd'
2243
- | 'sle'
2244
- | 'sll'
2245
- | 'sos'
2246
- | 'szl'
2247
- | 'thb'
2248
- | 'tjs'
2249
- | 'top'
2250
- | 'try'
2251
- | 'ttd'
2252
- | 'tzs'
2253
- | 'uah'
2254
- | 'uzs'
2255
- | 'vnd'
2256
- | 'vuv'
2257
- | 'wst'
2258
- | 'xaf'
2259
- | 'xcd'
2260
- | 'yer'
2261
- | 'zar'
2262
- | 'zmw'
2263
- | 'clp'
2264
- | 'djf'
2265
- | 'gnf'
2266
- | 'ugx'
2267
- | 'pyg'
2268
- | 'xof'
2269
- | 'xpf';
2270
- }
2271
-
2272
- /**
2273
- * A tier in tiered pricing.
2274
- */
2275
- export interface Tier {
2276
- /**
2277
- * Flat price for this tier
2278
- */
2279
- flatPrice?: Tier.FlatPrice;
2280
-
2281
- /**
2282
- * Per-unit price in this tier
2283
- */
2284
- unitPrice?: Tier.UnitPrice;
2285
-
2286
- /**
2287
- * Upper bound of this tier (null for unlimited)
2288
- */
2289
- upTo?: number;
2290
- }
2291
-
2292
- export namespace Tier {
2293
- /**
2294
- * Flat price for this tier
2295
- */
2296
- export interface FlatPrice {
2297
- /**
2298
- * The price amount
2299
- */
2300
- amount: number;
2301
-
2302
- /**
2303
- * The price currency
2304
- */
2305
- currency?:
2306
- | 'usd'
2307
- | 'aed'
2308
- | 'all'
2309
- | 'amd'
2310
- | 'ang'
2311
- | 'aud'
2312
- | 'awg'
2313
- | 'azn'
2314
- | 'bam'
2315
- | 'bbd'
2316
- | 'bdt'
2317
- | 'bgn'
2318
- | 'bif'
2319
- | 'bmd'
2320
- | 'bnd'
2321
- | 'bsd'
2322
- | 'bwp'
2323
- | 'byn'
2324
- | 'bzd'
2325
- | 'brl'
2326
- | 'cad'
2327
- | 'cdf'
2328
- | 'chf'
2329
- | 'cny'
2330
- | 'czk'
2331
- | 'dkk'
2332
- | 'dop'
2333
- | 'dzd'
2334
- | 'egp'
2335
- | 'etb'
2336
- | 'eur'
2337
- | 'fjd'
2338
- | 'gbp'
2339
- | 'gel'
2340
- | 'gip'
2341
- | 'gmd'
2342
- | 'gyd'
2343
- | 'hkd'
2344
- | 'hrk'
2345
- | 'htg'
2346
- | 'idr'
2347
- | 'ils'
2348
- | 'inr'
2349
- | 'isk'
2350
- | 'jmd'
2351
- | 'jpy'
2352
- | 'kes'
2353
- | 'kgs'
2354
- | 'khr'
2355
- | 'kmf'
2356
- | 'krw'
2357
- | 'kyd'
2358
- | 'kzt'
2359
- | 'lbp'
2360
- | 'lkr'
2361
- | 'lrd'
2362
- | 'lsl'
2363
- | 'mad'
2364
- | 'mdl'
2365
- | 'mga'
2366
- | 'mkd'
2367
- | 'mmk'
2368
- | 'mnt'
2369
- | 'mop'
2370
- | 'mro'
2371
- | 'mvr'
2372
- | 'mwk'
2373
- | 'mxn'
2374
- | 'myr'
2375
- | 'mzn'
2376
- | 'nad'
2377
- | 'ngn'
2378
- | 'nok'
2379
- | 'npr'
2380
- | 'nzd'
2381
- | 'pgk'
2382
- | 'php'
2383
- | 'pkr'
2384
- | 'pln'
2385
- | 'qar'
2386
- | 'ron'
2387
- | 'rsd'
2388
- | 'rub'
2389
- | 'rwf'
2390
- | 'sar'
2391
- | 'sbd'
2392
- | 'scr'
2393
- | 'sek'
2394
- | 'sgd'
2395
- | 'sle'
2396
- | 'sll'
2397
- | 'sos'
2398
- | 'szl'
2399
- | 'thb'
2400
- | 'tjs'
2401
- | 'top'
2402
- | 'try'
2403
- | 'ttd'
2404
- | 'tzs'
2405
- | 'uah'
2406
- | 'uzs'
2407
- | 'vnd'
2408
- | 'vuv'
2409
- | 'wst'
2410
- | 'xaf'
2411
- | 'xcd'
2412
- | 'yer'
2413
- | 'zar'
2414
- | 'zmw'
2415
- | 'clp'
2416
- | 'djf'
2417
- | 'gnf'
2418
- | 'ugx'
2419
- | 'pyg'
2420
- | 'xof'
2421
- | 'xpf';
2422
- }
2423
-
2424
- /**
2425
- * Per-unit price in this tier
2426
- */
2427
- export interface UnitPrice {
2428
- /**
2429
- * The price amount
2430
- */
2431
- amount: number;
2432
-
2433
- /**
2434
- * The price currency
2435
- */
2436
- currency?:
2437
- | 'usd'
2438
- | 'aed'
2439
- | 'all'
2440
- | 'amd'
2441
- | 'ang'
2442
- | 'aud'
2443
- | 'awg'
2444
- | 'azn'
2445
- | 'bam'
2446
- | 'bbd'
2447
- | 'bdt'
2448
- | 'bgn'
2449
- | 'bif'
2450
- | 'bmd'
2451
- | 'bnd'
2452
- | 'bsd'
2453
- | 'bwp'
2454
- | 'byn'
2455
- | 'bzd'
2456
- | 'brl'
2457
- | 'cad'
2458
- | 'cdf'
2459
- | 'chf'
2460
- | 'cny'
2461
- | 'czk'
2462
- | 'dkk'
2463
- | 'dop'
2464
- | 'dzd'
2465
- | 'egp'
2466
- | 'etb'
2467
- | 'eur'
2468
- | 'fjd'
2469
- | 'gbp'
2470
- | 'gel'
2471
- | 'gip'
2472
- | 'gmd'
2473
- | 'gyd'
2474
- | 'hkd'
2475
- | 'hrk'
2476
- | 'htg'
2477
- | 'idr'
2478
- | 'ils'
2479
- | 'inr'
2480
- | 'isk'
2481
- | 'jmd'
2482
- | 'jpy'
2483
- | 'kes'
2484
- | 'kgs'
2485
- | 'khr'
2486
- | 'kmf'
2487
- | 'krw'
2488
- | 'kyd'
2489
- | 'kzt'
2490
- | 'lbp'
2491
- | 'lkr'
2492
- | 'lrd'
2493
- | 'lsl'
2494
- | 'mad'
2495
- | 'mdl'
2496
- | 'mga'
2497
- | 'mkd'
2498
- | 'mmk'
2499
- | 'mnt'
2500
- | 'mop'
2501
- | 'mro'
2502
- | 'mvr'
2503
- | 'mwk'
2504
- | 'mxn'
2505
- | 'myr'
2506
- | 'mzn'
2507
- | 'nad'
2508
- | 'ngn'
2509
- | 'nok'
2510
- | 'npr'
2511
- | 'nzd'
2512
- | 'pgk'
2513
- | 'php'
2514
- | 'pkr'
2515
- | 'pln'
2516
- | 'qar'
2517
- | 'ron'
2518
- | 'rsd'
2519
- | 'rub'
2520
- | 'rwf'
2521
- | 'sar'
2522
- | 'sbd'
2523
- | 'scr'
2524
- | 'sek'
2525
- | 'sgd'
2526
- | 'sle'
2527
- | 'sll'
2528
- | 'sos'
2529
- | 'szl'
2530
- | 'thb'
2531
- | 'tjs'
2532
- | 'top'
2533
- | 'try'
2534
- | 'ttd'
2535
- | 'tzs'
2536
- | 'uah'
2537
- | 'uzs'
2538
- | 'vnd'
2539
- | 'vuv'
2540
- | 'wst'
2541
- | 'xaf'
2542
- | 'xcd'
2543
- | 'yer'
2544
- | 'zar'
2545
- | 'zmw'
2546
- | 'clp'
2547
- | 'djf'
2548
- | 'gnf'
2549
- | 'ugx'
2550
- | 'pyg'
2551
- | 'xof'
2552
- | 'xpf';
2553
- }
2554
- }
2555
- }
2556
-
2557
- /**
2558
- * Entitlement configuration for the overage feature
2559
- */
2560
- export interface Entitlement {
2561
- /**
2562
- * The feature ID for the entitlement
2563
- */
2564
- featureId: string;
2565
-
2566
- /**
2567
- * Whether the limit is soft (allows overage)
2568
- */
2569
- hasSoftLimit?: boolean;
2570
-
2571
- /**
2572
- * Whether usage is unlimited
2573
- */
2574
- hasUnlimitedUsage?: boolean;
2575
-
2576
- /**
2577
- * Monthly reset configuration
2578
- */
2579
- monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
2580
-
2581
- /**
2582
- * The usage reset period
2583
- */
2584
- resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
2585
-
2586
- /**
2587
- * The usage limit before overage kicks in
2588
- */
2589
- usageLimit?: number;
2590
-
2591
- /**
2592
- * Weekly reset configuration
2593
- */
2594
- weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
2595
-
2596
- /**
2597
- * Yearly reset configuration
2598
- */
2599
- yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
2600
- }
2601
-
2602
- export namespace Entitlement {
2603
- /**
2604
- * Monthly reset configuration
2605
- */
2606
- export interface MonthlyResetPeriodConfiguration {
2607
- /**
2608
- * Reset anchor (SubscriptionStart or StartOfTheMonth)
2609
- */
2610
- accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
2611
- }
2612
-
2613
- /**
2614
- * Weekly reset configuration
2615
- */
2616
- export interface WeeklyResetPeriodConfiguration {
2617
- /**
2618
- * Reset anchor (SubscriptionStart or specific day)
2619
- */
2620
- accordingTo:
2621
- | 'SubscriptionStart'
2622
- | 'EverySunday'
2623
- | 'EveryMonday'
2624
- | 'EveryTuesday'
2625
- | 'EveryWednesday'
2626
- | 'EveryThursday'
2627
- | 'EveryFriday'
2628
- | 'EverySaturday';
2629
- }
2630
-
2631
- /**
2632
- * Yearly reset configuration
2633
- */
2634
- export interface YearlyResetPeriodConfiguration {
2635
- /**
2636
- * Reset anchor (SubscriptionStart)
2637
- */
2638
- accordingTo: 'SubscriptionStart';
2639
- }
2640
- }
2641
- }
2642
-
2643
- /**
2644
- * A pricing model configuration with billing details and price periods.
2645
- */
2646
- export interface PricingModel {
2647
- /**
2648
- * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
2649
- */
2650
- billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
2651
-
2652
- /**
2653
- * Array of price period configurations (at least one required)
2654
- */
2655
- pricePeriods: Array<PricingModel.PricePeriod>;
2656
-
2657
- /**
2658
- * The billing cadence (RECURRING or ONE_OFF)
2659
- */
2660
- billingCadence?: 'RECURRING' | 'ONE_OFF';
2661
-
2662
- /**
2663
- * The feature ID this pricing model is associated with
2664
- */
2665
- featureId?: string;
2666
-
2667
- /**
2668
- * Maximum number of units (max 999999)
2669
- */
2670
- maxUnitQuantity?: number;
2671
-
2672
- /**
2673
- * Minimum number of units
2674
- */
2675
- minUnitQuantity?: number;
2676
-
2677
- /**
2678
- * Monthly reset period configuration
2679
- */
2680
- monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
2681
-
2682
- /**
2683
- * The usage reset period
2684
- */
2685
- resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
2686
-
2687
- /**
2688
- * The tiered pricing mode (VOLUME or GRADUATED)
2689
- */
2690
- tiersMode?: 'VOLUME' | 'GRADUATED';
2691
-
2692
- /**
2693
- * The custom currency ID for top-up pricing
2694
- */
2695
- topUpCustomCurrencyId?: string;
2696
-
2697
- /**
2698
- * Weekly reset period configuration
2699
- */
2700
- weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
2701
-
2702
- /**
2703
- * Yearly reset period configuration
2704
- */
2705
- yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
2706
- }
2707
-
2708
- export namespace PricingModel {
2709
- /**
2710
- * Price configuration for a specific billing period.
2711
- */
2712
- export interface PricePeriod {
2713
- /**
2714
- * The billing period (MONTHLY or ANNUALLY)
2715
- */
2716
- billingPeriod: 'MONTHLY' | 'ANNUALLY';
2717
-
2718
- /**
2719
- * ISO country code for localized pricing
2720
- */
2721
- billingCountryCode?: string;
2722
-
2723
- /**
2724
- * Block size for usage-based pricing
2725
- */
2726
- blockSize?: number;
2727
-
2728
- /**
2729
- * When credits are granted
2730
- */
2731
- creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
2732
-
2733
- /**
2734
- * Credit rate configuration for credit-based pricing
2735
- */
2736
- creditRate?: PricePeriod.CreditRate;
2737
-
2738
- /**
2739
- * The price amount and currency
2740
- */
2741
- price?: PricePeriod.Price;
2742
-
2743
- /**
2744
- * Tiered pricing configuration
2745
- */
2746
- tiers?: Array<PricePeriod.Tier>;
2747
- }
2748
-
2749
- export namespace PricePeriod {
2750
- /**
2751
- * Credit rate configuration for credit-based pricing
2752
- */
2753
- export interface CreditRate {
2754
- /**
2755
- * The credit rate amount
2756
- */
2757
- amount: number;
2758
-
2759
- /**
2760
- * The custom currency ID
2761
- */
2762
- currencyId: string;
2763
-
2764
- /**
2765
- * Optional cost formula expression
2766
- */
2767
- costFormula?: string;
2768
- }
2769
-
2770
- /**
2771
- * The price amount and currency
2772
- */
2773
- export interface Price {
2774
- /**
2775
- * The price amount
2776
- */
2777
- amount: number;
2778
-
2779
- /**
2780
- * The price currency
2781
- */
2782
- currency?:
2783
- | 'usd'
2784
- | 'aed'
2785
- | 'all'
2786
- | 'amd'
2787
- | 'ang'
2788
- | 'aud'
2789
- | 'awg'
2790
- | 'azn'
2791
- | 'bam'
2792
- | 'bbd'
2793
- | 'bdt'
2794
- | 'bgn'
2795
- | 'bif'
2796
- | 'bmd'
2797
- | 'bnd'
2798
- | 'bsd'
2799
- | 'bwp'
2800
- | 'byn'
2801
- | 'bzd'
2802
- | 'brl'
2803
- | 'cad'
2804
- | 'cdf'
2805
- | 'chf'
2806
- | 'cny'
2807
- | 'czk'
2808
- | 'dkk'
2809
- | 'dop'
2810
- | 'dzd'
2811
- | 'egp'
2812
- | 'etb'
2813
- | 'eur'
2814
- | 'fjd'
2815
- | 'gbp'
2816
- | 'gel'
2817
- | 'gip'
2818
- | 'gmd'
2819
- | 'gyd'
2820
- | 'hkd'
2821
- | 'hrk'
2822
- | 'htg'
2823
- | 'idr'
2824
- | 'ils'
2825
- | 'inr'
2826
- | 'isk'
2827
- | 'jmd'
2828
- | 'jpy'
2829
- | 'kes'
2830
- | 'kgs'
2831
- | 'khr'
2832
- | 'kmf'
2833
- | 'krw'
2834
- | 'kyd'
2835
- | 'kzt'
2836
- | 'lbp'
2837
- | 'lkr'
2838
- | 'lrd'
2839
- | 'lsl'
2840
- | 'mad'
2841
- | 'mdl'
2842
- | 'mga'
2843
- | 'mkd'
2844
- | 'mmk'
2845
- | 'mnt'
2846
- | 'mop'
2847
- | 'mro'
2848
- | 'mvr'
2849
- | 'mwk'
2850
- | 'mxn'
2851
- | 'myr'
2852
- | 'mzn'
2853
- | 'nad'
2854
- | 'ngn'
2855
- | 'nok'
2856
- | 'npr'
2857
- | 'nzd'
2858
- | 'pgk'
2859
- | 'php'
2860
- | 'pkr'
2861
- | 'pln'
2862
- | 'qar'
2863
- | 'ron'
2864
- | 'rsd'
2865
- | 'rub'
2866
- | 'rwf'
2867
- | 'sar'
2868
- | 'sbd'
2869
- | 'scr'
2870
- | 'sek'
2871
- | 'sgd'
2872
- | 'sle'
2873
- | 'sll'
2874
- | 'sos'
2875
- | 'szl'
2876
- | 'thb'
2877
- | 'tjs'
2878
- | 'top'
2879
- | 'try'
2880
- | 'ttd'
2881
- | 'tzs'
2882
- | 'uah'
2883
- | 'uzs'
2884
- | 'vnd'
2885
- | 'vuv'
2886
- | 'wst'
2887
- | 'xaf'
2888
- | 'xcd'
2889
- | 'yer'
2890
- | 'zar'
2891
- | 'zmw'
2892
- | 'clp'
2893
- | 'djf'
2894
- | 'gnf'
2895
- | 'ugx'
2896
- | 'pyg'
2897
- | 'xof'
2898
- | 'xpf';
2899
- }
2900
-
2901
- /**
2902
- * A tier in tiered pricing.
2903
- */
2904
- export interface Tier {
2905
- /**
2906
- * Flat price for this tier
2907
- */
2908
- flatPrice?: Tier.FlatPrice;
2909
-
2910
- /**
2911
- * Per-unit price in this tier
2912
- */
2913
- unitPrice?: Tier.UnitPrice;
2914
-
2915
- /**
2916
- * Upper bound of this tier (null for unlimited)
2917
- */
2918
- upTo?: number;
2919
- }
2920
-
2921
- export namespace Tier {
2922
- /**
2923
- * Flat price for this tier
2924
- */
2925
- export interface FlatPrice {
2926
- /**
2927
- * The price amount
2928
- */
2929
- amount: number;
2930
-
2931
- /**
2932
- * The price currency
2933
- */
2934
- currency?:
2935
- | 'usd'
2936
- | 'aed'
2937
- | 'all'
2938
- | 'amd'
2939
- | 'ang'
2940
- | 'aud'
2941
- | 'awg'
2942
- | 'azn'
2943
- | 'bam'
2944
- | 'bbd'
2945
- | 'bdt'
2946
- | 'bgn'
2947
- | 'bif'
2948
- | 'bmd'
2949
- | 'bnd'
2950
- | 'bsd'
2951
- | 'bwp'
2952
- | 'byn'
2953
- | 'bzd'
2954
- | 'brl'
2955
- | 'cad'
2956
- | 'cdf'
2957
- | 'chf'
2958
- | 'cny'
2959
- | 'czk'
2960
- | 'dkk'
2961
- | 'dop'
2962
- | 'dzd'
2963
- | 'egp'
2964
- | 'etb'
2965
- | 'eur'
2966
- | 'fjd'
2967
- | 'gbp'
2968
- | 'gel'
2969
- | 'gip'
2970
- | 'gmd'
2971
- | 'gyd'
2972
- | 'hkd'
2973
- | 'hrk'
2974
- | 'htg'
2975
- | 'idr'
2976
- | 'ils'
2977
- | 'inr'
2978
- | 'isk'
2979
- | 'jmd'
2980
- | 'jpy'
2981
- | 'kes'
2982
- | 'kgs'
2983
- | 'khr'
2984
- | 'kmf'
2985
- | 'krw'
2986
- | 'kyd'
2987
- | 'kzt'
2988
- | 'lbp'
2989
- | 'lkr'
2990
- | 'lrd'
2991
- | 'lsl'
2992
- | 'mad'
2993
- | 'mdl'
2994
- | 'mga'
2995
- | 'mkd'
2996
- | 'mmk'
2997
- | 'mnt'
2998
- | 'mop'
2999
- | 'mro'
3000
- | 'mvr'
3001
- | 'mwk'
3002
- | 'mxn'
3003
- | 'myr'
3004
- | 'mzn'
3005
- | 'nad'
3006
- | 'ngn'
3007
- | 'nok'
3008
- | 'npr'
3009
- | 'nzd'
3010
- | 'pgk'
3011
- | 'php'
3012
- | 'pkr'
3013
- | 'pln'
3014
- | 'qar'
3015
- | 'ron'
3016
- | 'rsd'
3017
- | 'rub'
3018
- | 'rwf'
3019
- | 'sar'
3020
- | 'sbd'
3021
- | 'scr'
3022
- | 'sek'
3023
- | 'sgd'
3024
- | 'sle'
3025
- | 'sll'
3026
- | 'sos'
3027
- | 'szl'
3028
- | 'thb'
3029
- | 'tjs'
3030
- | 'top'
3031
- | 'try'
3032
- | 'ttd'
3033
- | 'tzs'
3034
- | 'uah'
3035
- | 'uzs'
3036
- | 'vnd'
3037
- | 'vuv'
3038
- | 'wst'
3039
- | 'xaf'
3040
- | 'xcd'
3041
- | 'yer'
3042
- | 'zar'
3043
- | 'zmw'
3044
- | 'clp'
3045
- | 'djf'
3046
- | 'gnf'
3047
- | 'ugx'
3048
- | 'pyg'
3049
- | 'xof'
3050
- | 'xpf';
3051
- }
3052
-
3053
- /**
3054
- * Per-unit price in this tier
3055
- */
3056
- export interface UnitPrice {
3057
- /**
3058
- * The price amount
3059
- */
3060
- amount: number;
3061
-
3062
- /**
3063
- * The price currency
3064
- */
3065
- currency?:
3066
- | 'usd'
3067
- | 'aed'
3068
- | 'all'
3069
- | 'amd'
3070
- | 'ang'
3071
- | 'aud'
3072
- | 'awg'
3073
- | 'azn'
3074
- | 'bam'
3075
- | 'bbd'
3076
- | 'bdt'
3077
- | 'bgn'
3078
- | 'bif'
3079
- | 'bmd'
3080
- | 'bnd'
3081
- | 'bsd'
3082
- | 'bwp'
3083
- | 'byn'
3084
- | 'bzd'
3085
- | 'brl'
3086
- | 'cad'
3087
- | 'cdf'
3088
- | 'chf'
3089
- | 'cny'
3090
- | 'czk'
3091
- | 'dkk'
3092
- | 'dop'
3093
- | 'dzd'
3094
- | 'egp'
3095
- | 'etb'
3096
- | 'eur'
3097
- | 'fjd'
3098
- | 'gbp'
3099
- | 'gel'
3100
- | 'gip'
3101
- | 'gmd'
3102
- | 'gyd'
3103
- | 'hkd'
3104
- | 'hrk'
3105
- | 'htg'
3106
- | 'idr'
3107
- | 'ils'
3108
- | 'inr'
3109
- | 'isk'
3110
- | 'jmd'
3111
- | 'jpy'
3112
- | 'kes'
3113
- | 'kgs'
3114
- | 'khr'
3115
- | 'kmf'
3116
- | 'krw'
3117
- | 'kyd'
3118
- | 'kzt'
3119
- | 'lbp'
3120
- | 'lkr'
3121
- | 'lrd'
3122
- | 'lsl'
3123
- | 'mad'
3124
- | 'mdl'
3125
- | 'mga'
3126
- | 'mkd'
3127
- | 'mmk'
3128
- | 'mnt'
3129
- | 'mop'
3130
- | 'mro'
3131
- | 'mvr'
3132
- | 'mwk'
3133
- | 'mxn'
3134
- | 'myr'
3135
- | 'mzn'
3136
- | 'nad'
3137
- | 'ngn'
3138
- | 'nok'
3139
- | 'npr'
3140
- | 'nzd'
3141
- | 'pgk'
3142
- | 'php'
3143
- | 'pkr'
3144
- | 'pln'
3145
- | 'qar'
3146
- | 'ron'
3147
- | 'rsd'
3148
- | 'rub'
3149
- | 'rwf'
3150
- | 'sar'
3151
- | 'sbd'
3152
- | 'scr'
3153
- | 'sek'
3154
- | 'sgd'
3155
- | 'sle'
3156
- | 'sll'
3157
- | 'sos'
3158
- | 'szl'
3159
- | 'thb'
3160
- | 'tjs'
3161
- | 'top'
3162
- | 'try'
3163
- | 'ttd'
3164
- | 'tzs'
3165
- | 'uah'
3166
- | 'uzs'
3167
- | 'vnd'
3168
- | 'vuv'
3169
- | 'wst'
3170
- | 'xaf'
3171
- | 'xcd'
3172
- | 'yer'
3173
- | 'zar'
3174
- | 'zmw'
3175
- | 'clp'
3176
- | 'djf'
3177
- | 'gnf'
3178
- | 'ugx'
3179
- | 'pyg'
3180
- | 'xof'
3181
- | 'xpf';
3182
- }
3183
- }
3184
- }
3185
-
3186
- /**
3187
- * Monthly reset period configuration
3188
- */
3189
- export interface MonthlyResetPeriodConfiguration {
3190
- /**
3191
- * Reset anchor (SubscriptionStart or StartOfTheMonth)
3192
- */
3193
- accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
3194
- }
3195
-
3196
- /**
3197
- * Weekly reset period configuration
3198
- */
3199
- export interface WeeklyResetPeriodConfiguration {
3200
- /**
3201
- * Reset anchor (SubscriptionStart or specific day)
3202
- */
3203
- accordingTo:
3204
- | 'SubscriptionStart'
3205
- | 'EverySunday'
3206
- | 'EveryMonday'
3207
- | 'EveryTuesday'
3208
- | 'EveryWednesday'
3209
- | 'EveryThursday'
3210
- | 'EveryFriday'
3211
- | 'EverySaturday';
3212
- }
3213
-
3214
- /**
3215
- * Yearly reset period configuration
3216
- */
3217
- export interface YearlyResetPeriodConfiguration {
3218
- /**
3219
- * Reset anchor (SubscriptionStart)
3220
- */
3221
- accordingTo: 'SubscriptionStart';
3222
- }
3223
- }
1825
+ export interface AddonPublishParams {
1826
+ /**
1827
+ * The migration type of the package
1828
+ */
1829
+ migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
3224
1830
  }
3225
1831
 
3226
1832
  Addons.Entitlements = Entitlements;
@@ -3228,8 +1834,6 @@ Addons.Entitlements = Entitlements;
3228
1834
  export declare namespace Addons {
3229
1835
  export {
3230
1836
  type Addon as Addon,
3231
- type SetPackagePricing as SetPackagePricing,
3232
- type SetPackagePricingResponse as SetPackagePricingResponse,
3233
1837
  type AddonListResponse as AddonListResponse,
3234
1838
  type AddonPublishResponse as AddonPublishResponse,
3235
1839
  type AddonRemoveDraftResponse as AddonRemoveDraftResponse,
@@ -3238,7 +1842,6 @@ export declare namespace Addons {
3238
1842
  type AddonUpdateParams as AddonUpdateParams,
3239
1843
  type AddonListParams as AddonListParams,
3240
1844
  type AddonPublishParams as AddonPublishParams,
3241
- type AddonSetPricingParams as AddonSetPricingParams,
3242
1845
  };
3243
1846
 
3244
1847
  export {