@leaflow/sdk 0.0.0-dev.358.gbb34078 → 0.0.0-dev.359.gca6d1b5

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 (166) hide show
  1. package/dist/billing/type/order/v1/generated/models.d.ts +71 -33
  2. package/dist/billing/type/order/v1/generated/models.js +2 -1
  3. package/dist/billing/type/order/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  4. package/dist/billing/type/order/v1/generated/validators/cancellation.zod.js +2 -2
  5. package/dist/billing/type/order/v1/generated/validators/cancellationCreate.zod.js +2 -2
  6. package/dist/billing/type/order/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  7. package/dist/billing/type/order/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  8. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  9. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  10. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  11. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  12. package/dist/billing/type/order/v1/generated/validators/order.zod.d.ts +5 -3
  13. package/dist/billing/type/order/v1/generated/validators/orderItem.zod.d.ts +5 -3
  14. package/dist/billing/type/order/v1/generated/validators/orderItem.zod.js +10 -6
  15. package/dist/billing/type/order/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  16. package/dist/billing/type/order/v1/generated/validators/orderList.zod.d.ts +5 -3
  17. package/dist/billing/type/order/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  18. package/dist/billing/type/order/v1/generated/validators/price.zod.d.ts +4 -1
  19. package/dist/billing/type/order/v1/generated/validators/price.zod.js +10 -2
  20. package/dist/billing/type/order/v1/generated/validators/priceList.zod.d.ts +4 -1
  21. package/dist/billing/type/order/v1/generated/validators/quote.zod.d.ts +2 -0
  22. package/dist/billing/type/order/v1/generated/validators/quoteCancellation.zod.js +2 -2
  23. package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  24. package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.js +2 -2
  25. package/dist/billing/type/order/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  26. package/dist/billing/type/order/v1/generated/validators/quoteRenewal.zod.js +3 -3
  27. package/dist/billing/type/order/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  28. package/dist/billing/type/order/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  29. package/dist/billing/type/order/v1/generated/validators/refundPolicy.zod.js +2 -2
  30. package/dist/billing/type/order/v1/generated/validators/refundReason.zod.js +1 -1
  31. package/dist/billing/type/order/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  32. package/dist/billing/type/order/v1/generated/validators/renewRequest.zod.js +3 -3
  33. package/dist/billing/type/order/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  34. package/dist/billing/type/order/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  35. package/dist/billing/type/order/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  36. package/dist/billing/type/order/v1/generated/validators/renewalPrice.zod.js +4 -2
  37. package/dist/billing/type/order/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  38. package/dist/billing/type/order/v1/generated/validators/subscription.zod.d.ts +5 -1
  39. package/dist/billing/type/order/v1/generated/validators/subscription.zod.js +14 -2
  40. package/dist/billing/type/order/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  41. package/dist/billing/v1/generated/functions.d.ts +1 -1
  42. package/dist/billing/v1/generated/functions.js +1 -1
  43. package/dist/billing/v1/generated/models.d.ts +71 -33
  44. package/dist/billing/v1/generated/models.js +2 -1
  45. package/dist/billing/v1/generated/schemas.zod.d.ts +3 -3
  46. package/dist/billing/v1/generated/schemas.zod.js +1 -1
  47. package/dist/billing/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  48. package/dist/billing/v1/generated/validators/cancellation.zod.js +2 -2
  49. package/dist/billing/v1/generated/validators/cancellationCreate.zod.js +2 -2
  50. package/dist/billing/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  51. package/dist/billing/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  52. package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  53. package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  54. package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  55. package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  56. package/dist/billing/v1/generated/validators/order.zod.d.ts +5 -3
  57. package/dist/billing/v1/generated/validators/orderItem.zod.d.ts +5 -3
  58. package/dist/billing/v1/generated/validators/orderItem.zod.js +10 -6
  59. package/dist/billing/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  60. package/dist/billing/v1/generated/validators/orderList.zod.d.ts +5 -3
  61. package/dist/billing/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  62. package/dist/billing/v1/generated/validators/price.zod.d.ts +4 -1
  63. package/dist/billing/v1/generated/validators/price.zod.js +10 -2
  64. package/dist/billing/v1/generated/validators/priceList.zod.d.ts +4 -1
  65. package/dist/billing/v1/generated/validators/quote.zod.d.ts +2 -0
  66. package/dist/billing/v1/generated/validators/quoteCancellation.zod.js +2 -2
  67. package/dist/billing/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  68. package/dist/billing/v1/generated/validators/quoteItemInput.zod.js +2 -2
  69. package/dist/billing/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  70. package/dist/billing/v1/generated/validators/quoteRenewal.zod.js +3 -3
  71. package/dist/billing/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  72. package/dist/billing/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  73. package/dist/billing/v1/generated/validators/refundPolicy.zod.js +2 -2
  74. package/dist/billing/v1/generated/validators/refundReason.zod.js +1 -1
  75. package/dist/billing/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  76. package/dist/billing/v1/generated/validators/renewRequest.zod.js +3 -3
  77. package/dist/billing/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  78. package/dist/billing/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  79. package/dist/billing/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  80. package/dist/billing/v1/generated/validators/renewalPrice.zod.js +4 -2
  81. package/dist/billing/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  82. package/dist/billing/v1/generated/validators/subscription.zod.d.ts +5 -1
  83. package/dist/billing/v1/generated/validators/subscription.zod.js +14 -2
  84. package/dist/billing/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  85. package/dist/canopy/v1/generated/models.d.ts +71 -33
  86. package/dist/canopy/v1/generated/models.js +2 -1
  87. package/dist/canopy/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  88. package/dist/canopy/v1/generated/validators/cancellation.zod.js +2 -2
  89. package/dist/canopy/v1/generated/validators/cancellationCreate.zod.js +2 -2
  90. package/dist/canopy/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  91. package/dist/canopy/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  92. package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  93. package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  94. package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  95. package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  96. package/dist/canopy/v1/generated/validators/order.zod.d.ts +5 -3
  97. package/dist/canopy/v1/generated/validators/orderItem.zod.d.ts +5 -3
  98. package/dist/canopy/v1/generated/validators/orderItem.zod.js +10 -6
  99. package/dist/canopy/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  100. package/dist/canopy/v1/generated/validators/orderList.zod.d.ts +5 -3
  101. package/dist/canopy/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  102. package/dist/canopy/v1/generated/validators/price.zod.d.ts +4 -1
  103. package/dist/canopy/v1/generated/validators/price.zod.js +10 -2
  104. package/dist/canopy/v1/generated/validators/priceList.zod.d.ts +4 -1
  105. package/dist/canopy/v1/generated/validators/quote5f60d00.zod.d.ts +2 -0
  106. package/dist/canopy/v1/generated/validators/quoteA200529.zod.d.ts +2 -0
  107. package/dist/canopy/v1/generated/validators/quoteCancellation.zod.js +2 -2
  108. package/dist/canopy/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  109. package/dist/canopy/v1/generated/validators/quoteItemInput.zod.js +2 -2
  110. package/dist/canopy/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  111. package/dist/canopy/v1/generated/validators/quoteRenewal.zod.js +3 -3
  112. package/dist/canopy/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  113. package/dist/canopy/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  114. package/dist/canopy/v1/generated/validators/refundPolicy.zod.js +2 -2
  115. package/dist/canopy/v1/generated/validators/refundReason.zod.js +1 -1
  116. package/dist/canopy/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  117. package/dist/canopy/v1/generated/validators/renewRequest.zod.js +3 -3
  118. package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  119. package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  120. package/dist/canopy/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  121. package/dist/canopy/v1/generated/validators/renewalPrice.zod.js +4 -2
  122. package/dist/canopy/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  123. package/dist/canopy/v1/generated/validators/subscription.zod.d.ts +5 -1
  124. package/dist/canopy/v1/generated/validators/subscription.zod.js +14 -2
  125. package/dist/canopy/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  126. package/dist/membership/v1/generated/models.d.ts +71 -33
  127. package/dist/membership/v1/generated/models.js +2 -1
  128. package/dist/membership/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  129. package/dist/membership/v1/generated/validators/cancellation.zod.js +2 -2
  130. package/dist/membership/v1/generated/validators/cancellationCreate.zod.js +2 -2
  131. package/dist/membership/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  132. package/dist/membership/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  133. package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  134. package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  135. package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  136. package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  137. package/dist/membership/v1/generated/validators/order.zod.d.ts +5 -3
  138. package/dist/membership/v1/generated/validators/orderItem.zod.d.ts +5 -3
  139. package/dist/membership/v1/generated/validators/orderItem.zod.js +10 -6
  140. package/dist/membership/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  141. package/dist/membership/v1/generated/validators/orderList.zod.d.ts +5 -3
  142. package/dist/membership/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  143. package/dist/membership/v1/generated/validators/price.zod.d.ts +4 -1
  144. package/dist/membership/v1/generated/validators/price.zod.js +10 -2
  145. package/dist/membership/v1/generated/validators/priceList.zod.d.ts +4 -1
  146. package/dist/membership/v1/generated/validators/quote.zod.d.ts +2 -0
  147. package/dist/membership/v1/generated/validators/quoteCancellation.zod.js +2 -2
  148. package/dist/membership/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  149. package/dist/membership/v1/generated/validators/quoteItemInput.zod.js +2 -2
  150. package/dist/membership/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  151. package/dist/membership/v1/generated/validators/quoteRenewal.zod.js +3 -3
  152. package/dist/membership/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  153. package/dist/membership/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  154. package/dist/membership/v1/generated/validators/refundPolicy.zod.js +2 -2
  155. package/dist/membership/v1/generated/validators/refundReason.zod.js +1 -1
  156. package/dist/membership/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  157. package/dist/membership/v1/generated/validators/renewRequest.zod.js +3 -3
  158. package/dist/membership/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  159. package/dist/membership/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  160. package/dist/membership/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  161. package/dist/membership/v1/generated/validators/renewalPrice.zod.js +4 -2
  162. package/dist/membership/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  163. package/dist/membership/v1/generated/validators/subscription.zod.d.ts +5 -1
  164. package/dist/membership/v1/generated/validators/subscription.zod.js +14 -2
  165. package/dist/membership/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  166. package/package.json +1 -1
@@ -250,20 +250,34 @@ export interface WithdrawalItemList {
250
250
  pagination: OffsetPagination;
251
251
  }
252
252
  /**
253
- * Whether a delivered purchase may end immediately or only at the end of its paid term; refunds follow the refund policy. When absent, no termination terms were agreed.
253
+ * Whether a cancellation of a delivered purchase may take effect immediately or only at the end of its paid term; refunds follow the refund policy. When absent, no cancellation terms were agreed.
254
254
  */
255
- export type TerminationPolicy = (typeof TerminationPolicy)[keyof typeof TerminationPolicy];
256
- export declare const TerminationPolicy: {
255
+ export type CancellationPolicy = (typeof CancellationPolicy)[keyof typeof CancellationPolicy];
256
+ export declare const CancellationPolicy: {
257
257
  readonly immediate: "immediate";
258
258
  readonly period_end: "period_end";
259
259
  };
260
260
  /**
261
- * `none` refunds nothing. `prorated` refunds the amount paid for the current period minus the value of the time used, never below zero or above what remains unrefunded. Time used runs from the period start to the effective cancellation and is valued at prices frozen on the order item: each full calendar month at `refund_monthly_amount`, the rest at `refund_hourly_amount` or, without it, at the monthly price by the second. When the plan has no licensed period shorter than the one bought, time used is valued pro rata at the price paid. Discounts and setup fees are not refunded. Refunds return to the original payment sources, with tax refunded in proportion.
261
+ * `none` refunds nothing.
262
+ *
263
+ * `prorated` refunds the amount paid for the current period minus the value of the time used, never below zero
264
+ * or above what remains unrefunded. Time used runs from the period start to the effective cancellation, by the
265
+ * second. Each whole month from the period start is valued at the order item's `monthly_list_amount`, and the
266
+ * remainder at that amount in proportion to the length of the month it falls in; without `monthly_list_amount`,
267
+ * time used is valued at the amount paid in proportion to the length of the period. A renewal starts a new
268
+ * period, and an immediate change starts one at the change. Discounts and setup fees are not refunded. Refunds
269
+ * return to the original payment sources, with tax refunded in proportion.
270
+ *
271
+ * `short_rate` refunds as `prorated`, except that when the cancellation takes effect less than
272
+ * `short_rate_threshold_seconds` after the period start, the value of the time used is multiplied by
273
+ * `short_rate_multiplier`, up to `monthly_list_amount` for each month begun or, without `monthly_list_amount`,
274
+ * up to the amount paid.
262
275
  */
263
276
  export type RefundPolicy = (typeof RefundPolicy)[keyof typeof RefundPolicy];
264
277
  export declare const RefundPolicy: {
265
278
  readonly none: "none";
266
279
  readonly prorated: "prorated";
280
+ readonly short_rate: "short_rate";
267
281
  };
268
282
  export interface OrderCancel {
269
283
  /**
@@ -283,8 +297,8 @@ export declare const QuoteRenewalInterval: {
283
297
  * Price renewing a licensed subscription. Give `price_id`, or `interval` with
284
298
  * `interval_count`, to renew for another term at the price currently sold for it. Naming
285
299
  * the current term, or giving neither, renews at the agreed amount. A term sold at several
286
- * prices that differ in termination policy is refused with 409
287
- * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` or `price_id` is given.
300
+ * prices that differ in cancellation policy is refused with 409
301
+ * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` or `price_id` is given.
288
302
  */
289
303
  export interface QuoteRenewal {
290
304
  subscription_id: string;
@@ -292,8 +306,8 @@ export interface QuoteRenewal {
292
306
  interval?: QuoteRenewalInterval;
293
307
  /** @minimum 1 */
294
308
  interval_count?: number;
295
- /** With `interval` and `interval_count`, chooses among prices of that term that differ in termination policy. */
296
- termination_policy?: TerminationPolicy;
309
+ /** With `interval` and `interval_count`, chooses among prices of that term that differ in cancellation policy. */
310
+ cancellation_policy?: CancellationPolicy;
297
311
  /**
298
312
  * How many consecutive periods to renew for.
299
313
  * @minimum 1
@@ -444,6 +458,7 @@ export interface CancellationRefundPreviewItem {
444
458
  /** Whether automatic renewal is on now. Creating the cancellation turns it off; withdrawing it turns it back on for a metered subscription but not for a licensed one. */
445
459
  auto_renew: boolean;
446
460
  unused_amount: Money;
461
+ short_rate_surcharge_amount: Money;
447
462
  refundable_amount: Money;
448
463
  refund_amount: Money;
449
464
  credit_amount: Money;
@@ -454,8 +469,9 @@ export interface CancellationRefundPreviewItem {
454
469
  * What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and
455
470
  * `refundable_amount` when creating the cancellation.
456
471
  *
457
- * - `unused_amount`: before tax, the amount paid for the current periods minus the value of the time used,
458
- * valued as refund policy `prorated` describes, whatever the refund terms say.
472
+ * - `unused_amount`: before tax, the amount paid for the current periods in proportion to the time remaining.
473
+ * - `short_rate_surcharge_amount`: before tax, the part of `forfeited_amount` due to the short rate of the
474
+ * refund policy.
459
475
  * - `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus
460
476
  * `credit_amount`.
461
477
  * - `refund_amount`: the part returned to the balance or the payment method.
@@ -466,13 +482,14 @@ export interface CancellationRefundPreviewItem {
466
482
  * Metered and one-time subscriptions show zero; their usage until release is charged as usual.
467
483
  */
468
484
  export interface CancellationRefundPreview {
469
- mode: TerminationPolicy;
485
+ mode: CancellationPolicy;
470
486
  /** For `period_end`, when release begins, the end of the paid terms. */
471
487
  scheduled_at?: string;
472
488
  /** For `immediate`, the second the refund is computed as of. Give it when creating the cancellation. */
473
489
  proration_date?: string;
474
490
  currency: string;
475
491
  unused_amount: Money;
492
+ short_rate_surcharge_amount: Money;
476
493
  refundable_amount: Money;
477
494
  refund_amount: Money;
478
495
  credit_amount: Money;
@@ -481,7 +498,7 @@ export interface CancellationRefundPreview {
481
498
  items: CancellationRefundPreviewItem[];
482
499
  }
483
500
  /**
484
- * An estimated refund to the original payment sources. Before acceptance, cancellation returns the collected amount. For delivered service, only value paid by this order is included; renewals are evaluated with their own orders under the agreed termination terms. Nothing is refunded by the quote; the amount is fixed when cancellation or termination is confirmed.
501
+ * An estimated refund to the original payment sources. Before acceptance, cancellation returns the collected amount. For delivered service, only value paid by this order is included; renewals are evaluated with their own orders under the agreed cancellation terms. Nothing is refunded by the quote; the amount is fixed when cancellation or termination is confirmed.
485
502
  */
486
503
  export interface OrderRefundQuote {
487
504
  order_id: string;
@@ -520,7 +537,7 @@ export interface QuoteCancellation {
520
537
  * @maxItems 50
521
538
  */
522
539
  subscription_ids: string[];
523
- mode: TerminationPolicy;
540
+ mode: CancellationPolicy;
524
541
  }
525
542
  export interface CancellationCreate {
526
543
  /**
@@ -529,7 +546,7 @@ export interface CancellationCreate {
529
546
  * @maxItems 50
530
547
  */
531
548
  subscription_ids: string[];
532
- mode: TerminationPolicy;
549
+ mode: CancellationPolicy;
533
550
  /** For `immediate`, the quote's `proration_date`: a whole second, not in the future and at most ten minutes old; the refund is computed as of it. Now when omitted. */
534
551
  proration_date?: string;
535
552
  /** The quote's `refundable_amount`; the cancellation is refused when the refund differs. */
@@ -609,7 +626,7 @@ export interface CancellationItem {
609
626
  export interface Cancellation {
610
627
  id: string;
611
628
  status: CancellationStatus;
612
- mode: TerminationPolicy;
629
+ mode: CancellationPolicy;
613
630
  scheduled_at?: string;
614
631
  /** For `immediate`, the second the refund is computed as of. */
615
632
  proration_date?: string;
@@ -1542,9 +1559,11 @@ export declare const RefundStatus: {
1542
1559
  * - `change_expired`: a scheduled change could not take effect in time.
1543
1560
  * - `subscription_canceled`: the unused value of a canceled subscription, under its refund terms.
1544
1561
  * - `future_period_canceled`: a renewal that had not started was withdrawn.
1545
- * - `downgrade_difference`: after a downgrade, the remaining paid value, valued as refund policy `prorated`
1546
- * describes, minus the new configuration's cost for the remaining time at the change item's
1547
- * `refund_monthly_amount` and `refund_hourly_amount`.
1562
+ * - `downgrade_difference`: after a downgrade, the remaining paid value, valued under each paid period's refund
1563
+ * policy and as `prorated` where that policy is `none`, minus the new configuration's value for the remaining
1564
+ * time: each whole month at the change item's `monthly_list_amount` and the remainder in proportion to the
1565
+ * length of the month it falls in, or without `monthly_list_amount`, the new period price in proportion to the
1566
+ * remaining time.
1548
1567
  * - `usage_true_up`: usage priced over the whole month cost less than was charged.
1549
1568
  * - `payment_not_applied`: a payment arrived after its invoice could no longer be paid.
1550
1569
  * - `operator`: made by the platform operator.
@@ -1765,8 +1784,14 @@ export interface Subscription {
1765
1784
  interval_count?: number;
1766
1785
  /** The whole licensed subscription's renewal amount, after continuing discounts and before tax. A pending subscription shows base terms until paying the order fixes any new discount. Absent for metered and one-time subscriptions. */
1767
1786
  recurring_amount?: string;
1768
- termination_policy?: TerminationPolicy;
1787
+ cancellation_policy?: CancellationPolicy;
1769
1788
  refund_policy?: RefundPolicy;
1789
+ /** Refund policy `short_rate` only, as on the price bought. */
1790
+ short_rate_multiplier?: string;
1791
+ /** Refund policy `short_rate` only, as on the price bought. */
1792
+ short_rate_threshold_seconds?: number;
1793
+ /** Licensed recurring only, the `monthly_list_amount` that a renewal at the agreed amount keeps; see the order item. */
1794
+ monthly_list_amount?: string;
1770
1795
  order_item_id?: string;
1771
1796
  coupon_id?: string;
1772
1797
  coupon?: ObjectIdentity;
@@ -1839,8 +1864,12 @@ export declare const RenewalPriceInterval: {
1839
1864
  readonly year: "year";
1840
1865
  };
1841
1866
  export interface RenewalPrice {
1842
- termination_policy?: TerminationPolicy;
1867
+ cancellation_policy?: CancellationPolicy;
1843
1868
  refund_policy?: RefundPolicy;
1869
+ /** Refund policy `short_rate` only. */
1870
+ short_rate_multiplier?: string;
1871
+ /** Refund policy `short_rate` only. */
1872
+ short_rate_threshold_seconds?: number;
1844
1873
  price_id: string;
1845
1874
  /** How many periods one renewal covers. */
1846
1875
  interval_count: number;
@@ -1879,8 +1908,8 @@ export interface RenewRequest {
1879
1908
  * Leaving both out renews at the price this item already bills at, which a later price
1880
1909
  * change does not affect. Naming a term that differs from the current one is a fresh
1881
1910
  * choice, so it is bought at today's price. Naming the current term changes nothing. A
1882
- * term sold at several prices that differ in termination policy is refused with 409
1883
- * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` is given.
1911
+ * term sold at several prices that differ in cancellation policy is refused with 409
1912
+ * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.
1884
1913
  *
1885
1914
  * List the terms on offer with the renewal prices operation.
1886
1915
  * @minimum 1
@@ -1888,8 +1917,8 @@ export interface RenewRequest {
1888
1917
  interval_count?: number;
1889
1918
  /** The unit interval_count counts in. */
1890
1919
  interval?: RenewRequestInterval;
1891
- /** With `interval` and `interval_count`, chooses among prices of that term that differ in termination policy. */
1892
- termination_policy?: TerminationPolicy;
1920
+ /** With `interval` and `interval_count`, chooses among prices of that term that differ in cancellation policy. */
1921
+ cancellation_policy?: CancellationPolicy;
1893
1922
  payment_method_id?: string;
1894
1923
  /** Whether to pay from the balance, with or without `payment_method_id`. */
1895
1924
  use_balance?: boolean;
@@ -1925,7 +1954,7 @@ export interface RenewalOrderRequest {
1925
1954
  /** As in renewing. */
1926
1955
  interval?: RenewalOrderRequestInterval;
1927
1956
  /** As in renewing. */
1928
- termination_policy?: TerminationPolicy;
1957
+ cancellation_policy?: CancellationPolicy;
1929
1958
  }
1930
1959
  export interface AutoRenewSet {
1931
1960
  auto_renew: boolean;
@@ -2006,18 +2035,23 @@ export interface OrderItem {
2006
2035
  interval: OrderItemInterval;
2007
2036
  /** @minimum 1 */
2008
2037
  interval_count?: number;
2009
- termination_policy?: TerminationPolicy;
2038
+ cancellation_policy?: CancellationPolicy;
2010
2039
  refund_policy?: RefundPolicy;
2011
2040
  /**
2012
- * Recurring licensed items only: the plan's one-month licensed price for this item's quantity, before tax and frozen at purchase, used to value time under a prorated refund or a downgrade. Null when the plan has no licensed period shorter than the one bought.
2041
+ * Recurring licensed items only: a month at list price for this item's quantity, before tax and discounts, which values time under a refund or a downgrade. It is the monthly amount of the shortest period the plan sells, not longer than the one bought, at the item's dimensions, fixed at purchase; a renewal at the agreed amount keeps the previous value. Null when time used is valued at the amount paid, as for a daily period.
2042
+ * @nullable
2043
+ */
2044
+ monthly_list_amount?: string | null;
2045
+ /**
2046
+ * Refund policy `short_rate` only, as on the price when bought.
2013
2047
  * @nullable
2014
2048
  */
2015
- refund_monthly_amount?: string | null;
2049
+ short_rate_multiplier?: string | null;
2016
2050
  /**
2017
- * Recurring licensed items only, the plan's metered hourly price for this item's quantity before tax, frozen at purchase, used for time used short of a full month. Null when the licensed price has no meter.
2051
+ * Refund policy `short_rate` only, as on the price when bought.
2018
2052
  * @nullable
2019
2053
  */
2020
- refund_hourly_amount?: string | null;
2054
+ short_rate_threshold_seconds?: number | null;
2021
2055
  recurring_amount?: string;
2022
2056
  setup_amount?: string;
2023
2057
  type: PriceType;
@@ -2347,8 +2381,12 @@ export interface Price {
2347
2381
  unit_quantity: string;
2348
2382
  /** False once archived. An archived price cannot be bought until it is active again. */
2349
2383
  active: boolean;
2350
- termination_policy?: TerminationPolicy;
2384
+ cancellation_policy?: CancellationPolicy;
2351
2385
  refund_policy?: RefundPolicy;
2386
+ /** Refund policy `short_rate` only, the factor applied to the value of the time used when a cancellation takes effect less than `short_rate_threshold_seconds` after the period start. */
2387
+ short_rate_multiplier?: string;
2388
+ /** Refund policy `short_rate` only, how long after the period start `short_rate_multiplier` applies. */
2389
+ short_rate_threshold_seconds?: number;
2352
2390
  product_id?: ProductID;
2353
2391
  id: string;
2354
2392
  plan_id: string;
@@ -2473,7 +2511,7 @@ export interface QuoteItemInput {
2473
2511
  /** @minimum 1 */
2474
2512
  interval_count?: number;
2475
2513
  /** Selects among licensed prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily. */
2476
- termination_policy?: TerminationPolicy;
2514
+ cancellation_policy?: CancellationPolicy;
2477
2515
  /** @pattern ^(?:(?:[1-9][0-9]{0,27}|0(?:[1-9][0-9]{0,26}|0(?:[1-9][0-9]{0,25}|0(?:[1-9][0-9]{0,24}|0(?:[1-9][0-9]{0,23}|0(?:[1-9][0-9]{0,22}|0(?:[1-9][0-9]{0,21}|0(?:[1-9][0-9]{0,20}|0(?:[1-9][0-9]{0,19}|0(?:[1-9][0-9]{0,18}|0(?:[1-9][0-9]{0,17}|0(?:[1-9][0-9]{0,16}|0(?:[1-9][0-9]{0,15}|0(?:[1-9][0-9]{0,14}|0(?:[1-9][0-9]{0,13}|0(?:[1-9][0-9]{0,12}|0(?:[1-9][0-9]{0,11}|0(?:[1-9][0-9]{0,10}|0(?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9])))))))))))))))))))))))))))([.][0-9]{1,10})?|0{1,28}[.](?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9]))))))))))$ */
2478
2516
  quantity: string;
2479
2517
  meter_id?: string;
@@ -2698,7 +2736,7 @@ export interface ContactList {
2698
2736
  pagination: OffsetPagination;
2699
2737
  }
2700
2738
  export interface CancelSubscriptionRequest {
2701
- mode: TerminationPolicy;
2739
+ mode: CancellationPolicy;
2702
2740
  /** For immediate cancellation, the quoted whole-second refund basis. Now when omitted. */
2703
2741
  proration_date?: string;
2704
2742
  /** The cancellation quote's refundable amount, including an explicit zero. */
@@ -18,13 +18,14 @@ export const WithdrawalStatus = {
18
18
  failed: "failed",
19
19
  reversed: "reversed",
20
20
  };
21
- export const TerminationPolicy = {
21
+ export const CancellationPolicy = {
22
22
  immediate: "immediate",
23
23
  period_end: "period_end",
24
24
  };
25
25
  export const RefundPolicy = {
26
26
  none: "none",
27
27
  prorated: "prorated",
28
+ short_rate: "short_rate",
28
29
  };
29
30
  export const QuoteRenewalInterval = {
30
31
  day: "day",
@@ -6,12 +6,12 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  import * as zod from "zod";
9
+ import { CancellationPolicy } from "./cancellationPolicy.zod.js";
9
10
  import { Money } from "./money.zod.js";
10
- import { TerminationPolicy } from "./terminationPolicy.zod.js";
11
11
  export const cancelSubscriptionRequestExpectedRefundableAmountTwoRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
12
12
  export const cancelSubscriptionRequestReasonMax = 1024;
13
13
  export const CancelSubscriptionRequest = zod.strictObject({
14
- mode: TerminationPolicy,
14
+ mode: CancellationPolicy,
15
15
  proration_date: zod.iso
16
16
  .datetime({ offset: true })
17
17
  .optional()
@@ -7,13 +7,13 @@
7
7
  */
8
8
  import * as zod from "zod";
9
9
  import { CancellationItem } from "./cancellationItem.zod.js";
10
+ import { CancellationPolicy } from "./cancellationPolicy.zod.js";
10
11
  import { Money } from "./money.zod.js";
11
- import { TerminationPolicy } from "./terminationPolicy.zod.js";
12
12
  export const Cancellation = zod
13
13
  .strictObject({
14
14
  id: zod.uuid(),
15
15
  status: zod.enum(["requested", "scheduled", "releasing", "completed", "canceled", "failed"]),
16
- mode: TerminationPolicy,
16
+ mode: CancellationPolicy,
17
17
  scheduled_at: zod.iso.datetime({ offset: true }).optional(),
18
18
  proration_date: zod.iso
19
19
  .datetime({ offset: true })
@@ -6,8 +6,8 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  import * as zod from "zod";
9
+ import { CancellationPolicy } from "./cancellationPolicy.zod.js";
9
10
  import { Money } from "./money.zod.js";
10
- import { TerminationPolicy } from "./terminationPolicy.zod.js";
11
11
  export const cancellationCreateSubscriptionIdsMax = 50;
12
12
  export const cancellationCreateExpectedRefundableAmountTwoRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
13
13
  export const cancellationCreateReasonMax = 1024;
@@ -17,7 +17,7 @@ export const CancellationCreate = zod.strictObject({
17
17
  .min(1)
18
18
  .max(cancellationCreateSubscriptionIdsMax)
19
19
  .describe("As in the quote."),
20
- mode: TerminationPolicy,
20
+ mode: CancellationPolicy,
21
21
  proration_date: zod.iso
22
22
  .datetime({ offset: true })
23
23
  .optional()
@@ -6,9 +6,9 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  import * as zod from "zod";
9
- export declare const TerminationPolicy: zod.ZodEnum<{
9
+ export declare const CancellationPolicy: zod.ZodEnum<{
10
10
  immediate: "immediate";
11
11
  period_end: "period_end";
12
12
  }>;
13
- export type TerminationPolicy = zod.input<typeof TerminationPolicy>;
14
- export type TerminationPolicyOutput = zod.output<typeof TerminationPolicy>;
13
+ export type CancellationPolicy = zod.input<typeof CancellationPolicy>;
14
+ export type CancellationPolicyOutput = zod.output<typeof CancellationPolicy>;
@@ -6,6 +6,6 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  import * as zod from "zod";
9
- export const TerminationPolicy = zod
9
+ export const CancellationPolicy = zod
10
10
  .enum(["immediate", "period_end"])
11
- .describe("Whether a delivered purchase may end immediately or only at the end of its paid term; refunds follow the refund policy. When absent, no termination terms were agreed.");
11
+ .describe("Whether a cancellation of a delivered purchase may take effect immediately or only at the end of its paid term; refunds follow the refund policy. When absent, no cancellation terms were agreed.");
@@ -15,6 +15,7 @@ export declare const CancellationRefundPreview: zod.ZodObject<{
15
15
  proration_date: zod.ZodOptional<zod.z.ZodISODateTime>;
16
16
  currency: zod.ZodString;
17
17
  unused_amount: zod.ZodString;
18
+ short_rate_surcharge_amount: zod.ZodString;
18
19
  refundable_amount: zod.ZodString;
19
20
  refund_amount: zod.ZodString;
20
21
  credit_amount: zod.ZodString;
@@ -38,6 +39,7 @@ export declare const CancellationRefundPreview: zod.ZodObject<{
38
39
  }>;
39
40
  auto_renew: zod.ZodBoolean;
40
41
  unused_amount: zod.ZodString;
42
+ short_rate_surcharge_amount: zod.ZodString;
41
43
  refundable_amount: zod.ZodString;
42
44
  refund_amount: zod.ZodString;
43
45
  credit_amount: zod.ZodString;
@@ -6,12 +6,12 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  import * as zod from "zod";
9
+ import { CancellationPolicy } from "./cancellationPolicy.zod.js";
9
10
  import { CancellationRefundPreviewItem } from "./cancellationRefundPreviewItem.zod.js";
10
11
  import { Money } from "./money.zod.js";
11
- import { TerminationPolicy } from "./terminationPolicy.zod.js";
12
12
  export const CancellationRefundPreview = zod
13
13
  .strictObject({
14
- mode: TerminationPolicy,
14
+ mode: CancellationPolicy,
15
15
  scheduled_at: zod.iso
16
16
  .datetime({ offset: true })
17
17
  .optional()
@@ -22,6 +22,7 @@ export const CancellationRefundPreview = zod
22
22
  .describe("For `immediate`, the second the refund is computed as of. Give it when creating the cancellation."),
23
23
  currency: zod.string(),
24
24
  unused_amount: Money,
25
+ short_rate_surcharge_amount: Money,
25
26
  refundable_amount: Money,
26
27
  refund_amount: Money,
27
28
  credit_amount: Money,
@@ -29,4 +30,4 @@ export const CancellationRefundPreview = zod
29
30
  forfeited_amount: Money,
30
31
  items: zod.array(CancellationRefundPreviewItem),
31
32
  })
32
- .describe("What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and\n`refundable_amount` when creating the cancellation.\n\n- `unused_amount`: before tax, the amount paid for the current periods minus the value of the time used,\n valued as refund policy `prorated` describes, whatever the refund terms say.\n- `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus\n `credit_amount`.\n- `refund_amount`: the part returned to the balance or the payment method.\n- `credit_amount`: the part restored to the credit grants that paid.\n- `tax_amount`: the tax included in `refundable_amount`.\n- `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.\n\nMetered and one-time subscriptions show zero; their usage until release is charged as usual.");
33
+ .describe("What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and\n`refundable_amount` when creating the cancellation.\n\n- `unused_amount`: before tax, the amount paid for the current periods in proportion to the time remaining.\n- `short_rate_surcharge_amount`: before tax, the part of `forfeited_amount` due to the short rate of the\n refund policy.\n- `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus\n `credit_amount`.\n- `refund_amount`: the part returned to the balance or the payment method.\n- `credit_amount`: the part restored to the credit grants that paid.\n- `tax_amount`: the tax included in `refundable_amount`.\n- `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.\n\nMetered and one-time subscriptions show zero; their usage until release is charged as usual.");
@@ -24,6 +24,7 @@ export declare const CancellationRefundPreviewItem: zod.ZodObject<{
24
24
  }>;
25
25
  auto_renew: zod.ZodBoolean;
26
26
  unused_amount: zod.ZodString;
27
+ short_rate_surcharge_amount: zod.ZodString;
27
28
  refundable_amount: zod.ZodString;
28
29
  refund_amount: zod.ZodString;
29
30
  credit_amount: zod.ZodString;
@@ -25,6 +25,7 @@ export const CancellationRefundPreviewItem = zod
25
25
  .boolean()
26
26
  .describe("Whether automatic renewal is on now. Creating the cancellation turns it off; withdrawing it turns it back on for a metered subscription but not for a licensed one."),
27
27
  unused_amount: Money,
28
+ short_rate_surcharge_amount: Money,
28
29
  refundable_amount: Money,
29
30
  refund_amount: Money,
30
31
  credit_amount: Money,
@@ -92,16 +92,18 @@ export declare const Order: zod.ZodObject<{
92
92
  year: "year";
93
93
  }>;
94
94
  interval_count: zod.ZodOptional<zod.ZodInt>;
95
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
95
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
96
96
  immediate: "immediate";
97
97
  period_end: "period_end";
98
98
  }>>;
99
99
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
100
100
  none: "none";
101
101
  prorated: "prorated";
102
+ short_rate: "short_rate";
102
103
  }>>;
103
- refund_monthly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
104
- refund_hourly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
104
+ monthly_list_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
105
+ short_rate_multiplier: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
106
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodNullable<zod.ZodInt>>;
105
107
  recurring_amount: zod.ZodOptional<zod.ZodString>;
106
108
  setup_amount: zod.ZodOptional<zod.ZodString>;
107
109
  type: zod.ZodEnum<{
@@ -20,16 +20,18 @@ export declare const OrderItem: zod.ZodObject<{
20
20
  year: "year";
21
21
  }>;
22
22
  interval_count: zod.ZodOptional<zod.ZodInt>;
23
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
23
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
24
24
  immediate: "immediate";
25
25
  period_end: "period_end";
26
26
  }>>;
27
27
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
28
28
  none: "none";
29
29
  prorated: "prorated";
30
+ short_rate: "short_rate";
30
31
  }>>;
31
- refund_monthly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
32
- refund_hourly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
32
+ monthly_list_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
33
+ short_rate_multiplier: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
34
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodNullable<zod.ZodInt>>;
33
35
  recurring_amount: zod.ZodOptional<zod.ZodString>;
34
36
  setup_amount: zod.ZodOptional<zod.ZodString>;
35
37
  type: zod.ZodEnum<{
@@ -6,13 +6,13 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  import * as zod from "zod";
9
+ import { CancellationPolicy } from "./cancellationPolicy.zod.js";
9
10
  import { Money } from "./money.zod.js";
10
11
  import { OrderItemStatus } from "./orderItemStatus.zod.js";
11
12
  import { PriceType } from "./priceType.zod.js";
12
13
  import { Product } from "./product.zod.js";
13
14
  import { ProductID } from "./productID.zod.js";
14
15
  import { RefundPolicy } from "./refundPolicy.zod.js";
15
- import { TerminationPolicy } from "./terminationPolicy.zod.js";
16
16
  import { UsageType } from "./usageType.zod.js";
17
17
  export const orderItemPositionMin = 0;
18
18
  export const OrderItem = zod
@@ -33,16 +33,20 @@ export const OrderItem = zod
33
33
  .describe("The Billing subscription: the new pending subscription of a recurring purchase, or the existing one renewed or changed, which keeps its ID. Absent for a purchase without a subscription."),
34
34
  interval: zod.enum(["none", "day", "month", "year"]),
35
35
  interval_count: zod.int().min(1).optional(),
36
- termination_policy: TerminationPolicy.optional(),
36
+ cancellation_policy: CancellationPolicy.optional(),
37
37
  refund_policy: RefundPolicy.optional(),
38
- refund_monthly_amount: zod
38
+ monthly_list_amount: zod
39
39
  .string()
40
40
  .nullish()
41
- .describe("Recurring licensed items only: the plan's one-month licensed price for this item's quantity, before tax and frozen at purchase, used to value time under a prorated refund or a downgrade. Null when the plan has no licensed period shorter than the one bought."),
42
- refund_hourly_amount: zod
41
+ .describe("Recurring licensed items only: a month at list price for this item's quantity, before tax and discounts, which values time under a refund or a downgrade. It is the monthly amount of the shortest period the plan sells, not longer than the one bought, at the item's dimensions, fixed at purchase; a renewal at the agreed amount keeps the previous value. Null when time used is valued at the amount paid, as for a daily period."),
42
+ short_rate_multiplier: zod
43
43
  .string()
44
44
  .nullish()
45
- .describe("Recurring licensed items only, the plan's metered hourly price for this item's quantity before tax, frozen at purchase, used for time used short of a full month. Null when the licensed price has no meter."),
45
+ .describe("Refund policy `short_rate` only, as on the price when bought."),
46
+ short_rate_threshold_seconds: zod
47
+ .int()
48
+ .nullish()
49
+ .describe("Refund policy `short_rate` only, as on the price when bought."),
46
50
  recurring_amount: zod.string().optional(),
47
51
  setup_amount: zod.string().optional(),
48
52
  type: PriceType,
@@ -20,16 +20,18 @@ export declare const OrderItemList: zod.ZodObject<{
20
20
  year: "year";
21
21
  }>;
22
22
  interval_count: zod.ZodOptional<zod.ZodInt>;
23
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
23
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
24
24
  immediate: "immediate";
25
25
  period_end: "period_end";
26
26
  }>>;
27
27
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
28
28
  none: "none";
29
29
  prorated: "prorated";
30
+ short_rate: "short_rate";
30
31
  }>>;
31
- refund_monthly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
32
- refund_hourly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
32
+ monthly_list_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
33
+ short_rate_multiplier: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
34
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodNullable<zod.ZodInt>>;
33
35
  recurring_amount: zod.ZodOptional<zod.ZodString>;
34
36
  setup_amount: zod.ZodOptional<zod.ZodString>;
35
37
  type: zod.ZodEnum<{
@@ -93,16 +93,18 @@ export declare const OrderList: zod.ZodObject<{
93
93
  year: "year";
94
94
  }>;
95
95
  interval_count: zod.ZodOptional<zod.ZodInt>;
96
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
96
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
97
97
  immediate: "immediate";
98
98
  period_end: "period_end";
99
99
  }>>;
100
100
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
101
101
  none: "none";
102
102
  prorated: "prorated";
103
+ short_rate: "short_rate";
103
104
  }>>;
104
- refund_monthly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
105
- refund_hourly_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
105
+ monthly_list_amount: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
106
+ short_rate_multiplier: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
107
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodNullable<zod.ZodInt>>;
106
108
  recurring_amount: zod.ZodOptional<zod.ZodString>;
107
109
  setup_amount: zod.ZodOptional<zod.ZodString>;
108
110
  type: zod.ZodEnum<{
@@ -15,4 +15,4 @@ export const OrderRefundQuote = zod
15
15
  credit_amount: Money,
16
16
  currency: zod.string(),
17
17
  })
18
- .describe("An estimated refund to the original payment sources. Before acceptance, cancellation returns the collected amount. For delivered service, only value paid by this order is included; renewals are evaluated with their own orders under the agreed termination terms. Nothing is refunded by the quote; the amount is fixed when cancellation or termination is confirmed.");
18
+ .describe("An estimated refund to the original payment sources. Before acceptance, cancellation returns the collected amount. For delivered service, only value paid by this order is included; renewals are evaluated with their own orders under the agreed cancellation terms. Nothing is refunded by the quote; the amount is fixed when cancellation or termination is confirmed.");
@@ -31,14 +31,17 @@ export declare const Price: zod.ZodObject<{
31
31
  }, zod.z.core.$strict>>;
32
32
  unit_quantity: zod.ZodString;
33
33
  active: zod.ZodBoolean;
34
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
34
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
35
35
  immediate: "immediate";
36
36
  period_end: "period_end";
37
37
  }>>;
38
38
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
39
39
  none: "none";
40
40
  prorated: "prorated";
41
+ short_rate: "short_rate";
41
42
  }>>;
43
+ short_rate_multiplier: zod.ZodOptional<zod.ZodString>;
44
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodInt>;
42
45
  product_id: zod.ZodOptional<zod.ZodString>;
43
46
  id: zod.ZodUUID;
44
47
  plan_id: zod.ZodUUID;
@@ -7,13 +7,13 @@
7
7
  */
8
8
  import * as zod from "zod";
9
9
  import { BillingScheme } from "./billingScheme.zod.js";
10
+ import { CancellationPolicy } from "./cancellationPolicy.zod.js";
10
11
  import { Money } from "./money.zod.js";
11
12
  import { ObjectIdentity } from "./objectIdentity.zod.js";
12
13
  import { PriceType } from "./priceType.zod.js";
13
14
  import { Product } from "./product.zod.js";
14
15
  import { ProductID } from "./productID.zod.js";
15
16
  import { RefundPolicy } from "./refundPolicy.zod.js";
16
- import { TerminationPolicy } from "./terminationPolicy.zod.js";
17
17
  import { Tier } from "./tier.zod.js";
18
18
  import { UsageType } from "./usageType.zod.js";
19
19
  export const Price = zod.strictObject({
@@ -30,8 +30,16 @@ export const Price = zod.strictObject({
30
30
  active: zod
31
31
  .boolean()
32
32
  .describe("False once archived. An archived price cannot be bought until it is active again."),
33
- termination_policy: TerminationPolicy.optional(),
33
+ cancellation_policy: CancellationPolicy.optional(),
34
34
  refund_policy: RefundPolicy.optional(),
35
+ short_rate_multiplier: zod
36
+ .string()
37
+ .optional()
38
+ .describe("Refund policy `short_rate` only, the factor applied to the value of the time used when a cancellation takes effect less than `short_rate_threshold_seconds` after the period start."),
39
+ short_rate_threshold_seconds: zod
40
+ .int()
41
+ .optional()
42
+ .describe("Refund policy `short_rate` only, how long after the period start `short_rate_multiplier` applies."),
35
43
  product_id: ProductID.optional(),
36
44
  id: zod.uuid(),
37
45
  plan_id: zod.uuid(),