@leaflow/sdk 0.0.0-dev.352.g85966ed → 0.0.0-dev.355.g42152f5

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 (882) hide show
  1. package/dist/billing/type/funds/v1/generated/models.d.ts +4 -4
  2. package/dist/billing/type/funds/v1/generated/validators/funds.zod.js +4 -4
  3. package/dist/billing/type/order/v1/generated/models.d.ts +379 -779
  4. package/dist/billing/type/order/v1/generated/models.js +12 -44
  5. package/dist/billing/type/order/v1/generated/validators/accountBalance.zod.d.ts +22 -11
  6. package/dist/billing/type/order/v1/generated/validators/accountBalance.zod.js +8 -8
  7. package/dist/billing/type/order/v1/generated/validators/activeResource.zod.js +8 -5
  8. package/dist/billing/type/order/v1/generated/validators/allowance.zod.js +3 -3
  9. package/dist/billing/type/order/v1/generated/validators/applicability.zod.d.ts +22 -11
  10. package/dist/billing/type/order/v1/generated/validators/applicability.zod.js +12 -3
  11. package/dist/billing/type/order/v1/generated/validators/applicablePlan.zod.js +1 -1
  12. package/dist/billing/type/order/v1/generated/validators/billingAccount.zod.js +5 -5
  13. package/dist/billing/type/order/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
  14. package/dist/billing/type/order/v1/generated/validators/billingScheme.zod.d.ts +14 -0
  15. package/dist/billing/type/order/v1/generated/validators/billingScheme.zod.js +11 -0
  16. package/dist/billing/type/order/v1/generated/validators/cancellation.zod.d.ts +6 -3
  17. package/dist/billing/type/order/v1/generated/validators/cancellation.zod.js +4 -4
  18. package/dist/billing/type/order/v1/generated/validators/cancellationCreate.zod.js +3 -3
  19. package/dist/billing/type/order/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
  20. package/dist/billing/type/order/v1/generated/validators/cancellationItem.zod.js +6 -5
  21. package/dist/billing/type/order/v1/generated/validators/cancellationList.zod.d.ts +6 -3
  22. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
  23. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
  24. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
  25. package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
  26. package/dist/billing/type/order/v1/generated/validators/contact.zod.js +2 -2
  27. package/dist/billing/type/order/v1/generated/validators/creditGrant.zod.d.ts +22 -11
  28. package/dist/billing/type/order/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
  29. package/dist/billing/type/order/v1/generated/validators/creditGroup.zod.d.ts +22 -11
  30. package/dist/billing/type/order/v1/generated/validators/creditGroup.zod.js +1 -1
  31. package/dist/billing/type/order/v1/generated/validators/creditNote.zod.js +4 -4
  32. package/dist/billing/type/order/v1/generated/validators/currency.zod.js +1 -1
  33. package/dist/billing/type/order/v1/generated/validators/discount.zod.d.ts +23 -12
  34. package/dist/billing/type/order/v1/generated/validators/discount.zod.js +4 -4
  35. package/dist/billing/type/order/v1/generated/validators/discountList.zod.d.ts +23 -12
  36. package/dist/billing/type/order/v1/generated/validators/entitlement.zod.js +1 -1
  37. package/dist/billing/type/order/v1/generated/validators/funds.zod.js +4 -4
  38. package/dist/billing/type/order/v1/generated/validators/invoice.zod.d.ts +0 -1
  39. package/dist/billing/type/order/v1/generated/validators/invoice.zod.js +8 -8
  40. package/dist/billing/type/order/v1/generated/validators/invoiceItem.zod.d.ts +2 -0
  41. package/dist/billing/type/order/v1/generated/validators/invoiceItem.zod.js +10 -4
  42. package/dist/billing/type/order/v1/generated/validators/invoiceItemList.zod.d.ts +2 -0
  43. package/dist/billing/type/order/v1/generated/validators/invoiceItemProration.zod.js +1 -3
  44. package/dist/billing/type/order/v1/generated/validators/invoiceList.zod.d.ts +0 -1
  45. package/dist/billing/type/order/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
  46. package/dist/billing/type/order/v1/generated/validators/invoiceStatus.zod.js +2 -2
  47. package/dist/billing/type/order/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
  48. package/dist/billing/type/order/v1/generated/validators/invoiceSummary.zod.js +3 -3
  49. package/dist/billing/type/order/v1/generated/validators/monthlyStatement.zod.js +2 -2
  50. package/dist/billing/type/order/v1/generated/validators/objectIdentity.zod.js +1 -1
  51. package/dist/billing/type/order/v1/generated/validators/order.zod.d.ts +7 -4
  52. package/dist/billing/type/order/v1/generated/validators/order.zod.js +10 -12
  53. package/dist/billing/type/order/v1/generated/validators/orderItem.zod.d.ts +7 -3
  54. package/dist/billing/type/order/v1/generated/validators/orderItem.zod.js +16 -14
  55. package/dist/billing/type/order/v1/generated/validators/orderItemList.zod.d.ts +7 -3
  56. package/dist/billing/type/order/v1/generated/validators/orderItemStatus.zod.js +1 -1
  57. package/dist/billing/type/order/v1/generated/validators/orderList.zod.d.ts +7 -4
  58. package/dist/billing/type/order/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  59. package/dist/billing/type/order/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
  60. package/dist/billing/type/order/v1/generated/validators/orderStatus.zod.js +1 -1
  61. package/dist/billing/type/order/v1/generated/validators/paidWith.zod.js +1 -1
  62. package/dist/billing/type/order/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
  63. package/dist/billing/type/order/v1/generated/validators/payTogetherRequest.zod.js +2 -2
  64. package/dist/billing/type/order/v1/generated/validators/paymentAction.zod.js +4 -4
  65. package/dist/billing/type/order/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
  66. package/dist/billing/type/order/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
  67. package/dist/billing/type/order/v1/generated/validators/paymentOption.zod.js +1 -1
  68. package/dist/billing/type/order/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
  69. package/dist/billing/type/order/v1/generated/validators/paymentPreview.zod.js +4 -4
  70. package/dist/billing/type/order/v1/generated/validators/paymentResult.zod.js +5 -8
  71. package/dist/billing/type/order/v1/generated/validators/paymentStatus.zod.js +1 -1
  72. package/dist/billing/type/order/v1/generated/validators/placedOrder.zod.d.ts +0 -1
  73. package/dist/billing/type/order/v1/generated/validators/price.zod.d.ts +7 -5
  74. package/dist/billing/type/order/v1/generated/validators/price.zod.js +14 -11
  75. package/dist/billing/type/order/v1/generated/validators/priceList.zod.d.ts +7 -5
  76. package/dist/billing/type/order/v1/generated/validators/priceOption.zod.d.ts +7 -5
  77. package/dist/billing/type/order/v1/generated/validators/priceOption.zod.js +7 -3
  78. package/dist/billing/type/order/v1/generated/validators/priceType.zod.d.ts +14 -0
  79. package/dist/billing/type/order/v1/generated/validators/priceType.zod.js +11 -0
  80. package/dist/billing/type/order/v1/generated/validators/productID.zod.js +1 -1
  81. package/dist/billing/type/order/v1/generated/validators/projectAssignment.zod.js +2 -2
  82. package/dist/billing/type/order/v1/generated/validators/purchaseOperation.zod.js +1 -1
  83. package/dist/billing/type/order/v1/generated/validators/quote.zod.d.ts +6 -3
  84. package/dist/billing/type/order/v1/generated/validators/quote.zod.js +4 -4
  85. package/dist/billing/type/order/v1/generated/validators/quoteCancellation.zod.js +2 -2
  86. package/dist/billing/type/order/v1/generated/validators/quoteItem.zod.js +4 -4
  87. package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
  88. package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.js +8 -8
  89. package/dist/billing/type/order/v1/generated/validators/quoteRenewal.zod.js +1 -1
  90. package/dist/billing/type/order/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
  91. package/dist/billing/type/order/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
  92. package/dist/billing/type/order/v1/generated/validators/quoteRequest.zod.js +5 -5
  93. package/dist/billing/type/order/v1/generated/validators/quotedDiscount.zod.js +1 -1
  94. package/dist/billing/type/order/v1/generated/validators/rate.zod.d.ts +11 -0
  95. package/dist/billing/type/order/v1/generated/validators/rate.zod.js +14 -6
  96. package/dist/billing/type/order/v1/generated/validators/rateList.zod.d.ts +11 -0
  97. package/dist/billing/type/order/v1/generated/validators/refund.zod.js +3 -3
  98. package/dist/billing/type/order/v1/generated/validators/refundPolicy.zod.js +1 -1
  99. package/dist/billing/type/order/v1/generated/validators/refundReason.zod.js +1 -1
  100. package/dist/billing/type/order/v1/generated/validators/renewRequest.zod.js +2 -2
  101. package/dist/billing/type/order/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  102. package/dist/billing/type/order/v1/generated/validators/renewalPrice.zod.js +1 -1
  103. package/dist/billing/type/order/v1/generated/validators/scheduledChange.zod.js +2 -2
  104. package/dist/billing/type/order/v1/generated/validators/spendRow.zod.d.ts +8 -0
  105. package/dist/billing/type/order/v1/generated/validators/spendRow.zod.js +11 -0
  106. package/dist/billing/type/order/v1/generated/validators/spendRowList.zod.d.ts +8 -0
  107. package/dist/billing/type/order/v1/generated/validators/spendRowList.zod.js +1 -1
  108. package/dist/billing/type/order/v1/generated/validators/statement.zod.js +2 -2
  109. package/dist/billing/type/order/v1/generated/validators/statementItem.zod.d.ts +1 -0
  110. package/dist/billing/type/order/v1/generated/validators/statementItem.zod.js +4 -0
  111. package/dist/billing/type/order/v1/generated/validators/statementSummary.zod.d.ts +1 -0
  112. package/dist/billing/type/order/v1/generated/validators/statementType.zod.js +1 -1
  113. package/dist/billing/type/order/v1/generated/validators/subscription.zod.d.ts +7 -3
  114. package/dist/billing/type/order/v1/generated/validators/subscription.zod.js +20 -14
  115. package/dist/billing/type/order/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
  116. package/dist/billing/type/order/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
  117. package/dist/billing/type/order/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
  118. package/dist/billing/type/order/v1/generated/validators/terminationPolicy.zod.js +1 -1
  119. package/dist/billing/type/order/v1/generated/validators/tier.zod.js +1 -1
  120. package/dist/billing/type/order/v1/generated/validators/topUp.zod.js +8 -8
  121. package/dist/billing/type/order/v1/generated/validators/topUpCreate.zod.js +4 -4
  122. package/dist/billing/type/order/v1/generated/validators/transaction.zod.js +6 -6
  123. package/dist/billing/type/order/v1/generated/validators/usageCharge.zod.d.ts +1 -0
  124. package/dist/billing/type/order/v1/generated/validators/usageCharge.zod.js +8 -7
  125. package/dist/billing/type/order/v1/generated/validators/usageChargeList.zod.d.ts +1 -0
  126. package/dist/billing/type/order/v1/generated/validators/usageType.zod.d.ts +14 -0
  127. package/dist/billing/type/order/v1/generated/validators/usageType.zod.js +11 -0
  128. package/dist/billing/type/order/v1/generated/validators/withdrawal.zod.js +2 -2
  129. package/dist/billing/type/order/v1/generated/validators/withdrawalItem.zod.js +2 -2
  130. package/dist/billing/type/order/v1/generated/validators/withdrawalSource.zod.js +1 -1
  131. package/dist/billing/type/quote/v1/generated/models.d.ts +4 -4
  132. package/dist/billing/type/quote/v1/generated/validators/funds.zod.js +4 -4
  133. package/dist/billing/v1/generated/functions.d.ts +176 -310
  134. package/dist/billing/v1/generated/functions.js +175 -309
  135. package/dist/billing/v1/generated/models.d.ts +429 -863
  136. package/dist/billing/v1/generated/models.js +13 -49
  137. package/dist/billing/v1/generated/schemas.zod.d.ts +166 -383
  138. package/dist/billing/v1/generated/schemas.zod.js +213 -372
  139. package/dist/billing/v1/generated/validators/accountBalance.zod.d.ts +22 -11
  140. package/dist/billing/v1/generated/validators/accountBalance.zod.js +8 -8
  141. package/dist/billing/v1/generated/validators/activeResource.zod.js +8 -5
  142. package/dist/billing/v1/generated/validators/allowance.zod.js +3 -3
  143. package/dist/billing/v1/generated/validators/applicability.zod.d.ts +22 -11
  144. package/dist/billing/v1/generated/validators/applicability.zod.js +12 -3
  145. package/dist/billing/v1/generated/validators/applicablePlan.zod.js +1 -1
  146. package/dist/billing/v1/generated/validators/billingAccount.zod.js +5 -5
  147. package/dist/billing/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
  148. package/dist/billing/v1/generated/validators/billingScheme.zod.d.ts +14 -0
  149. package/dist/billing/v1/generated/validators/billingScheme.zod.js +11 -0
  150. package/dist/billing/v1/generated/validators/cancellation.zod.d.ts +6 -3
  151. package/dist/billing/v1/generated/validators/cancellation.zod.js +4 -4
  152. package/dist/billing/v1/generated/validators/cancellationCreate.zod.js +3 -3
  153. package/dist/billing/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
  154. package/dist/billing/v1/generated/validators/cancellationItem.zod.js +6 -5
  155. package/dist/billing/v1/generated/validators/cancellationList.zod.d.ts +6 -3
  156. package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
  157. package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
  158. package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
  159. package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
  160. package/dist/billing/v1/generated/validators/contact.zod.js +2 -2
  161. package/dist/billing/v1/generated/validators/creditGrant.zod.d.ts +22 -11
  162. package/dist/billing/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
  163. package/dist/billing/v1/generated/validators/creditGroup.zod.d.ts +22 -11
  164. package/dist/billing/v1/generated/validators/creditGroup.zod.js +1 -1
  165. package/dist/billing/v1/generated/validators/creditNote.zod.js +4 -4
  166. package/dist/billing/v1/generated/validators/currency.zod.js +1 -1
  167. package/dist/billing/v1/generated/validators/discount.zod.d.ts +23 -12
  168. package/dist/billing/v1/generated/validators/discount.zod.js +4 -4
  169. package/dist/billing/v1/generated/validators/discountList.zod.d.ts +23 -12
  170. package/dist/billing/v1/generated/validators/entitlement.zod.js +1 -1
  171. package/dist/billing/v1/generated/validators/funds.zod.js +4 -4
  172. package/dist/billing/v1/generated/validators/invoice.zod.d.ts +0 -1
  173. package/dist/billing/v1/generated/validators/invoice.zod.js +8 -8
  174. package/dist/billing/v1/generated/validators/invoiceItem.zod.d.ts +2 -0
  175. package/dist/billing/v1/generated/validators/invoiceItem.zod.js +10 -4
  176. package/dist/billing/v1/generated/validators/invoiceItemList.zod.d.ts +2 -0
  177. package/dist/billing/v1/generated/validators/invoiceItemProration.zod.js +1 -3
  178. package/dist/billing/v1/generated/validators/invoiceList.zod.d.ts +0 -1
  179. package/dist/billing/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
  180. package/dist/billing/v1/generated/validators/invoiceStatus.zod.js +2 -2
  181. package/dist/billing/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
  182. package/dist/billing/v1/generated/validators/invoiceSummary.zod.js +3 -3
  183. package/dist/billing/v1/generated/validators/listInvoicesParams.zod.d.ts +0 -1
  184. package/dist/billing/v1/generated/validators/listPricesParams.zod.d.ts +5 -2
  185. package/dist/billing/v1/generated/validators/listPricesParams.zod.js +4 -1
  186. package/dist/billing/v1/generated/validators/listSpendParams.zod.d.ts +1 -0
  187. package/dist/billing/v1/generated/validators/listSpendParams.zod.js +3 -1
  188. package/dist/billing/v1/generated/validators/monthlyStatement.zod.js +2 -2
  189. package/dist/billing/v1/generated/validators/objectIdentity.zod.js +1 -1
  190. package/dist/billing/v1/generated/validators/order.zod.d.ts +7 -4
  191. package/dist/billing/v1/generated/validators/order.zod.js +10 -12
  192. package/dist/billing/v1/generated/validators/orderItem.zod.d.ts +7 -3
  193. package/dist/billing/v1/generated/validators/orderItem.zod.js +16 -14
  194. package/dist/billing/v1/generated/validators/orderItemList.zod.d.ts +7 -3
  195. package/dist/billing/v1/generated/validators/orderItemStatus.zod.js +1 -1
  196. package/dist/billing/v1/generated/validators/orderList.zod.d.ts +7 -4
  197. package/dist/billing/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  198. package/dist/billing/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
  199. package/dist/billing/v1/generated/validators/orderStatus.zod.js +1 -1
  200. package/dist/billing/v1/generated/validators/paidWith.zod.js +1 -1
  201. package/dist/billing/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
  202. package/dist/billing/v1/generated/validators/payTogetherRequest.zod.js +2 -2
  203. package/dist/billing/v1/generated/validators/paymentAction.zod.js +4 -4
  204. package/dist/billing/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
  205. package/dist/billing/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
  206. package/dist/billing/v1/generated/validators/paymentOption.zod.js +1 -1
  207. package/dist/billing/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
  208. package/dist/billing/v1/generated/validators/paymentPreview.zod.js +4 -4
  209. package/dist/billing/v1/generated/validators/paymentResult.zod.js +5 -8
  210. package/dist/billing/v1/generated/validators/paymentStatus.zod.js +1 -1
  211. package/dist/billing/v1/generated/validators/price.zod.d.ts +7 -5
  212. package/dist/billing/v1/generated/validators/price.zod.js +14 -11
  213. package/dist/billing/v1/generated/validators/priceList.zod.d.ts +7 -5
  214. package/dist/billing/v1/generated/validators/priceOption.zod.d.ts +7 -5
  215. package/dist/billing/v1/generated/validators/priceOption.zod.js +7 -3
  216. package/dist/billing/v1/generated/validators/priceType.zod.d.ts +14 -0
  217. package/dist/billing/v1/generated/validators/priceType.zod.js +11 -0
  218. package/dist/billing/v1/generated/validators/productID.zod.js +1 -1
  219. package/dist/billing/v1/generated/validators/projectAssignment.zod.js +2 -2
  220. package/dist/billing/v1/generated/validators/purchaseOperation.zod.js +1 -1
  221. package/dist/billing/v1/generated/validators/quote.zod.d.ts +6 -3
  222. package/dist/billing/v1/generated/validators/quote.zod.js +4 -4
  223. package/dist/billing/v1/generated/validators/quoteCancellation.zod.js +2 -2
  224. package/dist/billing/v1/generated/validators/quoteItem.zod.js +4 -4
  225. package/dist/billing/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
  226. package/dist/billing/v1/generated/validators/quoteItemInput.zod.js +8 -8
  227. package/dist/billing/v1/generated/validators/quoteRenewal.zod.js +1 -1
  228. package/dist/billing/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
  229. package/dist/billing/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
  230. package/dist/billing/v1/generated/validators/quoteRequest.zod.js +5 -5
  231. package/dist/billing/v1/generated/validators/quotedDiscount.zod.js +1 -1
  232. package/dist/billing/v1/generated/validators/rate.zod.d.ts +11 -0
  233. package/dist/billing/v1/generated/validators/rate.zod.js +14 -6
  234. package/dist/billing/v1/generated/validators/rateList.zod.d.ts +11 -0
  235. package/dist/billing/v1/generated/validators/refund.zod.js +3 -3
  236. package/dist/billing/v1/generated/validators/refundPolicy.zod.js +1 -1
  237. package/dist/billing/v1/generated/validators/refundReason.zod.js +1 -1
  238. package/dist/billing/v1/generated/validators/renewRequest.zod.js +2 -2
  239. package/dist/billing/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  240. package/dist/billing/v1/generated/validators/renewalPrice.zod.js +1 -1
  241. package/dist/billing/v1/generated/validators/scheduledChange.zod.js +2 -2
  242. package/dist/billing/v1/generated/validators/spendRow.zod.d.ts +8 -0
  243. package/dist/billing/v1/generated/validators/spendRow.zod.js +11 -0
  244. package/dist/billing/v1/generated/validators/spendRowList.zod.d.ts +8 -0
  245. package/dist/billing/v1/generated/validators/spendRowList.zod.js +1 -1
  246. package/dist/billing/v1/generated/validators/statement.zod.js +2 -2
  247. package/dist/billing/v1/generated/validators/statementItem.zod.d.ts +1 -0
  248. package/dist/billing/v1/generated/validators/statementItem.zod.js +4 -0
  249. package/dist/billing/v1/generated/validators/statementSummary.zod.d.ts +1 -0
  250. package/dist/billing/v1/generated/validators/statementType.zod.js +1 -1
  251. package/dist/billing/v1/generated/validators/subscription.zod.d.ts +7 -3
  252. package/dist/billing/v1/generated/validators/subscription.zod.js +20 -14
  253. package/dist/billing/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
  254. package/dist/billing/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
  255. package/dist/billing/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
  256. package/dist/billing/v1/generated/validators/terminationPolicy.zod.js +1 -1
  257. package/dist/billing/v1/generated/validators/tier.zod.js +1 -1
  258. package/dist/billing/v1/generated/validators/topUp.zod.js +8 -8
  259. package/dist/billing/v1/generated/validators/topUpCreate.zod.js +4 -4
  260. package/dist/billing/v1/generated/validators/transaction.zod.js +6 -6
  261. package/dist/billing/v1/generated/validators/usageCharge.zod.d.ts +1 -0
  262. package/dist/billing/v1/generated/validators/usageCharge.zod.js +8 -7
  263. package/dist/billing/v1/generated/validators/usageChargeList.zod.d.ts +1 -0
  264. package/dist/billing/v1/generated/validators/usageType.zod.d.ts +14 -0
  265. package/dist/billing/v1/generated/validators/usageType.zod.js +11 -0
  266. package/dist/billing/v1/generated/validators/withdrawal.zod.js +2 -2
  267. package/dist/billing/v1/generated/validators/withdrawalItem.zod.js +2 -2
  268. package/dist/billing/v1/generated/validators/withdrawalSource.zod.js +1 -1
  269. package/dist/canopy/v1/generated/functions.d.ts +1 -1
  270. package/dist/canopy/v1/generated/functions.js +1 -1
  271. package/dist/canopy/v1/generated/models.d.ts +379 -779
  272. package/dist/canopy/v1/generated/models.js +12 -44
  273. package/dist/canopy/v1/generated/schemas.zod.d.ts +1 -1
  274. package/dist/canopy/v1/generated/schemas.zod.js +1 -1
  275. package/dist/canopy/v1/generated/validators/accountBalance.zod.d.ts +22 -11
  276. package/dist/canopy/v1/generated/validators/accountBalance.zod.js +8 -8
  277. package/dist/canopy/v1/generated/validators/activeResource.zod.js +8 -5
  278. package/dist/canopy/v1/generated/validators/allowance.zod.js +3 -3
  279. package/dist/canopy/v1/generated/validators/applicability.zod.d.ts +22 -11
  280. package/dist/canopy/v1/generated/validators/applicability.zod.js +12 -3
  281. package/dist/canopy/v1/generated/validators/applicablePlan.zod.js +1 -1
  282. package/dist/canopy/v1/generated/validators/billingAccount.zod.js +5 -5
  283. package/dist/canopy/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
  284. package/dist/canopy/v1/generated/validators/billingScheme.zod.d.ts +39 -0
  285. package/dist/canopy/v1/generated/validators/billingScheme.zod.js +36 -0
  286. package/dist/canopy/v1/generated/validators/cancellation.zod.d.ts +6 -3
  287. package/dist/canopy/v1/generated/validators/cancellation.zod.js +4 -4
  288. package/dist/canopy/v1/generated/validators/cancellationCreate.zod.js +3 -3
  289. package/dist/canopy/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
  290. package/dist/canopy/v1/generated/validators/cancellationItem.zod.js +6 -5
  291. package/dist/canopy/v1/generated/validators/cancellationList.zod.d.ts +6 -3
  292. package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
  293. package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
  294. package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
  295. package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
  296. package/dist/canopy/v1/generated/validators/contact.zod.js +2 -2
  297. package/dist/canopy/v1/generated/validators/createServiceResponseBody.zod.d.ts +0 -1
  298. package/dist/canopy/v1/generated/validators/creditGrant.zod.d.ts +22 -11
  299. package/dist/canopy/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
  300. package/dist/canopy/v1/generated/validators/creditGroup.zod.d.ts +22 -11
  301. package/dist/canopy/v1/generated/validators/creditGroup.zod.js +1 -1
  302. package/dist/canopy/v1/generated/validators/creditNote.zod.js +4 -4
  303. package/dist/canopy/v1/generated/validators/currency.zod.js +1 -1
  304. package/dist/canopy/v1/generated/validators/discount.zod.d.ts +23 -12
  305. package/dist/canopy/v1/generated/validators/discount.zod.js +4 -4
  306. package/dist/canopy/v1/generated/validators/discountList.zod.d.ts +23 -12
  307. package/dist/canopy/v1/generated/validators/entitlement.zod.js +1 -1
  308. package/dist/canopy/v1/generated/validators/funds.zod.js +4 -4
  309. package/dist/canopy/v1/generated/validators/invoice.zod.d.ts +0 -1
  310. package/dist/canopy/v1/generated/validators/invoice.zod.js +8 -8
  311. package/dist/canopy/v1/generated/validators/invoiceItem.zod.d.ts +2 -0
  312. package/dist/canopy/v1/generated/validators/invoiceItem.zod.js +10 -4
  313. package/dist/canopy/v1/generated/validators/invoiceItemList.zod.d.ts +2 -0
  314. package/dist/canopy/v1/generated/validators/invoiceItemProration.zod.js +1 -3
  315. package/dist/canopy/v1/generated/validators/invoiceList.zod.d.ts +0 -1
  316. package/dist/canopy/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
  317. package/dist/canopy/v1/generated/validators/invoiceStatus.zod.js +2 -2
  318. package/dist/canopy/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
  319. package/dist/canopy/v1/generated/validators/invoiceSummary.zod.js +3 -3
  320. package/dist/canopy/v1/generated/validators/monthlyStatement.zod.js +2 -2
  321. package/dist/canopy/v1/generated/validators/objectIdentity.zod.js +1 -1
  322. package/dist/canopy/v1/generated/validators/order.zod.d.ts +7 -4
  323. package/dist/canopy/v1/generated/validators/order.zod.js +10 -12
  324. package/dist/canopy/v1/generated/validators/orderItem.zod.d.ts +7 -3
  325. package/dist/canopy/v1/generated/validators/orderItem.zod.js +16 -14
  326. package/dist/canopy/v1/generated/validators/orderItemList.zod.d.ts +7 -3
  327. package/dist/canopy/v1/generated/validators/orderItemStatus.zod.js +1 -1
  328. package/dist/canopy/v1/generated/validators/orderList.zod.d.ts +7 -4
  329. package/dist/canopy/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  330. package/dist/canopy/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
  331. package/dist/canopy/v1/generated/validators/orderStatus.zod.js +1 -1
  332. package/dist/canopy/v1/generated/validators/paidWith.zod.js +1 -1
  333. package/dist/canopy/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
  334. package/dist/canopy/v1/generated/validators/payTogetherRequest.zod.js +2 -2
  335. package/dist/canopy/v1/generated/validators/paymentAction.zod.js +4 -4
  336. package/dist/canopy/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
  337. package/dist/canopy/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
  338. package/dist/canopy/v1/generated/validators/paymentOption.zod.js +1 -1
  339. package/dist/canopy/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
  340. package/dist/canopy/v1/generated/validators/paymentPreview.zod.js +4 -4
  341. package/dist/canopy/v1/generated/validators/paymentResult.zod.js +5 -8
  342. package/dist/canopy/v1/generated/validators/paymentStatus.zod.js +1 -1
  343. package/dist/canopy/v1/generated/validators/placedOrder.zod.d.ts +0 -1
  344. package/dist/canopy/v1/generated/validators/price.zod.d.ts +7 -5
  345. package/dist/canopy/v1/generated/validators/price.zod.js +14 -11
  346. package/dist/canopy/v1/generated/validators/priceList.zod.d.ts +7 -5
  347. package/dist/canopy/v1/generated/validators/priceOption.zod.d.ts +7 -5
  348. package/dist/canopy/v1/generated/validators/priceOption.zod.js +7 -3
  349. package/dist/canopy/v1/generated/validators/priceType.zod.d.ts +39 -0
  350. package/dist/canopy/v1/generated/validators/priceType.zod.js +36 -0
  351. package/dist/canopy/v1/generated/validators/productID.zod.js +1 -1
  352. package/dist/canopy/v1/generated/validators/projectAssignment.zod.js +2 -2
  353. package/dist/canopy/v1/generated/validators/purchaseOperation.zod.js +1 -1
  354. package/dist/canopy/v1/generated/validators/quote5f60d00.zod.d.ts +6 -3
  355. package/dist/canopy/v1/generated/validators/quote5f60d00.zod.js +4 -4
  356. package/dist/canopy/v1/generated/validators/quoteA200529.zod.d.ts +6 -3
  357. package/dist/canopy/v1/generated/validators/quoteCancellation.zod.js +2 -2
  358. package/dist/canopy/v1/generated/validators/quoteItem.zod.js +4 -4
  359. package/dist/canopy/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
  360. package/dist/canopy/v1/generated/validators/quoteItemInput.zod.js +8 -8
  361. package/dist/canopy/v1/generated/validators/quoteRenewal.zod.js +1 -1
  362. package/dist/canopy/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
  363. package/dist/canopy/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
  364. package/dist/canopy/v1/generated/validators/quoteRequest.zod.js +5 -5
  365. package/dist/canopy/v1/generated/validators/quotedDiscount.zod.js +1 -1
  366. package/dist/canopy/v1/generated/validators/rate.zod.d.ts +11 -0
  367. package/dist/canopy/v1/generated/validators/rate.zod.js +14 -6
  368. package/dist/canopy/v1/generated/validators/rateList.zod.d.ts +11 -0
  369. package/dist/canopy/v1/generated/validators/refund.zod.js +3 -3
  370. package/dist/canopy/v1/generated/validators/refundPolicy.zod.js +1 -1
  371. package/dist/canopy/v1/generated/validators/refundReason.zod.js +1 -1
  372. package/dist/canopy/v1/generated/validators/renewRequest.zod.js +2 -2
  373. package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  374. package/dist/canopy/v1/generated/validators/renewalPrice.zod.js +1 -1
  375. package/dist/canopy/v1/generated/validators/scheduledChange.zod.js +2 -2
  376. package/dist/canopy/v1/generated/validators/spendRow.zod.d.ts +8 -0
  377. package/dist/canopy/v1/generated/validators/spendRow.zod.js +11 -0
  378. package/dist/canopy/v1/generated/validators/spendRowList.zod.d.ts +8 -0
  379. package/dist/canopy/v1/generated/validators/spendRowList.zod.js +1 -1
  380. package/dist/canopy/v1/generated/validators/statement.zod.js +2 -2
  381. package/dist/canopy/v1/generated/validators/statementItem.zod.d.ts +1 -0
  382. package/dist/canopy/v1/generated/validators/statementItem.zod.js +4 -0
  383. package/dist/canopy/v1/generated/validators/statementSummary.zod.d.ts +1 -0
  384. package/dist/canopy/v1/generated/validators/statementType.zod.js +1 -1
  385. package/dist/canopy/v1/generated/validators/subscription.zod.d.ts +7 -3
  386. package/dist/canopy/v1/generated/validators/subscription.zod.js +20 -14
  387. package/dist/canopy/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
  388. package/dist/canopy/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
  389. package/dist/canopy/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
  390. package/dist/canopy/v1/generated/validators/terminationPolicy.zod.js +1 -1
  391. package/dist/canopy/v1/generated/validators/tier.zod.js +1 -1
  392. package/dist/canopy/v1/generated/validators/topUp.zod.js +8 -8
  393. package/dist/canopy/v1/generated/validators/topUpCreate.zod.js +4 -4
  394. package/dist/canopy/v1/generated/validators/transaction.zod.js +6 -6
  395. package/dist/canopy/v1/generated/validators/usageCharge.zod.d.ts +1 -0
  396. package/dist/canopy/v1/generated/validators/usageCharge.zod.js +8 -7
  397. package/dist/canopy/v1/generated/validators/usageChargeList.zod.d.ts +1 -0
  398. package/dist/canopy/v1/generated/validators/usageType.zod.d.ts +39 -0
  399. package/dist/canopy/v1/generated/validators/usageType.zod.js +36 -0
  400. package/dist/canopy/v1/generated/validators/withdrawal.zod.js +2 -2
  401. package/dist/canopy/v1/generated/validators/withdrawalItem.zod.js +2 -2
  402. package/dist/canopy/v1/generated/validators/withdrawalSource.zod.js +1 -1
  403. package/dist/compute/v1/generated/functions.d.ts +15 -15
  404. package/dist/compute/v1/generated/functions.js +13 -13
  405. package/dist/compute/v1/generated/models.d.ts +37 -29
  406. package/dist/compute/v1/generated/models.js +6 -6
  407. package/dist/compute/v1/generated/schemas.zod.d.ts +69 -69
  408. package/dist/compute/v1/generated/schemas.zod.js +15 -15
  409. package/dist/compute/v1/generated/validators/allocateFloatingIPQuoteRequestBody.zod.d.ts +5 -5
  410. package/dist/compute/v1/generated/validators/allocateFloatingIPQuoteRequestBody.zod.js +2 -2
  411. package/dist/compute/v1/generated/validators/allocateFloatingIPRequestBody.zod.d.ts +5 -5
  412. package/dist/compute/v1/generated/validators/allocateFloatingIPRequestBody.zod.js +2 -2
  413. package/dist/compute/v1/generated/validators/allocateFloatingIPResponseBody.zod.d.ts +2 -2
  414. package/dist/compute/v1/generated/validators/allocateFloatingIPResponseBody.zod.js +2 -2
  415. package/dist/compute/v1/generated/validators/attachDiskRequestBody.zod.d.ts +2 -2
  416. package/dist/compute/v1/generated/validators/attachDiskRequestBody.zod.js +2 -2
  417. package/dist/compute/v1/generated/validators/attachFloatingIPRequestBody.zod.d.ts +2 -2
  418. package/dist/compute/v1/generated/validators/attachFloatingIPRequestBody.zod.js +2 -2
  419. package/dist/compute/v1/generated/validators/attachPortRequestBody.zod.d.ts +2 -2
  420. package/dist/compute/v1/generated/validators/attachPortRequestBody.zod.js +2 -2
  421. package/dist/compute/v1/generated/validators/backupCapacityPack.zod.d.ts +2 -2
  422. package/dist/compute/v1/generated/validators/backupCapacityPack.zod.js +3 -3
  423. package/dist/compute/v1/generated/validators/backupCapacityPackListResponseBody.zod.d.ts +2 -2
  424. package/dist/compute/v1/generated/validators/backupCapacityPackListResponseBody.zod.js +2 -2
  425. package/dist/compute/v1/generated/validators/backupListResponseBody.zod.d.ts +2 -2
  426. package/dist/compute/v1/generated/validators/backupListResponseBody.zod.js +2 -2
  427. package/dist/compute/v1/generated/validators/backupOperation.zod.d.ts +2 -2
  428. package/dist/compute/v1/generated/validators/backupOperation.zod.js +2 -2
  429. package/dist/compute/v1/generated/validators/backupResource.zod.d.ts +2 -2
  430. package/dist/compute/v1/generated/validators/backupResource.zod.js +2 -2
  431. package/dist/compute/v1/generated/validators/backupService.zod.d.ts +10 -10
  432. package/dist/compute/v1/generated/validators/backupService.zod.js +7 -7
  433. package/dist/compute/v1/generated/validators/billingChoice.zod.d.ts +5 -5
  434. package/dist/compute/v1/generated/validators/billingChoice.zod.js +6 -4
  435. package/dist/compute/v1/generated/validators/billingPeriod.zod.d.ts +2 -2
  436. package/dist/compute/v1/generated/validators/billingPeriod.zod.js +2 -2
  437. package/dist/compute/v1/generated/validators/bindFloatingIPRequestBody.zod.d.ts +2 -2
  438. package/dist/compute/v1/generated/validators/bindFloatingIPRequestBody.zod.js +2 -2
  439. package/dist/compute/v1/generated/validators/bootDisk.zod.d.ts +5 -5
  440. package/dist/compute/v1/generated/validators/bootDisk.zod.js +2 -2
  441. package/dist/compute/v1/generated/validators/checkoutMode.zod.d.ts +2 -2
  442. package/dist/compute/v1/generated/validators/checkoutMode.zod.js +2 -2
  443. package/dist/compute/v1/generated/validators/checkoutOptions.zod.d.ts +2 -2
  444. package/dist/compute/v1/generated/validators/checkoutOptions.zod.js +2 -2
  445. package/dist/compute/v1/generated/validators/commandResultResponseBody.zod.d.ts +2 -2
  446. package/dist/compute/v1/generated/validators/commandResultResponseBody.zod.js +2 -2
  447. package/dist/compute/v1/generated/validators/consoleOutputResponseBody.zod.d.ts +2 -2
  448. package/dist/compute/v1/generated/validators/consoleOutputResponseBody.zod.js +2 -2
  449. package/dist/compute/v1/generated/validators/consoleResponseBody.zod.d.ts +2 -2
  450. package/dist/compute/v1/generated/validators/consoleResponseBody.zod.js +2 -2
  451. package/dist/compute/v1/generated/validators/createBackupCapacityPackQuoteRequestBody.zod.d.ts +5 -5
  452. package/dist/compute/v1/generated/validators/createBackupCapacityPackQuoteRequestBody.zod.js +2 -2
  453. package/dist/compute/v1/generated/validators/createBackupCapacityPackRequestBody.zod.d.ts +5 -5
  454. package/dist/compute/v1/generated/validators/createBackupCapacityPackRequestBody.zod.js +2 -2
  455. package/dist/compute/v1/generated/validators/createBackupCapacityPackResponseBody.zod.d.ts +2 -2
  456. package/dist/compute/v1/generated/validators/createBackupCapacityPackResponseBody.zod.js +2 -2
  457. package/dist/compute/v1/generated/validators/createBackupRequestBody.zod.d.ts +2 -2
  458. package/dist/compute/v1/generated/validators/createBackupRequestBody.zod.js +2 -2
  459. package/dist/compute/v1/generated/validators/createBackupServiceRequestBody.zod.d.ts +2 -2
  460. package/dist/compute/v1/generated/validators/createBackupServiceRequestBody.zod.js +2 -2
  461. package/dist/compute/v1/generated/validators/createBackupServiceResponseBody.zod.d.ts +9 -9
  462. package/dist/compute/v1/generated/validators/createBackupServiceResponseBody.zod.js +2 -2
  463. package/dist/compute/v1/generated/validators/createDiskQuoteRequestBody.zod.d.ts +5 -5
  464. package/dist/compute/v1/generated/validators/createDiskQuoteRequestBody.zod.js +2 -2
  465. package/dist/compute/v1/generated/validators/createDiskRequestBody.zod.d.ts +5 -5
  466. package/dist/compute/v1/generated/validators/createDiskRequestBody.zod.js +2 -2
  467. package/dist/compute/v1/generated/validators/createDiskResponseBody.zod.d.ts +2 -2
  468. package/dist/compute/v1/generated/validators/createDiskResponseBody.zod.js +2 -2
  469. package/dist/compute/v1/generated/validators/createImageQuoteRequestBody.zod.d.ts +5 -5
  470. package/dist/compute/v1/generated/validators/createImageQuoteRequestBody.zod.js +2 -2
  471. package/dist/compute/v1/generated/validators/createImageRequestBody.zod.d.ts +5 -5
  472. package/dist/compute/v1/generated/validators/createImageRequestBody.zod.js +2 -2
  473. package/dist/compute/v1/generated/validators/createImageResponseBody.zod.d.ts +2 -2
  474. package/dist/compute/v1/generated/validators/createImageResponseBody.zod.js +2 -2
  475. package/dist/compute/v1/generated/validators/createPeeringRequestBody.zod.d.ts +2 -2
  476. package/dist/compute/v1/generated/validators/createPeeringRequestBody.zod.js +2 -2
  477. package/dist/compute/v1/generated/validators/createPortRequestBody.zod.d.ts +2 -2
  478. package/dist/compute/v1/generated/validators/createPortRequestBody.zod.js +2 -2
  479. package/dist/compute/v1/generated/validators/createPrivateNetworkRequestBody.zod.d.ts +2 -2
  480. package/dist/compute/v1/generated/validators/createPrivateNetworkRequestBody.zod.js +2 -2
  481. package/dist/compute/v1/generated/validators/createRouteRequestBody.zod.d.ts +2 -2
  482. package/dist/compute/v1/generated/validators/createRouteRequestBody.zod.js +2 -2
  483. package/dist/compute/v1/generated/validators/createSecurityGroupRequestBody.zod.d.ts +2 -2
  484. package/dist/compute/v1/generated/validators/createSecurityGroupRequestBody.zod.js +2 -2
  485. package/dist/compute/v1/generated/validators/createSecurityRuleRequestBody.zod.d.ts +2 -2
  486. package/dist/compute/v1/generated/validators/createSecurityRuleRequestBody.zod.js +2 -2
  487. package/dist/compute/v1/generated/validators/createSnapshotRequestBody.zod.d.ts +2 -2
  488. package/dist/compute/v1/generated/validators/createSnapshotRequestBody.zod.js +2 -2
  489. package/dist/compute/v1/generated/validators/createSubnetRequestBody.zod.d.ts +2 -2
  490. package/dist/compute/v1/generated/validators/createSubnetRequestBody.zod.js +2 -2
  491. package/dist/compute/v1/generated/validators/cursorPagination.zod.d.ts +2 -2
  492. package/dist/compute/v1/generated/validators/cursorPagination.zod.js +2 -2
  493. package/dist/compute/v1/generated/validators/diskAttachment.zod.d.ts +2 -2
  494. package/dist/compute/v1/generated/validators/diskAttachment.zod.js +2 -2
  495. package/dist/compute/v1/generated/validators/diskAttachmentList.zod.d.ts +2 -2
  496. package/dist/compute/v1/generated/validators/diskAttachmentList.zod.js +2 -2
  497. package/dist/compute/v1/generated/validators/diskListResponseBody.zod.d.ts +2 -2
  498. package/dist/compute/v1/generated/validators/diskListResponseBody.zod.js +2 -2
  499. package/dist/compute/v1/generated/validators/diskOperation.zod.d.ts +2 -2
  500. package/dist/compute/v1/generated/validators/diskOperation.zod.js +2 -2
  501. package/dist/compute/v1/generated/validators/diskResource.zod.d.ts +2 -2
  502. package/dist/compute/v1/generated/validators/diskResource.zod.js +2 -2
  503. package/dist/compute/v1/generated/validators/diskTypeListResponseBody.zod.d.ts +5 -5
  504. package/dist/compute/v1/generated/validators/diskTypeListResponseBody.zod.js +2 -2
  505. package/dist/compute/v1/generated/validators/diskTypePurpose.zod.d.ts +2 -2
  506. package/dist/compute/v1/generated/validators/diskTypePurpose.zod.js +2 -2
  507. package/dist/compute/v1/generated/validators/diskTypeResource.zod.d.ts +5 -5
  508. package/dist/compute/v1/generated/validators/diskTypeResource.zod.js +2 -2
  509. package/dist/compute/v1/generated/validators/error.zod.d.ts +2 -2
  510. package/dist/compute/v1/generated/validators/error.zod.js +2 -2
  511. package/dist/compute/v1/generated/validators/existingBootDisk.zod.d.ts +2 -2
  512. package/dist/compute/v1/generated/validators/existingBootDisk.zod.js +2 -2
  513. package/dist/compute/v1/generated/validators/floatingIPListResponseBody.zod.d.ts +2 -2
  514. package/dist/compute/v1/generated/validators/floatingIPListResponseBody.zod.js +2 -2
  515. package/dist/compute/v1/generated/validators/floatingIPOperation.zod.d.ts +2 -2
  516. package/dist/compute/v1/generated/validators/floatingIPOperation.zod.js +2 -2
  517. package/dist/compute/v1/generated/validators/floatingIPResource.zod.d.ts +2 -2
  518. package/dist/compute/v1/generated/validators/floatingIPResource.zod.js +2 -2
  519. package/dist/compute/v1/generated/validators/funds.zod.d.ts +2 -2
  520. package/dist/compute/v1/generated/validators/funds.zod.js +6 -6
  521. package/dist/compute/v1/generated/validators/getInstanceConsoleOutputParams.zod.d.ts +2 -2
  522. package/dist/compute/v1/generated/validators/getInstanceConsoleOutputParams.zod.js +2 -2
  523. package/dist/compute/v1/generated/validators/iPv4Binding.zod.d.ts +2 -2
  524. package/dist/compute/v1/generated/validators/iPv4Binding.zod.js +2 -2
  525. package/dist/compute/v1/generated/validators/iPv4PoolListResponseBody.zod.d.ts +8 -8
  526. package/dist/compute/v1/generated/validators/iPv4PoolListResponseBody.zod.js +2 -2
  527. package/dist/compute/v1/generated/validators/iPv4PoolResource.zod.d.ts +8 -8
  528. package/dist/compute/v1/generated/validators/iPv4PoolResource.zod.js +2 -2
  529. package/dist/compute/v1/generated/validators/iPv6ResponseBody.zod.d.ts +2 -2
  530. package/dist/compute/v1/generated/validators/iPv6ResponseBody.zod.js +2 -2
  531. package/dist/compute/v1/generated/validators/imageListResponseBody.zod.d.ts +2 -2
  532. package/dist/compute/v1/generated/validators/imageListResponseBody.zod.js +2 -2
  533. package/dist/compute/v1/generated/validators/imageOperation.zod.d.ts +2 -2
  534. package/dist/compute/v1/generated/validators/imageOperation.zod.js +2 -2
  535. package/dist/compute/v1/generated/validators/imageResource.zod.d.ts +2 -2
  536. package/dist/compute/v1/generated/validators/imageResource.zod.js +2 -2
  537. package/dist/compute/v1/generated/validators/imageVisibility.zod.d.ts +2 -2
  538. package/dist/compute/v1/generated/validators/imageVisibility.zod.js +2 -2
  539. package/dist/compute/v1/generated/validators/instanceListResponseBody.zod.d.ts +2 -2
  540. package/dist/compute/v1/generated/validators/instanceListResponseBody.zod.js +2 -2
  541. package/dist/compute/v1/generated/validators/instanceOperation.zod.d.ts +2 -2
  542. package/dist/compute/v1/generated/validators/instanceOperation.zod.js +2 -2
  543. package/dist/compute/v1/generated/validators/instanceResource.zod.d.ts +2 -2
  544. package/dist/compute/v1/generated/validators/instanceResource.zod.js +2 -2
  545. package/dist/compute/v1/generated/validators/instanceRestriction.zod.d.ts +2 -2
  546. package/dist/compute/v1/generated/validators/instanceRestriction.zod.js +2 -2
  547. package/dist/compute/v1/generated/validators/instanceTypeListResponseBody.zod.d.ts +5 -5
  548. package/dist/compute/v1/generated/validators/instanceTypeListResponseBody.zod.js +2 -2
  549. package/dist/compute/v1/generated/validators/instanceTypeResource.zod.d.ts +5 -5
  550. package/dist/compute/v1/generated/validators/instanceTypeResource.zod.js +2 -2
  551. package/dist/compute/v1/generated/validators/launchInstanceQuoteRequestBody.zod.d.ts +11 -11
  552. package/dist/compute/v1/generated/validators/launchInstanceQuoteRequestBody.zod.js +2 -2
  553. package/dist/compute/v1/generated/validators/launchInstanceRequestBody.zod.d.ts +11 -11
  554. package/dist/compute/v1/generated/validators/launchInstanceRequestBody.zod.js +2 -2
  555. package/dist/compute/v1/generated/validators/launchInstanceResponseBody.zod.d.ts +2 -2
  556. package/dist/compute/v1/generated/validators/launchInstanceResponseBody.zod.js +2 -2
  557. package/dist/compute/v1/generated/validators/listAvailabilityZonesParams.zod.d.ts +2 -2
  558. package/dist/compute/v1/generated/validators/listAvailabilityZonesParams.zod.js +2 -2
  559. package/dist/compute/v1/generated/validators/listBackupCapacityPacksParams.zod.d.ts +2 -2
  560. package/dist/compute/v1/generated/validators/listBackupCapacityPacksParams.zod.js +2 -2
  561. package/dist/compute/v1/generated/validators/listBackupsParams.zod.d.ts +2 -2
  562. package/dist/compute/v1/generated/validators/listBackupsParams.zod.js +2 -2
  563. package/dist/compute/v1/generated/validators/listDiskTypesParams.zod.d.ts +2 -2
  564. package/dist/compute/v1/generated/validators/listDiskTypesParams.zod.js +2 -2
  565. package/dist/compute/v1/generated/validators/listDisksParams.zod.d.ts +2 -2
  566. package/dist/compute/v1/generated/validators/listDisksParams.zod.js +2 -2
  567. package/dist/compute/v1/generated/validators/listFloatingIpsParams.zod.d.ts +2 -2
  568. package/dist/compute/v1/generated/validators/listFloatingIpsParams.zod.js +2 -2
  569. package/dist/compute/v1/generated/validators/listImagesParams.zod.d.ts +2 -2
  570. package/dist/compute/v1/generated/validators/listImagesParams.zod.js +2 -2
  571. package/dist/compute/v1/generated/validators/listInstanceDisksParams.zod.d.ts +2 -2
  572. package/dist/compute/v1/generated/validators/listInstanceDisksParams.zod.js +2 -2
  573. package/dist/compute/v1/generated/validators/listInstancePortsParams.zod.d.ts +2 -2
  574. package/dist/compute/v1/generated/validators/listInstancePortsParams.zod.js +2 -2
  575. package/dist/compute/v1/generated/validators/listInstanceTypesParams.zod.d.ts +2 -2
  576. package/dist/compute/v1/generated/validators/listInstanceTypesParams.zod.js +2 -2
  577. package/dist/compute/v1/generated/validators/listInstancesParams.zod.d.ts +2 -2
  578. package/dist/compute/v1/generated/validators/listInstancesParams.zod.js +2 -2
  579. package/dist/compute/v1/generated/validators/listIpv4PoolsParams.zod.d.ts +2 -2
  580. package/dist/compute/v1/generated/validators/listIpv4PoolsParams.zod.js +2 -2
  581. package/dist/compute/v1/generated/validators/listOperationLogsParams.zod.d.ts +2 -2
  582. package/dist/compute/v1/generated/validators/listOperationLogsParams.zod.js +2 -2
  583. package/dist/compute/v1/generated/validators/listPeeringsParams.zod.d.ts +2 -2
  584. package/dist/compute/v1/generated/validators/listPeeringsParams.zod.js +2 -2
  585. package/dist/compute/v1/generated/validators/listPortsParams.zod.d.ts +2 -2
  586. package/dist/compute/v1/generated/validators/listPortsParams.zod.js +2 -2
  587. package/dist/compute/v1/generated/validators/listPrivateNetworksParams.zod.d.ts +2 -2
  588. package/dist/compute/v1/generated/validators/listPrivateNetworksParams.zod.js +2 -2
  589. package/dist/compute/v1/generated/validators/listRegionsParams.zod.d.ts +2 -2
  590. package/dist/compute/v1/generated/validators/listRegionsParams.zod.js +2 -2
  591. package/dist/compute/v1/generated/validators/listRoutesParams.zod.d.ts +2 -2
  592. package/dist/compute/v1/generated/validators/listRoutesParams.zod.js +2 -2
  593. package/dist/compute/v1/generated/validators/listSecurityGroupRulesParams.zod.d.ts +2 -2
  594. package/dist/compute/v1/generated/validators/listSecurityGroupRulesParams.zod.js +2 -2
  595. package/dist/compute/v1/generated/validators/listSecurityGroupsParams.zod.d.ts +2 -2
  596. package/dist/compute/v1/generated/validators/listSecurityGroupsParams.zod.js +2 -2
  597. package/dist/compute/v1/generated/validators/listSnapshotsParams.zod.d.ts +2 -2
  598. package/dist/compute/v1/generated/validators/listSnapshotsParams.zod.js +2 -2
  599. package/dist/compute/v1/generated/validators/listSubnetsParams.zod.d.ts +2 -2
  600. package/dist/compute/v1/generated/validators/listSubnetsParams.zod.js +2 -2
  601. package/dist/compute/v1/generated/validators/money.zod.d.ts +2 -2
  602. package/dist/compute/v1/generated/validators/money.zod.js +2 -2
  603. package/dist/compute/v1/generated/validators/newBootDisk.zod.d.ts +5 -5
  604. package/dist/compute/v1/generated/validators/newBootDisk.zod.js +2 -2
  605. package/dist/compute/v1/generated/validators/newCompute.zod.d.ts +5 -5
  606. package/dist/compute/v1/generated/validators/newCompute.zod.js +2 -2
  607. package/dist/compute/v1/generated/validators/newFloatingIP.zod.d.ts +5 -5
  608. package/dist/compute/v1/generated/validators/newFloatingIP.zod.js +2 -2
  609. package/dist/compute/v1/generated/validators/nextFreeCidrResponseBody.zod.d.ts +2 -2
  610. package/dist/compute/v1/generated/validators/nextFreeCidrResponseBody.zod.js +2 -2
  611. package/dist/compute/v1/generated/validators/offsetPagination.zod.d.ts +2 -2
  612. package/dist/compute/v1/generated/validators/offsetPagination.zod.js +2 -2
  613. package/dist/compute/v1/generated/validators/operationLogListResponseBody.zod.d.ts +2 -2
  614. package/dist/compute/v1/generated/validators/operationLogListResponseBody.zod.js +2 -2
  615. package/dist/compute/v1/generated/validators/operationLogResource.zod.d.ts +2 -2
  616. package/dist/compute/v1/generated/validators/operationLogResource.zod.js +2 -2
  617. package/dist/compute/v1/generated/validators/peeringListResponseBody.zod.d.ts +2 -2
  618. package/dist/compute/v1/generated/validators/peeringListResponseBody.zod.js +2 -2
  619. package/dist/compute/v1/generated/validators/peeringOperation.zod.d.ts +2 -2
  620. package/dist/compute/v1/generated/validators/peeringOperation.zod.js +2 -2
  621. package/dist/compute/v1/generated/validators/peeringResource.zod.d.ts +2 -2
  622. package/dist/compute/v1/generated/validators/peeringResource.zod.js +2 -2
  623. package/dist/compute/v1/generated/validators/placedOrder.zod.d.ts +2 -2
  624. package/dist/compute/v1/generated/validators/placedOrder.zod.js +2 -2
  625. package/dist/compute/v1/generated/validators/portAddress.zod.d.ts +2 -2
  626. package/dist/compute/v1/generated/validators/portAddress.zod.js +2 -2
  627. package/dist/compute/v1/generated/validators/portAttachment.zod.d.ts +2 -2
  628. package/dist/compute/v1/generated/validators/portAttachment.zod.js +2 -2
  629. package/dist/compute/v1/generated/validators/portAttachmentList.zod.d.ts +2 -2
  630. package/dist/compute/v1/generated/validators/portAttachmentList.zod.js +2 -2
  631. package/dist/compute/v1/generated/validators/portListResponseBody.zod.d.ts +2 -2
  632. package/dist/compute/v1/generated/validators/portListResponseBody.zod.js +2 -2
  633. package/dist/compute/v1/generated/validators/portOperation.zod.d.ts +2 -2
  634. package/dist/compute/v1/generated/validators/portOperation.zod.js +2 -2
  635. package/dist/compute/v1/generated/validators/portResource.zod.d.ts +2 -2
  636. package/dist/compute/v1/generated/validators/portResource.zod.js +2 -2
  637. package/dist/compute/v1/generated/validators/powerRequest.zod.d.ts +2 -2
  638. package/dist/compute/v1/generated/validators/powerRequest.zod.js +2 -2
  639. package/dist/compute/v1/generated/validators/pricing.zod.d.ts +5 -5
  640. package/dist/compute/v1/generated/validators/pricing.zod.js +2 -2
  641. package/dist/compute/v1/generated/validators/pricingOption.zod.d.ts +5 -5
  642. package/dist/compute/v1/generated/validators/pricingOption.zod.js +12 -10
  643. package/dist/compute/v1/generated/validators/privateNetworkListResponseBody.zod.d.ts +2 -2
  644. package/dist/compute/v1/generated/validators/privateNetworkListResponseBody.zod.js +2 -2
  645. package/dist/compute/v1/generated/validators/privateNetworkResource.zod.d.ts +2 -2
  646. package/dist/compute/v1/generated/validators/privateNetworkResource.zod.js +2 -2
  647. package/dist/compute/v1/generated/validators/quote.zod.d.ts +2 -2
  648. package/dist/compute/v1/generated/validators/quote.zod.js +2 -2
  649. package/dist/compute/v1/generated/validators/quoteItem.zod.d.ts +2 -2
  650. package/dist/compute/v1/generated/validators/quoteItem.zod.js +2 -2
  651. package/dist/compute/v1/generated/validators/rebootInstanceRequestBody.zod.d.ts +2 -2
  652. package/dist/compute/v1/generated/validators/rebootInstanceRequestBody.zod.js +2 -2
  653. package/dist/compute/v1/generated/validators/rebuildInstanceRequestBody.zod.d.ts +2 -2
  654. package/dist/compute/v1/generated/validators/rebuildInstanceRequestBody.zod.js +2 -2
  655. package/dist/compute/v1/generated/validators/rebuildInstanceResponseBody.zod.d.ts +2 -2
  656. package/dist/compute/v1/generated/validators/rebuildInstanceResponseBody.zod.js +2 -2
  657. package/dist/compute/v1/generated/validators/regionListResponseBody.zod.d.ts +5 -5
  658. package/dist/compute/v1/generated/validators/regionListResponseBody.zod.js +2 -2
  659. package/dist/compute/v1/generated/validators/regionResource.zod.d.ts +5 -5
  660. package/dist/compute/v1/generated/validators/regionResource.zod.js +2 -2
  661. package/dist/compute/v1/generated/validators/releaseResource.zod.d.ts +2 -2
  662. package/dist/compute/v1/generated/validators/releaseResource.zod.js +2 -2
  663. package/dist/compute/v1/generated/validators/releaseSetItem.zod.d.ts +2 -2
  664. package/dist/compute/v1/generated/validators/releaseSetItem.zod.js +2 -2
  665. package/dist/compute/v1/generated/validators/renameBackupRequestBody.zod.d.ts +2 -2
  666. package/dist/compute/v1/generated/validators/renameBackupRequestBody.zod.js +2 -2
  667. package/dist/compute/v1/generated/validators/renameDiskRequestBody.zod.d.ts +2 -2
  668. package/dist/compute/v1/generated/validators/renameDiskRequestBody.zod.js +2 -2
  669. package/dist/compute/v1/generated/validators/renameImageRequestBody.zod.d.ts +2 -2
  670. package/dist/compute/v1/generated/validators/renameImageRequestBody.zod.js +2 -2
  671. package/dist/compute/v1/generated/validators/renameInstanceRequestBody.zod.d.ts +2 -2
  672. package/dist/compute/v1/generated/validators/renameInstanceRequestBody.zod.js +2 -2
  673. package/dist/compute/v1/generated/validators/renamePrivateNetworkRequestBody.zod.d.ts +2 -2
  674. package/dist/compute/v1/generated/validators/renamePrivateNetworkRequestBody.zod.js +2 -2
  675. package/dist/compute/v1/generated/validators/renameSecurityGroupRequestBody.zod.d.ts +2 -2
  676. package/dist/compute/v1/generated/validators/renameSecurityGroupRequestBody.zod.js +2 -2
  677. package/dist/compute/v1/generated/validators/renameSnapshotRequestBody.zod.d.ts +2 -2
  678. package/dist/compute/v1/generated/validators/renameSnapshotRequestBody.zod.js +2 -2
  679. package/dist/compute/v1/generated/validators/resetPasswordRequestBody.zod.d.ts +2 -2
  680. package/dist/compute/v1/generated/validators/resetPasswordRequestBody.zod.js +2 -2
  681. package/dist/compute/v1/generated/validators/resetPasswordResponseBody.zod.d.ts +2 -2
  682. package/dist/compute/v1/generated/validators/resetPasswordResponseBody.zod.js +2 -2
  683. package/dist/compute/v1/generated/validators/resizeDiskQuoteRequestBody.zod.d.ts +2 -2
  684. package/dist/compute/v1/generated/validators/resizeDiskQuoteRequestBody.zod.js +2 -2
  685. package/dist/compute/v1/generated/validators/resizeDiskRequestBody.zod.d.ts +2 -2
  686. package/dist/compute/v1/generated/validators/resizeDiskRequestBody.zod.js +2 -2
  687. package/dist/compute/v1/generated/validators/resizeDiskResponseBody.zod.d.ts +2 -2
  688. package/dist/compute/v1/generated/validators/resizeDiskResponseBody.zod.js +2 -2
  689. package/dist/compute/v1/generated/validators/resizeInstanceQuoteRequestBody.zod.d.ts +2 -2
  690. package/dist/compute/v1/generated/validators/resizeInstanceQuoteRequestBody.zod.js +2 -2
  691. package/dist/compute/v1/generated/validators/resizeInstanceRequestBody.zod.d.ts +2 -2
  692. package/dist/compute/v1/generated/validators/resizeInstanceRequestBody.zod.js +2 -2
  693. package/dist/compute/v1/generated/validators/resizeInstanceResponseBody.zod.d.ts +2 -2
  694. package/dist/compute/v1/generated/validators/resizeInstanceResponseBody.zod.js +2 -2
  695. package/dist/compute/v1/generated/validators/restoreBackupQuoteRequestBody.zod.d.ts +5 -5
  696. package/dist/compute/v1/generated/validators/restoreBackupQuoteRequestBody.zod.js +2 -2
  697. package/dist/compute/v1/generated/validators/restoreBackupRequestBody.zod.d.ts +5 -5
  698. package/dist/compute/v1/generated/validators/restoreBackupRequestBody.zod.js +2 -2
  699. package/dist/compute/v1/generated/validators/revertDiskRequestBody.zod.d.ts +2 -2
  700. package/dist/compute/v1/generated/validators/revertDiskRequestBody.zod.js +2 -2
  701. package/dist/compute/v1/generated/validators/routeListResponseBody.zod.d.ts +2 -2
  702. package/dist/compute/v1/generated/validators/routeListResponseBody.zod.js +2 -2
  703. package/dist/compute/v1/generated/validators/routeResource.zod.d.ts +2 -2
  704. package/dist/compute/v1/generated/validators/routeResource.zod.js +2 -2
  705. package/dist/compute/v1/generated/validators/runCommandRequestBody.zod.d.ts +2 -2
  706. package/dist/compute/v1/generated/validators/runCommandRequestBody.zod.js +2 -2
  707. package/dist/compute/v1/generated/validators/securityGroupListResponseBody.zod.d.ts +2 -2
  708. package/dist/compute/v1/generated/validators/securityGroupListResponseBody.zod.js +2 -2
  709. package/dist/compute/v1/generated/validators/securityGroupResource.zod.d.ts +2 -2
  710. package/dist/compute/v1/generated/validators/securityGroupResource.zod.js +2 -2
  711. package/dist/compute/v1/generated/validators/securityRuleListResponseBody.zod.d.ts +2 -2
  712. package/dist/compute/v1/generated/validators/securityRuleListResponseBody.zod.js +2 -2
  713. package/dist/compute/v1/generated/validators/securityRuleResource.zod.d.ts +2 -2
  714. package/dist/compute/v1/generated/validators/securityRuleResource.zod.js +2 -2
  715. package/dist/compute/v1/generated/validators/setFloatingIPBandwidthQuoteRequestBody.zod.d.ts +2 -2
  716. package/dist/compute/v1/generated/validators/setFloatingIPBandwidthQuoteRequestBody.zod.js +2 -2
  717. package/dist/compute/v1/generated/validators/setFloatingIPBandwidthRequestBody.zod.d.ts +2 -2
  718. package/dist/compute/v1/generated/validators/setFloatingIPBandwidthRequestBody.zod.js +2 -2
  719. package/dist/compute/v1/generated/validators/setFloatingIPBandwidthResponseBody.zod.d.ts +2 -2
  720. package/dist/compute/v1/generated/validators/setFloatingIPBandwidthResponseBody.zod.js +2 -2
  721. package/dist/compute/v1/generated/validators/setInstanceLabelsRequestBody.zod.d.ts +2 -2
  722. package/dist/compute/v1/generated/validators/setInstanceLabelsRequestBody.zod.js +2 -2
  723. package/dist/compute/v1/generated/validators/setInstanceNotesRequestBody.zod.d.ts +2 -2
  724. package/dist/compute/v1/generated/validators/setInstanceNotesRequestBody.zod.js +2 -2
  725. package/dist/compute/v1/generated/validators/setSnapshotQuotaQuoteRequestBody.zod.d.ts +5 -5
  726. package/dist/compute/v1/generated/validators/setSnapshotQuotaQuoteRequestBody.zod.js +2 -2
  727. package/dist/compute/v1/generated/validators/setSnapshotQuotaRequestBody.zod.d.ts +5 -5
  728. package/dist/compute/v1/generated/validators/setSnapshotQuotaRequestBody.zod.js +2 -2
  729. package/dist/compute/v1/generated/validators/setSnapshotQuotaResponseBody.zod.d.ts +8 -8
  730. package/dist/compute/v1/generated/validators/setSnapshotQuotaResponseBody.zod.js +2 -2
  731. package/dist/compute/v1/generated/validators/snapshotListResponseBody.zod.d.ts +2 -2
  732. package/dist/compute/v1/generated/validators/snapshotListResponseBody.zod.js +2 -2
  733. package/dist/compute/v1/generated/validators/snapshotOperation.zod.d.ts +2 -2
  734. package/dist/compute/v1/generated/validators/snapshotOperation.zod.js +2 -2
  735. package/dist/compute/v1/generated/validators/snapshotQuota.zod.d.ts +8 -8
  736. package/dist/compute/v1/generated/validators/snapshotQuota.zod.js +2 -2
  737. package/dist/compute/v1/generated/validators/snapshotResource.zod.d.ts +2 -2
  738. package/dist/compute/v1/generated/validators/snapshotResource.zod.js +2 -2
  739. package/dist/compute/v1/generated/validators/subnetListResponseBody.zod.d.ts +2 -2
  740. package/dist/compute/v1/generated/validators/subnetListResponseBody.zod.js +2 -2
  741. package/dist/compute/v1/generated/validators/subnetResource.zod.d.ts +2 -2
  742. package/dist/compute/v1/generated/validators/subnetResource.zod.js +2 -2
  743. package/dist/compute/v1/generated/validators/suggestSubnetCidrParams.zod.d.ts +2 -2
  744. package/dist/compute/v1/generated/validators/suggestSubnetCidrParams.zod.js +2 -2
  745. package/dist/compute/v1/generated/validators/terminationPolicy.zod.d.ts +2 -2
  746. package/dist/compute/v1/generated/validators/terminationPolicy.zod.js +2 -2
  747. package/dist/compute/v1/generated/validators/zoneListResponseBody.zod.d.ts +2 -2
  748. package/dist/compute/v1/generated/validators/zoneListResponseBody.zod.js +2 -2
  749. package/dist/compute/v1/generated/validators/zoneResource.zod.d.ts +2 -2
  750. package/dist/compute/v1/generated/validators/zoneResource.zod.js +2 -2
  751. package/dist/membership/v1/generated/models.d.ts +379 -779
  752. package/dist/membership/v1/generated/models.js +12 -44
  753. package/dist/membership/v1/generated/validators/accountBalance.zod.d.ts +22 -11
  754. package/dist/membership/v1/generated/validators/accountBalance.zod.js +8 -8
  755. package/dist/membership/v1/generated/validators/activeResource.zod.js +8 -5
  756. package/dist/membership/v1/generated/validators/allowance.zod.js +3 -3
  757. package/dist/membership/v1/generated/validators/applicability.zod.d.ts +22 -11
  758. package/dist/membership/v1/generated/validators/applicability.zod.js +12 -3
  759. package/dist/membership/v1/generated/validators/applicablePlan.zod.js +1 -1
  760. package/dist/membership/v1/generated/validators/billingAccount.zod.js +5 -5
  761. package/dist/membership/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
  762. package/dist/membership/v1/generated/validators/billingScheme.zod.d.ts +14 -0
  763. package/dist/membership/v1/generated/validators/billingScheme.zod.js +11 -0
  764. package/dist/membership/v1/generated/validators/cancellation.zod.d.ts +6 -3
  765. package/dist/membership/v1/generated/validators/cancellation.zod.js +4 -4
  766. package/dist/membership/v1/generated/validators/cancellationCreate.zod.js +3 -3
  767. package/dist/membership/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
  768. package/dist/membership/v1/generated/validators/cancellationItem.zod.js +6 -5
  769. package/dist/membership/v1/generated/validators/cancellationList.zod.d.ts +6 -3
  770. package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
  771. package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
  772. package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
  773. package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
  774. package/dist/membership/v1/generated/validators/contact.zod.js +2 -2
  775. package/dist/membership/v1/generated/validators/creditGrant.zod.d.ts +22 -11
  776. package/dist/membership/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
  777. package/dist/membership/v1/generated/validators/creditGroup.zod.d.ts +22 -11
  778. package/dist/membership/v1/generated/validators/creditGroup.zod.js +1 -1
  779. package/dist/membership/v1/generated/validators/creditNote.zod.js +4 -4
  780. package/dist/membership/v1/generated/validators/currency6ff0ec7.zod.js +1 -1
  781. package/dist/membership/v1/generated/validators/discount.zod.d.ts +23 -12
  782. package/dist/membership/v1/generated/validators/discount.zod.js +4 -4
  783. package/dist/membership/v1/generated/validators/discountList.zod.d.ts +23 -12
  784. package/dist/membership/v1/generated/validators/entitlement.zod.js +1 -1
  785. package/dist/membership/v1/generated/validators/funds.zod.js +4 -4
  786. package/dist/membership/v1/generated/validators/invoice.zod.d.ts +0 -1
  787. package/dist/membership/v1/generated/validators/invoice.zod.js +8 -8
  788. package/dist/membership/v1/generated/validators/invoiceItem.zod.d.ts +2 -0
  789. package/dist/membership/v1/generated/validators/invoiceItem.zod.js +10 -4
  790. package/dist/membership/v1/generated/validators/invoiceItemList.zod.d.ts +2 -0
  791. package/dist/membership/v1/generated/validators/invoiceItemProration.zod.js +1 -3
  792. package/dist/membership/v1/generated/validators/invoiceList.zod.d.ts +0 -1
  793. package/dist/membership/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
  794. package/dist/membership/v1/generated/validators/invoiceStatus.zod.js +2 -2
  795. package/dist/membership/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
  796. package/dist/membership/v1/generated/validators/invoiceSummary.zod.js +3 -3
  797. package/dist/membership/v1/generated/validators/membershipPurchase.zod.d.ts +0 -1
  798. package/dist/membership/v1/generated/validators/monthlyStatement.zod.js +2 -2
  799. package/dist/membership/v1/generated/validators/objectIdentity.zod.js +1 -1
  800. package/dist/membership/v1/generated/validators/order.zod.d.ts +7 -4
  801. package/dist/membership/v1/generated/validators/order.zod.js +10 -12
  802. package/dist/membership/v1/generated/validators/orderItem.zod.d.ts +7 -3
  803. package/dist/membership/v1/generated/validators/orderItem.zod.js +16 -14
  804. package/dist/membership/v1/generated/validators/orderItemList.zod.d.ts +7 -3
  805. package/dist/membership/v1/generated/validators/orderItemStatus.zod.js +1 -1
  806. package/dist/membership/v1/generated/validators/orderList.zod.d.ts +7 -4
  807. package/dist/membership/v1/generated/validators/orderRefundQuote.zod.js +1 -1
  808. package/dist/membership/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
  809. package/dist/membership/v1/generated/validators/orderStatus.zod.js +1 -1
  810. package/dist/membership/v1/generated/validators/paidWith.zod.js +1 -1
  811. package/dist/membership/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
  812. package/dist/membership/v1/generated/validators/payTogetherRequest.zod.js +2 -2
  813. package/dist/membership/v1/generated/validators/paymentAction.zod.js +4 -4
  814. package/dist/membership/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
  815. package/dist/membership/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
  816. package/dist/membership/v1/generated/validators/paymentOption.zod.js +1 -1
  817. package/dist/membership/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
  818. package/dist/membership/v1/generated/validators/paymentPreview.zod.js +4 -4
  819. package/dist/membership/v1/generated/validators/paymentResult.zod.js +5 -8
  820. package/dist/membership/v1/generated/validators/paymentStatus.zod.js +1 -1
  821. package/dist/membership/v1/generated/validators/placedOrder.zod.d.ts +0 -1
  822. package/dist/membership/v1/generated/validators/price.zod.d.ts +7 -5
  823. package/dist/membership/v1/generated/validators/price.zod.js +14 -11
  824. package/dist/membership/v1/generated/validators/priceList.zod.d.ts +7 -5
  825. package/dist/membership/v1/generated/validators/priceOption.zod.d.ts +7 -5
  826. package/dist/membership/v1/generated/validators/priceOption.zod.js +7 -3
  827. package/dist/membership/v1/generated/validators/priceType.zod.d.ts +14 -0
  828. package/dist/membership/v1/generated/validators/priceType.zod.js +11 -0
  829. package/dist/membership/v1/generated/validators/productID.zod.js +1 -1
  830. package/dist/membership/v1/generated/validators/projectAssignment.zod.js +2 -2
  831. package/dist/membership/v1/generated/validators/purchaseOperation.zod.js +1 -1
  832. package/dist/membership/v1/generated/validators/quote.zod.d.ts +6 -3
  833. package/dist/membership/v1/generated/validators/quote.zod.js +4 -4
  834. package/dist/membership/v1/generated/validators/quoteCancellation.zod.js +2 -2
  835. package/dist/membership/v1/generated/validators/quoteItem.zod.js +4 -4
  836. package/dist/membership/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
  837. package/dist/membership/v1/generated/validators/quoteItemInput.zod.js +8 -8
  838. package/dist/membership/v1/generated/validators/quoteRenewal.zod.js +1 -1
  839. package/dist/membership/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
  840. package/dist/membership/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
  841. package/dist/membership/v1/generated/validators/quoteRequest.zod.js +5 -5
  842. package/dist/membership/v1/generated/validators/quotedDiscount.zod.js +1 -1
  843. package/dist/membership/v1/generated/validators/rate.zod.d.ts +11 -0
  844. package/dist/membership/v1/generated/validators/rate.zod.js +14 -6
  845. package/dist/membership/v1/generated/validators/rateList.zod.d.ts +11 -0
  846. package/dist/membership/v1/generated/validators/refund.zod.js +3 -3
  847. package/dist/membership/v1/generated/validators/refundPolicy.zod.js +1 -1
  848. package/dist/membership/v1/generated/validators/refundReason.zod.js +1 -1
  849. package/dist/membership/v1/generated/validators/renewRequest.zod.js +2 -2
  850. package/dist/membership/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
  851. package/dist/membership/v1/generated/validators/renewalPrice.zod.js +1 -1
  852. package/dist/membership/v1/generated/validators/scheduledChange.zod.js +2 -2
  853. package/dist/membership/v1/generated/validators/spendRow.zod.d.ts +8 -0
  854. package/dist/membership/v1/generated/validators/spendRow.zod.js +11 -0
  855. package/dist/membership/v1/generated/validators/spendRowList.zod.d.ts +8 -0
  856. package/dist/membership/v1/generated/validators/spendRowList.zod.js +1 -1
  857. package/dist/membership/v1/generated/validators/statement.zod.js +2 -2
  858. package/dist/membership/v1/generated/validators/statementItem.zod.d.ts +1 -0
  859. package/dist/membership/v1/generated/validators/statementItem.zod.js +4 -0
  860. package/dist/membership/v1/generated/validators/statementSummary.zod.d.ts +1 -0
  861. package/dist/membership/v1/generated/validators/statementType.zod.js +1 -1
  862. package/dist/membership/v1/generated/validators/subscription.zod.d.ts +7 -3
  863. package/dist/membership/v1/generated/validators/subscription.zod.js +20 -14
  864. package/dist/membership/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
  865. package/dist/membership/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
  866. package/dist/membership/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
  867. package/dist/membership/v1/generated/validators/terminationPolicy.zod.js +1 -1
  868. package/dist/membership/v1/generated/validators/tier.zod.js +1 -1
  869. package/dist/membership/v1/generated/validators/topUp.zod.js +8 -8
  870. package/dist/membership/v1/generated/validators/topUpCreate.zod.js +4 -4
  871. package/dist/membership/v1/generated/validators/transaction.zod.js +6 -6
  872. package/dist/membership/v1/generated/validators/usageCharge.zod.d.ts +1 -0
  873. package/dist/membership/v1/generated/validators/usageCharge.zod.js +8 -7
  874. package/dist/membership/v1/generated/validators/usageChargeList.zod.d.ts +1 -0
  875. package/dist/membership/v1/generated/validators/usageType.zod.d.ts +14 -0
  876. package/dist/membership/v1/generated/validators/usageType.zod.js +11 -0
  877. package/dist/membership/v1/generated/validators/withdrawal.zod.js +2 -2
  878. package/dist/membership/v1/generated/validators/withdrawalItem.zod.js +2 -2
  879. package/dist/membership/v1/generated/validators/withdrawalSource.zod.js +1 -1
  880. package/dist/routes.d.ts +4 -4
  881. package/dist/routes.js +4 -4
  882. package/package.json +1 -1
@@ -6,7 +6,7 @@
6
6
  * OpenAPI spec version: v1
7
7
  */
8
8
  /**
9
- * Whether a fulfilled purchase may end immediately or only after its paid term. Does not grant a refund. When absent, the terms are not configured and termination requires review.
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.
10
10
  */
11
11
  export type TerminationPolicy = (typeof TerminationPolicy)[keyof typeof TerminationPolicy];
12
12
  export declare const TerminationPolicy: {
@@ -14,16 +14,7 @@ export declare const TerminationPolicy: {
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
18
- * the time used, never below zero and never more than what remains unrefunded. The time used runs
19
- * from the period start to the effective cancellation time and is valued at the plan's
20
- * shorter-period prices in the same currency, frozen at purchase as the order item's
21
- * refund_monthly_amount and refund_hourly_amount: each full calendar month at the one-month prepaid
22
- * price, the remainder at the postpaid hourly price or, without one, at the one-month price by the
23
- * second. When the plan has no prepaid period shorter than the one bought, the time used is valued
24
- * at the price paid, pro rata by the second. Discounts are not refunded, as they were never paid,
25
- * and setup fees are excluded. The refunded part returns to the payment sources it came from. Tax
26
- * paid is refunded in the same proportion as the amount it was paid on.
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.
27
18
  */
28
19
  export type RefundPolicy = (typeof RefundPolicy)[keyof typeof RefundPolicy];
29
20
  export declare const RefundPolicy: {
@@ -45,7 +36,7 @@ export declare const QuoteRenewalInterval: {
45
36
  readonly year: "year";
46
37
  };
47
38
  /**
48
- * Price renewing a prepaid subscription. Give `price_id`, or `interval` with
39
+ * Price renewing a licensed subscription. Give `price_id`, or `interval` with
49
40
  * `interval_count`, to renew for another term at the price currently sold for it. Naming
50
41
  * the current term, or giving neither, renews at the agreed amount. A term sold at several
51
42
  * prices that differ in termination policy is refused with 409
@@ -85,9 +76,7 @@ export declare const QuoteRenewalResultInterval: {
85
76
  */
86
77
  export type Money = string;
87
78
  /**
88
- * What renewing would charge. Renewing the same subscription for the same term and number
89
- * of periods charges exactly `total`, unless prices or the discounts the account holds
90
- * change in between.
79
+ * What renewing would charge. Renewing the same subscription for the same term and periods charges exactly `total` unless prices or the account's discounts change first.
91
80
  */
92
81
  export interface QuoteRenewalResult {
93
82
  /** Which renewal of the request this answers. */
@@ -98,11 +87,7 @@ export interface QuoteRenewalResult {
98
87
  interval: QuoteRenewalResultInterval;
99
88
  interval_count: number;
100
89
  periods: number;
101
- /**
102
- * The price of the periods before the discounts the account holds. A discount the
103
- * subscription already carries is reflected here. Contains tax only where the price
104
- * itself includes it.
105
- */
90
+ /** The price of the periods before the account's discounts, with any discount the subscription carries already reflected; includes tax only where the price does. */
106
91
  amount: Money;
107
92
  /** The reduction from a discount the account holds. */
108
93
  discount_amount: Money;
@@ -117,25 +102,25 @@ export interface QuoteRenewalResult {
117
102
  total: Money;
118
103
  }
119
104
  /**
120
- * One fully calculated purchase, estimated postpaid usage or recorded order item. Amounts use the
105
+ * One fully calculated purchase, estimated metered usage or recorded order item. Amounts use the
121
106
  * billing-account currency. An item with no immediate charge has zero checkout amounts.
122
107
  */
123
108
  export interface QuoteItem {
124
109
  tax_amount: Money;
125
110
  tax_included_amount: Money;
126
111
  /**
127
- * Zero-based request line index, or the recorded order item's position for an order quote.
112
+ * The zero-based request line index, or the recorded order item's position for an order quote.
128
113
  * @minimum 0
129
114
  */
130
115
  index: number;
131
116
  /** Present for an existing order quote; identifies the recorded item being priced. */
132
117
  order_item_id?: string;
133
- /** The selected price, including when the request identified it indirectly. */
118
+ /** The selected price, also when the request identified it indirectly. */
134
119
  price_id: string;
135
120
  plan_name: string;
136
121
  /** Unit price before discounts. Null when no single unit price applies, such as tiered or multiple-rate pricing. */
137
122
  unit_amount: Money | null;
138
- /** The quantity priced. When duration_seconds is supplied for metered usage, this is quantity multiplied by that duration. */
123
+ /** The quantity priced; with duration_seconds, quantity times the duration. */
139
124
  quantity: string;
140
125
  /** Amount before discounts and including any setup charge. For requested future usage this is an estimate, not a collectible checkout amount. */
141
126
  amount: Money;
@@ -146,16 +131,16 @@ export interface QuoteItem {
146
131
  /**
147
132
  * Account funding for this purchase, calculated by Billing. Amounts use the enclosing response currency.
148
133
  * Credit eligibility and all purchase requirements are already evaluated. Nothing is charged or reserved.
149
- * A prepaid purchase may instead use an online payment method.
134
+ * A licensed purchase may instead be paid with an online payment method.
150
135
  */
151
136
  export interface Funds {
152
137
  /** Spendable balance after pending returns. */
153
138
  available_balance_amount: Money;
154
- /** Currently effective credits eligible for the quoted purchases or postpaid usage. Each grant is counted once. */
139
+ /** Currently effective credits eligible for the quoted purchases or metered usage. Each grant is counted once. */
155
140
  usable_credit_amount: Money;
156
- /** Currently effective credits that cannot fund any quoted purchase or postpaid target. Unused eligible credits are not restricted. */
141
+ /** Currently effective credits that cannot fund any quoted purchase or metered target. Unused eligible credits are not restricted. */
157
142
  restricted_credit_amount: Money;
158
- /** Minimum spendable balance needed after eligible credits, covering immediate charges and every new postpaid admission requirement. */
143
+ /** Minimum spendable balance needed after eligible credits, covering immediate charges and every new metered purchase's admission requirement. */
159
144
  required_balance_amount: Money;
160
145
  /** Additional balance needed now. Zero means account funds satisfy this quote. No funds are reserved. */
161
146
  balance_shortfall_amount: Money;
@@ -168,8 +153,7 @@ export declare const QuotedDiscountType: {
168
153
  readonly account_discount: "account_discount";
169
154
  };
170
155
  /**
171
- * The discount selected for this calculation. Its presence in a quote does not apply it or
172
- * reserve a redemption. Discount amounts are reported on the quote and its lines.
156
+ * The discount selected for this calculation, not applied and not reserved. Amounts are on the quote and its lines.
173
157
  */
174
158
  export interface QuotedDiscount {
175
159
  type: QuotedDiscountType;
@@ -197,30 +181,35 @@ export interface NamedIdentity {
197
181
  /** @maxLength 255 */
198
182
  name: string;
199
183
  }
200
- export type CancellationRefundPreviewItemChargeType = (typeof CancellationRefundPreviewItemChargeType)[keyof typeof CancellationRefundPreviewItemChargeType];
201
- export declare const CancellationRefundPreviewItemChargeType: {
202
- readonly postpaid: "postpaid";
203
- readonly prepaid: "prepaid";
184
+ /**
185
+ * `one_time` charges once when bought. `recurring` charges again for every period, or for usage as it is settled.
186
+ */
187
+ export type PriceType = (typeof PriceType)[keyof typeof PriceType];
188
+ export declare const PriceType: {
204
189
  readonly one_time: "one_time";
190
+ readonly recurring: "recurring";
205
191
  };
206
192
  /**
207
- * One subscription of the quoted cancellation. The amounts mean what they mean in the total.
193
+ * `licensed` charges for the quantity bought, each period paid before it starts. `metered` charges for the usage
194
+ * reported, after it is settled; a metered subscription lasts until it is canceled. A one-time price is licensed.
195
+ */
196
+ export type UsageType = (typeof UsageType)[keyof typeof UsageType];
197
+ export declare const UsageType: {
198
+ readonly licensed: "licensed";
199
+ readonly metered: "metered";
200
+ };
201
+ /**
202
+ * One subscription of the quoted cancellation.
208
203
  */
209
204
  export interface CancellationRefundPreviewItem {
210
205
  subscription_id: string;
211
206
  plan_id: string;
212
207
  plan_name: string;
213
- /**
214
- * The project and its current name, for display. Absent for a purchase at account level, and when the
215
- * project details cannot be read at the moment.
216
- */
208
+ /** The project and its current name. Absent for an account-level purchase or when the project cannot be read. */
217
209
  project?: NamedIdentity | null;
218
- charge_type: CancellationRefundPreviewItemChargeType;
219
- /**
220
- * Whether automatic renewal is on now. Creating the cancellation turns it off. Withdrawing the
221
- * cancellation does not turn it back on for a prepaid subscription; a postpaid subscription continues
222
- * until it is canceled and turns it back on.
223
- */
210
+ type: PriceType;
211
+ usage_type: UsageType;
212
+ /** 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. */
224
213
  auto_renew: boolean;
225
214
  unused_amount: Money;
226
215
  refundable_amount: Money;
@@ -230,19 +219,19 @@ export interface CancellationRefundPreviewItem {
230
219
  forfeited_amount: Money;
231
220
  }
232
221
  /**
233
- * What the cancellation would return, subscription by subscription and in total, as of now. Give
234
- * `proration_date` and `refundable_amount` when creating the cancellation.
222
+ * What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and
223
+ * `refundable_amount` when creating the cancellation.
235
224
  *
236
- * - `unused_amount`: before tax, the amount paid for the current periods minus the value of the
237
- * time used, valued as refund policy `prorated` describes, whatever the refund terms say.
238
- * - `refundable_amount`: what is returned the way it was paid, including the tax paid on it;
239
- * `refund_amount` plus `credit_amount`.
240
- * - `refund_amount`: the part returned to the balance or to the payment method.
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.
227
+ * - `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus
228
+ * `credit_amount`.
229
+ * - `refund_amount`: the part returned to the balance or the payment method.
241
230
  * - `credit_amount`: the part restored to the credit grants that paid.
242
231
  * - `tax_amount`: the tax included in `refundable_amount`.
243
232
  * - `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.
244
233
  *
245
- * Postpaid and one-time subscriptions show zero; usage until release is charged as usual.
234
+ * Metered and one-time subscriptions show zero; their usage until release is charged as usual.
246
235
  */
247
236
  export interface CancellationRefundPreview {
248
237
  mode: TerminationPolicy;
@@ -260,11 +249,7 @@ export interface CancellationRefundPreview {
260
249
  items: CancellationRefundPreviewItem[];
261
250
  }
262
251
  /**
263
- * An estimated refund to original payment sources. Before acceptance, cancellation returns the
264
- * collected amount. For delivered service, only value funded by this order is included; renewals
265
- * are evaluated under their own orders and the agreed termination terms apply. An unknown
266
- * delivery outcome is not evidence that a refund is eligible. This calculation does not create
267
- * a refund; the amount returned is determined when cancellation or termination is confirmed.
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.
268
253
  */
269
254
  export interface OrderRefundQuote {
270
255
  order_id: string;
@@ -274,21 +259,15 @@ export interface OrderRefundQuote {
274
259
  currency: string;
275
260
  }
276
261
  /**
277
- * A complete calculation in one billing-account currency, without saving a quote or reserving funds or
278
- * redemptions. The request fails if any item cannot be priced. Requested future usage estimates are
279
- * included in totals for reporting and are not collectible at checkout. Only an existing-order quote
280
- * provides that order's checkout amount.
262
+ * A complete calculation in the billing account's currency; nothing is saved or reserved. The request fails if any item cannot be priced. Usage estimates are included in totals but are not collected at checkout; only an existing-order quote gives that order's checkout amount.
281
263
  */
282
264
  export interface Quote {
283
- /** Account funding for an existing-order checkout quote. Absent for usage estimates, refunds and cancellation previews. */
265
+ /** Account funds for an existing-order checkout quote. Absent for usage estimates, refunds and cancellations. */
284
266
  funds?: Funds;
285
267
  subtotal: Money;
286
268
  discount_amount: Money;
287
269
  tax_amount: Money;
288
- /**
289
- * The discount evaluated for a purchase or order, without applying it. Null when none is selected or
290
- * when quoting renewals or a cancellation. A confirmed order reports its recorded discount.
291
- */
270
+ /** The discount a purchase or order would get, not yet applied. Null when there is none, and for renewals and cancellations. A confirmed order reports its recorded discount. */
292
271
  discount: QuotedDiscount | null;
293
272
  items: QuoteItem[];
294
273
  renewals: QuoteRenewalResult[];
@@ -296,20 +275,15 @@ export interface Quote {
296
275
  cancellation?: CancellationRefundPreview;
297
276
  total: Money;
298
277
  currency: string;
299
- /** Present only when an order refund was requested. Nothing is collectible for this target. */
278
+ /** Present when an order refund was requested. */
300
279
  refund?: OrderRefundQuote;
301
280
  }
302
281
  /**
303
- * A cancellation to quote: what ending these subscriptions together would return. One mode per
304
- * request; to compare, quote `immediate` and `period_end` separately.
305
- *
306
- * Refused with 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being
307
- * canceled (`meta.cancellation_id`), is being reclaimed (`meta.reason` `reclaim_requested`) or has a
308
- * paid change still waiting to switch (`meta.order_id`).
282
+ * A cancellation to quote: what ending these subscriptions together would return, for one mode; quote `immediate` and `period_end` separately to compare. Refused with 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled (`meta.cancellation_id`), is being reclaimed (`meta.reason` `reclaim_requested`) or has a paid change waiting to switch (`meta.order_id`).
309
283
  */
310
284
  export interface QuoteCancellation {
311
285
  /**
312
- * The subscriptions to end together, all of one service. Every subscription released with a resource must be included.
286
+ * The subscriptions to end together, all of one service, including every subscription released with a resource.
313
287
  * @minItems 1
314
288
  * @maxItems 50
315
289
  */
@@ -324,15 +298,12 @@ export interface CancellationCreate {
324
298
  */
325
299
  subscription_ids: string[];
326
300
  mode: TerminationPolicy;
327
- /**
328
- * For `immediate`, the `proration_date` of the quote: a whole second, not in the future and
329
- * at most ten minutes old. The refund is computed as of it. Now when omitted.
330
- */
301
+ /** 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. */
331
302
  proration_date?: string;
332
- /** The `refundable_amount` of the quote. The cancellation is refused when the refund differs. */
303
+ /** The quote's `refundable_amount`; the cancellation is refused when the refund differs. */
333
304
  expected_refundable_amount: Money & string;
334
305
  /**
335
- * A note from the account holder. It is kept with the cancellation and not shown elsewhere.
306
+ * A note from the account holder, kept with the cancellation.
336
307
  * @maxLength 1024
337
308
  */
338
309
  reason?: string;
@@ -347,7 +318,7 @@ export declare const CancellationStatus: {
347
318
  readonly failed: "failed";
348
319
  };
349
320
  /**
350
- * Who asked for it. `project_deletion` means the project was deleted.
321
+ * Who requested it; `project_deletion` means the project was deleted.
351
322
  */
352
323
  export type CancellationOrigin = (typeof CancellationOrigin)[keyof typeof CancellationOrigin];
353
324
  export declare const CancellationOrigin: {
@@ -355,17 +326,6 @@ export declare const CancellationOrigin: {
355
326
  readonly operator: "operator";
356
327
  readonly project_deletion: "project_deletion";
357
328
  };
358
- /**
359
- * How the subscription is charged. Creating the cancellation turned automatic renewal off;
360
- * withdrawing it turns renewal back on for a `postpaid` subscription and leaves it off for a
361
- * `prepaid` one.
362
- */
363
- export type CancellationItemChargeType = (typeof CancellationItemChargeType)[keyof typeof CancellationItemChargeType];
364
- export declare const CancellationItemChargeType: {
365
- readonly postpaid: "postpaid";
366
- readonly prepaid: "prepaid";
367
- readonly one_time: "one_time";
368
- };
369
329
  export type CancellationItemStatus = (typeof CancellationItemStatus)[keyof typeof CancellationItemStatus];
370
330
  export declare const CancellationItemStatus: {
371
331
  readonly requested: "requested";
@@ -379,19 +339,19 @@ export declare const CancellationItemStatus: {
379
339
  * One subscription of the cancellation.
380
340
  */
381
341
  export interface CancellationItem {
382
- /** The cancellation item of this subscription, the same as `Subscription.cancellation.id`. */
342
+ /** The subscription's cancellation item, the same as `Subscription.cancellation.id`. */
383
343
  id: string;
384
344
  subscription_id: string;
385
345
  plan_id: string;
386
346
  plan_name: string;
347
+ type: PriceType;
387
348
  /**
388
- * How the subscription is charged. Creating the cancellation turned automatic renewal off;
389
- * withdrawing it turns renewal back on for a `postpaid` subscription and leaves it off for a
390
- * `prepaid` one.
349
+ * Creating the cancellation turned automatic renewal off; withdrawing it turns renewal back on
350
+ * for a `metered` subscription and leaves it off for a `licensed` one.
391
351
  */
392
- charge_type: CancellationItemChargeType;
352
+ usage_type: UsageType;
393
353
  status: CancellationItemStatus;
394
- /** Execution stopped or its result is unknown. Present while release still requires resolution; it does not establish refund eligibility. */
354
+ /** The release stopped or its result is unknown; present while the release needs resolution. */
395
355
  failure_code?: string;
396
356
  release_started_at?: string;
397
357
  /** When the service ended, as confirmed by the service that provides it. */
@@ -421,20 +381,14 @@ export interface Cancellation {
421
381
  scheduled_at?: string;
422
382
  /** For `immediate`, the second the refund is computed as of. */
423
383
  proration_date?: string;
424
- /** Who asked for it. `project_deletion` means the project was deleted. */
384
+ /** Who requested it; `project_deletion` means the project was deleted. */
425
385
  origin: CancellationOrigin;
426
- /**
427
- * The billing account that paid for these subscriptions when the cancellation was created: the
428
- * account of an account-level purchase, or the account the project was linked to.
429
- */
386
+ /** The billing account paying for these subscriptions when the cancellation was created: the purchasing account of an account-level purchase, or the project's linked account. */
430
387
  billing_account_id: number;
431
388
  currency: string;
432
- /** The refund confirmed when it was created. Absent when the platform created it. */
389
+ /** The refund confirmed when the cancellation was created. Absent when the platform created it. */
433
390
  expected_refundable_amount?: Money;
434
- /**
435
- * Present with `failed`. A code of the service that provides the resources, such as a disk
436
- * that can only be released with its server. Clients map it to their own wording.
437
- */
391
+ /** Present with `failed`: the owning service's code, such as for a disk that can only be released with its server. */
438
392
  failure_code?: string;
439
393
  requested_at: string;
440
394
  completed_at?: string;
@@ -471,13 +425,11 @@ export declare const SubscriptionCancellationMode: {
471
425
  readonly period_end: "period_end";
472
426
  };
473
427
  /**
474
- * The latest cancellation that includes the subscription, with this subscription's item. `id` is the
475
- * item; `cancellation_id` is the cancellation. scheduled_at is the intended time; effective_at is the
476
- * confirmed end of service. A cancellation alone does not stop metering or issue a refund.
428
+ * The latest cancellation including the subscription, with this subscription's item: `id` is the item and `cancellation_id` the cancellation. scheduled_at is the intended time and effective_at the confirmed end of service.
477
429
  */
478
430
  export interface SubscriptionCancellation {
479
431
  reason?: string;
480
- /** The cancellation this request belongs to, with the other subscriptions released together. */
432
+ /** The cancellation this item belongs to, with the other subscriptions released together. */
481
433
  cancellation_id?: string;
482
434
  id: string;
483
435
  subscription_id: string;
@@ -511,7 +463,7 @@ export interface Error {
511
463
  status: number;
512
464
  }
513
465
  /**
514
- * Immutable platform service identifier, such as compute, canopy or assistant.
466
+ * The platform service's fixed identifier, such as compute, canopy or assistant.
515
467
  * @minLength 1
516
468
  * @maxLength 64
517
469
  * @pattern ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
@@ -530,29 +482,22 @@ export declare const BillingAccountStatus: {
530
482
  };
531
483
  export interface BillingAccount {
532
484
  /**
533
- * The active contact used for invoicing. Must belong to this account; null clears the selection.
485
+ * The active contact used for invoices, of this account; null clears it.
534
486
  * @nullable
535
487
  */
536
488
  invoice_contact_id?: string | null;
537
489
  id: number;
538
- /** What you call this account. */
490
+ /** Your name for the account. */
539
491
  name?: string;
540
492
  /** Fixed when the account was opened. */
541
493
  currency: string;
542
494
  status: BillingAccountStatus;
543
- /**
544
- * How far past the suspension threshold this account may go before its resources are
545
- * suspended. "0" means none: the account is suspended as soon as it crosses the threshold.
546
- */
495
+ /** How far past the suspension threshold the account may go before its resources are suspended; `0` means none. */
547
496
  grace_amount?: string;
548
- /**
549
- * How long this account has to top up after crossing the suspension threshold.
550
- * 0 means none. Whichever runs out first — this or grace_amount — ends the grace.
551
- */
497
+ /** How long the account has to top up after crossing the suspension threshold, in seconds; `0` means none. Grace ends when this or grace_amount runs out. */
552
498
  grace_period_seconds?: number;
553
499
  /**
554
- * The actual time this account was closed, in UTC (RFC 3339).
555
- * Null or absent if the account is not closed or its historical close time is unknown.
500
+ * When the account was closed. Null if it is not closed or the time is unknown.
556
501
  * @nullable
557
502
  */
558
503
  readonly closed_at?: string | null;
@@ -569,7 +514,7 @@ export interface Currency {
569
514
  */
570
515
  code: string;
571
516
  /**
572
- * Decimal places of the currency, the ISO 4217 minor unit.
517
+ * Decimal places of the ISO 4217 minor unit.
573
518
  * @minimum 0
574
519
  * @maximum 4
575
520
  */
@@ -596,7 +541,7 @@ export interface BillingAccountCreate {
596
541
  }
597
542
  export interface BillingAccountUpdate {
598
543
  /**
599
- * The active contact used for invoicing. Must belong to this account; null clears the selection.
544
+ * The active contact used for invoices, of this account; null clears it.
600
545
  * @nullable
601
546
  */
602
547
  invoice_contact_id?: string | null;
@@ -608,7 +553,7 @@ export interface BillingAccountList {
608
553
  pagination: OffsetPagination;
609
554
  }
610
555
  /**
611
- * A plan it refers to. active is false once the plan is archived; it still applies to subscriptions already on this plan.
556
+ * A plan referenced by an applicability; active is false once it is archived, and the reference still applies.
612
557
  */
613
558
  export interface ApplicablePlan {
614
559
  id: string;
@@ -616,24 +561,20 @@ export interface ApplicablePlan {
616
561
  active: boolean;
617
562
  }
618
563
  /**
619
- * A catalog object inlined for display.
564
+ * A catalog object, inlined for display.
620
565
  */
621
566
  export interface ObjectIdentity {
622
567
  lookup_key?: string;
623
568
  id: string;
624
569
  name: string;
625
570
  }
626
- export type PriceOptionBillingScheme = (typeof PriceOptionBillingScheme)[keyof typeof PriceOptionBillingScheme];
627
- export declare const PriceOptionBillingScheme: {
571
+ /**
572
+ * `per_unit` multiplies a unit amount; `tiered` walks a ladder.
573
+ */
574
+ export type BillingScheme = (typeof BillingScheme)[keyof typeof BillingScheme];
575
+ export declare const BillingScheme: {
628
576
  readonly per_unit: "per_unit";
629
577
  readonly tiered: "tiered";
630
- readonly rated: "rated";
631
- };
632
- export type PriceOptionType = (typeof PriceOptionType)[keyof typeof PriceOptionType];
633
- export declare const PriceOptionType: {
634
- readonly postpaid: "postpaid";
635
- readonly prepaid: "prepaid";
636
- readonly one_time: "one_time";
637
578
  };
638
579
  export type PriceOptionInterval = (typeof PriceOptionInterval)[keyof typeof PriceOptionInterval];
639
580
  export declare const PriceOptionInterval: {
@@ -643,16 +584,18 @@ export declare const PriceOptionInterval: {
643
584
  readonly year: "year";
644
585
  };
645
586
  /**
646
- * A price's display terms, including archived prices referenced by an applicability list.
587
+ * A price's display terms, including archived prices referenced by an applicability.
647
588
  */
648
589
  export interface PriceOption {
649
590
  product: Product;
650
591
  plan: ObjectIdentity;
651
- billing_scheme: PriceOptionBillingScheme;
592
+ /** Absent when the price delegates to a rate card. */
593
+ billing_scheme?: BillingScheme;
652
594
  unit_quantity: string;
653
595
  id: string;
654
596
  currency: string;
655
- type: PriceOptionType;
597
+ type: PriceType;
598
+ usage_type: UsageType;
656
599
  interval: PriceOptionInterval;
657
600
  /** How many periods one purchase covers. */
658
601
  interval_count?: number;
@@ -661,11 +604,7 @@ export interface PriceOption {
661
604
  active: boolean;
662
605
  }
663
606
  /**
664
- * Which purchase operation this applies to. `new` covers every new purchase, including
665
- * zero-charge purchases. It does not mean the account's first purchase; use
666
- * `first_purchase_only` for that restriction. `renew` covers renewals. `modify` covers
667
- * configuration or billing-term changes, including changes that increase or decrease
668
- * the amount due and changes with no additional charge or refund.
607
+ * The purchase operation covered. `new`: every new purchase, including zero-charge ones; it does not mean the account's first purchase, which `first_purchase_only` restricts. `renew`: renewals. `modify`: configuration or billing-term changes, whether they charge, refund or neither.
669
608
  */
670
609
  export type PurchaseOperation = (typeof PurchaseOperation)[keyof typeof PurchaseOperation];
671
610
  export declare const PurchaseOperation: {
@@ -674,20 +613,18 @@ export declare const PurchaseOperation: {
674
613
  readonly modify: "modify";
675
614
  };
676
615
  /**
677
- * Anything not excluded that matches an inclusion, or anything not excluded when no inclusion is
678
- * given, subject to the charge type, operation and term conditions. Entries always include their
679
- * display fields; archived plans and prices stay listed with active set to false.
616
+ * Covers anything not excluded that matches an inclusion, or anything not excluded when no inclusion is given, subject to the price type, usage type, operation and term conditions. Archived plans and prices stay listed with active false.
680
617
  */
681
618
  export interface Applicability {
682
619
  products?: Product[];
683
620
  plans?: ApplicablePlan[];
684
621
  prices?: PriceOption[];
685
- price_types?: string[];
622
+ /** The price types covered; empty covers both. */
623
+ price_types?: PriceType[];
624
+ /** The usage types covered; empty covers both. */
625
+ usage_types?: UsageType[];
686
626
  operations?: PurchaseOperation[];
687
- /**
688
- * The shortest term a purchase may have, in months. A purchase with no term, such as
689
- * metered usage, never qualifies while this is set.
690
- */
627
+ /** The shortest term a purchase may have, in months. Purchases without a term, such as metered usage, do not qualify while this is set. */
691
628
  min_term_months?: number;
692
629
  /** The longest term a purchase may have, in months. */
693
630
  max_term_months?: number;
@@ -696,56 +633,42 @@ export interface Applicability {
696
633
  excluded_prices?: PriceOption[];
697
634
  }
698
635
  export interface CreditGroup {
699
- /** What the credit in this group may pay for. No restrictions means anything on the account. */
636
+ /** What the credit in this group may pay for; no restrictions means anything on the account. */
700
637
  applies_to: Applicability;
701
638
  /** Restricted to your first purchase of anything it applies to. */
702
639
  first_purchase_only?: boolean;
703
640
  amount: Money;
704
641
  }
705
642
  /**
706
- * Account balance, credits, and unpaid charges are reported separately.
643
+ * Balance, credits and unpaid charges, each reported separately.
707
644
  */
708
645
  export interface AccountBalance {
709
646
  /** Balance minus pending balance returns and the part of unbilled_amount and due that estimated_credit_applied does not cover. Negative only when the balance and applicable credit fall short of what the account owes. */
710
647
  available_credit: Money;
711
- /** Credit expected to pay unbilled_amount and due. Each charge is matched to grants whose scope, validity and conditions it meets, in the order credit is applied at payment. Nothing is reserved or deducted until an invoice is paid, so credits still includes this amount. */
648
+ /** Credit expected to pay unbilled_amount and due, matching each charge to the grants whose scope, validity and conditions it meets, in the order credit is applied at payment. Nothing is deducted until an invoice is paid, so credits still includes this amount. */
712
649
  estimated_credit_applied: Money;
713
- /** Current estimate of rated usage that has not been invoiced. Final pricing and tax are fixed at issuance. */
650
+ /** Current estimate of priced usage that has not been invoiced. Final pricing and tax are fixed at issuance. */
714
651
  unbilled_amount: Money;
715
652
  billing_account_id: number;
716
653
  currency: string;
717
- /**
718
- * Prepaid funds in the account currency, excluding credits. May be negative after a payment
719
- * dispute. Outstanding charges are reported separately in due; this value is not a withdrawal quote.
720
- */
654
+ /** Topped-up funds in the account's currency, excluding credits. May be negative after a payment dispute. Amounts owed are reported in due; this is not a withdrawable amount. */
721
655
  balance: Money;
722
- /**
723
- * The recorded remaining credit, including restricted grants. It is not withdrawable
724
- * and is not part of balance. credit_groups describes currently valid credit by permitted use; a positive
725
- * credits balance does not imply that due is zero.
726
- */
656
+ /** Remaining credit, including restricted grants; not withdrawable and not part of balance. credit_groups shows currently valid credit by permitted use; positive credits do not mean due is zero. */
727
657
  credits: Money;
728
- /** Currently valid credit whose use has applicable product, operation or eligibility conditions. Included in credits, separate from the balance. */
658
+ /** Currently valid credit restricted to certain products, operations or conditions; part of credits, not of balance. */
729
659
  restricted_credits: Money;
730
- /**
731
- * Currently valid, unspent credit grouped by permitted use. Restrictions and
732
- * validity dates determine which charges a group can cover, so these groups are not a general
733
- * spendable balance and may differ from the recorded credits total.
734
- */
660
+ /** Currently valid unspent credit grouped by permitted use. Each group covers only the charges its restrictions and validity allow, and the groups may differ from the recorded credits total. */
735
661
  credit_groups: CreditGroup[];
736
- /** Amount still payable on issued invoices. The invoice of an order not yet accepted is a request to pay for that order rather than a debt, so it is excluded here and from available_credit. Unbilled usage is reported separately; arrears depend on actual eligible funding and grace terms. */
662
+ /** Amount still payable on issued invoices. The invoice of an order not yet accepted is excluded, here and from available_credit. Usage not yet invoiced is reported separately. */
737
663
  due: Money;
738
664
  pending_returns_amount: Money;
739
665
  }
740
666
  /**
741
- * A project's assignment to a billing account for the interval from effective_from to effective_to. An open-ended assignment has no end time.
667
+ * A project's assignment to a billing account from effective_from until effective_to; an open assignment has no end.
742
668
  */
743
669
  export interface ProjectAssignment {
744
670
  project_id: string;
745
- /**
746
- * The project and its current name, for display. Absent when the project no longer exists or its
747
- * details cannot be read at the moment; `project_id` still identifies it.
748
- */
671
+ /** The project and its current name. Absent when the project cannot be read; `project_id` still identifies it. */
749
672
  project?: NamedIdentity | null;
750
673
  billing_account_id: number;
751
674
  account_name?: string;
@@ -762,16 +685,7 @@ export interface SetProjectAssignmentRequest {
762
685
  billing_account_id: number;
763
686
  }
764
687
  /**
765
- * `pending` until the payment gateway reaches a result. The balance increases on `succeeded`.
766
- *
767
- * `failed` means the gateway declined the payment. A declined attempt ends the top-up at once
768
- * and the payment is withdrawn at the gateway; to pay another way, create a new top-up.
769
- * `canceled` means the attempt was withdrawn without collecting money; `cancellation_reason`
770
- * says why. Unknown gateway outcomes remain `pending`, and a browser redirect is not proof of
771
- * payment.
772
- *
773
- * `failed` and `canceled` are final. If the gateway nevertheless collects payment for such an
774
- * attempt, the amount is credited as a separate `succeeded` top-up.
688
+ * `pending` until the payment gateway reaches a result; the balance increases on `succeeded`. `failed`: the gateway declined the payment, which is withdrawn at the gateway; create a new top-up to pay another way. `canceled`: withdrawn without collecting money, for the reason in `cancellation_reason`. Unknown gateway outcomes stay `pending`; a browser redirect is not proof of payment. `failed` and `canceled` are final; a payment the gateway collects afterwards is credited as a separate `succeeded` top-up.
775
689
  */
776
690
  export type TopUpStatus = (typeof TopUpStatus)[keyof typeof TopUpStatus];
777
691
  export declare const TopUpStatus: {
@@ -786,8 +700,7 @@ export interface AccountIdentity {
786
700
  currency: string;
787
701
  }
788
702
  /**
789
- * Why a gateway payment was withdrawn. `abandoned` means the customer did not complete it within the time
790
- * allowed for payment. `requested_by_customer` means the customer canceled it.
703
+ * Why a gateway payment was withdrawn: `abandoned` when the customer did not complete it in time, `requested_by_customer` when the customer canceled it.
791
704
  */
792
705
  export type PaymentCancellationReason = (typeof PaymentCancellationReason)[keyof typeof PaymentCancellationReason];
793
706
  export declare const PaymentCancellationReason: {
@@ -801,83 +714,55 @@ export declare const PaymentActionType: {
801
714
  readonly sdk: "sdk";
802
715
  };
803
716
  /**
804
- * The customer's next interaction. The gateway reports the actual payment outcome separately.
717
+ * The customer's next step; the payment outcome is reported separately.
805
718
  */
806
719
  export interface PaymentAction {
807
720
  type: PaymentActionType;
808
- /** Identifies the browser adapter for an SDK action, for example stripe. */
721
+ /** The browser adapter for the action, for example stripe. */
809
722
  provider?: string;
810
723
  url?: string;
811
- /** QR content to render and scan, not an image URL. */
724
+ /** QR content to render, not an image URL. */
812
725
  qr_code?: string;
813
- /** Short-lived client credential for this payment's browser confirmation. */
726
+ /** Short-lived client credential for confirming this payment in the browser. */
814
727
  client_secret?: string;
815
728
  public_key?: string;
816
729
  }
817
730
  /**
818
- * A top-up attempt and its outcome. A successful top-up adds a traceable amount to the balance; it is not a credit grant and has no associated invoice.
731
+ * A top-up attempt and its outcome. A successful top-up adds to the balance; it is not a credit grant and has no invoice.
819
732
  */
820
733
  export interface TopUp {
821
734
  id: string;
822
735
  billing_account_id: number;
823
736
  account: AccountIdentity;
824
- /** What is credited to the account, in the account's own currency. */
737
+ /** What is credited to the account, in its currency. */
825
738
  amount: Money;
826
739
  currency: string;
827
- /**
828
- * The part of this top-up still held in the balance. Pending refunds can temporarily
829
- * reserve part of it; it is not a promise that the whole amount is immediately withdrawable.
830
- */
740
+ /** The part of this top-up still in the balance. Pending refunds may hold part of it, so not all of it is necessarily withdrawable. */
831
741
  remaining_amount?: Money;
832
- /**
833
- * `pending` until the payment gateway reaches a result. The balance increases on `succeeded`.
834
- *
835
- * `failed` means the gateway declined the payment. A declined attempt ends the top-up at once
836
- * and the payment is withdrawn at the gateway; to pay another way, create a new top-up.
837
- * `canceled` means the attempt was withdrawn without collecting money; `cancellation_reason`
838
- * says why. Unknown gateway outcomes remain `pending`, and a browser redirect is not proof of
839
- * payment.
840
- *
841
- * `failed` and `canceled` are final. If the gateway nevertheless collects payment for such an
842
- * attempt, the amount is credited as a separate `succeeded` top-up.
843
- */
742
+ /** `pending` until the payment gateway reaches a result; the balance increases on `succeeded`. `failed`: the gateway declined the payment, which is withdrawn at the gateway; create a new top-up to pay another way. `canceled`: withdrawn without collecting money, for the reason in `cancellation_reason`. Unknown gateway outcomes stay `pending`; a browser redirect is not proof of payment. `failed` and `canceled` are final; a payment the gateway collects afterwards is credited as a separate `succeeded` top-up. */
844
743
  status: TopUpStatus;
845
744
  cancellation_reason?: PaymentCancellationReason;
846
745
  /** Which payment gateway collected it. */
847
746
  payment_gateway?: string;
848
747
  /** The selected payment method, such as card, wechat_pay or alipay. */
849
748
  method_type?: string;
850
- /**
851
- * The currency the customer was actually charged in, when the checkout page collected a
852
- * local one. Absent when it was the same as the account's.
853
- */
749
+ /** The currency the customer was charged in when the checkout collected a local currency; absent when it is the account's. */
854
750
  presentment_currency?: string;
855
- /**
856
- * What was charged, in `presentment_currency`. It will not equal `amount`, and it is
857
- * the figure that appears on the customer's card or wallet statement.
858
- */
751
+ /** The amount charged in `presentment_currency`, as shown on the customer's statement. */
859
752
  presentment_amount?: Money;
860
- /**
861
- * Why the gateway declined it. Present with `failed`. The value is the gateway's own code,
862
- * passed on unchanged: the card issuer's decline code when there is one (Stripe's decline_code,
863
- * such as insufficient_funds or lost_card), otherwise the gateway's error code (Stripe's code,
864
- * such as card_declined, expired_card or payment_intent_authentication_failure). Clients map it
865
- * to their own wording and treat an unknown value as a generic decline.
866
- */
753
+ /** Why the gateway declined it; present with `failed`. The gateway's code unchanged: the issuer's decline code when there is one (Stripe decline_code, such as insufficient_funds), otherwise the gateway's error code (Stripe code, such as card_declined). Treat an unknown value as a generic decline. */
867
754
  failure_reason?: string;
868
755
  action?: PaymentAction;
869
756
  created_at: string;
870
757
  /**
871
- * When the funds arrived. Later than `created_at` — by days for a bank transfer — so
872
- * reconciling against a statement uses this rather than the moment it was started.
873
- * Absent until the payment completes.
758
+ * When the funds arrived, possibly days after `created_at`. Absent until the payment completes.
874
759
  * @nullable
875
760
  */
876
761
  settled_at?: string | null;
877
762
  }
878
763
  export interface TopUpCreate {
879
764
  /**
880
- * The gateway explicitly selected from the available payment options.
765
+ * The gateway selected from the available payment options.
881
766
  * @minLength 1
882
767
  * @maxLength 32
883
768
  */
@@ -888,21 +773,12 @@ export interface TopUpCreate {
888
773
  * @maxLength 64
889
774
  */
890
775
  method_type: string;
891
- /** The ID of this top-up attempt. Keep it before submitting and query it after an uncertain response. */
776
+ /** The top-up ID, chosen by the caller. Read it after an uncertain response. */
892
777
  id: string;
893
778
  billing_account_id: number;
894
- /**
895
- * In the account's currency, and no finer than that currency's smallest unit:
896
- * two decimals for most, none for the yen. A finer amount is refused here rather
897
- * than at the checkout page, where the customer would see the gateway's own wording
898
- * instead of an explanation.
899
- *
900
- * There is a minimum, which differs by currency. Below it the gateway's fee
901
- * exceeds the top-up itself, so such a payment costs more to accept than it brings.
902
- * The minimum in force is returned with the rejection.
903
- */
779
+ /** In the account's currency, no finer than its smallest unit (two decimals for most currencies, none for JPY). An amount below the currency's minimum top-up is refused, and the minimum is returned with the error. */
904
780
  amount: Money & string;
905
- /** Charge a saved method instead of opening a checkout page. */
781
+ /** Charge a saved payment method instead of opening a checkout page. */
906
782
  payment_method_id?: string;
907
783
  /** Where to send the customer after checkout. */
908
784
  return_url?: string;
@@ -914,14 +790,11 @@ export interface TopUpList {
914
790
  export interface PaymentOptionMethod {
915
791
  /** The value to send as `method_type`, such as card, wechat_pay or alipay. */
916
792
  method_type: string;
917
- /**
918
- * Whether a method of this type can be saved with create-payment-method-setup and charged later
919
- * without the customer present. Methods that are not reusable are paid anew each time.
920
- */
793
+ /** Whether this method type can be saved with create-payment-method-setup and charged later without the customer. */
921
794
  reusable: boolean;
922
795
  }
923
796
  /**
924
- * A payment gateway that accepts payment in the account's currency, with the methods it accepts.
797
+ * A gateway accepting the account's currency, with its payment methods.
925
798
  */
926
799
  export interface PaymentOption {
927
800
  /** The value to send as `payment_gateway`. */
@@ -965,15 +838,10 @@ export interface PaymentMethodSetup {
965
838
  billing_account_id: number;
966
839
  }
967
840
  /**
968
- * What the payment gateway's browser library needs in order to collect a card. There is
969
- * no address to redirect to: the form is rendered in the page, and the card goes straight
970
- * from the browser to the gateway.
841
+ * What the payment gateway's browser library needs to collect a card in the page; the card goes from the browser straight to the gateway.
971
842
  */
972
843
  export interface PaymentMethodSetupResult {
973
- /**
974
- * The gateway's identifier for this attempt. Use it to tell a reloaded page apart
975
- * from a second attempt.
976
- */
844
+ /** The gateway's identifier for this attempt. */
977
845
  setup_id: string;
978
846
  payment_gateway: string;
979
847
  action: PaymentAction;
@@ -989,7 +857,7 @@ export interface PaymentMethodSetupResult {
989
857
  */
990
858
  export interface PayInvoiceRequest {
991
859
  /**
992
- * Required to collect an online remainder. An existing attempt keeps its original gateway.
860
+ * Required to collect an online remainder. An existing attempt keeps its gateway.
993
861
  * @minLength 1
994
862
  * @maxLength 32
995
863
  */
@@ -1000,51 +868,35 @@ export interface PayInvoiceRequest {
1000
868
  * @maxLength 64
1001
869
  */
1002
870
  method_type?: string;
1003
- /** Optional saved card owned by this billing account and belonging to the selected gateway. Omit to complete payment interactively. */
871
+ /** A saved card of this billing account at the selected gateway. Omit to pay interactively. */
1004
872
  payment_method_id?: string;
1005
- /** Whether to apply the available balance. Credit grants are controlled separately by use_credits. */
873
+ /** Whether to apply the balance; credit grants are controlled by use_credits. */
1006
874
  use_balance?: boolean;
1007
- /** Apply eligible, unexpired credit grants before using the balance. This never withdraws grants or converts them into balance. */
875
+ /** Apply eligible, unexpired credit grants before the balance. Grants are never converted into balance. */
1008
876
  use_credits?: boolean;
1009
877
  return_url?: string;
1010
878
  /**
1011
- * The code to apply while the order's terms are not yet fixed. Omit to apply the best applicable
1012
- * account discount, or to keep the discount already recorded.
879
+ * The code to apply while the order's terms are not fixed. Omit to apply the best applicable account discount, or to keep the discount already recorded.
1013
880
  * @minLength 1
1014
881
  * @maxLength 64
1015
882
  */
1016
883
  promotion_code?: string;
1017
- /**
1018
- * The invoice total to expect, after discounts and tax and before credit grants or balance, as the
1019
- * payment preview or an order quote gave it. A different total fails with BILLING_AMOUNT_CHANGED
1020
- * and nothing is charged. Omit to skip the comparison; an explicit zero is compared.
1021
- */
884
+ /** The invoice total to expect, after discounts and tax and before credit grants or balance, as the payment preview or an order quote gave it. A different total fails with `BILLING_AMOUNT_CHANGED` and nothing is charged. Omit to skip the check; zero is checked. */
1022
885
  expected_amount?: Money & string;
1023
886
  }
1024
887
  /**
1025
- * Name at least one invoice or order. They must all belong to the same account and share
1026
- * its currency; anything else is refused rather than partly paid.
888
+ * Name at least one invoice or order. All must belong to one account in its currency.
1027
889
  */
1028
890
  export interface PayTogetherRequest {
1029
891
  /** @maxItems 100 */
1030
892
  invoice_ids?: string[];
1031
893
  /** @maxItems 100 */
1032
894
  order_ids?: string[];
1033
- /**
1034
- * The amount due to expect across all of them, before credit grants or balance, as preview-pay-together
1035
- * gave it. A different amount fails with BILLING_AMOUNT_CHANGED and nothing is charged. Omit to skip
1036
- * the comparison.
1037
- */
895
+ /** The amount due across all invoices, before credit grants or balance, as preview-pay-together gave it. A different amount fails with `BILLING_AMOUNT_CHANGED` and nothing is charged. Omit to skip the check. */
1038
896
  expected_amount?: Money & string;
1039
897
  }
1040
898
  /**
1041
- * The current payment outcome.
1042
- *
1043
- * succeeded means payment is complete. processing means confirmation is pending; poll the invoice or
1044
- * order rather than submitting another payment. requires_action means the customer must complete the
1045
- * supplied action. failed means the attempt did not succeed and failure_reason explains the outcome; a
1046
- * declined gateway payment is withdrawn at the gateway, and paying again starts a new payment with the
1047
- * same or another method.
899
+ * `succeeded`: paid. `processing`: confirmation is pending; poll the invoice or order instead of paying again. `requires_action`: the customer must complete the returned action. `failed`: the attempt did not succeed, for the reason in failure_reason; a declined gateway payment is withdrawn, and paying again starts a new payment.
1048
900
  */
1049
901
  export type PaymentStatus = (typeof PaymentStatus)[keyof typeof PaymentStatus];
1050
902
  export declare const PaymentStatus: {
@@ -1070,7 +922,7 @@ export interface PaymentPreviewInvoice {
1070
922
  balance_applied: Money;
1071
923
  }
1072
924
  /**
1073
- * What paying would take, computed as paying computes it. Nothing is charged or reserved.
925
+ * What paying would take, calculated as paying does. Nothing is charged or reserved.
1074
926
  */
1075
927
  export interface PaymentPreview {
1076
928
  funds?: Funds;
@@ -1079,23 +931,19 @@ export interface PaymentPreview {
1079
931
  amount_due: Money;
1080
932
  /** What credit grants would pay. Grants restricted to other purchases pay nothing here. */
1081
933
  credit_applied: Money;
1082
- /** The credit grants that would pay, in the order they would be used. */
934
+ /** The credit grants that would pay, in the order used. */
1083
935
  credit_grants: AppliedCredit[];
1084
936
  /** What the balance would pay. */
1085
937
  balance_applied: Money;
1086
- /** What would remain to be paid online. Paying without a gateway is refused with `BILLING_INSUFFICIENT_FUNDS` while this is above zero. */
938
+ /** What would remain to pay online. Paying without a gateway is refused with `BILLING_INSUFFICIENT_FUNDS` while this is above zero. */
1087
939
  gateway_amount: Money;
1088
940
  /** The available balance after paying. */
1089
941
  balance_after: Money;
1090
- /** Paying together only. Each invoice, in the order it would be paid. */
942
+ /** Paying together only: each invoice, in payment order. */
1091
943
  invoices?: PaymentPreviewInvoice[];
1092
944
  }
1093
945
  /**
1094
- * Present on refunds. Where this part of the refund goes.
1095
- *
1096
- * - `balance`: back to the account balance.
1097
- * - `credit`: back to the credit grant that paid, which keeps its original expiry.
1098
- * - `gateway`: back to the payment method it was paid with.
946
+ * Present on refunds: where this part goes. `balance`: the account balance. `credit`: the credit grant that paid, keeping its original expiry. `gateway`: the payment method it was paid with.
1099
947
  */
1100
948
  export type TransactionRefundDestination = (typeof TransactionRefundDestination)[keyof typeof TransactionRefundDestination];
1101
949
  export declare const TransactionRefundDestination: {
@@ -1104,9 +952,7 @@ export declare const TransactionRefundDestination: {
1104
952
  readonly gateway: "gateway";
1105
953
  };
1106
954
  /**
1107
- * `failed` means the operation did not succeed; for a gateway payment, that the gateway declined
1108
- * it. `canceled` means a gateway payment was withdrawn without collecting money. After either,
1109
- * an invoice the payment was meant to pay remains open for another payment.
955
+ * `failed`: the operation did not succeed; for a gateway payment, the gateway declined it. `canceled`: a gateway payment was withdrawn without collecting money. Either way, the invoice it was for stays open.
1110
956
  */
1111
957
  export type TransactionStatus = (typeof TransactionStatus)[keyof typeof TransactionStatus];
1112
958
  export declare const TransactionStatus: {
@@ -1127,7 +973,7 @@ export declare const TransactionType: {
1127
973
  readonly fee: "fee";
1128
974
  };
1129
975
  /**
1130
- * A funds operation. Each payment has one source; refunds identify the original successful transaction. Unknown gateway results remain pending. Payments from the balance or a gateway are distinct from credit-grant payments.
976
+ * A funds movement with one source. Refunds name the original transaction. Unknown gateway results stay pending.
1131
977
  */
1132
978
  export interface Transaction {
1133
979
  invoice_id?: string;
@@ -1136,47 +982,22 @@ export interface Transaction {
1136
982
  credit_grant_id?: string;
1137
983
  credit_grant?: ObjectIdentity;
1138
984
  refund_id?: string;
1139
- /**
1140
- * Present on refunds. Where this part of the refund goes.
1141
- *
1142
- * - `balance`: back to the account balance.
1143
- * - `credit`: back to the credit grant that paid, which keeps its original expiry.
1144
- * - `gateway`: back to the payment method it was paid with.
1145
- */
985
+ /** Present on refunds: where this part goes. `balance`: the account balance. `credit`: the credit grant that paid, keeping its original expiry. `gateway`: the payment method it was paid with. */
1146
986
  refund_destination?: TransactionRefundDestination;
1147
- /**
1148
- * `failed` means the operation did not succeed; for a gateway payment, that the gateway declined
1149
- * it. `canceled` means a gateway payment was withdrawn without collecting money. After either,
1150
- * an invoice the payment was meant to pay remains open for another payment.
1151
- */
987
+ /** `failed`: the operation did not succeed; for a gateway payment, the gateway declined it. `canceled`: a gateway payment was withdrawn without collecting money. Either way, the invoice it was for stays open. */
1152
988
  status?: TransactionStatus;
1153
989
  cancellation_reason?: PaymentCancellationReason;
1154
990
  payment_gateway?: string;
1155
991
  method_type?: string;
1156
- /**
1157
- * Why it failed. Present with `failed`. For a declined gateway payment the value is the
1158
- * gateway's own code, passed on unchanged: the card issuer's decline code when there is one
1159
- * (Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the gateway's
1160
- * error code (Stripe's code, such as card_declined, expired_card or
1161
- * payment_intent_authentication_failure). Clients map it to their own wording and treat an
1162
- * unknown value as a generic decline.
1163
- */
992
+ /** Why it failed; present with `failed`. For a declined gateway payment, the gateway's code unchanged: the issuer's decline code when there is one (Stripe decline_code, such as insufficient_funds), otherwise the gateway's error code (Stripe code, such as card_declined). Treat an unknown value as a generic decline. */
1164
993
  failure_reason?: string;
1165
994
  settled_at?: string;
1166
995
  id: string;
1167
996
  billing_account_id?: number;
1168
997
  type: TransactionType;
1169
- /**
1170
- * Signed by type: positive for `topup` and `payment`, negative for `refund`.
1171
- * An `adjustment` is positive when it adds to the balance and negative when it takes from
1172
- * it. For the other types the sign does not tell the effect on the balance: a payment from
1173
- * the balance lowers it, while a payment by gateway or by credit leaves it unchanged.
1174
- */
998
+ /** Signed by type: positive for `topup` and `payment`, negative for `refund`. An `adjustment` is positive when it adds to the balance and negative when it takes from it. For other types the sign does not show the effect on the balance: a payment from balance lowers it, a payment by gateway or credit does not. */
1175
999
  amount: Money;
1176
- /**
1177
- * How much of this transaction is still available in the balance. Only top-ups, positive
1178
- * adjustments and gateway payments later returned to the balance can be non-zero.
1179
- */
1000
+ /** How much of this transaction is still in the balance. Only top-ups, positive adjustments and gateway payments returned to the balance can be non-zero. */
1180
1001
  remaining_amount: Money;
1181
1002
  currency: string;
1182
1003
  reason?: string;
@@ -1184,53 +1005,31 @@ export interface Transaction {
1184
1005
  }
1185
1006
  export interface PaymentResult {
1186
1007
  transactions: Transaction[];
1187
- /** The gateway transaction, when one is involved. Balance and credit-grant payments are separate transactions. */
1008
+ /** The gateway transaction, when one is involved. */
1188
1009
  transaction_id?: string;
1189
1010
  status: PaymentStatus;
1190
1011
  amount_paid: Money;
1191
- /**
1192
- * What is still outstanding. Zero once the payment succeeds. Unchanged while
1193
- * `processing`: nothing is collected until the gateway confirms it.
1194
- */
1012
+ /** What is still outstanding: zero once the payment succeeds, unchanged while `processing`. */
1195
1013
  amount_due: Money;
1196
1014
  currency: string;
1197
1015
  credit_applied?: Money;
1198
1016
  gateway_amount?: Money;
1199
1017
  payment_gateway?: string;
1200
1018
  method_type?: string;
1201
- /**
1202
- * The amount already paid from the account's balance toward this invoice. Retrying an online remainder
1203
- * does not debit it again. A canceled purchase returns funds through its refund process.
1204
- */
1019
+ /** The amount already paid from balance toward this invoice; retrying the online remainder does not debit it again. */
1205
1020
  balance_applied?: Money;
1206
1021
  action?: PaymentAction;
1207
- /**
1208
- * Whether paying again is worth attempting. False for a refusal that will keep
1209
- * happening — a closed account, an amount over a limit — so that a client does not
1210
- * retry in a loop.
1211
- */
1022
+ /** Whether paying again can succeed. False for a refusal that will repeat, such as a closed account or an amount over a limit. */
1212
1023
  retriable?: boolean;
1213
1024
  /** @nullable */
1214
1025
  invoice_id?: string | null;
1215
1026
  /** @nullable */
1216
1027
  order_id?: string | null;
1217
- /**
1218
- * Why the payment did not go through. Present with `failed`. For a declined gateway payment the
1219
- * value is the gateway's own code, passed on unchanged: the card issuer's decline code when
1220
- * there is one (Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the
1221
- * gateway's error code (Stripe's code, such as card_declined, expired_card or
1222
- * payment_intent_authentication_failure). Clients map it to their own wording and treat an
1223
- * unknown value as a generic decline.
1224
- */
1028
+ /** Why the payment failed; present with `failed`. For a declined gateway payment, the gateway's code unchanged: the issuer's decline code when there is one (Stripe decline_code, such as insufficient_funds), otherwise the gateway's error code (Stripe code, such as card_declined). Treat an unknown value as a generic decline. */
1225
1029
  failure_reason?: string;
1226
1030
  }
1227
1031
  /**
1228
- * A draft is not yet issued. The draft invoice of an order shows base prices until it is paid, when
1229
- * the discount is applied and it is issued; other drafts are private to administrators.
1230
- * An issued invoice is open until settled; a zero-total issued invoice is immediately paid.
1231
- * Unbilled usage remains separate from invoices until it is invoiced.
1232
- * A refund does not change the status: a paid invoice stays paid, with the refunded part in
1233
- * amount_refunded. void means collection has stopped and any funds received have been returned.
1032
+ * `draft`: not yet issued; an order's draft invoice shows base prices until it is paid, when the discount is applied and it is issued. Other drafts are visible only to operators. `open`: issued and not yet settled; a zero-total invoice is paid at once. `paid` stays paid after a refund, with the refunded part in amount_refunded. `void`: collection has stopped and any funds received have been returned. Usage not yet invoiced is not on any invoice.
1234
1033
  */
1235
1034
  export type InvoiceStatus = (typeof InvoiceStatus)[keyof typeof InvoiceStatus];
1236
1035
  export declare const InvoiceStatus: {
@@ -1238,11 +1037,9 @@ export declare const InvoiceStatus: {
1238
1037
  readonly open: "open";
1239
1038
  readonly paid: "paid";
1240
1039
  readonly void: "void";
1241
- readonly uncollectible: "uncollectible";
1242
1040
  };
1243
1041
  /**
1244
- * How tax applied to the customer when the invoice was issued. `reverse` means no tax was
1245
- * charged because the customer accounts for it under the reverse-charge mechanism.
1042
+ * How tax applied to the customer when the invoice was issued; `reverse` means no tax was charged under the reverse-charge mechanism.
1246
1043
  */
1247
1044
  export type InvoiceCustomerTaxExempt = (typeof InvoiceCustomerTaxExempt)[keyof typeof InvoiceCustomerTaxExempt];
1248
1045
  export declare const InvoiceCustomerTaxExempt: {
@@ -1265,7 +1062,7 @@ export interface TaxItem {
1265
1062
  currency: string;
1266
1063
  }
1267
1064
  export interface Invoice {
1268
- /** Collection has been stopped; any accepted return obligations are completed before final voiding. */
1065
+ /** Collection has stopped; accepted return obligations are completed. */
1269
1066
  void_requested_at?: string;
1270
1067
  due_at?: string;
1271
1068
  amount_refunded?: string;
@@ -1285,16 +1082,16 @@ export interface Invoice {
1285
1082
  /** Sum of the line discounts, taken off before tax. */
1286
1083
  discount_amount?: Money;
1287
1084
  tax_amount?: Money;
1288
- /** Successful credit-grant payments included in amount_paid. Does not reduce the receivable or tax base. */
1085
+ /** Successful credit-grant payments, included in amount_paid; they do not reduce the receivable or tax base. */
1289
1086
  credit_applied?: Money;
1290
- /** Subtotal less discount plus tax. Balance and credit grants are payment sources, not reductions of the receivable. */
1087
+ /** Subtotal less discount plus tax. Balance and credit grants pay it; they do not reduce it. */
1291
1088
  total: Money;
1292
1089
  amount_paid?: Money;
1293
- /** Issued, non-void credit notes that reduced unpaid receivables. Does not rewrite the original invoice total. */
1090
+ /** Issued credit notes that reduced unpaid receivables; the original invoice total is unchanged. */
1294
1091
  pre_payment_credit_notes_amount: Money;
1295
- /** Issued credit notes against payments already received. This is a return obligation, not evidence of completed refunds. */
1092
+ /** Issued credit notes against payments already received; their refunds may not have completed. */
1296
1093
  post_payment_credit_notes_amount: Money;
1297
- /** What is still collectible after unpaid credit notes and successful payments; never below zero. A draft has none; its total is the base price, and a payment preview shows what paying it would collect. A paid or void invoice has none either. */
1094
+ /** What is still collectible after unpaid credit notes and successful payments; never below zero. Zero for a draft, whose total is the base price, and for a paid or void invoice. */
1298
1095
  amount_due: Money;
1299
1096
  /** @nullable */
1300
1097
  period_start?: string | null;
@@ -1303,17 +1100,11 @@ export interface Invoice {
1303
1100
  * @nullable
1304
1101
  */
1305
1102
  period_end?: string | null;
1306
- /**
1307
- * Who this was billed to, as recorded when the invoice was issued. Later changes to
1308
- * the account do not alter it.
1309
- */
1103
+ /** The billing details recorded when the invoice was issued. */
1310
1104
  customer_name?: string;
1311
1105
  customer_email?: string;
1312
1106
  customer_tax_id?: string;
1313
- /**
1314
- * How tax applied to the customer when the invoice was issued. `reverse` means no tax was
1315
- * charged because the customer accounts for it under the reverse-charge mechanism.
1316
- */
1107
+ /** How tax applied to the customer when the invoice was issued; `reverse` means no tax was charged under the reverse-charge mechanism. */
1317
1108
  customer_tax_exempt?: InvoiceCustomerTaxExempt;
1318
1109
  customer_address_line1?: string;
1319
1110
  customer_address_line2?: string;
@@ -1336,13 +1127,19 @@ export declare const InvoiceItemType: {
1336
1127
  readonly setup: "setup";
1337
1128
  readonly adjustment: "adjustment";
1338
1129
  };
1130
+ /**
1131
+ * For a usage line, the values of its meter's presentation dimensions, such as the model and token kind. Empty for other lines.
1132
+ */
1133
+ export type InvoiceItemDimensions = {
1134
+ [key: string]: string;
1135
+ };
1339
1136
  /**
1340
1137
  * The value of one paid period moved to the new configuration of a subscription.
1341
1138
  */
1342
1139
  export interface InvoiceItemProration {
1343
1140
  /** The earlier invoice line that paid for the period. */
1344
1141
  credited_invoice_item_id: string;
1345
- /** The wording of the earlier invoice line as recorded when this invoice was created. */
1142
+ /** The earlier invoice line's wording as recorded. */
1346
1143
  description: string;
1347
1144
  period_start: string;
1348
1145
  /** Exclusive. */
@@ -1374,29 +1171,26 @@ export interface InvoiceItem {
1374
1171
  type?: InvoiceItemType;
1375
1172
  /** @nullable */
1376
1173
  project_id?: string | null;
1377
- /**
1378
- * The project the charge was for and its current name, for display. Absent when the line is
1379
- * not for a project, and when the project no longer exists or its details cannot be read at
1380
- * the moment; `project_id` still identifies it then.
1381
- */
1174
+ /** The project the charge was for and its current name. Absent when the line has no project or the project cannot be read; `project_id` still identifies it. */
1382
1175
  project?: NamedIdentity | null;
1383
1176
  resource_id?: string;
1384
- /**
1385
- * The wording as recorded when the invoice was issued. It is not re-translated
1386
- * afterwards, so that an invoice continues to read as it did when it was sent.
1387
- */
1177
+ /** The line's wording as recorded when the invoice was issued. */
1388
1178
  description: string;
1389
1179
  unit?: string;
1390
1180
  quantity?: string;
1391
1181
  /** The part covered by an included allowance, and therefore not charged. */
1392
1182
  deducted_quantity?: string;
1393
1183
  unit_amount?: Money;
1184
+ /** The quantity `unit_amount` prices, such as 1000000 tokens or 3600 seconds: `amount` is `quantity` × `unit_amount` ÷ `unit_quantity`. Present together with `unit_amount`. */
1185
+ unit_quantity?: string;
1394
1186
  amount: Money;
1395
1187
  currency: string;
1396
1188
  /** @nullable */
1397
1189
  period_start?: string | null;
1398
1190
  /** @nullable */
1399
1191
  period_end?: string | null;
1192
+ /** For a usage line, the values of its meter's presentation dimensions, such as the model and token kind. Empty for other lines. */
1193
+ dimensions?: InvoiceItemDimensions;
1400
1194
  /**
1401
1195
  * Present on a line that changes a subscription immediately, one entry for each paid period it
1402
1196
  * covers. `amount` is the sum of `remaining_amount` minus `credited_amount` over the entries.
@@ -1445,9 +1239,7 @@ export declare const CreditNoteStatus: {
1445
1239
  readonly void: "void";
1446
1240
  };
1447
1241
  /**
1448
- * Why the note was issued. Notes from canceled, expired or failed orders carry the order's reason;
1449
- * `usage_true_up` returns a tier price reduction settled after the original invoice; `operator` is
1450
- * issued by Leaflow on request.
1242
+ * Why the note was issued. Notes for canceled, expired or failed orders carry the order's reason; `usage_true_up` returns a tier price reduction settled after the original invoice; `operator` was issued on request.
1451
1243
  */
1452
1244
  export type CreditNoteReason = (typeof CreditNoteReason)[keyof typeof CreditNoteReason];
1453
1245
  export declare const CreditNoteReason: {
@@ -1461,7 +1253,7 @@ export declare const CreditNoteReason: {
1461
1253
  readonly operator: "operator";
1462
1254
  };
1463
1255
  /**
1464
- * An issued invoice reduction. Its credited amount is pre_payment_amount plus post_payment_amount. A paid credit records a return obligation; refund_id identifies its refund, whose outcome may still be pending. Original invoice amounts remain unchanged.
1256
+ * A reduction of an issued invoice; the original invoice amounts do not change. The credited amount is pre_payment_amount plus post_payment_amount. A paid part creates a refund, identified by refund_id, whose outcome may still be pending.
1465
1257
  */
1466
1258
  export interface CreditNote {
1467
1259
  id: string;
@@ -1476,18 +1268,14 @@ export interface CreditNote {
1476
1268
  voided_at: string | null;
1477
1269
  /** The reduction of unpaid receivables. A void note no longer reduces what is due. */
1478
1270
  pre_payment_amount: Money;
1479
- /** The credited part of payments already received. This is not proof that its refund has completed. */
1271
+ /** The credited part of payments already received; its refund may not have completed. */
1480
1272
  post_payment_amount: Money;
1481
1273
  /**
1482
- * The refund to the original payment sources, or null when no paid amount was credited.
1274
+ * The refund to the original payment sources; null when no paid amount was credited.
1483
1275
  * @nullable
1484
1276
  */
1485
1277
  refund_id: string | null;
1486
- /**
1487
- * Why the note was issued. Notes from canceled, expired or failed orders carry the order's reason;
1488
- * `usage_true_up` returns a tier price reduction settled after the original invoice; `operator` is
1489
- * issued by Leaflow on request.
1490
- */
1278
+ /** Why the note was issued. Notes for canceled, expired or failed orders carry the order's reason; `usage_true_up` returns a tier price reduction settled after the original invoice; `operator` was issued on request. */
1491
1279
  reason: CreditNoteReason;
1492
1280
  }
1493
1281
  export interface CreditNoteItem {
@@ -1506,7 +1294,7 @@ export interface CreditNoteItemList {
1506
1294
  pagination: OffsetPagination;
1507
1295
  }
1508
1296
  /**
1509
- * Use balance_amount, credit_amount and gateway_amount, which also show a refund split between several destinations.
1297
+ * Use balance_amount, credit_amount and gateway_amount, which also show a refund split between destinations.
1510
1298
  * @deprecated
1511
1299
  */
1512
1300
  export type RefundDestination = (typeof RefundDestination)[keyof typeof RefundDestination];
@@ -1534,22 +1322,19 @@ export declare const RefundStatus: {
1534
1322
  readonly failed: "failed";
1535
1323
  };
1536
1324
  /**
1537
- * Why the refund was made. Clients map the code to their own wording. More codes may be added;
1538
- * treat an unknown code as a refund without a stated reason.
1325
+ * Why the refund was made. New codes may be added; treat an unknown code as unspecified.
1539
1326
  *
1540
1327
  * - `provisioning_failed`: the purchase could not be delivered.
1541
- * - `order_expired`: the order expired after part of it had been paid.
1542
- * - `order_canceled`: the account holder canceled the order after part of it had been paid.
1543
- * - `change_canceled`: a scheduled change was withdrawn after part of it had been paid.
1544
- * - `change_expired`: a scheduled change could not take effect before its time passed.
1545
- * - `subscription_canceled`: the subscription was canceled and its unused value returned under
1546
- * its refund terms.
1547
- * - `future_period_canceled`: a renewal that had not started yet was withdrawn.
1548
- * - `downgrade_difference`: after a downgrade, the remaining value of what was paid, valued as refund
1549
- * policy `prorated` describes, minus the new configuration's cost for the remaining time at the
1550
- * change item's `refund_monthly_amount` and `refund_hourly_amount`. Nothing is refunded when that is
1551
- * zero or less.
1552
- * - `usage_true_up`: usage priced again over the whole month cost less than was charged.
1328
+ * - `order_expired`: the order expired after part of it was paid.
1329
+ * - `order_canceled`: the order was canceled after part of it was paid.
1330
+ * - `change_canceled`: a scheduled change was withdrawn after part of it was paid.
1331
+ * - `change_expired`: a scheduled change could not take effect in time.
1332
+ * - `subscription_canceled`: the unused value of a canceled subscription, under its refund terms.
1333
+ * - `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`.
1337
+ * - `usage_true_up`: usage priced over the whole month cost less than was charged.
1553
1338
  * - `payment_not_applied`: a payment arrived after its invoice could no longer be paid.
1554
1339
  * - `operator`: made by the platform operator.
1555
1340
  */
@@ -1570,15 +1355,14 @@ export declare const RefundReason: {
1570
1355
  export interface Refund {
1571
1356
  transaction_id?: string;
1572
1357
  cancellation_item_id?: string;
1573
- /** Original funds-return split and each result. Unknown gateway results remain pending. */
1358
+ /** The refund split by original payment source, with each result. Unknown gateway results stay pending. */
1574
1359
  transactions: Transaction[];
1575
1360
  id: string;
1576
1361
  billing_account_id?: number;
1577
1362
  /** @nullable */
1578
1363
  invoice_id?: string | null;
1579
1364
  /**
1580
- * The order the refund belongs to: the order that caused it, such as a downgrade, otherwise
1581
- * the order of the refunded invoice. Null for refunds of top-ups and of usage invoices.
1365
+ * The order the refund belongs to: the order that caused it, such as a downgrade, otherwise the order of the refunded invoice. Null for refunds of top-ups and usage invoices.
1582
1366
  * @nullable
1583
1367
  */
1584
1368
  order_id?: string | null;
@@ -1594,7 +1378,7 @@ export interface Refund {
1594
1378
  settled_amount?: Money;
1595
1379
  currency: string;
1596
1380
  /**
1597
- * Use balance_amount, credit_amount and gateway_amount, which also show a refund split between several destinations.
1381
+ * Use balance_amount, credit_amount and gateway_amount, which also show a refund split between destinations.
1598
1382
  * @deprecated
1599
1383
  */
1600
1384
  destination?: RefundDestination;
@@ -1621,7 +1405,7 @@ export interface RefundList {
1621
1405
  pagination: OffsetPagination;
1622
1406
  }
1623
1407
  /**
1624
- * The attributes the rate was chosen by, such as region and machine type.
1408
+ * The dimension values the rate was matched by, such as region and machine type.
1625
1409
  */
1626
1410
  export type UsageChargeDimensions = {
1627
1411
  [key: string]: string;
@@ -1630,28 +1414,27 @@ export interface UsageCharge {
1630
1414
  subscription_id: string;
1631
1415
  id: string;
1632
1416
  project_id?: string;
1633
- /**
1634
- * The project and its current name, for display. Absent when the project no longer exists or its
1635
- * details cannot be read at the moment; `project_id` still identifies it.
1636
- */
1417
+ /** The project and its current name. Absent when the project cannot be read; `project_id` still identifies it. */
1637
1418
  project?: NamedIdentity | null;
1638
1419
  product: Product;
1639
1420
  /** Which resource this was charged for. Empty for charges not tied to one. */
1640
1421
  resource_id?: string;
1641
1422
  meter: ObjectIdentity;
1642
1423
  unit?: string;
1643
- /** The attributes the rate was chosen by, such as region and machine type. */
1424
+ /** The dimension values the rate was matched by, such as region and machine type. */
1644
1425
  dimensions?: UsageChargeDimensions;
1645
1426
  window_start: string;
1646
1427
  /** Exclusive. */
1647
1428
  window_end: string;
1648
- /** How much was used, before any included allowance. */
1429
+ /** Quantity used before allowances. */
1649
1430
  gross_quantity?: string;
1650
1431
  /** How much of that was covered by an allowance. */
1651
1432
  deducted_quantity?: string;
1652
- /** What was charged for — the gross quantity less the part covered. */
1433
+ /** The quantity charged: gross quantity less the part covered by allowances. */
1653
1434
  quantity: string;
1654
1435
  unit_amount?: Money;
1436
+ /** The quantity `unit_amount` prices, such as 1000000 tokens or 3600 seconds: `amount` is `quantity` × `unit_amount` ÷ `unit_quantity`. */
1437
+ unit_quantity?: string;
1655
1438
  amount: Money;
1656
1439
  currency: string;
1657
1440
  /**
@@ -1671,12 +1454,6 @@ export interface UsageChargeList {
1671
1454
  items: UsageCharge[];
1672
1455
  pagination: OffsetPagination;
1673
1456
  }
1674
- export type SubscriptionChargeType = (typeof SubscriptionChargeType)[keyof typeof SubscriptionChargeType];
1675
- export declare const SubscriptionChargeType: {
1676
- readonly postpaid: "postpaid";
1677
- readonly prepaid: "prepaid";
1678
- readonly one_time: "one_time";
1679
- };
1680
1457
  export type SubscriptionInterval = (typeof SubscriptionInterval)[keyof typeof SubscriptionInterval];
1681
1458
  export declare const SubscriptionInterval: {
1682
1459
  readonly none: "none";
@@ -1685,7 +1462,7 @@ export declare const SubscriptionInterval: {
1685
1462
  readonly year: "year";
1686
1463
  };
1687
1464
  /**
1688
- * An operation Leaflow prevents on a subscription. billing.subscriptions.use stops the service. renew prevents renewal and payment of a renewal order. modify prevents placing a change order. cancel prevents cancellation. terminate prevents immediate termination.
1465
+ * An operation prevented on the subscription. `billing.subscriptions.use` stops the service. `renew` prevents renewal and paying a renewal order. `modify` prevents placing a change order. `cancel` prevents cancellation. `terminate` prevents immediate termination.
1689
1466
  */
1690
1467
  export type SubscriptionRestriction = (typeof SubscriptionRestriction)[keyof typeof SubscriptionRestriction];
1691
1468
  export declare const SubscriptionRestriction: {
@@ -1696,13 +1473,7 @@ export declare const SubscriptionRestriction: {
1696
1473
  readonly billingsubscriptionsterminate: "billing.subscriptions.terminate";
1697
1474
  };
1698
1475
  /**
1699
- * Follows the items. `pending` is not yet accepted and may be unpaid or paid; its invoice shows
1700
- * whether payment is still needed, and it can expire or be canceled. `accepted` is accepted with items still
1701
- * being set up. `completed` means every item was set up. `partially_completed` means some items were set up
1702
- * and the others failed or were canceled and were refunded to their original payment sources. `failed` means
1703
- * no item was delivered and at least one failed; collected amounts for the undelivered items are refunded.
1704
- * `canceled` means every item was withdrawn without delivery; collected amounts are returned to their original
1705
- * payment sources. No status establishes service delivery by itself.
1476
+ * Follows the items. `pending`: not yet accepted, paid or unpaid; its invoice shows whether payment is needed, and it can expire or be canceled. `accepted`: items are being set up. `completed`: every item was set up. `partially_completed`: some items were set up and the others failed or were canceled and refunded to their original payment sources. `failed`: no item was delivered and at least one failed; amounts collected for undelivered items are refunded. `canceled`: every item was withdrawn without delivery; collected amounts are returned to their original payment sources. No status by itself means the service was delivered.
1706
1477
  */
1707
1478
  export type OrderStatus = (typeof OrderStatus)[keyof typeof OrderStatus];
1708
1479
  export declare const OrderStatus: {
@@ -1720,7 +1491,7 @@ export declare const ScheduledChangeInterval: {
1720
1491
  readonly year: "year";
1721
1492
  };
1722
1493
  /**
1723
- * The next accepted period-end change for a subscription. It describes the target terms and does not change the current subscription until effective_at.
1494
+ * The next accepted period-end change of the subscription: the target terms, applied at effective_at.
1724
1495
  */
1725
1496
  export interface ScheduledChange {
1726
1497
  order_id: string;
@@ -1731,7 +1502,7 @@ export interface ScheduledChange {
1731
1502
  plan_name: string;
1732
1503
  price_id: string;
1733
1504
  quantity: string;
1734
- /** The target prepaid renewal amount before tax. */
1505
+ /** The target licensed renewal amount before tax. */
1735
1506
  recurring_amount: string;
1736
1507
  currency: string;
1737
1508
  interval: ScheduledChangeInterval;
@@ -1739,11 +1510,7 @@ export interface ScheduledChange {
1739
1510
  interval_count: number;
1740
1511
  }
1741
1512
  /**
1742
- * pending means the purchase relationship exists but its order has not been accepted.
1743
- * provisioning means the service accepted the order and is delivering. For a service-owned
1744
- * purchase, only confirmed delivery moves it to active; paying alone does not.
1745
- * canceled means cancellation completed, or an unfulfilled purchase was canceled or failed without delivery.
1746
- * terminated means an administrator or the owning service immediately ended the commercial relationship.
1513
+ * `pending`: the order has not been accepted. `provisioning`: the owning service accepted the order and is delivering. `active`: delivery was confirmed; payment alone does not make a subscription active. `suspended`: service is stopped while a lien restricts its use. `canceled`: cancellation completed, or an undelivered purchase was canceled or failed. `terminated`: an operator or the owning service ended it immediately.
1747
1514
  */
1748
1515
  export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus];
1749
1516
  export declare const SubscriptionStatus: {
@@ -1755,42 +1522,37 @@ export declare const SubscriptionStatus: {
1755
1522
  readonly terminated: "terminated";
1756
1523
  };
1757
1524
  /**
1758
- * An independently billed purchase relationship, separate from the owning service's resource.
1759
- * Placing a new prepaid or postpaid service order creates a pending subscription for each line
1760
- * in the same purchase transaction. Its ID is returned on the order item and remains stable
1761
- * through checkout and delivery. One order may create several subscriptions, such as an instance,
1762
- * its system disk and its address; it has no single subscription ID.
1763
- *
1764
- * Pending and provisioning do not grant service or accrue usage. A service-owned subscription
1765
- * becomes provisioning when the owning service accepts the order, and active when the service
1766
- * confirms delivery, with started_at set to the confirmed effective time; payment changes neither. Prepaid service periods start
1767
- * then; postpaid usage starts only when the service reports actual delivery and metering.
1525
+ * The dimension values of what was bought, such as region and instance type. Empty when the purchase gave none.
1526
+ */
1527
+ export type SubscriptionDimensions = {
1528
+ [key: string]: string;
1529
+ };
1530
+ /**
1531
+ * A purchase that is billed, renewed and changed on its own, separate from the owning service's resource. A new
1532
+ * recurring purchase creates a pending subscription for each order line; its ID is returned on the order item
1533
+ * and stays the same through checkout, delivery, renewals and changes. A one-time purchase may create none.
1768
1534
  *
1769
- * One-time delivery may omit a subscription. Renewals reference and extend existing subscriptions
1770
- * rather than creating another; a change keeps the subscription ID and switches its terms when it
1771
- * takes effect. Canceling or failing an unfulfilled purchase sets its pending or provisioning
1772
- * subscriptions to canceled without starting a service period.
1773
- * Fixed renewals use the agreed recurring_amount and interval; already paid periods retain their
1774
- * original value. Technical state belongs to the owning service.
1535
+ * Pending and provisioning subscriptions grant no service. A subscription becomes provisioning when the owning
1536
+ * service accepts the order, and active when the service confirms delivery, which sets started_at; payment
1537
+ * changes neither. Licensed service periods start at delivery, and metered usage is charged as the service
1538
+ * reports it. Canceling or failing an undelivered purchase cancels its subscriptions without starting a period.
1539
+ * Renewals use recurring_amount and the agreed interval; paid periods keep their value.
1775
1540
  *
1776
- * A purchased shared capacity limit, such as a regional snapshot count quota, can have its own
1777
- * subscription. Activating that capacity confirms delivery of the quota, not individual snapshots.
1778
- * Creating or deleting snapshots within it does not create, activate or terminate more subscriptions;
1779
- * the owning service enforces current holdings against the purchased count.
1541
+ * A shared capacity limit, such as a regional snapshot quota, has one subscription for the purchased quantity
1542
+ * rather than one per item.
1780
1543
  */
1781
1544
  export interface Subscription {
1782
1545
  /** Whether new account discounts may apply to future renewals. A fixed operator renewal agreement disables automatic discounts; catalog repricing or a newly selected purchase agreement enables them. */
1783
1546
  renewal_discounts_enabled?: boolean;
1784
1547
  currency: string;
1785
- charge_type: SubscriptionChargeType;
1548
+ type: PriceType;
1549
+ usage_type: UsageType;
1550
+ /** The dimension values of what was bought, such as region and instance type. Empty when the purchase gave none. */
1551
+ dimensions: SubscriptionDimensions;
1786
1552
  interval: SubscriptionInterval;
1787
1553
  /** @minimum 1 */
1788
1554
  interval_count?: number;
1789
- /**
1790
- * Whole-subscription prepaid renewal amount, after continuing discounts and before tax.
1791
- * Pending subscriptions show base terms until paying the order fixes any new continuing discount.
1792
- * Absent for other charge types.
1793
- */
1555
+ /** 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. */
1794
1556
  recurring_amount?: string;
1795
1557
  termination_policy?: TerminationPolicy;
1796
1558
  refund_policy?: RefundPolicy;
@@ -1799,17 +1561,14 @@ export interface Subscription {
1799
1561
  coupon?: ObjectIdentity;
1800
1562
  /** @minimum 0 */
1801
1563
  discounted_renewals_remaining?: number;
1802
- /** The operations currently prevented on the subscription, sorted. The subscription is suspended while this contains billing.subscriptions.use. */
1564
+ /** The operations currently prevented on the subscription, sorted; it is suspended while this contains `billing.subscriptions.use`. */
1803
1565
  restrictions?: SubscriptionRestriction[];
1804
1566
  billing_cycle_anchor?: string;
1805
1567
  cancellation?: SubscriptionCancellation;
1806
- /** The accepted period-end change currently scheduled for this subscription. Null when no such change exists. */
1568
+ /** The accepted period-end change scheduled for this subscription; null when there is none. */
1807
1569
  scheduled_change?: ScheduledChange | null;
1808
1570
  /**
1809
- * The saved payment method automatic renewal charges after the account's balance and credits,
1810
- * before the account's default payment method. Set when the purchase, a renewal or a change is paid with a
1811
- * saved payment method; paying any other way leaves it unchanged. It is used only while it belongs to the
1812
- * account that pays the renewal.
1571
+ * The saved payment method automatic renewal charges after balance and credits, before the account's default payment method. Set when a purchase, renewal or change is paid with a saved payment method. Used only while it belongs to the account paying the renewal.
1813
1572
  * @nullable
1814
1573
  */
1815
1574
  default_payment_method_id?: string | null;
@@ -1820,16 +1579,11 @@ export interface Subscription {
1820
1579
  account: AccountIdentity;
1821
1580
  product_id: ProductID;
1822
1581
  /**
1823
- * Which project this is for. Absent when it was bought at account level, such as a
1824
- * membership, which belongs to no single project.
1582
+ * The project it is for. Absent for an account-level purchase, such as a membership.
1825
1583
  * @nullable
1826
1584
  */
1827
1585
  project_id?: string | null;
1828
- /**
1829
- * The project and its current name, for display. Absent for a purchase at account level,
1830
- * and when the project no longer exists or its details cannot be read at the moment;
1831
- * `project_id` still identifies it then.
1832
- */
1586
+ /** The project and its current name. Absent for an account-level purchase or when the project cannot be read; `project_id` still identifies it. */
1833
1587
  project?: NamedIdentity | null;
1834
1588
  product: Product;
1835
1589
  plan_id: string;
@@ -1837,35 +1591,26 @@ export interface Subscription {
1837
1591
  price_id: string;
1838
1592
  quantity: string;
1839
1593
  /**
1840
- * When a prepaid subscription renews or expires, the end of the last service period bought.
1841
- * Renewing several periods in advance moves it. Null until a new subscription becomes active, even when
1842
- * its purchase has been paid, and for postpaid subscriptions.
1594
+ * When a licensed subscription renews or expires: the end of the last period bought, moved by renewing in advance. Null until the subscription becomes active, even when its purchase has been paid, and for metered subscriptions.
1843
1595
  * @nullable
1844
1596
  */
1845
1597
  current_term_end?: string | null;
1846
1598
  /**
1847
- * Start of the service period in effect now. Null when none is, including for postpaid subscriptions.
1599
+ * Start of the service period in effect now. Null when none is, including for metered subscriptions.
1848
1600
  * @nullable
1849
1601
  */
1850
1602
  current_period_start?: string | null;
1851
1603
  /**
1852
- * End of the service period in effect now. Renewing in advance moves `current_term_end`, not
1853
- * this. Null when no period is in effect, including for postpaid subscriptions.
1604
+ * End of the service period in effect now; renewing in advance moves `current_term_end`, not this. Null when no period is in effect, including for metered subscriptions.
1854
1605
  * @nullable
1855
1606
  */
1856
1607
  current_period_end?: string | null;
1857
- /** A prepaid subscription renews automatically while this is on. A postpaid subscription always continues until it is canceled; this is true until a cancellation is requested and cannot be set. */
1608
+ /** Whether a licensed subscription renews automatically. A metered subscription continues until it is canceled; for it this is true until a cancellation is requested, and cannot be set. */
1858
1609
  auto_renew: boolean;
1859
- /**
1860
- * pending means the purchase relationship exists but its order has not been accepted.
1861
- * provisioning means the service accepted the order and is delivering. For a service-owned
1862
- * purchase, only confirmed delivery moves it to active; paying alone does not.
1863
- * canceled means cancellation completed, or an unfulfilled purchase was canceled or failed without delivery.
1864
- * terminated means an administrator or the owning service immediately ended the commercial relationship.
1865
- */
1610
+ /** `pending`: the order has not been accepted. `provisioning`: the owning service accepted the order and is delivering. `active`: delivery was confirmed; payment alone does not make a subscription active. `suspended`: service is stopped while a lien restricts its use. `canceled`: cancellation completed, or an undelivered purchase was canceled or failed. `terminated`: an operator or the owning service ended it immediately. */
1866
1611
  status: SubscriptionStatus;
1867
1612
  /**
1868
- * Confirmed start of service. Null until a new subscription becomes active, including after payment.
1613
+ * When service started. Null until a new subscription becomes active, also after payment.
1869
1614
  * @nullable
1870
1615
  */
1871
1616
  started_at?: string | null;
@@ -1892,10 +1637,7 @@ export interface RenewalPrice {
1892
1637
  /** What renewing for this term costs, for the quantity held. */
1893
1638
  amount?: Money;
1894
1639
  currency?: string;
1895
- /**
1896
- * The term this item already bills at. Renewing for it uses the price bought
1897
- * originally, so a later price change does not affect it.
1898
- */
1640
+ /** The term the subscription renews at now; renewing for it keeps the agreed price. */
1899
1641
  current: boolean;
1900
1642
  }
1901
1643
  export interface RenewalPriceList {
@@ -1912,14 +1654,10 @@ export declare const RenewRequestInterval: {
1912
1654
  readonly year: "year";
1913
1655
  };
1914
1656
  export interface RenewRequest {
1915
- /** Purchase ID saved before submitting. Duplicate creation conflicts; query this order after an unknown result. */
1657
+ /** The order ID, chosen by the caller. Creating it again conflicts; read the order after an unknown outcome. */
1916
1658
  order_id: string;
1917
1659
  /**
1918
- * How many further periods to buy, each at the price this item already bills at.
1919
- *
1920
- * Buying twelve monthly periods is not the same as buying one yearly term: a longer
1921
- * term is usually sold at a lower price, and that price is only reached by naming the
1922
- * interval. Use `interval_count` and `interval` for that.
1660
+ * How many further periods to buy, each at the price the subscription already renews at. To buy a longer term at its own price, give `interval` and `interval_count` instead.
1923
1661
  * @minimum 1
1924
1662
  */
1925
1663
  periods?: number;
@@ -1958,10 +1696,10 @@ export declare const RenewalOrderRequestInterval: {
1958
1696
  readonly year: "year";
1959
1697
  };
1960
1698
  /**
1961
- * The periods and price of the renewal, chosen as in renewing.
1699
+ * The renewal's periods and price, chosen as in renewing.
1962
1700
  */
1963
1701
  export interface RenewalOrderRequest {
1964
- /** Purchase ID saved before submitting. Duplicate creation conflicts; query this order after an unknown result. */
1702
+ /** The order ID, chosen by the caller. Creating it again conflicts; read the order after an unknown outcome. */
1965
1703
  order_id: string;
1966
1704
  /**
1967
1705
  * As in renewing.
@@ -1982,10 +1720,7 @@ export interface AutoRenewSet {
1982
1720
  auto_renew: boolean;
1983
1721
  }
1984
1722
  /**
1985
- * `pending` is waiting to be set up. `completed` was confirmed by the service.
1986
- * `failed` was not set up and its amount was refunded to the original payment sources.
1987
- * `canceled` was confirmed withdrawn without delivery; any collected amount is returned. A completed item is ended by canceling
1988
- * its subscription.
1723
+ * `pending`: waiting to be set up. `completed`: set up, as confirmed by the service. `failed`: not set up; its amount was refunded to the original payment sources. `canceled`: withdrawn without delivery; any collected amount is returned. A completed item ends when its subscription is canceled.
1989
1724
  */
1990
1725
  export type OrderItemStatus = (typeof OrderItemStatus)[keyof typeof OrderItemStatus];
1991
1726
  export declare const OrderItemStatus: {
@@ -1995,7 +1730,7 @@ export declare const OrderItemStatus: {
1995
1730
  readonly canceled: "canceled";
1996
1731
  };
1997
1732
  /**
1998
- * `new` buys, `renew` extends a prepaid subscription, `modify` changes a subscription's configuration or billing terms.
1733
+ * `new` buys, `renew` extends a licensed subscription, `modify` changes a subscription's configuration or billing terms.
1999
1734
  */
2000
1735
  export type OrderType = (typeof OrderType)[keyof typeof OrderType];
2001
1736
  export declare const OrderType: {
@@ -2004,12 +1739,7 @@ export declare const OrderType: {
2004
1739
  readonly modify: "modify";
2005
1740
  };
2006
1741
  /**
2007
- * When a plan change takes effect. `none` on anything that is not a change.
2008
- *
2009
- * `period_end` orders stay pending until the first period at the new price is paid. That period
2010
- * is invoiced shortly before the current paid period ends and starts when it ends; if the
2011
- * invoice is still unpaid by then, the order is canceled and the subscription renews or ends as
2012
- * usual. Renewing in the meantime moves all of this along with it.
1742
+ * When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced shortly before the current paid period ends and starts when it ends; if the invoice is unpaid by then, the order is canceled and the subscription renews or ends as usual. A renewal in the meantime moves the change to the end of the renewed period.
2013
1743
  */
2014
1744
  export type OrderChangeEffective = (typeof OrderChangeEffective)[keyof typeof OrderChangeEffective];
2015
1745
  export declare const OrderChangeEffective: {
@@ -2018,10 +1748,7 @@ export declare const OrderChangeEffective: {
2018
1748
  readonly period_end: "period_end";
2019
1749
  };
2020
1750
  /**
2021
- * Purchase-related invoice amounts, without account contact details or payment methods. Every order
2022
- * has an invoice from placement. A draft shows base prices until it is paid, when the discount is
2023
- * applied and it is issued; a zero-total invoice is issued and paid at placement whatever the
2024
- * checkout mode. Neither establishes acceptance or delivery.
1751
+ * An order's invoice amounts, without contact details or payment methods. A draft shows base prices until it is paid, when the discount is applied and it is issued; a zero-total invoice is issued and paid at placement.
2025
1752
  */
2026
1753
  export interface InvoiceSummary {
2027
1754
  id: string;
@@ -2039,9 +1766,9 @@ export interface InvoiceSummary {
2039
1766
  tax_amount: string;
2040
1767
  total: string;
2041
1768
  amount_paid: string;
2042
- /** Issued, non-void credit notes that reduced unpaid receivables. Does not rewrite the original invoice total. */
1769
+ /** Issued credit notes that reduced unpaid receivables; the original invoice total is unchanged. */
2043
1770
  pre_payment_credit_notes_amount: Money;
2044
- /** Issued credit notes against payments already received. This is a return obligation, not evidence of completed refunds. */
1771
+ /** Issued credit notes against payments already received; their refunds may not have completed. */
2045
1772
  post_payment_credit_notes_amount: Money;
2046
1773
  /**
2047
1774
  * What is still collectible after unpaid credit notes and successful payments; never below zero.
@@ -2052,8 +1779,7 @@ export interface InvoiceSummary {
2052
1779
  due_at?: string;
2053
1780
  }
2054
1781
  /**
2055
- * How it was paid. Removing the payment method afterwards does not change it; `payment_method_id`
2056
- * then names a removed payment method.
1782
+ * How it was paid. `payment_method_id` still names the payment method after it is removed.
2057
1783
  */
2058
1784
  export interface PaidWith {
2059
1785
  /**
@@ -2075,22 +1801,17 @@ export declare const OrderItemInterval: {
2075
1801
  readonly month: "month";
2076
1802
  readonly year: "year";
2077
1803
  };
2078
- /**
2079
- * The payment timing of the selected price.
2080
- */
2081
- export type OrderItemChargeType = (typeof OrderItemChargeType)[keyof typeof OrderItemChargeType];
2082
- export declare const OrderItemChargeType: {
2083
- readonly postpaid: "postpaid";
2084
- readonly prepaid: "prepaid";
2085
- readonly one_time: "one_time";
2086
- };
2087
1804
  export type OrderItemConfiguration = {
2088
1805
  [key: string]: unknown;
2089
1806
  };
2090
1807
  /**
2091
- * Frozen purchase terms. Monetary fields come from related invoice-line snapshots and are zero
2092
- * for a line with no immediate charge, such as postpaid admission. Later catalog changes do not reprice this line. A new service
2093
- * purchase creates its pending subscription when this item is recorded, not when payment succeeds.
1808
+ * The dimension values the line was bought with, such as region and instance type. Empty when the purchase gave none.
1809
+ */
1810
+ export type OrderItemDimensions = {
1811
+ [key: string]: string;
1812
+ };
1813
+ /**
1814
+ * The purchase terms frozen at placement. Monetary fields come from the order's invoice lines and are zero without an immediate charge, such as for a metered purchase. Later catalog changes do not reprice the line. A new service purchase has its pending subscription from placement.
2094
1815
  */
2095
1816
  export interface OrderItem {
2096
1817
  /** Whether new account discounts may apply to future renewals. A fixed operator renewal agreement disables automatic discounts; catalog repricing or a newly selected purchase agreement enables them. */
@@ -2100,11 +1821,7 @@ export interface OrderItem {
2100
1821
  /** @minimum 0 */
2101
1822
  position?: number;
2102
1823
  configuration?: OrderItemConfiguration;
2103
- /**
2104
- * Stable Billing subscription ID. A new prepaid or postpaid service purchase returns the
2105
- * pending subscription here; renewals and changes reference the existing subscription, which
2106
- * keeps its ID. Absent for delivery without a subscription. This is not a business resource ID.
2107
- */
1824
+ /** 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. */
2108
1825
  subscription_id?: string;
2109
1826
  interval: OrderItemInterval;
2110
1827
  /** @minimum 1 */
@@ -2112,22 +1829,21 @@ export interface OrderItem {
2112
1829
  termination_policy?: TerminationPolicy;
2113
1830
  refund_policy?: RefundPolicy;
2114
1831
  /**
2115
- * Prepaid items only: the plan's one-month prepaid price for this item's quantity before tax, frozen
2116
- * at purchase, used to value time used under a prorated refund or a downgrade. Null when the plan has
2117
- * no prepaid period shorter than the one bought.
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.
2118
1833
  * @nullable
2119
1834
  */
2120
1835
  refund_monthly_amount?: string | null;
2121
1836
  /**
2122
- * Prepaid items only: the plan's postpaid hourly price for this item's quantity before tax, frozen at
2123
- * purchase, used for time used short of a full month. Null when the plan has no postpaid price.
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.
2124
1838
  * @nullable
2125
1839
  */
2126
1840
  refund_hourly_amount?: string | null;
2127
1841
  recurring_amount?: string;
2128
1842
  setup_amount?: string;
2129
- /** The payment timing of the selected price. */
2130
- charge_type: OrderItemChargeType;
1843
+ type: PriceType;
1844
+ usage_type: UsageType;
1845
+ /** The dimension values the line was bought with, such as region and instance type. Empty when the purchase gave none. */
1846
+ dimensions: OrderItemDimensions;
2131
1847
  /** Total tax after discounts, including any tax already included in the price. */
2132
1848
  tax_amount?: string;
2133
1849
  /** The part of tax_amount already included in gross_amount; it is not charged again. */
@@ -2139,45 +1855,28 @@ export interface OrderItem {
2139
1855
  product?: Product;
2140
1856
  /** Which plan was bought. */
2141
1857
  plan_id: string;
2142
- /**
2143
- * What it was called when bought. It does not follow later catalogue renames and is
2144
- * not translated.
2145
- */
1858
+ /** The name when bought. */
2146
1859
  plan_name: string;
2147
1860
  quantity: string;
2148
- /**
2149
- * The unit amount of the price this line is charged under. Absent for a tiered price, which has no
2150
- * single unit amount, and for a change that takes effect at once, which is charged as `gross_amount`
2151
- * describes.
2152
- */
1861
+ /** The unit amount of the price the line is charged under. Absent for a tiered price, and for an immediate change, which is charged as `gross_amount` describes. */
2153
1862
  unit_amount?: Money;
2154
1863
  /**
2155
- * Before discounts: the price applied to the quantity, which for a per-unit price is `unit_amount`
2156
- * times `quantity`; a minimum charge can make it higher. For an upgrade that takes effect at once it is
2157
- * the new price for the time left in the paid period, at the subscription's own period price, minus
2158
- * the amount paid for that time, and the period end does not move; a downgrade charges nothing and may refund the
2159
- * difference instead. A change between equal period prices charges and refunds nothing. The setup fee is not part of it; see `setup_amount`.
1864
+ * Before discounts and setup fees: the price applied to the quantity, `unit_amount` times `quantity` for a per-
1865
+ * unit price, raised by any minimum charge. For an immediate upgrade it is the new price for the rest of the
1866
+ * paid period minus the amount paid for that time; a downgrade, or a change between equal period prices, charges
1867
+ * nothing.
2160
1868
  *
2161
- * Under an inclusive tax rate it includes tax, as the price does, and the included part is
2162
- * `tax_included_amount`. A renewal at the agreed terms is the exception: the agreed amount excludes
2163
- * tax, and tax is added to it.
1869
+ * Under an inclusive tax rate it includes tax, shown in `tax_included_amount`, except for a renewal at agreed
1870
+ * terms, whose amount excludes tax.
2164
1871
  */
2165
1872
  gross_amount?: Money;
2166
- /**
2167
- * The reduction on this line: from the coupon the order uses and, for a renewal at the agreed terms,
2168
- * from the discount the subscription carries.
2169
- *
2170
- * A carried discount is part of the agreed amount. It is listed here, and `gross_amount` is then
2171
- * `unit_amount` times `quantity`, except in two cases where `gross_amount` is the agreed amount and
2172
- * the carried discount is already reflected in it: the renewal order also uses a coupon the account
2173
- * holds, or the account's tax rate is inclusive.
2174
- */
1873
+ /** The reduction on this line, from the order's coupon and, for a renewal at agreed terms, from the subscription's carried discount. With a carried discount, `gross_amount` is `unit_amount` times `quantity`, except when the renewal order also uses an account coupon or the tax rate is inclusive: then `gross_amount` is the agreed amount, which already reflects the carried discount. */
2175
1874
  discount_amount?: Money;
2176
1875
  /** `gross_amount` less `discount_amount`. */
2177
1876
  amount?: Money;
2178
1877
  currency: string;
2179
1878
  /**
2180
- * The start of the service period this line paid for. Frozen at placement for renewals and period-end changes; for a prepaid line of a new purchase, fixed from the second its invoice is paid and kept when delivery is confirmed. Absent for postpaid and one-time lines.
1879
+ * The start of the service period this line paid for. Fixed at placement for renewals and period-end changes, and for a licensed line of a new purchase when its invoice is paid. Absent for metered and one-time lines.
2181
1880
  * @nullable
2182
1881
  */
2183
1882
  period_start?: string | null;
@@ -2189,17 +1888,13 @@ export interface OrderItem {
2189
1888
  status: OrderItemStatus;
2190
1889
  }
2191
1890
  /**
2192
- * A recorded purchase with its invoice from placement; a zero-total invoice, such as for postpaid
2193
- * admission, is issued and paid at placement whatever the checkout mode. Until checkout_confirmed_at is set, the
2194
- * invoice is a draft at base prices: paying it fixes the discount and amount, issues it and collects it, and the
2195
- * order cannot be accepted before then. Coupon fields describe the discount fixed at that point and are absent
2196
- * before it; a quote never populates them. Payment and acceptance remain separate from resource delivery.
1891
+ * A recorded purchase with its invoice from placement; a zero-total invoice, such as for a metered purchase, is issued and paid at placement in either checkout mode. Until checkout_confirmed_at is set, the invoice is a draft at base prices: paying it fixes the discount and amount, issues it and collects it, and the order cannot be accepted before then. Coupon fields describe the discount fixed then and are absent before. Payment and acceptance do not mean the resources were delivered.
2197
1892
  */
2198
1893
  export interface Order {
2199
1894
  coupon_id?: string;
2200
1895
  coupon?: ObjectIdentity;
2201
1896
  promotion_code_id?: string;
2202
- /** Code text frozen when the coupon was applied. Absent for an account discount. */
1897
+ /** The promotion code applied. Absent for an account discount. */
2203
1898
  promotion_code?: string;
2204
1899
  /** The order's invoice, the same as invoice.id. */
2205
1900
  invoice_id: string;
@@ -2210,53 +1905,32 @@ export interface Order {
2210
1905
  change_effective_at?: string;
2211
1906
  id: string;
2212
1907
  /**
2213
- * Which project it was bought for. Absent for a purchase made at account level, such
2214
- * as a membership.
1908
+ * The project it was bought for. Absent for an account-level purchase, such as a membership.
2215
1909
  * @nullable
2216
1910
  */
2217
1911
  project_id?: string | null;
2218
- /**
2219
- * The project and its current name, for display. Absent for a purchase at account level,
2220
- * and when the project no longer exists or its details cannot be read at the moment;
2221
- * `project_id` still identifies it then.
2222
- */
1912
+ /** The project and its current name. Absent for an account-level purchase or when the project cannot be read; `project_id` still identifies it. */
2223
1913
  project?: NamedIdentity | null;
2224
- /**
2225
- * The billing account the order was placed with. It does not change when the project is later
2226
- * linked to another billing account. While this account is suspended or closed the order cannot
2227
- * be accepted, and the invoice of a change scheduled for the end of a period is not issued and the change is called off
2228
- * when the current period ends; such requests fail with BILLING_ACCOUNT_UNAVAILABLE.
2229
- */
1914
+ /** The billing account the order was placed with, unchanged when the project is later linked to another account. While it is suspended or closed, the order cannot be accepted, and a period-end change's invoice is not issued and the change is called off when the current period ends; such requests fail with `BILLING_ACCOUNT_UNAVAILABLE`. */
2230
1915
  billing_account_id?: number;
2231
1916
  currency: string;
2232
- /** `new` buys, `renew` extends a prepaid subscription, `modify` changes a subscription's configuration or billing terms. */
1917
+ /** `new` buys, `renew` extends a licensed subscription, `modify` changes a subscription's configuration or billing terms. */
2233
1918
  type: OrderType;
2234
1919
  status: OrderStatus;
2235
- /**
2236
- * When a plan change takes effect. `none` on anything that is not a change.
2237
- *
2238
- * `period_end` orders stay pending until the first period at the new price is paid. That period
2239
- * is invoiced shortly before the current paid period ends and starts when it ends; if the
2240
- * invoice is still unpaid by then, the order is canceled and the subscription renews or ends as
2241
- * usual. Renewing in the meantime moves all of this along with it.
2242
- */
1920
+ /** When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced shortly before the current paid period ends and starts when it ends; if the invoice is unpaid by then, the order is canceled and the subscription renews or ends as usual. A renewal in the meantime moves the change to the end of the renewed period. */
2243
1921
  change_effective?: OrderChangeEffective;
2244
1922
  /**
2245
- * Acceptance deadline. Pending orders can expire automatically.
1923
+ * Acceptance deadline; a pending order expires after it.
2246
1924
  * @nullable
2247
1925
  */
2248
1926
  expires_at?: string | null;
2249
1927
  /**
2250
- * When the discount and amount were fixed: at placement for automatic checkout and for a
2251
- * zero total, otherwise when the invoice was first paid. Null while a deferred order awaits payment.
1928
+ * When the discount and amount were fixed: at placement for automatic checkout or a zero total, otherwise when the invoice was first paid. Null while a deferred order awaits payment.
2252
1929
  * @nullable
2253
1930
  */
2254
1931
  checkout_confirmed_at?: string | null;
2255
1932
  created_at: string;
2256
- /**
2257
- * What was bought. Present on a single order and on every order in a list, so a list
2258
- * can be rendered without a further request per row.
2259
- */
1933
+ /** What was bought. */
2260
1934
  items: OrderItem[];
2261
1935
  }
2262
1936
  export interface OrderList {
@@ -2264,8 +1938,7 @@ export interface OrderList {
2264
1938
  pagination: OffsetPagination;
2265
1939
  }
2266
1940
  /**
2267
- * `scheduled` before valid_from, `active` within the validity, `expired` after valid_until, or
2268
- * `voided` once Leaflow withdrew it.
1941
+ * `scheduled` before valid_from, `active` within the validity, `expired` after valid_until, or `voided` once withdrawn.
2269
1942
  */
2270
1943
  export type DiscountStatus = (typeof DiscountStatus)[keyof typeof DiscountStatus];
2271
1944
  export declare const DiscountStatus: {
@@ -2282,9 +1955,7 @@ export declare const DiscountType: {
2282
1955
  readonly free_setup: "free_setup";
2283
1956
  };
2284
1957
  /**
2285
- * Whether the discount continues on renewals of the purchased item. `once` applies only to the
2286
- * purchase or renewal that uses the coupon, `recurring` continues for `frequency_duration` billing
2287
- * periods including the first, and `forever` continues on every renewal.
1958
+ * Whether the discount continues on renewals: `once` applies only to the purchase or renewal using the coupon, `recurring` for `frequency_duration` periods including the first, `forever` on every renewal.
2288
1959
  */
2289
1960
  export type DiscountFrequency = (typeof DiscountFrequency)[keyof typeof DiscountFrequency];
2290
1961
  export declare const DiscountFrequency: {
@@ -2293,26 +1964,18 @@ export declare const DiscountFrequency: {
2293
1964
  readonly forever: "forever";
2294
1965
  };
2295
1966
  /**
2296
- * A coupon held on this account for a period. Within the period it applies without a code to purchases and
2297
- * to metered usage that the coupon covers.
1967
+ * A coupon held by the account for a period, applying without a code to the purchases and metered usage it covers.
2298
1968
  */
2299
1969
  export interface Discount {
2300
1970
  min_amount?: string;
2301
1971
  billing_account_id?: number;
2302
1972
  coupon_id: string;
2303
1973
  promotion_code_id?: string;
2304
- /**
2305
- * `scheduled` before valid_from, `active` within the validity, `expired` after valid_until, or
2306
- * `voided` once Leaflow withdrew it.
2307
- */
1974
+ /** `scheduled` before valid_from, `active` within the validity, `expired` after valid_until, or `voided` once withdrawn. */
2308
1975
  status: DiscountStatus;
2309
1976
  voided_at?: string;
2310
1977
  type: DiscountType;
2311
- /**
2312
- * Whether the discount continues on renewals of the purchased item. `once` applies only to the
2313
- * purchase or renewal that uses the coupon, `recurring` continues for `frequency_duration` billing
2314
- * periods including the first, and `forever` continues on every renewal.
2315
- */
1978
+ /** Whether the discount continues on renewals: `once` applies only to the purchase or renewal using the coupon, `recurring` for `frequency_duration` periods including the first, `forever` on every renewal. */
2316
1979
  frequency?: DiscountFrequency;
2317
1980
  /** @minimum 1 */
2318
1981
  frequency_duration?: number;
@@ -2324,10 +1987,7 @@ export interface Discount {
2324
1987
  /** Caps a percentage discount. */
2325
1988
  max_discount?: Money;
2326
1989
  currency?: string;
2327
- /**
2328
- * What it may be used for. Absent means it applies to anything on the account,
2329
- * including setup fees and traffic.
2330
- */
1990
+ /** What it may pay for. Absent means anything on the account, including setup fees and usage. */
2331
1991
  applies_to: Applicability;
2332
1992
  /** Restricted to your first purchase of anything it applies to. */
2333
1993
  first_purchase_only?: boolean;
@@ -2347,7 +2007,7 @@ export interface OrderItemList {
2347
2007
  pagination: OffsetPagination;
2348
2008
  }
2349
2009
  /**
2350
- * Whether the quantity was paid for or granted free of charge. Both are consumed the same way.
2010
+ * Whether the quantity was paid for or granted free; both are consumed the same way.
2351
2011
  */
2352
2012
  export type AllowanceCategory = (typeof AllowanceCategory)[keyof typeof AllowanceCategory];
2353
2013
  export declare const AllowanceCategory: {
@@ -2378,7 +2038,7 @@ export interface Allowance {
2378
2038
  meter: ObjectIdentity;
2379
2039
  /** The unit it is counted in, such as `MiB`. */
2380
2040
  unit?: string;
2381
- /** Whether the quantity was paid for or granted free of charge. Both are consumed the same way. */
2041
+ /** Whether the quantity was paid for or granted free; both are consumed the same way. */
2382
2042
  category: AllowanceCategory;
2383
2043
  /**
2384
2044
  * Exact values for a subset of the meter's dimensions. Only usage with these values is deducted;
@@ -2390,16 +2050,12 @@ export interface Allowance {
2390
2050
  quantity: string;
2391
2051
  /** How much is left. */
2392
2052
  remaining_quantity: string;
2393
- /**
2394
- * Lower values are consumed first. At equal priority, earlier expiry and then earlier issuance take
2395
- * precedence.
2396
- */
2053
+ /** Lower values are consumed first; at equal priority, earlier expiry and then earlier issuance. */
2397
2054
  priority?: number;
2398
2055
  status: AllowanceStatus;
2399
2056
  valid_from: string;
2400
2057
  /**
2401
- * When it lapses. Anything unused at that point is lost; it is not refunded and does
2402
- * not carry over. Absent when it does not expire on its own.
2058
+ * When the allowance lapses; unused quantity is lost. Absent when it does not expire.
2403
2059
  * @nullable
2404
2060
  */
2405
2061
  valid_until?: string | null;
@@ -2442,8 +2098,7 @@ export interface Entitlement {
2442
2098
  name?: string;
2443
2099
  enabled: boolean;
2444
2100
  /**
2445
- * When the subscription providing it ends. Absent for a metered subscription, which
2446
- * has no end date.
2101
+ * When the providing subscription ends. Absent for a metered subscription.
2447
2102
  * @nullable
2448
2103
  */
2449
2104
  expires_at?: string | null;
@@ -2476,30 +2131,7 @@ export interface PlanList {
2476
2131
  pagination: OffsetPagination;
2477
2132
  }
2478
2133
  /**
2479
- * `postpaid` charges for what is used, `prepaid` buys a period in advance, `one_time`
2480
- * charges once.
2481
- */
2482
- export type PriceType = (typeof PriceType)[keyof typeof PriceType];
2483
- export declare const PriceType: {
2484
- readonly postpaid: "postpaid";
2485
- readonly prepaid: "prepaid";
2486
- readonly one_time: "one_time";
2487
- };
2488
- /**
2489
- * How the amount is arrived at. `rated` means the rate depends on attributes such as
2490
- * region or machine type, and is looked up on a price list.
2491
- */
2492
- export type PriceBillingScheme = (typeof PriceBillingScheme)[keyof typeof PriceBillingScheme];
2493
- export declare const PriceBillingScheme: {
2494
- readonly per_unit: "per_unit";
2495
- readonly tiered: "tiered";
2496
- readonly rated: "rated";
2497
- };
2498
- /**
2499
- * `none` for a price that is not tiered, which is most of them.
2500
- *
2501
- * Otherwise `graduated` charges each band at its own rate, and `volume` charges
2502
- * everything at the rate of the band the total falls in.
2134
+ * How a ladder is walked: `graduated` charges each band at its own rate, `volume` charges everything at the rate of the band the total falls in. `none` when not tiered.
2503
2135
  */
2504
2136
  export type PriceTiersMode = (typeof PriceTiersMode)[keyof typeof PriceTiersMode];
2505
2137
  export declare const PriceTiersMode: {
@@ -2516,7 +2148,7 @@ export declare const PriceInterval: {
2516
2148
  };
2517
2149
  export interface Tier {
2518
2150
  /**
2519
- * The upper bound of this band. Null on the last band, which has no bound.
2151
+ * The band's inclusive upper bound; null for the last band.
2520
2152
  * @nullable
2521
2153
  */
2522
2154
  up_to?: string | null;
@@ -2529,6 +2161,7 @@ export interface Price {
2529
2161
  lookup_key?: string;
2530
2162
  product: Product;
2531
2163
  plan: ObjectIdentity;
2164
+ /** For a metered price with its own amounts, the meter it charges. For a licensed price, the meter its quantity is held on. Absent otherwise. */
2532
2165
  meter_id?: string;
2533
2166
  meter?: ObjectIdentity;
2534
2167
  unit_quantity: string;
@@ -2540,39 +2173,25 @@ export interface Price {
2540
2173
  id: string;
2541
2174
  plan_id: string;
2542
2175
  currency: string;
2543
- /**
2544
- * `postpaid` charges for what is used, `prepaid` buys a period in advance, `one_time`
2545
- * charges once.
2546
- */
2547
2176
  type: PriceType;
2548
- /**
2549
- * How the amount is arrived at. `rated` means the rate depends on attributes such as
2550
- * region or machine type, and is looked up on a price list.
2551
- */
2552
- billing_scheme: PriceBillingScheme;
2177
+ usage_type: UsageType;
2178
+ /** Absent when the price delegates to a rate card, where the rate depends on attributes such as region or machine type. */
2179
+ billing_scheme?: BillingScheme;
2553
2180
  /** Present for `per_unit`. */
2554
2181
  unit_amount?: Money;
2555
- /**
2556
- * `none` for a price that is not tiered, which is most of them.
2557
- *
2558
- * Otherwise `graduated` charges each band at its own rate, and `volume` charges
2559
- * everything at the rate of the band the total falls in.
2560
- */
2182
+ /** How a ladder is walked: `graduated` charges each band at its own rate, `volume` charges everything at the rate of the band the total falls in. `none` when not tiered. */
2561
2183
  tiers_mode?: PriceTiersMode;
2562
2184
  /** Present for `tiered`, in ascending order. */
2563
2185
  tiers?: Tier[];
2564
- /** For `rated` prices, the price list the rates are read from. */
2186
+ /** Present when the price delegates to a rate card, the price list its rates are read from. */
2565
2187
  rate_card_id?: string;
2566
2188
  /** The smallest quantity that can be bought. Absent means no lower bound. */
2567
2189
  min_quantity?: string;
2568
- /**
2569
- * The largest purchasable quantity. Omitted when no maximum applies. A quantity above this limit is
2570
- * rejected with BILLING_PRICE_INVALID and field=max_quantity.
2571
- */
2190
+ /** The largest quantity that may be bought; absent when there is no limit. A larger quantity is refused with `BILLING_PRICE_INVALID` and `field` `max_quantity`. */
2572
2191
  max_quantity?: string;
2573
2192
  /** Quantities must be a multiple of this. Absent means any quantity within the bounds. */
2574
2193
  quantity_step?: string;
2575
- /** For prepaid prices, how many periods one purchase covers. */
2194
+ /** For recurring licensed prices, how many interval units one period covers. */
2576
2195
  interval_count?: number;
2577
2196
  interval: PriceInterval;
2578
2197
  setup_fee?: Money;
@@ -2582,18 +2201,20 @@ export interface PriceList {
2582
2201
  pagination: OffsetPagination;
2583
2202
  }
2584
2203
  /**
2585
- * The attributes this rate applies to, such as region and machine type.
2204
+ * The dimension values this rate applies to, such as region and machine type.
2586
2205
  */
2587
2206
  export type RateDimensions = {
2588
2207
  [key: string]: string;
2589
2208
  };
2590
2209
  /**
2591
- * `per_unit` multiplies `unit_amount`; `tiered` walks the tiers as `tiers_mode` says.
2210
+ * Licensed rates only, the period the amount buys; `none` for metered rates.
2592
2211
  */
2593
- export type RateBillingScheme = (typeof RateBillingScheme)[keyof typeof RateBillingScheme];
2594
- export declare const RateBillingScheme: {
2595
- readonly per_unit: "per_unit";
2596
- readonly tiered: "tiered";
2212
+ export type RateInterval = (typeof RateInterval)[keyof typeof RateInterval];
2213
+ export declare const RateInterval: {
2214
+ readonly none: "none";
2215
+ readonly day: "day";
2216
+ readonly month: "month";
2217
+ readonly year: "year";
2597
2218
  };
2598
2219
  /**
2599
2220
  * `graduated` charges each band at its own rate; `volume` charges everything at the rate of the band the total lands in. `none` for a `per_unit` rate.
@@ -2606,22 +2227,24 @@ export declare const RateTiersMode: {
2606
2227
  };
2607
2228
  export interface Rate {
2608
2229
  meter: ObjectIdentity;
2609
- /** The unit readings arrive in, such as `core-second`. */
2230
+ /** The unit readings are reported in, such as `core-second`. */
2610
2231
  unit?: string;
2611
- /** The attributes this rate applies to, such as region and machine type. */
2232
+ /** The dimension values this rate applies to, such as region and machine type. */
2612
2233
  dimensions: RateDimensions;
2613
- /** `per_unit` multiplies `unit_amount`; `tiered` walks the tiers as `tiers_mode` says. */
2614
- billing_scheme: RateBillingScheme;
2234
+ billing_scheme: BillingScheme;
2235
+ /** `metered` prices usage; `licensed` prices holding a quantity for one period. */
2236
+ usage_type: UsageType;
2237
+ /** Licensed rates only, the period the amount buys; `none` for metered rates. */
2238
+ interval: RateInterval;
2239
+ /** @nullable */
2240
+ interval_count?: number | null;
2615
2241
  /** `graduated` charges each band at its own rate; `volume` charges everything at the rate of the band the total lands in. `none` for a `per_unit` rate. */
2616
2242
  tiers_mode: RateTiersMode;
2617
2243
  /** Present for `per_unit`. Tiered rates carry their amounts on the tiers. */
2618
2244
  unit_amount?: Money;
2619
2245
  /** Present for a tiered rate, in ascending order. */
2620
2246
  tiers?: Tier[];
2621
- /**
2622
- * How many measured units one amount covers. An hourly rate on a per-second meter is
2623
- * `"3600"`.
2624
- */
2247
+ /** How many measured units one amount covers; an hourly rate on a per-second meter is `"3600"`. */
2625
2248
  unit_quantity?: string;
2626
2249
  currency: string;
2627
2250
  effective_from: string;
@@ -2632,15 +2255,6 @@ export interface RateList {
2632
2255
  items: Rate[];
2633
2256
  pagination: OffsetPagination;
2634
2257
  }
2635
- /**
2636
- * Narrows the selection when a plan offers more than one charge type.
2637
- */
2638
- export type QuoteItemInputPriceType = (typeof QuoteItemInputPriceType)[keyof typeof QuoteItemInputPriceType];
2639
- export declare const QuoteItemInputPriceType: {
2640
- readonly postpaid: "postpaid";
2641
- readonly prepaid: "prepaid";
2642
- readonly one_time: "one_time";
2643
- };
2644
2258
  export type QuoteItemInputInterval = (typeof QuoteItemInputInterval)[keyof typeof QuoteItemInputInterval];
2645
2259
  export declare const QuoteItemInputInterval: {
2646
2260
  readonly none: "none";
@@ -2649,23 +2263,13 @@ export declare const QuoteItemInputInterval: {
2649
2263
  readonly year: "year";
2650
2264
  };
2651
2265
  /**
2652
- * The attributes the price depends on — region, instance type, token class.
2653
- *
2654
- * Required when the price draws its rates from a price list, which is how anything
2655
- * sold by region or by machine type is priced. A price that carries a single unit
2656
- * amount, or a ladder, has no attributes to give and takes none.
2657
- *
2658
- * Every attribute the meter declares must be present. A combination with no rate
2659
- * covering it is refused rather than priced at zero.
2266
+ * The dimension values the rate depends on, such as region, instance type or token kind: those of the usage for a metered estimate, and those of what is bought for a licensed price on a rate card. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused rather than priced at zero.
2660
2267
  */
2661
2268
  export type QuoteItemInputDimensions = {
2662
2269
  [key: string]: string;
2663
2270
  };
2664
2271
  /**
2665
- * Identify a price directly, or select a price for a plan. For each resource give its ID or lookup
2666
- * key, never both. Lookup keys require product_id. Meter, dimensions or duration_seconds request a
2667
- * postpaid usage estimate. Such an estimate cannot be combined with a promotion code or treated as a
2668
- * checkout amount. Without a usage estimate, a postpaid item includes only any setup charge.
2272
+ * Identify a price, or select one for a plan; give each resource's ID or lookup key, never both, and product_id with lookup keys. For a metered price, a meter or duration_seconds requests a usage estimate, which cannot be combined with a promotion code and is not a checkout amount. Without one, a metered item includes only any setup charge.
2669
2273
  */
2670
2274
  export interface QuoteItemInput {
2671
2275
  /**
@@ -2681,12 +2285,14 @@ export interface QuoteItemInput {
2681
2285
  price_id?: string;
2682
2286
  product_id?: ProductID;
2683
2287
  plan_id?: string;
2684
- /** Narrows the selection when a plan offers more than one charge type. */
2685
- price_type?: QuoteItemInputPriceType;
2288
+ /** Narrows the selection when a plan offers more than one price type. */
2289
+ price_type?: PriceType;
2290
+ /** Narrows the selection when a plan offers more than one usage type. */
2291
+ usage_type?: UsageType;
2686
2292
  interval?: QuoteItemInputInterval;
2687
2293
  /** @minimum 1 */
2688
2294
  interval_count?: number;
2689
- /** Selects among prepaid prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily. */
2295
+ /** Selects among licensed prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily. */
2690
2296
  termination_policy?: TerminationPolicy;
2691
2297
  /** @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]))))))))))$ */
2692
2298
  quantity: string;
@@ -2696,36 +2302,37 @@ export interface QuoteItemInput {
2696
2302
  * @maxLength 128
2697
2303
  */
2698
2304
  meter_lookup_key?: string;
2699
- /**
2700
- * The attributes the price depends on — region, instance type, token class.
2701
- *
2702
- * Required when the price draws its rates from a price list, which is how anything
2703
- * sold by region or by machine type is priced. A price that carries a single unit
2704
- * amount, or a ladder, has no attributes to give and takes none.
2705
- *
2706
- * Every attribute the meter declares must be present. A combination with no rate
2707
- * covering it is refused rather than priced at zero.
2708
- */
2305
+ /** The dimension values the rate depends on, such as region, instance type or token kind: those of the usage for a metered estimate, and those of what is bought for a licensed price on a rate card. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused rather than priced at zero. */
2709
2306
  dimensions?: QuoteItemInputDimensions;
2710
- /**
2711
- * For metered items, how long to price for. This allows an estimate such as "about
2712
- * this much per month" to be shown before anything exists. The priced quantity is
2713
- * `quantity` multiplied by this duration.
2714
- */
2307
+ /** For a metered estimate, how long to price for, in seconds; the priced quantity is `quantity` times this duration. */
2715
2308
  duration_seconds?: number;
2716
2309
  }
2310
+ /**
2311
+ * The values of the meter's presentation dimensions, present only when grouped by meter.
2312
+ */
2313
+ export type SpendRowDimensions = {
2314
+ [key: string]: string;
2315
+ };
2717
2316
  export interface SpendRow {
2718
2317
  product?: Product;
2719
2318
  plan_id?: string;
2720
2319
  plan_name?: string;
2721
2320
  /** Present only when grouped by resource. */
2722
2321
  resource_id?: string;
2322
+ /** Present only when grouped by meter. */
2323
+ meter?: ObjectIdentity;
2324
+ /** Present only when grouped by meter. */
2325
+ unit?: string;
2326
+ /** Net usage quantity, present only when grouped by meter. */
2327
+ quantity?: string;
2328
+ /** The values of the meter's presentation dimensions, present only when grouped by meter. */
2329
+ dimensions?: SpendRowDimensions;
2723
2330
  amount: Money;
2724
2331
  currency: string;
2725
2332
  }
2726
2333
  export interface SpendRowList {
2727
2334
  items: SpendRow[];
2728
- /** The sum over the whole period, not only the page returned. */
2335
+ /** The total over all matching groups, not only the page returned. */
2729
2336
  total: Money;
2730
2337
  currency: string;
2731
2338
  pagination: OffsetPagination;
@@ -2741,28 +2348,28 @@ export declare const ActiveResourceStatus: {
2741
2348
  readonly closed: "closed";
2742
2349
  };
2743
2350
  /**
2744
- * A resource currently accruing charges by the second.
2351
+ * A resource charged continuously by the second.
2745
2352
  */
2746
2353
  export interface ActiveResource {
2747
2354
  id: string;
2748
2355
  ended_at?: string;
2749
2356
  suspended_at?: string;
2750
2357
  state_changed_at?: string;
2751
- /** The postpaid subscription charged for this metering record, including shared services. */
2358
+ /** The metered subscription charged for this metering record. */
2752
2359
  subscription_id: string;
2753
2360
  resource_id: string;
2754
2361
  product: Product;
2755
- /** What it is, as its own service names it. */
2362
+ /** The resource type, as the owning service names it. */
2756
2363
  resource_type?: string;
2757
2364
  meter: ObjectIdentity;
2758
2365
  unit?: string;
2759
- /** How much is held — cores, MiB, cards. Not how much has been used. */
2366
+ /** How much is held, such as cores, MiB or cards; not how much was used. */
2760
2367
  quantity: string;
2761
2368
  dimensions?: ActiveResourceDimensions;
2762
2369
  status: ActiveResourceStatus;
2763
2370
  started_at: string;
2764
2371
  project_id?: string;
2765
- /** Usage has been generated up to this boundary; it does not imply invoicing or payment. */
2372
+ /** Usage has been generated up to this boundary; it says nothing about invoicing or payment. */
2766
2373
  usage_generated_until: string;
2767
2374
  }
2768
2375
  export interface ActiveResourceList {
@@ -2770,7 +2377,7 @@ export interface ActiveResourceList {
2770
2377
  pagination: OffsetPagination;
2771
2378
  }
2772
2379
  /**
2773
- * An estimate of the refundable value of one order or selected items. This does not cancel the order, stop service or create a refund.
2380
+ * An estimate of the refundable value of an order or selected items; nothing is canceled or refunded.
2774
2381
  */
2775
2382
  export interface OrderRefundQuoteInput {
2776
2383
  order_id: string;
@@ -2782,33 +2389,24 @@ export interface OrderRefundQuoteInput {
2782
2389
  order_item_ids?: string[];
2783
2390
  }
2784
2391
  /**
2785
- * "Quote exactly one target: proposed items, an existing order, renewals, a cancellation or an order
2786
- * refund. All targets use the specified billing account. Nothing is saved, charged, reserved or
2787
- * canceled. Promotion codes apply only to a purchase basket or an existing order. An invalid
2788
- * combination returns BILLING_PURCHASE_INVALID with the offending field."
2392
+ * Quote exactly one target for the billing account: proposed items, an existing order, renewals, a cancellation or an order refund. Promotion codes apply only to proposed items or an existing order. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.
2789
2393
  */
2790
2394
  export interface QuoteRequest {
2791
2395
  /**
2792
- * The billing account to price for. It must belong to you. Existing orders must have been purchased
2793
- * with this account; renewals and cancellations must currently be paid for by it.
2396
+ * The billing account to price for; it must be yours. Existing orders must have been placed with it, and renewals and cancellations must currently be paid by it.
2794
2397
  * @minimum 1
2795
2398
  */
2796
2399
  billing_account_id: number;
2797
2400
  /**
2798
- * A proposed purchase priced in the account currency. Metered items may estimate specified usage
2799
- * quantities; those estimates are not amounts collectible at checkout.
2401
+ * A proposed purchase priced in the account's currency. Metered items may include usage estimates, which are not checkout amounts.
2800
2402
  * @minItems 1
2801
2403
  * @maxItems 100
2802
2404
  */
2803
2405
  items?: QuoteItemInput[];
2804
- /**
2805
- * Preview paying this existing order. Its recorded purchase terms supply every line, and an order
2806
- * whose terms are fixed returns its recorded amounts. A preview does not change the order.
2807
- */
2406
+ /** Preview paying this order. Its recorded terms supply every line, and an order whose terms are fixed returns its recorded amounts. The order does not change. */
2808
2407
  order_id?: string;
2809
2408
  /**
2810
- * Preview renewing these subscriptions, each at most once. Each entry represents a separate
2811
- * renewal order. To preview a new promotion code, create a renewal order and quote it by order_id.
2409
+ * Preview renewing these subscriptions, each at most once; each entry is a separate renewal order. To preview a promotion code, create a renewal order and quote it by order_id.
2812
2410
  * @minItems 1
2813
2411
  * @maxItems 100
2814
2412
  */
@@ -2847,7 +2445,7 @@ export declare const WithdrawalItemStatus: {
2847
2445
  readonly reversed: "reversed";
2848
2446
  };
2849
2447
  /**
2850
- * The original top-up and its refund destination. Card details are included when the original payment method was saved; missing card details do not change the original refund route.
2448
+ * The original top-up and where its refund goes. Card details are included when the original payment method was saved.
2851
2449
  */
2852
2450
  export interface WithdrawalSource {
2853
2451
  /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
@@ -2865,7 +2463,7 @@ export interface WithdrawalSource {
2865
2463
  card_last4?: string;
2866
2464
  }
2867
2465
  /**
2868
- * The fixed principal deduction, withdrawal fee and exact refund obligation for one original top-up. Each item has its own refund; payment_gateway and method_type identify the original route.
2466
+ * For one original top-up: the principal deducted, the withdrawal fee and the amount refunded, through its own refund. payment_gateway and method_type identify the original route.
2869
2467
  */
2870
2468
  export interface WithdrawalItem {
2871
2469
  source_transaction_id: string;
@@ -2890,7 +2488,7 @@ export interface WithdrawalItem {
2890
2488
  payment_gateway: string;
2891
2489
  method_type: string;
2892
2490
  source: WithdrawalSource;
2893
- /** The original gateway failure code when a refund failed, or refund_reversed when a completed refund was reversed. Absent while pending or successful. */
2491
+ /** The gateway's failure code when a refund failed, or `refund_reversed` when a completed refund was reversed. Absent while pending or successful. */
2894
2492
  failure_code?: string;
2895
2493
  }
2896
2494
  export type WithdrawalStatus = (typeof WithdrawalStatus)[keyof typeof WithdrawalStatus];
@@ -2903,7 +2501,7 @@ export declare const WithdrawalStatus: {
2903
2501
  readonly reversed: "reversed";
2904
2502
  };
2905
2503
  /**
2906
- * An account withdrawal to the original payment methods of its unused top-ups. Accepted amounts are fixed. deducted_amount, settled_amount and charged_fee_amount report completed source items. Failed items release their principal and fee reservations; successful items are retained when another source fails.
2504
+ * A withdrawal of account balance to the original payment methods of its unused top-ups. Accepted amounts are fixed. deducted_amount, settled_amount and charged_fee_amount cover completed items. A failed item releases its principal and fee; successful items stand when another item fails.
2907
2505
  */
2908
2506
  export interface Withdrawal {
2909
2507
  id: string;
@@ -2928,7 +2526,7 @@ export interface Withdrawal {
2928
2526
  status: WithdrawalStatus;
2929
2527
  created_at: string;
2930
2528
  completed_at?: string;
2931
- /** Identity that submitted this withdrawal. It can differ from the billing account owner. */
2529
+ /** Who submitted the withdrawal; may differ from the account owner. */
2932
2530
  created_by?: string;
2933
2531
  }
2934
2532
  export interface WithdrawalPreviewItem {
@@ -2986,9 +2584,7 @@ export interface WithdrawalItemList {
2986
2584
  pagination: OffsetPagination;
2987
2585
  }
2988
2586
  /**
2989
- * How tax applies to the customer, as in Stripe. `none` taxes normally. `exempt` charges no tax.
2990
- * `reverse` charges no tax and leaves it to the customer under the reverse-charge mechanism;
2991
- * invoices state this. Only operators change it.
2587
+ * How tax applies to the customer, as in Stripe: `none` taxes normally, `exempt` charges no tax, `reverse` charges no tax under the reverse-charge mechanism, stated on invoices. Only operators change it.
2992
2588
  */
2993
2589
  export type ContactTaxExempt = (typeof ContactTaxExempt)[keyof typeof ContactTaxExempt];
2994
2590
  export declare const ContactTaxExempt: {
@@ -2997,7 +2593,7 @@ export declare const ContactTaxExempt: {
2997
2593
  readonly reverse: "reverse";
2998
2594
  };
2999
2595
  /**
3000
- * A billing-account contact profile with one address. An account can hold multiple contacts; this is not a login identity.
2596
+ * A contact of a billing account with one address. An account can hold several; a contact is not a login.
3001
2597
  */
3002
2598
  export interface Contact {
3003
2599
  id: string;
@@ -3025,11 +2621,7 @@ export interface Contact {
3025
2621
  address_postal_code?: string;
3026
2622
  /** @pattern ^([A-Z]{2})?$ */
3027
2623
  address_country?: string;
3028
- /**
3029
- * How tax applies to the customer, as in Stripe. `none` taxes normally. `exempt` charges no tax.
3030
- * `reverse` charges no tax and leaves it to the customer under the reverse-charge mechanism;
3031
- * invoices state this. Only operators change it.
3032
- */
2624
+ /** How tax applies to the customer, as in Stripe: `none` taxes normally, `exempt` charges no tax, `reverse` charges no tax under the reverse-charge mechanism, stated on invoices. Only operators change it. */
3033
2625
  tax_exempt: ContactTaxExempt;
3034
2626
  active: boolean;
3035
2627
  created_at: string;
@@ -3105,14 +2697,14 @@ export interface StatementAmounts {
3105
2697
  total: Money;
3106
2698
  }
3107
2699
  /**
3108
- * One billing account's usage billing for one UTC calendar month, summed over the month's statements. It is a summary, not something to pay; each closing's invoice is collected on its own.
2700
+ * One billing account's usage billing for one UTC calendar month, summed over its statements. Not payable itself; each statement's invoice is collected on its own.
3109
2701
  */
3110
2702
  export interface MonthlyStatement {
3111
2703
  billing_account_id: number;
3112
2704
  currency: string;
3113
2705
  period_start: string;
3114
2706
  period_end: string;
3115
- /** True after the period's final closing, which applies minimum charges for the whole month. Usage priced later is still billed in supplement statements and added here. */
2707
+ /** True after the period's final closing, which applies the month's minimum charges. Usage priced later is billed in supplement statements and added here. */
3116
2708
  finalized: boolean;
3117
2709
  finalized_at?: string;
3118
2710
  /** Statements of the period, including the open one. */
@@ -3135,7 +2727,7 @@ export declare const StatementStatus: {
3135
2727
  readonly closed: "closed";
3136
2728
  };
3137
2729
  /**
3138
- * interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.
2730
+ * `interim`: a closing before the period's usage is final, without minimum charges. `final`: the first closing after the period ended and its late usage was settled, applying the period's minimum charges. `supplement`: a closing after the final one, for usage priced late. An open statement is interim.
3139
2731
  */
3140
2732
  export type StatementType = (typeof StatementType)[keyof typeof StatementType];
3141
2733
  export declare const StatementType: {
@@ -3144,7 +2736,7 @@ export declare const StatementType: {
3144
2736
  readonly supplement: "supplement";
3145
2737
  };
3146
2738
  /**
3147
- * An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.
2739
+ * An account's consumption for one billing period up to one closing. Usage is invoiced after every settlement run, about hourly: each closing issues an invoice for the usage priced since the previous one and collects it from credits and balance, and later usage goes into the next statement of the same period. A closed statement does not change. The period's consumption is the sum of its statements.
3148
2740
  */
3149
2741
  export interface Statement {
3150
2742
  id: string;
@@ -3156,7 +2748,7 @@ export interface Statement {
3156
2748
  sequence: number;
3157
2749
  status: StatementStatus;
3158
2750
  type: StatementType;
3159
- /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
2751
+ /** True while the statement is open. The estimate prices the period's usage so far at tier prices and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's charges is credited to the period's earlier invoices at closing. */
3160
2752
  estimated: boolean;
3161
2753
  amounts: StatementAmounts;
3162
2754
  closed_at?: string;
@@ -3170,11 +2762,19 @@ export interface StatementList {
3170
2762
  items: Statement[];
3171
2763
  pagination: OffsetPagination;
3172
2764
  }
2765
+ /**
2766
+ * The values of the meter's presentation dimensions, such as the model and token kind. Included only when grouping by meter, which splits each meter by these values.
2767
+ */
2768
+ export type StatementItemDimensions = {
2769
+ [key: string]: string;
2770
+ };
3173
2771
  export interface StatementItem {
3174
2772
  project_id?: string;
3175
2773
  product_id?: string;
3176
2774
  meter_id?: string;
3177
2775
  unit?: string;
2776
+ /** The values of the meter's presentation dimensions, such as the model and token kind. Included only when grouping by meter, which splits each meter by these values. */
2777
+ dimensions?: StatementItemDimensions;
3178
2778
  /** Net usage quantity. Included only when grouping by meter. */
3179
2779
  quantity?: string;
3180
2780
  deducted_quantity?: string;
@@ -3200,7 +2800,7 @@ export interface StatementSummary {
3200
2800
  */
3201
2801
  export type ErrorResponse = Error;
3202
2802
  /**
3203
- * Unchanged since the `ETag` that was sent. No body.
2803
+ * Unchanged since the given `ETag`; no body.
3204
2804
  */
3205
2805
  export type NotModifiedResponse = void;
3206
2806
  export type FromParameter = string;
@@ -3209,14 +2809,11 @@ export type FromParameter = string;
3209
2809
  */
3210
2810
  export type ToParameter = string;
3211
2811
  /**
3212
- * Restrict to one of your accounts. All of them when omitted.
2812
+ * Only this account of yours; all when omitted.
3213
2813
  */
3214
2814
  export type AccountIdQueryParameter = number;
3215
2815
  /**
3216
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3217
- * answer is `304` with no body.
3218
- *
3219
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
2816
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3220
2817
  */
3221
2818
  export type IfNoneMatchParameter = string;
3222
2819
  export type FromRequiredParameter = string;
@@ -3225,7 +2822,7 @@ export type FromRequiredParameter = string;
3225
2822
  */
3226
2823
  export type ToRequiredParameter = string;
3227
2824
  /**
3228
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
2825
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3229
2826
  */
3230
2827
  export type ProjectIdsQueryParameter = string[];
3231
2828
  export type ListWithdrawalItemsParams = {
@@ -3328,7 +2925,7 @@ export type ListProjectAssignmentsParams = {
3328
2925
  page_size?: number;
3329
2926
  billing_account_id?: number;
3330
2927
  /**
3331
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
2928
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3332
2929
  * @minItems 1
3333
2930
  * @maxItems 100
3334
2931
  */
@@ -3348,7 +2945,7 @@ export type ListTopUpsParams = {
3348
2945
  */
3349
2946
  page_size?: number;
3350
2947
  /**
3351
- * Restrict to one of your accounts. All of them when omitted.
2948
+ * Only this account of yours; all when omitted.
3352
2949
  */
3353
2950
  billing_account_id?: AccountIdQueryParameter;
3354
2951
  };
@@ -3366,13 +2963,13 @@ export type ListPaymentMethodsParams = {
3366
2963
  */
3367
2964
  page_size?: number;
3368
2965
  /**
3369
- * Restrict to one of your accounts. All of them when omitted.
2966
+ * Only this account of yours; all when omitted.
3370
2967
  */
3371
2968
  billing_account_id?: AccountIdQueryParameter;
3372
2969
  };
3373
2970
  export type PreviewInvoicePaymentParams = {
3374
2971
  /**
3375
- * As in paying. Considered only while the order's terms are not yet fixed.
2972
+ * As in paying; used only while the order's terms are not fixed.
3376
2973
  * @minLength 1
3377
2974
  * @maxLength 64
3378
2975
  */
@@ -3400,12 +2997,12 @@ export type ListInvoicesParams = {
3400
2997
  */
3401
2998
  page_size?: number;
3402
2999
  /**
3403
- * Restrict to one of your accounts. All of them when omitted.
3000
+ * Only this account of yours; all when omitted.
3404
3001
  */
3405
3002
  billing_account_id?: AccountIdQueryParameter;
3406
3003
  status?: InvoiceStatus;
3407
3004
  /**
3408
- * Only invoices containing a charge from this subscription. The returned invoice amount is the total for the whole invoice.
3005
+ * Only invoices with a charge from this subscription; amounts are for the whole invoice.
3409
3006
  */
3410
3007
  subscription_id?: string;
3411
3008
  from?: FromParameter;
@@ -3442,7 +3039,7 @@ export type ListTransactionsParams = {
3442
3039
  */
3443
3040
  page_size?: number;
3444
3041
  /**
3445
- * Restrict to one of your accounts. All of them when omitted.
3042
+ * Only this account of yours; all when omitted.
3446
3043
  */
3447
3044
  billing_account_id?: AccountIdQueryParameter;
3448
3045
  from?: FromParameter;
@@ -3465,7 +3062,7 @@ export type ListAccountDiscountsParams = {
3465
3062
  */
3466
3063
  page_size?: number;
3467
3064
  /**
3468
- * Restrict to one of your accounts. All of them when omitted.
3065
+ * Only this account of yours; all when omitted.
3469
3066
  */
3470
3067
  billing_account_id?: AccountIdQueryParameter;
3471
3068
  };
@@ -3483,7 +3080,7 @@ export type ListCreditGrantsParams = {
3483
3080
  */
3484
3081
  page_size?: number;
3485
3082
  /**
3486
- * Restrict to one of your accounts. All of them when omitted.
3083
+ * Only this account of yours; all when omitted.
3487
3084
  */
3488
3085
  billing_account_id?: AccountIdQueryParameter;
3489
3086
  status?: ListCreditGrantsStatus;
@@ -3509,7 +3106,7 @@ export type ListCreditNotesParams = {
3509
3106
  */
3510
3107
  page_size?: number;
3511
3108
  /**
3512
- * Restrict to one of your accounts. All of them when omitted.
3109
+ * Only this account of yours; all when omitted.
3513
3110
  */
3514
3111
  billing_account_id?: AccountIdQueryParameter;
3515
3112
  /**
@@ -3545,7 +3142,7 @@ export type ListRefundsParams = {
3545
3142
  */
3546
3143
  page_size?: number;
3547
3144
  /**
3548
- * Restrict to one of your accounts. All of them when omitted.
3145
+ * Only this account of yours; all when omitted.
3549
3146
  */
3550
3147
  billing_account_id?: AccountIdQueryParameter;
3551
3148
  /**
@@ -3553,9 +3150,7 @@ export type ListRefundsParams = {
3553
3150
  */
3554
3151
  invoice_id?: string;
3555
3152
  /**
3556
- * Only the refunds that belong to this order: those of its invoice, such as the refund of a
3557
- * purchase that could not be delivered, and those it caused on an earlier invoice, such as
3558
- * the difference returned after a downgrade.
3153
+ * Refunds of this order: those of its invoice, such as for an undeliverable purchase, and those it caused on an earlier invoice, such as a downgrade difference.
3559
3154
  */
3560
3155
  order_id?: string;
3561
3156
  };
@@ -3573,7 +3168,7 @@ export type ListUsageChargesParams = {
3573
3168
  */
3574
3169
  page_size?: number;
3575
3170
  /**
3576
- * Restrict to one of your accounts. All of them when omitted.
3171
+ * Only this account of yours; all when omitted.
3577
3172
  */
3578
3173
  billing_account_id?: AccountIdQueryParameter;
3579
3174
  product_id?: ProductID;
@@ -3588,7 +3183,7 @@ export type ListUsageChargesParams = {
3588
3183
  */
3589
3184
  to?: ToParameter;
3590
3185
  /**
3591
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3186
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3592
3187
  * @minItems 1
3593
3188
  * @maxItems 100
3594
3189
  */
@@ -3611,11 +3206,11 @@ export type ListSubscriptionsParams = {
3611
3206
  */
3612
3207
  page_size?: number;
3613
3208
  /**
3614
- * Restrict to one of your accounts. All of them when omitted.
3209
+ * Only this account of yours; all when omitted.
3615
3210
  */
3616
3211
  billing_account_id?: AccountIdQueryParameter;
3617
3212
  /**
3618
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3213
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3619
3214
  * @minItems 1
3620
3215
  * @maxItems 100
3621
3216
  */
@@ -3635,7 +3230,7 @@ export type ListCancellationsParams = {
3635
3230
  */
3636
3231
  page_size?: number;
3637
3232
  /**
3638
- * Restrict to one of your accounts. All of them when omitted.
3233
+ * Only this account of yours; all when omitted.
3639
3234
  */
3640
3235
  billing_account_id?: AccountIdQueryParameter;
3641
3236
  /**
@@ -3647,7 +3242,7 @@ export type ListCancellationsParams = {
3647
3242
  */
3648
3243
  status?: ListCancellationsStatus;
3649
3244
  /**
3650
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3245
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3651
3246
  * @minItems 1
3652
3247
  * @maxItems 100
3653
3248
  */
@@ -3691,7 +3286,7 @@ export type ListAllowancesParams = {
3691
3286
  */
3692
3287
  page_size?: number;
3693
3288
  /**
3694
- * Restrict to one of your accounts. All of them when omitted.
3289
+ * Only this account of yours; all when omitted.
3695
3290
  */
3696
3291
  billing_account_id?: AccountIdQueryParameter;
3697
3292
  /**
@@ -3701,7 +3296,7 @@ export type ListAllowancesParams = {
3701
3296
  status?: ListAllowancesStatus;
3702
3297
  product_id?: ProductID;
3703
3298
  /**
3704
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3299
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3705
3300
  * @minItems 1
3706
3301
  * @maxItems 100
3707
3302
  */
@@ -3728,7 +3323,7 @@ export type ListOrdersParams = {
3728
3323
  */
3729
3324
  page_size?: number;
3730
3325
  /**
3731
- * Restrict to one of your accounts. All of them when omitted.
3326
+ * Only this account of yours; all when omitted.
3732
3327
  */
3733
3328
  billing_account_id?: AccountIdQueryParameter;
3734
3329
  status?: OrderStatus;
@@ -3738,7 +3333,7 @@ export type ListOrdersParams = {
3738
3333
  */
3739
3334
  to?: ToParameter;
3740
3335
  /**
3741
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3336
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3742
3337
  * @minItems 1
3743
3338
  * @maxItems 100
3744
3339
  */
@@ -3772,11 +3367,11 @@ export type ListEntitlementsParams = {
3772
3367
  */
3773
3368
  page_size?: number;
3774
3369
  /**
3775
- * Restrict to one of your accounts. All of them when omitted.
3370
+ * Only this account of yours; all when omitted.
3776
3371
  */
3777
3372
  billing_account_id?: AccountIdQueryParameter;
3778
3373
  /**
3779
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3374
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3780
3375
  * @minItems 1
3781
3376
  * @maxItems 100
3782
3377
  */
@@ -3797,7 +3392,7 @@ export type ListFeatureGrantsParams = {
3797
3392
  */
3798
3393
  page_size?: number;
3799
3394
  /**
3800
- * Restrict to one of your accounts. All of them when omitted.
3395
+ * Only this account of yours; all when omitted.
3801
3396
  */
3802
3397
  billing_account_id?: AccountIdQueryParameter;
3803
3398
  product_id?: ProductID;
@@ -3824,22 +3419,17 @@ export type ListPricesParams = {
3824
3419
  currency: string;
3825
3420
  product_id?: ProductID;
3826
3421
  /**
3827
- * Narrows to one payment timing.
3422
+ * Narrows to one price type.
3828
3423
  */
3829
- type?: ListPricesType;
3830
- };
3831
- export type ListPricesType = (typeof ListPricesType)[keyof typeof ListPricesType];
3832
- export declare const ListPricesType: {
3833
- readonly postpaid: "postpaid";
3834
- readonly prepaid: "prepaid";
3835
- readonly one_time: "one_time";
3424
+ type?: PriceType;
3425
+ /**
3426
+ * Narrows to one usage type.
3427
+ */
3428
+ usage_type?: UsageType;
3836
3429
  };
3837
3430
  export type ListPricesHeaders = {
3838
3431
  /**
3839
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3840
- * answer is `304` with no body.
3841
- *
3842
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3432
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3843
3433
  */
3844
3434
  "If-None-Match"?: IfNoneMatchParameter;
3845
3435
  };
@@ -3859,37 +3449,25 @@ export type ListProductsParams = {
3859
3449
  };
3860
3450
  export type ListProductsHeaders = {
3861
3451
  /**
3862
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3863
- * answer is `304` with no body.
3864
- *
3865
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3452
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3866
3453
  */
3867
3454
  "If-None-Match"?: IfNoneMatchParameter;
3868
3455
  };
3869
3456
  export type GetProductHeaders = {
3870
3457
  /**
3871
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3872
- * answer is `304` with no body.
3873
- *
3874
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3458
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3875
3459
  */
3876
3460
  "If-None-Match"?: IfNoneMatchParameter;
3877
3461
  };
3878
3462
  export type GetPlanHeaders = {
3879
3463
  /**
3880
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3881
- * answer is `304` with no body.
3882
- *
3883
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3464
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3884
3465
  */
3885
3466
  "If-None-Match"?: IfNoneMatchParameter;
3886
3467
  };
3887
3468
  export type GetPriceHeaders = {
3888
3469
  /**
3889
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3890
- * answer is `304` with no body.
3891
- *
3892
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3470
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3893
3471
  */
3894
3472
  "If-None-Match"?: IfNoneMatchParameter;
3895
3473
  };
@@ -3910,10 +3488,7 @@ export type ListPlansParams = {
3910
3488
  };
3911
3489
  export type ListPlansHeaders = {
3912
3490
  /**
3913
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3914
- * answer is `304` with no body.
3915
- *
3916
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3491
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3917
3492
  */
3918
3493
  "If-None-Match"?: IfNoneMatchParameter;
3919
3494
  };
@@ -3934,10 +3509,7 @@ export type ListPricesByPlanParams = {
3934
3509
  };
3935
3510
  export type ListPricesByPlanHeaders = {
3936
3511
  /**
3937
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3938
- * answer is `304` with no body.
3939
- *
3940
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3512
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3941
3513
  */
3942
3514
  "If-None-Match"?: IfNoneMatchParameter;
3943
3515
  };
@@ -3959,16 +3531,13 @@ export type ListRatesParams = {
3959
3531
  */
3960
3532
  meter_id?: string;
3961
3533
  /**
3962
- * Return the rates in effect at this moment. Defaults to now.
3534
+ * Rates in effect at this moment; defaults to now.
3963
3535
  */
3964
3536
  at?: string;
3965
3537
  };
3966
3538
  export type ListRatesHeaders = {
3967
3539
  /**
3968
- * The `ETag` from an earlier reply. When the catalogue has not changed since, the
3969
- * answer is `304` with no body.
3970
- *
3971
- * Send it on every catalogue read. An unchanged catalogue is answered without a body.
3540
+ * The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body.
3972
3541
  */
3973
3542
  "If-None-Match"?: IfNoneMatchParameter;
3974
3543
  };
@@ -3987,11 +3556,11 @@ export type ListActiveResourcesParams = {
3987
3556
  page_size?: number;
3988
3557
  resource_id?: string;
3989
3558
  /**
3990
- * Restrict to one of your accounts. All of them when omitted.
3559
+ * Only this account of yours; all when omitted.
3991
3560
  */
3992
3561
  billing_account_id?: AccountIdQueryParameter;
3993
3562
  /**
3994
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3563
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
3995
3564
  * @minItems 1
3996
3565
  * @maxItems 100
3997
3566
  */
@@ -4014,11 +3583,7 @@ export type ListSpendParams = {
4014
3583
  */
4015
3584
  to: ToRequiredParameter;
4016
3585
  /**
4017
- * `plan` groups by the plan of the price each charge was priced with, which stays the same after the
4018
- * subscription changes plan. `resource` groups by the resource each charge names. Items billed under their own
4019
- * identifier — a disk, a public address — appear as their own rows rather than under
4020
- * the machine they are attached to, since the relationship between them is known to
4021
- * the owning service and not here.
3586
+ * `plan` groups by the plan of the price each charge was priced with, unchanged after the subscription changes plan. `resource` groups by the resource each charge names; a disk or an address billed under its own identifier is its own row. `meter` groups by meter and the values of its presentation dimensions, such as the model and token kind, and includes the quantity used.
4022
3587
  */
4023
3588
  group_by?: ListSpendGroupBy;
4024
3589
  /**
@@ -4038,11 +3603,11 @@ export type ListSpendParams = {
4038
3603
  */
4039
3604
  page_size?: number;
4040
3605
  /**
4041
- * The authorized billing account whose currency and charges are used for this report.
3606
+ * The billing account whose currency and charges the report uses; it must be authorized.
4042
3607
  */
4043
3608
  billing_account_id: number;
4044
3609
  /**
4045
- * Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account.
3610
+ * Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts.
4046
3611
  * @minItems 1
4047
3612
  * @maxItems 100
4048
3613
  */
@@ -4053,6 +3618,7 @@ export declare const ListSpendGroupBy: {
4053
3618
  readonly product: "product";
4054
3619
  readonly plan: "plan";
4055
3620
  readonly resource: "resource";
3621
+ readonly meter: "meter";
4056
3622
  };
4057
3623
  export type ListMonthlyStatementsParams = {
4058
3624
  billing_account_id?: number;