@leaflow/sdk 0.0.0-dev.357.gf8331d0 → 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 (249) hide show
  1. package/dist/account/v1/generated/functions.d.ts +10 -3
  2. package/dist/account/v1/generated/functions.js +8 -3
  3. package/dist/account/v1/generated/models.d.ts +2 -0
  4. package/dist/account/v1/generated/schemas.zod.d.ts +10 -3
  5. package/dist/account/v1/generated/schemas.zod.js +10 -3
  6. package/dist/account/v1/generated/validators/acceptConsentsRequestBody.zod.d.ts +2 -0
  7. package/dist/account/v1/generated/validators/acceptConsentsRequestBody.zod.js +2 -0
  8. package/dist/account/v1/generated/validators/acceptInvitationByTokenRequestBody.zod.d.ts +2 -0
  9. package/dist/account/v1/generated/validators/acceptInvitationByTokenRequestBody.zod.js +2 -0
  10. package/dist/account/v1/generated/validators/acceptedInvitationResponseBody.zod.d.ts +2 -0
  11. package/dist/account/v1/generated/validators/acceptedInvitationResponseBody.zod.js +2 -0
  12. package/dist/account/v1/generated/validators/accountResource.zod.d.ts +2 -0
  13. package/dist/account/v1/generated/validators/accountResource.zod.js +2 -0
  14. package/dist/account/v1/generated/validators/agreementListResponseBody.zod.d.ts +2 -0
  15. package/dist/account/v1/generated/validators/agreementListResponseBody.zod.js +2 -0
  16. package/dist/account/v1/generated/validators/agreementResource.zod.d.ts +2 -0
  17. package/dist/account/v1/generated/validators/agreementResource.zod.js +2 -0
  18. package/dist/account/v1/generated/validators/consentBody.zod.d.ts +2 -0
  19. package/dist/account/v1/generated/validators/consentBody.zod.js +2 -0
  20. package/dist/account/v1/generated/validators/consentListResponseBody.zod.d.ts +2 -0
  21. package/dist/account/v1/generated/validators/consentListResponseBody.zod.js +2 -0
  22. package/dist/account/v1/generated/validators/consentResource.zod.d.ts +2 -0
  23. package/dist/account/v1/generated/validators/consentResource.zod.js +2 -0
  24. package/dist/account/v1/generated/validators/countryOption.zod.d.ts +2 -0
  25. package/dist/account/v1/generated/validators/countryOption.zod.js +2 -0
  26. package/dist/account/v1/generated/validators/createProjectRequestBody.zod.d.ts +2 -0
  27. package/dist/account/v1/generated/validators/createProjectRequestBody.zod.js +2 -0
  28. package/dist/account/v1/generated/validators/cursorPagination.zod.d.ts +2 -0
  29. package/dist/account/v1/generated/validators/cursorPagination.zod.js +2 -0
  30. package/dist/account/v1/generated/validators/error.zod.d.ts +2 -0
  31. package/dist/account/v1/generated/validators/error.zod.js +2 -0
  32. package/dist/account/v1/generated/validators/grantResource.zod.d.ts +2 -0
  33. package/dist/account/v1/generated/validators/grantResource.zod.js +2 -0
  34. package/dist/account/v1/generated/validators/identityVerificationResource.zod.d.ts +2 -0
  35. package/dist/account/v1/generated/validators/identityVerificationResource.zod.js +2 -0
  36. package/dist/account/v1/generated/validators/invitationPreviewResource.zod.d.ts +2 -0
  37. package/dist/account/v1/generated/validators/invitationPreviewResource.zod.js +2 -0
  38. package/dist/account/v1/generated/validators/invitationResource.zod.d.ts +2 -0
  39. package/dist/account/v1/generated/validators/invitationResource.zod.js +2 -0
  40. package/dist/account/v1/generated/validators/languageOption.zod.d.ts +2 -0
  41. package/dist/account/v1/generated/validators/languageOption.zod.js +2 -0
  42. package/dist/account/v1/generated/validators/lengthAwarePageInvitationResource.zod.d.ts +2 -0
  43. package/dist/account/v1/generated/validators/lengthAwarePageInvitationResource.zod.js +2 -0
  44. package/dist/account/v1/generated/validators/lengthAwarePageProjectAccessResource.zod.d.ts +2 -0
  45. package/dist/account/v1/generated/validators/lengthAwarePageProjectAccessResource.zod.js +2 -0
  46. package/dist/account/v1/generated/validators/listMyInvitationsParams.zod.d.ts +2 -0
  47. package/dist/account/v1/generated/validators/listMyInvitationsParams.zod.js +2 -0
  48. package/dist/account/v1/generated/validators/listProjectsParams.zod.d.ts +2 -0
  49. package/dist/account/v1/generated/validators/listProjectsParams.zod.js +2 -0
  50. package/dist/account/v1/generated/validators/locale.zod.d.ts +2 -0
  51. package/dist/account/v1/generated/validators/locale.zod.js +2 -0
  52. package/dist/account/v1/generated/validators/localeOptionsResource.zod.d.ts +2 -0
  53. package/dist/account/v1/generated/validators/localeOptionsResource.zod.js +2 -0
  54. package/dist/account/v1/generated/validators/offsetPagination.zod.d.ts +2 -0
  55. package/dist/account/v1/generated/validators/offsetPagination.zod.js +2 -0
  56. package/dist/account/v1/generated/validators/previewInvitationByTokenParams.zod.d.ts +2 -0
  57. package/dist/account/v1/generated/validators/previewInvitationByTokenParams.zod.js +2 -0
  58. package/dist/account/v1/generated/validators/projectAccessResource.zod.d.ts +2 -0
  59. package/dist/account/v1/generated/validators/projectAccessResource.zod.js +2 -0
  60. package/dist/account/v1/generated/validators/projectResource.zod.d.ts +2 -0
  61. package/dist/account/v1/generated/validators/projectResource.zod.js +2 -0
  62. package/dist/account/v1/generated/validators/projectSlugAvailabilityResource.zod.d.ts +2 -0
  63. package/dist/account/v1/generated/validators/projectSlugAvailabilityResource.zod.js +2 -0
  64. package/dist/account/v1/generated/validators/projectTraitResource.zod.d.ts +2 -0
  65. package/dist/account/v1/generated/validators/projectTraitResource.zod.js +2 -0
  66. package/dist/account/v1/generated/validators/registerRequestBody.zod.d.ts +2 -0
  67. package/dist/account/v1/generated/validators/registerRequestBody.zod.js +2 -0
  68. package/dist/account/v1/generated/validators/resourceRefResource.zod.d.ts +2 -0
  69. package/dist/account/v1/generated/validators/resourceRefResource.zod.js +2 -0
  70. package/dist/account/v1/generated/validators/ruleResource.zod.d.ts +2 -0
  71. package/dist/account/v1/generated/validators/ruleResource.zod.js +2 -0
  72. package/dist/account/v1/generated/validators/scopedTokenResponseBody.zod.d.ts +2 -0
  73. package/dist/account/v1/generated/validators/scopedTokenResponseBody.zod.js +2 -0
  74. package/dist/account/v1/generated/validators/settingsResource.zod.d.ts +2 -0
  75. package/dist/account/v1/generated/validators/settingsResource.zod.js +2 -0
  76. package/dist/account/v1/generated/validators/submitIdentityVerificationRequestBody.zod.d.ts +2 -0
  77. package/dist/account/v1/generated/validators/submitIdentityVerificationRequestBody.zod.js +2 -0
  78. package/dist/account/v1/generated/validators/updateAccountRequestBody.zod.d.ts +2 -0
  79. package/dist/account/v1/generated/validators/updateAccountRequestBody.zod.js +2 -0
  80. package/dist/billing/type/order/v1/generated/models.d.ts +71 -33
  81. package/dist/billing/type/order/v1/generated/models.js +2 -1
  82. package/dist/billing/type/order/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  83. package/dist/billing/type/order/v1/generated/validators/cancellation.zod.js +2 -2
  84. package/dist/billing/type/order/v1/generated/validators/cancellationCreate.zod.js +2 -2
  85. package/dist/billing/type/order/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  86. package/dist/billing/type/order/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  87. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  88. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  89. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  90. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  91. package/dist/billing/type/order/v1/generated/validators/order.zod.d.ts +5 -3
  92. package/dist/billing/type/order/v1/generated/validators/orderItem.zod.d.ts +5 -3
  93. package/dist/billing/type/order/v1/generated/validators/orderItem.zod.js +10 -6
  94. package/dist/billing/type/order/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  95. package/dist/billing/type/order/v1/generated/validators/orderList.zod.d.ts +5 -3
  96. package/dist/billing/type/order/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  97. package/dist/billing/type/order/v1/generated/validators/price.zod.d.ts +4 -1
  98. package/dist/billing/type/order/v1/generated/validators/price.zod.js +10 -2
  99. package/dist/billing/type/order/v1/generated/validators/priceList.zod.d.ts +4 -1
  100. package/dist/billing/type/order/v1/generated/validators/quote.zod.d.ts +2 -0
  101. package/dist/billing/type/order/v1/generated/validators/quoteCancellation.zod.js +2 -2
  102. package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  103. package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.js +2 -2
  104. package/dist/billing/type/order/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  105. package/dist/billing/type/order/v1/generated/validators/quoteRenewal.zod.js +3 -3
  106. package/dist/billing/type/order/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  107. package/dist/billing/type/order/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  108. package/dist/billing/type/order/v1/generated/validators/refundPolicy.zod.js +2 -2
  109. package/dist/billing/type/order/v1/generated/validators/refundReason.zod.js +1 -1
  110. package/dist/billing/type/order/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  111. package/dist/billing/type/order/v1/generated/validators/renewRequest.zod.js +3 -3
  112. package/dist/billing/type/order/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  113. package/dist/billing/type/order/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  114. package/dist/billing/type/order/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  115. package/dist/billing/type/order/v1/generated/validators/renewalPrice.zod.js +4 -2
  116. package/dist/billing/type/order/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  117. package/dist/billing/type/order/v1/generated/validators/subscription.zod.d.ts +5 -1
  118. package/dist/billing/type/order/v1/generated/validators/subscription.zod.js +14 -2
  119. package/dist/billing/type/order/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  120. package/dist/billing/v1/generated/functions.d.ts +1 -1
  121. package/dist/billing/v1/generated/functions.js +1 -1
  122. package/dist/billing/v1/generated/models.d.ts +71 -33
  123. package/dist/billing/v1/generated/models.js +2 -1
  124. package/dist/billing/v1/generated/schemas.zod.d.ts +3 -3
  125. package/dist/billing/v1/generated/schemas.zod.js +1 -1
  126. package/dist/billing/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  127. package/dist/billing/v1/generated/validators/cancellation.zod.js +2 -2
  128. package/dist/billing/v1/generated/validators/cancellationCreate.zod.js +2 -2
  129. package/dist/billing/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  130. package/dist/billing/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  131. package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  132. package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  133. package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  134. package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  135. package/dist/billing/v1/generated/validators/order.zod.d.ts +5 -3
  136. package/dist/billing/v1/generated/validators/orderItem.zod.d.ts +5 -3
  137. package/dist/billing/v1/generated/validators/orderItem.zod.js +10 -6
  138. package/dist/billing/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  139. package/dist/billing/v1/generated/validators/orderList.zod.d.ts +5 -3
  140. package/dist/billing/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  141. package/dist/billing/v1/generated/validators/price.zod.d.ts +4 -1
  142. package/dist/billing/v1/generated/validators/price.zod.js +10 -2
  143. package/dist/billing/v1/generated/validators/priceList.zod.d.ts +4 -1
  144. package/dist/billing/v1/generated/validators/quote.zod.d.ts +2 -0
  145. package/dist/billing/v1/generated/validators/quoteCancellation.zod.js +2 -2
  146. package/dist/billing/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  147. package/dist/billing/v1/generated/validators/quoteItemInput.zod.js +2 -2
  148. package/dist/billing/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  149. package/dist/billing/v1/generated/validators/quoteRenewal.zod.js +3 -3
  150. package/dist/billing/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  151. package/dist/billing/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  152. package/dist/billing/v1/generated/validators/refundPolicy.zod.js +2 -2
  153. package/dist/billing/v1/generated/validators/refundReason.zod.js +1 -1
  154. package/dist/billing/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  155. package/dist/billing/v1/generated/validators/renewRequest.zod.js +3 -3
  156. package/dist/billing/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  157. package/dist/billing/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  158. package/dist/billing/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  159. package/dist/billing/v1/generated/validators/renewalPrice.zod.js +4 -2
  160. package/dist/billing/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  161. package/dist/billing/v1/generated/validators/subscription.zod.d.ts +5 -1
  162. package/dist/billing/v1/generated/validators/subscription.zod.js +14 -2
  163. package/dist/billing/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  164. package/dist/canopy/v1/generated/models.d.ts +71 -33
  165. package/dist/canopy/v1/generated/models.js +2 -1
  166. package/dist/canopy/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  167. package/dist/canopy/v1/generated/validators/cancellation.zod.js +2 -2
  168. package/dist/canopy/v1/generated/validators/cancellationCreate.zod.js +2 -2
  169. package/dist/canopy/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  170. package/dist/canopy/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  171. package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  172. package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  173. package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  174. package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  175. package/dist/canopy/v1/generated/validators/order.zod.d.ts +5 -3
  176. package/dist/canopy/v1/generated/validators/orderItem.zod.d.ts +5 -3
  177. package/dist/canopy/v1/generated/validators/orderItem.zod.js +10 -6
  178. package/dist/canopy/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  179. package/dist/canopy/v1/generated/validators/orderList.zod.d.ts +5 -3
  180. package/dist/canopy/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  181. package/dist/canopy/v1/generated/validators/price.zod.d.ts +4 -1
  182. package/dist/canopy/v1/generated/validators/price.zod.js +10 -2
  183. package/dist/canopy/v1/generated/validators/priceList.zod.d.ts +4 -1
  184. package/dist/canopy/v1/generated/validators/quote5f60d00.zod.d.ts +2 -0
  185. package/dist/canopy/v1/generated/validators/quoteA200529.zod.d.ts +2 -0
  186. package/dist/canopy/v1/generated/validators/quoteCancellation.zod.js +2 -2
  187. package/dist/canopy/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  188. package/dist/canopy/v1/generated/validators/quoteItemInput.zod.js +2 -2
  189. package/dist/canopy/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  190. package/dist/canopy/v1/generated/validators/quoteRenewal.zod.js +3 -3
  191. package/dist/canopy/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  192. package/dist/canopy/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  193. package/dist/canopy/v1/generated/validators/refundPolicy.zod.js +2 -2
  194. package/dist/canopy/v1/generated/validators/refundReason.zod.js +1 -1
  195. package/dist/canopy/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  196. package/dist/canopy/v1/generated/validators/renewRequest.zod.js +3 -3
  197. package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  198. package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  199. package/dist/canopy/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  200. package/dist/canopy/v1/generated/validators/renewalPrice.zod.js +4 -2
  201. package/dist/canopy/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  202. package/dist/canopy/v1/generated/validators/subscription.zod.d.ts +5 -1
  203. package/dist/canopy/v1/generated/validators/subscription.zod.js +14 -2
  204. package/dist/canopy/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  205. package/dist/iam/v1/generated/functions.d.ts +2 -1
  206. package/dist/iam/v1/generated/functions.js +2 -1
  207. package/dist/iam/v1/generated/schemas.zod.d.ts +2 -1
  208. package/dist/iam/v1/generated/schemas.zod.js +2 -1
  209. package/dist/membership/v1/generated/models.d.ts +71 -33
  210. package/dist/membership/v1/generated/models.js +2 -1
  211. package/dist/membership/v1/generated/validators/cancelSubscriptionRequest.zod.js +2 -2
  212. package/dist/membership/v1/generated/validators/cancellation.zod.js +2 -2
  213. package/dist/membership/v1/generated/validators/cancellationCreate.zod.js +2 -2
  214. package/dist/membership/v1/generated/validators/{terminationPolicy.zod.d.ts → cancellationPolicy.zod.d.ts} +3 -3
  215. package/dist/membership/v1/generated/validators/{terminationPolicy.zod.js → cancellationPolicy.zod.js} +2 -2
  216. package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.d.ts +2 -0
  217. package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.js +4 -3
  218. package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +1 -0
  219. package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.js +1 -0
  220. package/dist/membership/v1/generated/validators/order.zod.d.ts +5 -3
  221. package/dist/membership/v1/generated/validators/orderItem.zod.d.ts +5 -3
  222. package/dist/membership/v1/generated/validators/orderItem.zod.js +10 -6
  223. package/dist/membership/v1/generated/validators/orderItemList.zod.d.ts +5 -3
  224. package/dist/membership/v1/generated/validators/orderList.zod.d.ts +5 -3
  225. package/dist/membership/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  226. package/dist/membership/v1/generated/validators/price.zod.d.ts +4 -1
  227. package/dist/membership/v1/generated/validators/price.zod.js +10 -2
  228. package/dist/membership/v1/generated/validators/priceList.zod.d.ts +4 -1
  229. package/dist/membership/v1/generated/validators/quote.zod.d.ts +2 -0
  230. package/dist/membership/v1/generated/validators/quoteCancellation.zod.js +2 -2
  231. package/dist/membership/v1/generated/validators/quoteItemInput.zod.d.ts +1 -1
  232. package/dist/membership/v1/generated/validators/quoteItemInput.zod.js +2 -2
  233. package/dist/membership/v1/generated/validators/quoteRenewal.zod.d.ts +1 -1
  234. package/dist/membership/v1/generated/validators/quoteRenewal.zod.js +3 -3
  235. package/dist/membership/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
  236. package/dist/membership/v1/generated/validators/refundPolicy.zod.d.ts +1 -0
  237. package/dist/membership/v1/generated/validators/refundPolicy.zod.js +2 -2
  238. package/dist/membership/v1/generated/validators/refundReason.zod.js +1 -1
  239. package/dist/membership/v1/generated/validators/renewRequest.zod.d.ts +1 -1
  240. package/dist/membership/v1/generated/validators/renewRequest.zod.js +3 -3
  241. package/dist/membership/v1/generated/validators/renewalOrderRequest.zod.d.ts +1 -1
  242. package/dist/membership/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  243. package/dist/membership/v1/generated/validators/renewalPrice.zod.d.ts +4 -1
  244. package/dist/membership/v1/generated/validators/renewalPrice.zod.js +4 -2
  245. package/dist/membership/v1/generated/validators/renewalPriceList.zod.d.ts +4 -1
  246. package/dist/membership/v1/generated/validators/subscription.zod.d.ts +5 -1
  247. package/dist/membership/v1/generated/validators/subscription.zod.js +14 -2
  248. package/dist/membership/v1/generated/validators/subscriptionList.zod.d.ts +5 -1
  249. package/package.json +1 -1
@@ -8,14 +8,17 @@
8
8
  import * as zod from "zod";
9
9
  export declare const RenewalPriceList: zod.ZodObject<{
10
10
  items: zod.ZodArray<zod.ZodObject<{
11
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
11
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
12
12
  immediate: "immediate";
13
13
  period_end: "period_end";
14
14
  }>>;
15
15
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
16
16
  none: "none";
17
17
  prorated: "prorated";
18
+ short_rate: "short_rate";
18
19
  }>>;
20
+ short_rate_multiplier: zod.ZodOptional<zod.ZodString>;
21
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodInt>;
19
22
  price_id: zod.ZodUUID;
20
23
  interval_count: zod.ZodInt;
21
24
  interval: zod.ZodEnum<{
@@ -27,14 +27,18 @@ export declare const Subscription: zod.ZodObject<{
27
27
  }>;
28
28
  interval_count: zod.ZodOptional<zod.ZodInt>;
29
29
  recurring_amount: zod.ZodOptional<zod.ZodString>;
30
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
30
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
31
31
  immediate: "immediate";
32
32
  period_end: "period_end";
33
33
  }>>;
34
34
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
35
35
  none: "none";
36
36
  prorated: "prorated";
37
+ short_rate: "short_rate";
37
38
  }>>;
39
+ short_rate_multiplier: zod.ZodOptional<zod.ZodString>;
40
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodInt>;
41
+ monthly_list_amount: zod.ZodOptional<zod.ZodString>;
38
42
  order_item_id: zod.ZodOptional<zod.ZodUUID>;
39
43
  coupon_id: zod.ZodOptional<zod.ZodUUID>;
40
44
  coupon: zod.ZodOptional<zod.ZodObject<{
@@ -7,6 +7,7 @@
7
7
  */
8
8
  import * as zod from "zod";
9
9
  import { AccountIdentity } from "./accountIdentity.zod.js";
10
+ import { CancellationPolicy } from "./cancellationPolicy.zod.js";
10
11
  import { NamedIdentity } from "./namedIdentity.zod.js";
11
12
  import { ObjectIdentity } from "./objectIdentity.zod.js";
12
13
  import { PriceType } from "./priceType.zod.js";
@@ -16,7 +17,6 @@ import { RefundPolicy } from "./refundPolicy.zod.js";
16
17
  import { ScheduledChange } from "./scheduledChange.zod.js";
17
18
  import { SubscriptionCancellation } from "./subscriptionCancellation.zod.js";
18
19
  import { SubscriptionRestriction } from "./subscriptionRestriction.zod.js";
19
- import { TerminationPolicy } from "./terminationPolicy.zod.js";
20
20
  import { UsageType } from "./usageType.zod.js";
21
21
  export const subscriptionDiscountedRenewalsRemainingMin = 0;
22
22
  export const Subscription = zod
@@ -37,8 +37,20 @@ export const Subscription = zod
37
37
  .string()
38
38
  .optional()
39
39
  .describe("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."),
40
- termination_policy: TerminationPolicy.optional(),
40
+ cancellation_policy: CancellationPolicy.optional(),
41
41
  refund_policy: RefundPolicy.optional(),
42
+ short_rate_multiplier: zod
43
+ .string()
44
+ .optional()
45
+ .describe("Refund policy `short_rate` only, as on the price bought."),
46
+ short_rate_threshold_seconds: zod
47
+ .int()
48
+ .optional()
49
+ .describe("Refund policy `short_rate` only, as on the price bought."),
50
+ monthly_list_amount: zod
51
+ .string()
52
+ .optional()
53
+ .describe("Licensed recurring only, the `monthly_list_amount` that a renewal at the agreed amount keeps; see the order item."),
42
54
  order_item_id: zod.uuid().optional(),
43
55
  coupon_id: zod.uuid().optional(),
44
56
  coupon: ObjectIdentity.optional(),
@@ -27,14 +27,18 @@ export declare const SubscriptionList: zod.ZodObject<{
27
27
  }>;
28
28
  interval_count: zod.ZodOptional<zod.ZodInt>;
29
29
  recurring_amount: zod.ZodOptional<zod.ZodString>;
30
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
30
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
31
31
  immediate: "immediate";
32
32
  period_end: "period_end";
33
33
  }>>;
34
34
  refund_policy: zod.ZodOptional<zod.ZodEnum<{
35
35
  none: "none";
36
36
  prorated: "prorated";
37
+ short_rate: "short_rate";
37
38
  }>>;
39
+ short_rate_multiplier: zod.ZodOptional<zod.ZodString>;
40
+ short_rate_threshold_seconds: zod.ZodOptional<zod.ZodInt>;
41
+ monthly_list_amount: zod.ZodOptional<zod.ZodString>;
38
42
  order_item_id: zod.ZodOptional<zod.ZodUUID>;
39
43
  coupon_id: zod.ZodOptional<zod.ZodUUID>;
40
44
  coupon: zod.ZodOptional<zod.ZodObject<{
@@ -1176,7 +1176,7 @@ export declare const getCreateCancellationUrl: () => string;
1176
1176
  * the subscriptions do not share one service, project, account and currency;
1177
1177
  * - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
1178
1178
  * - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed, and `BILLING_CANCELLATION_TERMS_UNSET`
1179
- * when a licensed subscription has no termination terms, both with `meta.subscription_id`;
1179
+ * when a licensed subscription has no cancellation terms, both with `meta.subscription_id`;
1180
1180
  * - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at different times;
1181
1181
  * - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
1182
1182
  * (`meta.cancellation_id`) or reclaimed (`meta.reason` `reclaim_requested`), or has a paid change waiting to
@@ -1318,7 +1318,7 @@ export const getCreateCancellationUrl = () => {
1318
1318
  * the subscriptions do not share one service, project, account and currency;
1319
1319
  * - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
1320
1320
  * - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed, and `BILLING_CANCELLATION_TERMS_UNSET`
1321
- * when a licensed subscription has no termination terms, both with `meta.subscription_id`;
1321
+ * when a licensed subscription has no cancellation terms, both with `meta.subscription_id`;
1322
1322
  * - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at different times;
1323
1323
  * - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
1324
1324
  * (`meta.cancellation_id`) or reclaimed (`meta.reason` `reclaim_requested`), or has a paid change waiting to
@@ -6,20 +6,34 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  /**
9
- * 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.
9
+ * 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.
10
10
  */
11
- export type TerminationPolicy = (typeof TerminationPolicy)[keyof typeof TerminationPolicy];
12
- export declare const TerminationPolicy: {
11
+ export type CancellationPolicy = (typeof CancellationPolicy)[keyof typeof CancellationPolicy];
12
+ export declare const CancellationPolicy: {
13
13
  readonly immediate: "immediate";
14
14
  readonly period_end: "period_end";
15
15
  };
16
16
  /**
17
- * `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.
17
+ * `none` refunds nothing.
18
+ *
19
+ * `prorated` refunds the amount paid for the current period minus the value of the time used, never below zero
20
+ * or above what remains unrefunded. Time used runs from the period start to the effective cancellation, by the
21
+ * second. Each whole month from the period start is valued at the order item's `monthly_list_amount`, and the
22
+ * remainder at that amount in proportion to the length of the month it falls in; without `monthly_list_amount`,
23
+ * time used is valued at the amount paid in proportion to the length of the period. A renewal starts a new
24
+ * period, and an immediate change starts one at the change. Discounts and setup fees are not refunded. Refunds
25
+ * return to the original payment sources, with tax refunded in proportion.
26
+ *
27
+ * `short_rate` refunds as `prorated`, except that when the cancellation takes effect less than
28
+ * `short_rate_threshold_seconds` after the period start, the value of the time used is multiplied by
29
+ * `short_rate_multiplier`, up to `monthly_list_amount` for each month begun or, without `monthly_list_amount`,
30
+ * up to the amount paid.
18
31
  */
19
32
  export type RefundPolicy = (typeof RefundPolicy)[keyof typeof RefundPolicy];
20
33
  export declare const RefundPolicy: {
21
34
  readonly none: "none";
22
35
  readonly prorated: "prorated";
36
+ readonly short_rate: "short_rate";
23
37
  };
24
38
  export interface OrderCancel {
25
39
  /**
@@ -39,8 +53,8 @@ export declare const QuoteRenewalInterval: {
39
53
  * Price renewing a licensed subscription. Give `price_id`, or `interval` with
40
54
  * `interval_count`, to renew for another term at the price currently sold for it. Naming
41
55
  * the current term, or giving neither, renews at the agreed amount. A term sold at several
42
- * prices that differ in termination policy is refused with 409
43
- * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` or `price_id` is given.
56
+ * prices that differ in cancellation policy is refused with 409
57
+ * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` or `price_id` is given.
44
58
  */
45
59
  export interface QuoteRenewal {
46
60
  subscription_id: string;
@@ -48,8 +62,8 @@ export interface QuoteRenewal {
48
62
  interval?: QuoteRenewalInterval;
49
63
  /** @minimum 1 */
50
64
  interval_count?: number;
51
- /** With `interval` and `interval_count`, chooses among prices of that term that differ in termination policy. */
52
- termination_policy?: TerminationPolicy;
65
+ /** With `interval` and `interval_count`, chooses among prices of that term that differ in cancellation policy. */
66
+ cancellation_policy?: CancellationPolicy;
53
67
  /**
54
68
  * How many consecutive periods to renew for.
55
69
  * @minimum 1
@@ -212,6 +226,7 @@ export interface CancellationRefundPreviewItem {
212
226
  /** 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. */
213
227
  auto_renew: boolean;
214
228
  unused_amount: Money;
229
+ short_rate_surcharge_amount: Money;
215
230
  refundable_amount: Money;
216
231
  refund_amount: Money;
217
232
  credit_amount: Money;
@@ -222,8 +237,9 @@ export interface CancellationRefundPreviewItem {
222
237
  * What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and
223
238
  * `refundable_amount` when creating the cancellation.
224
239
  *
225
- * - `unused_amount`: before tax, the amount paid for the current periods minus the value of the time used,
226
- * valued as refund policy `prorated` describes, whatever the refund terms say.
240
+ * - `unused_amount`: before tax, the amount paid for the current periods in proportion to the time remaining.
241
+ * - `short_rate_surcharge_amount`: before tax, the part of `forfeited_amount` due to the short rate of the
242
+ * refund policy.
227
243
  * - `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus
228
244
  * `credit_amount`.
229
245
  * - `refund_amount`: the part returned to the balance or the payment method.
@@ -234,13 +250,14 @@ export interface CancellationRefundPreviewItem {
234
250
  * Metered and one-time subscriptions show zero; their usage until release is charged as usual.
235
251
  */
236
252
  export interface CancellationRefundPreview {
237
- mode: TerminationPolicy;
253
+ mode: CancellationPolicy;
238
254
  /** For `period_end`, when release begins, the end of the paid terms. */
239
255
  scheduled_at?: string;
240
256
  /** For `immediate`, the second the refund is computed as of. Give it when creating the cancellation. */
241
257
  proration_date?: string;
242
258
  currency: string;
243
259
  unused_amount: Money;
260
+ short_rate_surcharge_amount: Money;
244
261
  refundable_amount: Money;
245
262
  refund_amount: Money;
246
263
  credit_amount: Money;
@@ -249,7 +266,7 @@ export interface CancellationRefundPreview {
249
266
  items: CancellationRefundPreviewItem[];
250
267
  }
251
268
  /**
252
- * 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.
269
+ * 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.
253
270
  */
254
271
  export interface OrderRefundQuote {
255
272
  order_id: string;
@@ -288,7 +305,7 @@ export interface QuoteCancellation {
288
305
  * @maxItems 50
289
306
  */
290
307
  subscription_ids: string[];
291
- mode: TerminationPolicy;
308
+ mode: CancellationPolicy;
292
309
  }
293
310
  export interface CancellationCreate {
294
311
  /**
@@ -297,7 +314,7 @@ export interface CancellationCreate {
297
314
  * @maxItems 50
298
315
  */
299
316
  subscription_ids: string[];
300
- mode: TerminationPolicy;
317
+ mode: CancellationPolicy;
301
318
  /** 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. */
302
319
  proration_date?: string;
303
320
  /** The quote's `refundable_amount`; the cancellation is refused when the refund differs. */
@@ -377,7 +394,7 @@ export interface CancellationItem {
377
394
  export interface Cancellation {
378
395
  id: string;
379
396
  status: CancellationStatus;
380
- mode: TerminationPolicy;
397
+ mode: CancellationPolicy;
381
398
  scheduled_at?: string;
382
399
  /** For `immediate`, the second the refund is computed as of. */
383
400
  proration_date?: string;
@@ -1331,9 +1348,11 @@ export declare const RefundStatus: {
1331
1348
  * - `change_expired`: a scheduled change could not take effect in time.
1332
1349
  * - `subscription_canceled`: the unused value of a canceled subscription, under its refund terms.
1333
1350
  * - `future_period_canceled`: a renewal that had not started was withdrawn.
1334
- * - `downgrade_difference`: after a downgrade, the remaining paid value, valued as refund policy `prorated`
1335
- * describes, minus the new configuration's cost for the remaining time at the change item's
1336
- * `refund_monthly_amount` and `refund_hourly_amount`.
1351
+ * - `downgrade_difference`: after a downgrade, the remaining paid value, valued under each paid period's refund
1352
+ * policy and as `prorated` where that policy is `none`, minus the new configuration's value for the remaining
1353
+ * time: each whole month at the change item's `monthly_list_amount` and the remainder in proportion to the
1354
+ * length of the month it falls in, or without `monthly_list_amount`, the new period price in proportion to the
1355
+ * remaining time.
1337
1356
  * - `usage_true_up`: usage priced over the whole month cost less than was charged.
1338
1357
  * - `payment_not_applied`: a payment arrived after its invoice could no longer be paid.
1339
1358
  * - `operator`: made by the platform operator.
@@ -1554,8 +1573,14 @@ export interface Subscription {
1554
1573
  interval_count?: number;
1555
1574
  /** 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. */
1556
1575
  recurring_amount?: string;
1557
- termination_policy?: TerminationPolicy;
1576
+ cancellation_policy?: CancellationPolicy;
1558
1577
  refund_policy?: RefundPolicy;
1578
+ /** Refund policy `short_rate` only, as on the price bought. */
1579
+ short_rate_multiplier?: string;
1580
+ /** Refund policy `short_rate` only, as on the price bought. */
1581
+ short_rate_threshold_seconds?: number;
1582
+ /** Licensed recurring only, the `monthly_list_amount` that a renewal at the agreed amount keeps; see the order item. */
1583
+ monthly_list_amount?: string;
1559
1584
  order_item_id?: string;
1560
1585
  coupon_id?: string;
1561
1586
  coupon?: ObjectIdentity;
@@ -1628,8 +1653,12 @@ export declare const RenewalPriceInterval: {
1628
1653
  readonly year: "year";
1629
1654
  };
1630
1655
  export interface RenewalPrice {
1631
- termination_policy?: TerminationPolicy;
1656
+ cancellation_policy?: CancellationPolicy;
1632
1657
  refund_policy?: RefundPolicy;
1658
+ /** Refund policy `short_rate` only. */
1659
+ short_rate_multiplier?: string;
1660
+ /** Refund policy `short_rate` only. */
1661
+ short_rate_threshold_seconds?: number;
1633
1662
  price_id: string;
1634
1663
  /** How many periods one renewal covers. */
1635
1664
  interval_count: number;
@@ -1668,8 +1697,8 @@ export interface RenewRequest {
1668
1697
  * Leaving both out renews at the price this item already bills at, which a later price
1669
1698
  * change does not affect. Naming a term that differs from the current one is a fresh
1670
1699
  * choice, so it is bought at today's price. Naming the current term changes nothing. A
1671
- * term sold at several prices that differ in termination policy is refused with 409
1672
- * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` is given.
1700
+ * term sold at several prices that differ in cancellation policy is refused with 409
1701
+ * `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.
1673
1702
  *
1674
1703
  * List the terms on offer with the renewal prices operation.
1675
1704
  * @minimum 1
@@ -1677,8 +1706,8 @@ export interface RenewRequest {
1677
1706
  interval_count?: number;
1678
1707
  /** The unit interval_count counts in. */
1679
1708
  interval?: RenewRequestInterval;
1680
- /** With `interval` and `interval_count`, chooses among prices of that term that differ in termination policy. */
1681
- termination_policy?: TerminationPolicy;
1709
+ /** With `interval` and `interval_count`, chooses among prices of that term that differ in cancellation policy. */
1710
+ cancellation_policy?: CancellationPolicy;
1682
1711
  payment_method_id?: string;
1683
1712
  /** Whether to pay from the balance, with or without `payment_method_id`. */
1684
1713
  use_balance?: boolean;
@@ -1714,7 +1743,7 @@ export interface RenewalOrderRequest {
1714
1743
  /** As in renewing. */
1715
1744
  interval?: RenewalOrderRequestInterval;
1716
1745
  /** As in renewing. */
1717
- termination_policy?: TerminationPolicy;
1746
+ cancellation_policy?: CancellationPolicy;
1718
1747
  }
1719
1748
  export interface AutoRenewSet {
1720
1749
  auto_renew: boolean;
@@ -1826,18 +1855,23 @@ export interface OrderItem {
1826
1855
  interval: OrderItemInterval;
1827
1856
  /** @minimum 1 */
1828
1857
  interval_count?: number;
1829
- termination_policy?: TerminationPolicy;
1858
+ cancellation_policy?: CancellationPolicy;
1830
1859
  refund_policy?: RefundPolicy;
1831
1860
  /**
1832
- * 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.
1861
+ * 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.
1862
+ * @nullable
1863
+ */
1864
+ monthly_list_amount?: string | null;
1865
+ /**
1866
+ * Refund policy `short_rate` only, as on the price when bought.
1833
1867
  * @nullable
1834
1868
  */
1835
- refund_monthly_amount?: string | null;
1869
+ short_rate_multiplier?: string | null;
1836
1870
  /**
1837
- * 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.
1871
+ * Refund policy `short_rate` only, as on the price when bought.
1838
1872
  * @nullable
1839
1873
  */
1840
- refund_hourly_amount?: string | null;
1874
+ short_rate_threshold_seconds?: number | null;
1841
1875
  recurring_amount?: string;
1842
1876
  setup_amount?: string;
1843
1877
  type: PriceType;
@@ -2167,8 +2201,12 @@ export interface Price {
2167
2201
  unit_quantity: string;
2168
2202
  /** False once archived. An archived price cannot be bought until it is active again. */
2169
2203
  active: boolean;
2170
- termination_policy?: TerminationPolicy;
2204
+ cancellation_policy?: CancellationPolicy;
2171
2205
  refund_policy?: RefundPolicy;
2206
+ /** 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. */
2207
+ short_rate_multiplier?: string;
2208
+ /** Refund policy `short_rate` only, how long after the period start `short_rate_multiplier` applies. */
2209
+ short_rate_threshold_seconds?: number;
2172
2210
  product_id?: ProductID;
2173
2211
  id: string;
2174
2212
  plan_id: string;
@@ -2293,7 +2331,7 @@ export interface QuoteItemInput {
2293
2331
  /** @minimum 1 */
2294
2332
  interval_count?: number;
2295
2333
  /** Selects among licensed prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily. */
2296
- termination_policy?: TerminationPolicy;
2334
+ cancellation_policy?: CancellationPolicy;
2297
2335
  /** @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]))))))))))$ */
2298
2336
  quantity: string;
2299
2337
  meter_id?: string;
@@ -2682,7 +2720,7 @@ export interface ContactList {
2682
2720
  pagination: OffsetPagination;
2683
2721
  }
2684
2722
  export interface CancelSubscriptionRequest {
2685
- mode: TerminationPolicy;
2723
+ mode: CancellationPolicy;
2686
2724
  /** For immediate cancellation, the quoted whole-second refund basis. Now when omitted. */
2687
2725
  proration_date?: string;
2688
2726
  /** The cancellation quote's refundable amount, including an explicit zero. */
@@ -1,10 +1,11 @@
1
- export const TerminationPolicy = {
1
+ export const CancellationPolicy = {
2
2
  immediate: "immediate",
3
3
  period_end: "period_end",
4
4
  };
5
5
  export const RefundPolicy = {
6
6
  none: "none",
7
7
  prorated: "prorated",
8
+ short_rate: "short_rate",
8
9
  };
9
10
  export const QuoteRenewalInterval = {
10
11
  day: "day",
@@ -676,7 +676,7 @@ export declare const ListCancellationsQueryParams: zod.ZodObject<{
676
676
  * the subscriptions do not share one service, project, account and currency;
677
677
  * - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
678
678
  * - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed, and `BILLING_CANCELLATION_TERMS_UNSET`
679
- * when a licensed subscription has no termination terms, both with `meta.subscription_id`;
679
+ * when a licensed subscription has no cancellation terms, both with `meta.subscription_id`;
680
680
  * - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at different times;
681
681
  * - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
682
682
  * (`meta.cancellation_id`) or reclaimed (`meta.reason` `reclaim_requested`), or has a paid change waiting to
@@ -752,7 +752,7 @@ export declare const RenewSubscriptionBody: zod.ZodObject<{
752
752
  month: "month";
753
753
  year: "year";
754
754
  }>>;
755
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
755
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
756
756
  immediate: "immediate";
757
757
  period_end: "period_end";
758
758
  }>>;
@@ -784,7 +784,7 @@ export declare const CreateRenewalOrderBody: zod.ZodObject<{
784
784
  month: "month";
785
785
  year: "year";
786
786
  }>>;
787
- termination_policy: zod.ZodOptional<zod.ZodEnum<{
787
+ cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
788
788
  immediate: "immediate";
789
789
  period_end: "period_end";
790
790
  }>>;
@@ -888,7 +888,7 @@ export const ListCancellationsQueryParams = zod.strictObject({
888
888
  * the subscriptions do not share one service, project, account and currency;
889
889
  * - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
890
890
  * - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed, and `BILLING_CANCELLATION_TERMS_UNSET`
891
- * when a licensed subscription has no termination terms, both with `meta.subscription_id`;
891
+ * when a licensed subscription has no cancellation terms, both with `meta.subscription_id`;
892
892
  * - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at different times;
893
893
  * - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
894
894
  * (`meta.cancellation_id`) or reclaimed (`meta.reason` `reclaim_requested`), or has a paid change waiting to
@@ -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<{