@leaflow/sdk 0.0.0-dev.352.g85966ed → 0.0.0-dev.353.g74313e0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/billing/type/funds/v1/generated/models.d.ts +4 -4
- package/dist/billing/type/funds/v1/generated/validators/funds.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/models.d.ts +375 -779
- package/dist/billing/type/order/v1/generated/models.js +12 -44
- package/dist/billing/type/order/v1/generated/validators/accountBalance.zod.d.ts +22 -11
- package/dist/billing/type/order/v1/generated/validators/accountBalance.zod.js +8 -8
- package/dist/billing/type/order/v1/generated/validators/activeResource.zod.js +8 -5
- package/dist/billing/type/order/v1/generated/validators/allowance.zod.js +3 -3
- package/dist/billing/type/order/v1/generated/validators/applicability.zod.d.ts +22 -11
- package/dist/billing/type/order/v1/generated/validators/applicability.zod.js +12 -3
- package/dist/billing/type/order/v1/generated/validators/applicablePlan.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/billingAccount.zod.js +5 -5
- package/dist/billing/type/order/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/billingScheme.zod.d.ts +14 -0
- package/dist/billing/type/order/v1/generated/validators/billingScheme.zod.js +11 -0
- package/dist/billing/type/order/v1/generated/validators/cancellation.zod.d.ts +6 -3
- package/dist/billing/type/order/v1/generated/validators/cancellation.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/cancellationCreate.zod.js +3 -3
- package/dist/billing/type/order/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
- package/dist/billing/type/order/v1/generated/validators/cancellationItem.zod.js +6 -5
- package/dist/billing/type/order/v1/generated/validators/cancellationList.zod.d.ts +6 -3
- package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
- package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
- package/dist/billing/type/order/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
- package/dist/billing/type/order/v1/generated/validators/contact.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/creditGrant.zod.d.ts +22 -11
- package/dist/billing/type/order/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
- package/dist/billing/type/order/v1/generated/validators/creditGroup.zod.d.ts +22 -11
- package/dist/billing/type/order/v1/generated/validators/creditGroup.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/creditNote.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/currency.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/discount.zod.d.ts +23 -12
- package/dist/billing/type/order/v1/generated/validators/discount.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/discountList.zod.d.ts +23 -12
- package/dist/billing/type/order/v1/generated/validators/entitlement.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/funds.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/invoice.zod.d.ts +0 -1
- package/dist/billing/type/order/v1/generated/validators/invoice.zod.js +8 -8
- package/dist/billing/type/order/v1/generated/validators/invoiceItem.zod.d.ts +1 -0
- package/dist/billing/type/order/v1/generated/validators/invoiceItem.zod.js +6 -4
- package/dist/billing/type/order/v1/generated/validators/invoiceItemList.zod.d.ts +1 -0
- package/dist/billing/type/order/v1/generated/validators/invoiceItemProration.zod.js +1 -3
- package/dist/billing/type/order/v1/generated/validators/invoiceList.zod.d.ts +0 -1
- package/dist/billing/type/order/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
- package/dist/billing/type/order/v1/generated/validators/invoiceStatus.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
- package/dist/billing/type/order/v1/generated/validators/invoiceSummary.zod.js +3 -3
- package/dist/billing/type/order/v1/generated/validators/monthlyStatement.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/objectIdentity.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/order.zod.d.ts +7 -4
- package/dist/billing/type/order/v1/generated/validators/order.zod.js +10 -12
- package/dist/billing/type/order/v1/generated/validators/orderItem.zod.d.ts +7 -3
- package/dist/billing/type/order/v1/generated/validators/orderItem.zod.js +16 -14
- package/dist/billing/type/order/v1/generated/validators/orderItemList.zod.d.ts +7 -3
- package/dist/billing/type/order/v1/generated/validators/orderItemStatus.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/orderList.zod.d.ts +7 -4
- package/dist/billing/type/order/v1/generated/validators/orderRefundQuote.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/orderStatus.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/paidWith.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
- package/dist/billing/type/order/v1/generated/validators/payTogetherRequest.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/paymentAction.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
- package/dist/billing/type/order/v1/generated/validators/paymentOption.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/paymentPreview.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/paymentResult.zod.js +5 -8
- package/dist/billing/type/order/v1/generated/validators/paymentStatus.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/placedOrder.zod.d.ts +0 -1
- package/dist/billing/type/order/v1/generated/validators/price.zod.d.ts +7 -5
- package/dist/billing/type/order/v1/generated/validators/price.zod.js +14 -11
- package/dist/billing/type/order/v1/generated/validators/priceList.zod.d.ts +7 -5
- package/dist/billing/type/order/v1/generated/validators/priceOption.zod.d.ts +7 -5
- package/dist/billing/type/order/v1/generated/validators/priceOption.zod.js +7 -3
- package/dist/billing/type/order/v1/generated/validators/priceType.zod.d.ts +14 -0
- package/dist/billing/type/order/v1/generated/validators/priceType.zod.js +11 -0
- package/dist/billing/type/order/v1/generated/validators/productID.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/projectAssignment.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/purchaseOperation.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/quote.zod.d.ts +6 -3
- package/dist/billing/type/order/v1/generated/validators/quote.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/quoteCancellation.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/quoteItem.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
- package/dist/billing/type/order/v1/generated/validators/quoteItemInput.zod.js +8 -8
- package/dist/billing/type/order/v1/generated/validators/quoteRenewal.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
- package/dist/billing/type/order/v1/generated/validators/quoteRequest.zod.js +5 -5
- package/dist/billing/type/order/v1/generated/validators/quotedDiscount.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/rate.zod.d.ts +11 -0
- package/dist/billing/type/order/v1/generated/validators/rate.zod.js +14 -6
- package/dist/billing/type/order/v1/generated/validators/rateList.zod.d.ts +11 -0
- package/dist/billing/type/order/v1/generated/validators/refund.zod.js +3 -3
- package/dist/billing/type/order/v1/generated/validators/refundPolicy.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/refundReason.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/renewRequest.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/renewalPrice.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/scheduledChange.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/spendRow.zod.d.ts +8 -0
- package/dist/billing/type/order/v1/generated/validators/spendRow.zod.js +11 -0
- package/dist/billing/type/order/v1/generated/validators/spendRowList.zod.d.ts +8 -0
- package/dist/billing/type/order/v1/generated/validators/spendRowList.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/statement.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/statementItem.zod.d.ts +1 -0
- package/dist/billing/type/order/v1/generated/validators/statementItem.zod.js +4 -0
- package/dist/billing/type/order/v1/generated/validators/statementSummary.zod.d.ts +1 -0
- package/dist/billing/type/order/v1/generated/validators/statementType.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/subscription.zod.d.ts +7 -3
- package/dist/billing/type/order/v1/generated/validators/subscription.zod.js +20 -14
- package/dist/billing/type/order/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
- package/dist/billing/type/order/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/terminationPolicy.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/tier.zod.js +1 -1
- package/dist/billing/type/order/v1/generated/validators/topUp.zod.js +8 -8
- package/dist/billing/type/order/v1/generated/validators/topUpCreate.zod.js +4 -4
- package/dist/billing/type/order/v1/generated/validators/transaction.zod.js +6 -6
- package/dist/billing/type/order/v1/generated/validators/usageCharge.zod.js +4 -7
- package/dist/billing/type/order/v1/generated/validators/usageType.zod.d.ts +14 -0
- package/dist/billing/type/order/v1/generated/validators/usageType.zod.js +11 -0
- package/dist/billing/type/order/v1/generated/validators/withdrawal.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/withdrawalItem.zod.js +2 -2
- package/dist/billing/type/order/v1/generated/validators/withdrawalSource.zod.js +1 -1
- package/dist/billing/type/quote/v1/generated/models.d.ts +4 -4
- package/dist/billing/type/quote/v1/generated/validators/funds.zod.js +4 -4
- package/dist/billing/v1/generated/functions.d.ts +176 -310
- package/dist/billing/v1/generated/functions.js +175 -309
- package/dist/billing/v1/generated/models.d.ts +425 -863
- package/dist/billing/v1/generated/models.js +13 -49
- package/dist/billing/v1/generated/schemas.zod.d.ts +166 -383
- package/dist/billing/v1/generated/schemas.zod.js +213 -372
- package/dist/billing/v1/generated/validators/accountBalance.zod.d.ts +22 -11
- package/dist/billing/v1/generated/validators/accountBalance.zod.js +8 -8
- package/dist/billing/v1/generated/validators/activeResource.zod.js +8 -5
- package/dist/billing/v1/generated/validators/allowance.zod.js +3 -3
- package/dist/billing/v1/generated/validators/applicability.zod.d.ts +22 -11
- package/dist/billing/v1/generated/validators/applicability.zod.js +12 -3
- package/dist/billing/v1/generated/validators/applicablePlan.zod.js +1 -1
- package/dist/billing/v1/generated/validators/billingAccount.zod.js +5 -5
- package/dist/billing/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
- package/dist/billing/v1/generated/validators/billingScheme.zod.d.ts +14 -0
- package/dist/billing/v1/generated/validators/billingScheme.zod.js +11 -0
- package/dist/billing/v1/generated/validators/cancellation.zod.d.ts +6 -3
- package/dist/billing/v1/generated/validators/cancellation.zod.js +4 -4
- package/dist/billing/v1/generated/validators/cancellationCreate.zod.js +3 -3
- package/dist/billing/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
- package/dist/billing/v1/generated/validators/cancellationItem.zod.js +6 -5
- package/dist/billing/v1/generated/validators/cancellationList.zod.d.ts +6 -3
- package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
- package/dist/billing/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
- package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
- package/dist/billing/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
- package/dist/billing/v1/generated/validators/contact.zod.js +2 -2
- package/dist/billing/v1/generated/validators/creditGrant.zod.d.ts +22 -11
- package/dist/billing/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
- package/dist/billing/v1/generated/validators/creditGroup.zod.d.ts +22 -11
- package/dist/billing/v1/generated/validators/creditGroup.zod.js +1 -1
- package/dist/billing/v1/generated/validators/creditNote.zod.js +4 -4
- package/dist/billing/v1/generated/validators/currency.zod.js +1 -1
- package/dist/billing/v1/generated/validators/discount.zod.d.ts +23 -12
- package/dist/billing/v1/generated/validators/discount.zod.js +4 -4
- package/dist/billing/v1/generated/validators/discountList.zod.d.ts +23 -12
- package/dist/billing/v1/generated/validators/entitlement.zod.js +1 -1
- package/dist/billing/v1/generated/validators/funds.zod.js +4 -4
- package/dist/billing/v1/generated/validators/invoice.zod.d.ts +0 -1
- package/dist/billing/v1/generated/validators/invoice.zod.js +8 -8
- package/dist/billing/v1/generated/validators/invoiceItem.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/invoiceItem.zod.js +6 -4
- package/dist/billing/v1/generated/validators/invoiceItemList.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/invoiceItemProration.zod.js +1 -3
- package/dist/billing/v1/generated/validators/invoiceList.zod.d.ts +0 -1
- package/dist/billing/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
- package/dist/billing/v1/generated/validators/invoiceStatus.zod.js +2 -2
- package/dist/billing/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
- package/dist/billing/v1/generated/validators/invoiceSummary.zod.js +3 -3
- package/dist/billing/v1/generated/validators/listInvoicesParams.zod.d.ts +0 -1
- package/dist/billing/v1/generated/validators/listPricesParams.zod.d.ts +5 -2
- package/dist/billing/v1/generated/validators/listPricesParams.zod.js +4 -1
- package/dist/billing/v1/generated/validators/listSpendParams.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/listSpendParams.zod.js +3 -1
- package/dist/billing/v1/generated/validators/monthlyStatement.zod.js +2 -2
- package/dist/billing/v1/generated/validators/objectIdentity.zod.js +1 -1
- package/dist/billing/v1/generated/validators/order.zod.d.ts +7 -4
- package/dist/billing/v1/generated/validators/order.zod.js +10 -12
- package/dist/billing/v1/generated/validators/orderItem.zod.d.ts +7 -3
- package/dist/billing/v1/generated/validators/orderItem.zod.js +16 -14
- package/dist/billing/v1/generated/validators/orderItemList.zod.d.ts +7 -3
- package/dist/billing/v1/generated/validators/orderItemStatus.zod.js +1 -1
- package/dist/billing/v1/generated/validators/orderList.zod.d.ts +7 -4
- package/dist/billing/v1/generated/validators/orderRefundQuote.zod.js +1 -1
- package/dist/billing/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
- package/dist/billing/v1/generated/validators/orderStatus.zod.js +1 -1
- package/dist/billing/v1/generated/validators/paidWith.zod.js +1 -1
- package/dist/billing/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
- package/dist/billing/v1/generated/validators/payTogetherRequest.zod.js +2 -2
- package/dist/billing/v1/generated/validators/paymentAction.zod.js +4 -4
- package/dist/billing/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
- package/dist/billing/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
- package/dist/billing/v1/generated/validators/paymentOption.zod.js +1 -1
- package/dist/billing/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
- package/dist/billing/v1/generated/validators/paymentPreview.zod.js +4 -4
- package/dist/billing/v1/generated/validators/paymentResult.zod.js +5 -8
- package/dist/billing/v1/generated/validators/paymentStatus.zod.js +1 -1
- package/dist/billing/v1/generated/validators/price.zod.d.ts +7 -5
- package/dist/billing/v1/generated/validators/price.zod.js +14 -11
- package/dist/billing/v1/generated/validators/priceList.zod.d.ts +7 -5
- package/dist/billing/v1/generated/validators/priceOption.zod.d.ts +7 -5
- package/dist/billing/v1/generated/validators/priceOption.zod.js +7 -3
- package/dist/billing/v1/generated/validators/priceType.zod.d.ts +14 -0
- package/dist/billing/v1/generated/validators/priceType.zod.js +11 -0
- package/dist/billing/v1/generated/validators/productID.zod.js +1 -1
- package/dist/billing/v1/generated/validators/projectAssignment.zod.js +2 -2
- package/dist/billing/v1/generated/validators/purchaseOperation.zod.js +1 -1
- package/dist/billing/v1/generated/validators/quote.zod.d.ts +6 -3
- package/dist/billing/v1/generated/validators/quote.zod.js +4 -4
- package/dist/billing/v1/generated/validators/quoteCancellation.zod.js +2 -2
- package/dist/billing/v1/generated/validators/quoteItem.zod.js +4 -4
- package/dist/billing/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
- package/dist/billing/v1/generated/validators/quoteItemInput.zod.js +8 -8
- package/dist/billing/v1/generated/validators/quoteRenewal.zod.js +1 -1
- package/dist/billing/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
- package/dist/billing/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
- package/dist/billing/v1/generated/validators/quoteRequest.zod.js +5 -5
- package/dist/billing/v1/generated/validators/quotedDiscount.zod.js +1 -1
- package/dist/billing/v1/generated/validators/rate.zod.d.ts +11 -0
- package/dist/billing/v1/generated/validators/rate.zod.js +14 -6
- package/dist/billing/v1/generated/validators/rateList.zod.d.ts +11 -0
- package/dist/billing/v1/generated/validators/refund.zod.js +3 -3
- package/dist/billing/v1/generated/validators/refundPolicy.zod.js +1 -1
- package/dist/billing/v1/generated/validators/refundReason.zod.js +1 -1
- package/dist/billing/v1/generated/validators/renewRequest.zod.js +2 -2
- package/dist/billing/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
- package/dist/billing/v1/generated/validators/renewalPrice.zod.js +1 -1
- package/dist/billing/v1/generated/validators/scheduledChange.zod.js +2 -2
- package/dist/billing/v1/generated/validators/spendRow.zod.d.ts +8 -0
- package/dist/billing/v1/generated/validators/spendRow.zod.js +11 -0
- package/dist/billing/v1/generated/validators/spendRowList.zod.d.ts +8 -0
- package/dist/billing/v1/generated/validators/spendRowList.zod.js +1 -1
- package/dist/billing/v1/generated/validators/statement.zod.js +2 -2
- package/dist/billing/v1/generated/validators/statementItem.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/statementItem.zod.js +4 -0
- package/dist/billing/v1/generated/validators/statementSummary.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/statementType.zod.js +1 -1
- package/dist/billing/v1/generated/validators/subscription.zod.d.ts +7 -3
- package/dist/billing/v1/generated/validators/subscription.zod.js +20 -14
- package/dist/billing/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
- package/dist/billing/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
- package/dist/billing/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
- package/dist/billing/v1/generated/validators/terminationPolicy.zod.js +1 -1
- package/dist/billing/v1/generated/validators/tier.zod.js +1 -1
- package/dist/billing/v1/generated/validators/topUp.zod.js +8 -8
- package/dist/billing/v1/generated/validators/topUpCreate.zod.js +4 -4
- package/dist/billing/v1/generated/validators/transaction.zod.js +6 -6
- package/dist/billing/v1/generated/validators/usageCharge.zod.js +4 -7
- package/dist/billing/v1/generated/validators/usageType.zod.d.ts +14 -0
- package/dist/billing/v1/generated/validators/usageType.zod.js +11 -0
- package/dist/billing/v1/generated/validators/withdrawal.zod.js +2 -2
- package/dist/billing/v1/generated/validators/withdrawalItem.zod.js +2 -2
- package/dist/billing/v1/generated/validators/withdrawalSource.zod.js +1 -1
- package/dist/canopy/v1/generated/models.d.ts +375 -779
- package/dist/canopy/v1/generated/models.js +12 -44
- package/dist/canopy/v1/generated/validators/accountBalance.zod.d.ts +22 -11
- package/dist/canopy/v1/generated/validators/accountBalance.zod.js +8 -8
- package/dist/canopy/v1/generated/validators/activeResource.zod.js +8 -5
- package/dist/canopy/v1/generated/validators/allowance.zod.js +3 -3
- package/dist/canopy/v1/generated/validators/applicability.zod.d.ts +22 -11
- package/dist/canopy/v1/generated/validators/applicability.zod.js +12 -3
- package/dist/canopy/v1/generated/validators/applicablePlan.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/billingAccount.zod.js +5 -5
- package/dist/canopy/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/billingScheme.zod.d.ts +39 -0
- package/dist/canopy/v1/generated/validators/billingScheme.zod.js +36 -0
- package/dist/canopy/v1/generated/validators/cancellation.zod.d.ts +6 -3
- package/dist/canopy/v1/generated/validators/cancellation.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/cancellationCreate.zod.js +3 -3
- package/dist/canopy/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
- package/dist/canopy/v1/generated/validators/cancellationItem.zod.js +6 -5
- package/dist/canopy/v1/generated/validators/cancellationList.zod.d.ts +6 -3
- package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
- package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
- package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
- package/dist/canopy/v1/generated/validators/contact.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/createServiceResponseBody.zod.d.ts +0 -1
- package/dist/canopy/v1/generated/validators/creditGrant.zod.d.ts +22 -11
- package/dist/canopy/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
- package/dist/canopy/v1/generated/validators/creditGroup.zod.d.ts +22 -11
- package/dist/canopy/v1/generated/validators/creditGroup.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/creditNote.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/currency.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/discount.zod.d.ts +23 -12
- package/dist/canopy/v1/generated/validators/discount.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/discountList.zod.d.ts +23 -12
- package/dist/canopy/v1/generated/validators/entitlement.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/funds.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/invoice.zod.d.ts +0 -1
- package/dist/canopy/v1/generated/validators/invoice.zod.js +8 -8
- package/dist/canopy/v1/generated/validators/invoiceItem.zod.d.ts +1 -0
- package/dist/canopy/v1/generated/validators/invoiceItem.zod.js +6 -4
- package/dist/canopy/v1/generated/validators/invoiceItemList.zod.d.ts +1 -0
- package/dist/canopy/v1/generated/validators/invoiceItemProration.zod.js +1 -3
- package/dist/canopy/v1/generated/validators/invoiceList.zod.d.ts +0 -1
- package/dist/canopy/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
- package/dist/canopy/v1/generated/validators/invoiceStatus.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
- package/dist/canopy/v1/generated/validators/invoiceSummary.zod.js +3 -3
- package/dist/canopy/v1/generated/validators/monthlyStatement.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/objectIdentity.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/order.zod.d.ts +7 -4
- package/dist/canopy/v1/generated/validators/order.zod.js +10 -12
- package/dist/canopy/v1/generated/validators/orderItem.zod.d.ts +7 -3
- package/dist/canopy/v1/generated/validators/orderItem.zod.js +16 -14
- package/dist/canopy/v1/generated/validators/orderItemList.zod.d.ts +7 -3
- package/dist/canopy/v1/generated/validators/orderItemStatus.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/orderList.zod.d.ts +7 -4
- package/dist/canopy/v1/generated/validators/orderRefundQuote.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/orderStatus.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/paidWith.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
- package/dist/canopy/v1/generated/validators/payTogetherRequest.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/paymentAction.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
- package/dist/canopy/v1/generated/validators/paymentOption.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/paymentPreview.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/paymentResult.zod.js +5 -8
- package/dist/canopy/v1/generated/validators/paymentStatus.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/placedOrder.zod.d.ts +0 -1
- package/dist/canopy/v1/generated/validators/price.zod.d.ts +7 -5
- package/dist/canopy/v1/generated/validators/price.zod.js +14 -11
- package/dist/canopy/v1/generated/validators/priceList.zod.d.ts +7 -5
- package/dist/canopy/v1/generated/validators/priceOption.zod.d.ts +7 -5
- package/dist/canopy/v1/generated/validators/priceOption.zod.js +7 -3
- package/dist/canopy/v1/generated/validators/priceType.zod.d.ts +39 -0
- package/dist/canopy/v1/generated/validators/priceType.zod.js +36 -0
- package/dist/canopy/v1/generated/validators/productID.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/projectAssignment.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/purchaseOperation.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/quote5f60d00.zod.d.ts +6 -3
- package/dist/canopy/v1/generated/validators/quote5f60d00.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/quoteA200529.zod.d.ts +6 -3
- package/dist/canopy/v1/generated/validators/quoteCancellation.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/quoteItem.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
- package/dist/canopy/v1/generated/validators/quoteItemInput.zod.js +8 -8
- package/dist/canopy/v1/generated/validators/quoteRenewal.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
- package/dist/canopy/v1/generated/validators/quoteRequest.zod.js +5 -5
- package/dist/canopy/v1/generated/validators/quotedDiscount.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/rate.zod.d.ts +11 -0
- package/dist/canopy/v1/generated/validators/rate.zod.js +14 -6
- package/dist/canopy/v1/generated/validators/rateList.zod.d.ts +11 -0
- package/dist/canopy/v1/generated/validators/refund.zod.js +3 -3
- package/dist/canopy/v1/generated/validators/refundPolicy.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/refundReason.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/renewRequest.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/renewalPrice.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/scheduledChange.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/spendRow.zod.d.ts +8 -0
- package/dist/canopy/v1/generated/validators/spendRow.zod.js +11 -0
- package/dist/canopy/v1/generated/validators/spendRowList.zod.d.ts +8 -0
- package/dist/canopy/v1/generated/validators/spendRowList.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/statement.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/statementItem.zod.d.ts +1 -0
- package/dist/canopy/v1/generated/validators/statementItem.zod.js +4 -0
- package/dist/canopy/v1/generated/validators/statementSummary.zod.d.ts +1 -0
- package/dist/canopy/v1/generated/validators/statementType.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/subscription.zod.d.ts +7 -3
- package/dist/canopy/v1/generated/validators/subscription.zod.js +20 -14
- package/dist/canopy/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
- package/dist/canopy/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/terminationPolicy.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/tier.zod.js +1 -1
- package/dist/canopy/v1/generated/validators/topUp.zod.js +8 -8
- package/dist/canopy/v1/generated/validators/topUpCreate.zod.js +4 -4
- package/dist/canopy/v1/generated/validators/transaction.zod.js +6 -6
- package/dist/canopy/v1/generated/validators/usageCharge.zod.js +4 -7
- package/dist/canopy/v1/generated/validators/usageType.zod.d.ts +39 -0
- package/dist/canopy/v1/generated/validators/usageType.zod.js +36 -0
- package/dist/canopy/v1/generated/validators/withdrawal.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/withdrawalItem.zod.js +2 -2
- package/dist/canopy/v1/generated/validators/withdrawalSource.zod.js +1 -1
- package/dist/compute/v1/generated/models.d.ts +4 -4
- package/dist/compute/v1/generated/schemas.zod.d.ts +18 -18
- package/dist/compute/v1/generated/validators/allocateFloatingIPQuoteRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/allocateFloatingIPRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/backupService.zod.d.ts +2 -2
- package/dist/compute/v1/generated/validators/billingChoice.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/bootDisk.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createBackupCapacityPackQuoteRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createBackupCapacityPackRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createBackupServiceResponseBody.zod.d.ts +2 -2
- package/dist/compute/v1/generated/validators/createDiskQuoteRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createDiskRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createImageQuoteRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createImageRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/diskTypeListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/diskTypeResource.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/funds.zod.js +4 -4
- package/dist/compute/v1/generated/validators/iPv4PoolListResponseBody.zod.d.ts +2 -2
- package/dist/compute/v1/generated/validators/iPv4PoolResource.zod.d.ts +2 -2
- package/dist/compute/v1/generated/validators/instanceTypeListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/instanceTypeResource.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/launchInstanceQuoteRequestBody.zod.d.ts +3 -3
- package/dist/compute/v1/generated/validators/launchInstanceRequestBody.zod.d.ts +3 -3
- package/dist/compute/v1/generated/validators/newBootDisk.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/newCompute.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/newFloatingIP.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/pricing.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/pricingOption.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/regionListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/regionResource.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/restoreBackupQuoteRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/restoreBackupRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/setSnapshotQuotaQuoteRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/setSnapshotQuotaRequestBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/setSnapshotQuotaResponseBody.zod.d.ts +2 -2
- package/dist/compute/v1/generated/validators/snapshotQuota.zod.d.ts +2 -2
- package/dist/membership/v1/generated/models.d.ts +375 -779
- package/dist/membership/v1/generated/models.js +12 -44
- package/dist/membership/v1/generated/validators/accountBalance.zod.d.ts +22 -11
- package/dist/membership/v1/generated/validators/accountBalance.zod.js +8 -8
- package/dist/membership/v1/generated/validators/activeResource.zod.js +8 -5
- package/dist/membership/v1/generated/validators/allowance.zod.js +3 -3
- package/dist/membership/v1/generated/validators/applicability.zod.d.ts +22 -11
- package/dist/membership/v1/generated/validators/applicability.zod.js +12 -3
- package/dist/membership/v1/generated/validators/applicablePlan.zod.js +1 -1
- package/dist/membership/v1/generated/validators/billingAccount.zod.js +5 -5
- package/dist/membership/v1/generated/validators/billingAccountUpdate.zod.js +1 -1
- package/dist/membership/v1/generated/validators/billingScheme.zod.d.ts +14 -0
- package/dist/membership/v1/generated/validators/billingScheme.zod.js +11 -0
- package/dist/membership/v1/generated/validators/cancellation.zod.d.ts +6 -3
- package/dist/membership/v1/generated/validators/cancellation.zod.js +4 -4
- package/dist/membership/v1/generated/validators/cancellationCreate.zod.js +3 -3
- package/dist/membership/v1/generated/validators/cancellationItem.zod.d.ts +6 -3
- package/dist/membership/v1/generated/validators/cancellationItem.zod.js +6 -5
- package/dist/membership/v1/generated/validators/cancellationList.zod.d.ts +6 -3
- package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.d.ts +6 -3
- package/dist/membership/v1/generated/validators/cancellationRefundPreview.zod.js +1 -1
- package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +6 -3
- package/dist/membership/v1/generated/validators/cancellationRefundPreviewItem.zod.js +7 -4
- package/dist/membership/v1/generated/validators/contact.zod.js +2 -2
- package/dist/membership/v1/generated/validators/creditGrant.zod.d.ts +22 -11
- package/dist/membership/v1/generated/validators/creditGrantList.zod.d.ts +22 -11
- package/dist/membership/v1/generated/validators/creditGroup.zod.d.ts +22 -11
- package/dist/membership/v1/generated/validators/creditGroup.zod.js +1 -1
- package/dist/membership/v1/generated/validators/creditNote.zod.js +4 -4
- package/dist/membership/v1/generated/validators/currency6ff0ec7.zod.js +1 -1
- package/dist/membership/v1/generated/validators/discount.zod.d.ts +23 -12
- package/dist/membership/v1/generated/validators/discount.zod.js +4 -4
- package/dist/membership/v1/generated/validators/discountList.zod.d.ts +23 -12
- package/dist/membership/v1/generated/validators/entitlement.zod.js +1 -1
- package/dist/membership/v1/generated/validators/funds.zod.js +4 -4
- package/dist/membership/v1/generated/validators/invoice.zod.d.ts +0 -1
- package/dist/membership/v1/generated/validators/invoice.zod.js +8 -8
- package/dist/membership/v1/generated/validators/invoiceItem.zod.d.ts +1 -0
- package/dist/membership/v1/generated/validators/invoiceItem.zod.js +6 -4
- package/dist/membership/v1/generated/validators/invoiceItemList.zod.d.ts +1 -0
- package/dist/membership/v1/generated/validators/invoiceItemProration.zod.js +1 -3
- package/dist/membership/v1/generated/validators/invoiceList.zod.d.ts +0 -1
- package/dist/membership/v1/generated/validators/invoiceStatus.zod.d.ts +0 -1
- package/dist/membership/v1/generated/validators/invoiceStatus.zod.js +2 -2
- package/dist/membership/v1/generated/validators/invoiceSummary.zod.d.ts +0 -1
- package/dist/membership/v1/generated/validators/invoiceSummary.zod.js +3 -3
- package/dist/membership/v1/generated/validators/membershipPurchase.zod.d.ts +0 -1
- package/dist/membership/v1/generated/validators/monthlyStatement.zod.js +2 -2
- package/dist/membership/v1/generated/validators/objectIdentity.zod.js +1 -1
- package/dist/membership/v1/generated/validators/order.zod.d.ts +7 -4
- package/dist/membership/v1/generated/validators/order.zod.js +10 -12
- package/dist/membership/v1/generated/validators/orderItem.zod.d.ts +7 -3
- package/dist/membership/v1/generated/validators/orderItem.zod.js +16 -14
- package/dist/membership/v1/generated/validators/orderItemList.zod.d.ts +7 -3
- package/dist/membership/v1/generated/validators/orderItemStatus.zod.js +1 -1
- package/dist/membership/v1/generated/validators/orderList.zod.d.ts +7 -4
- package/dist/membership/v1/generated/validators/orderRefundQuote.zod.js +1 -1
- package/dist/membership/v1/generated/validators/orderRefundQuoteInput.zod.js +1 -1
- package/dist/membership/v1/generated/validators/orderStatus.zod.js +1 -1
- package/dist/membership/v1/generated/validators/paidWith.zod.js +1 -1
- package/dist/membership/v1/generated/validators/payInvoiceRequest.zod.js +6 -6
- package/dist/membership/v1/generated/validators/payTogetherRequest.zod.js +2 -2
- package/dist/membership/v1/generated/validators/paymentAction.zod.js +4 -4
- package/dist/membership/v1/generated/validators/paymentCancellationReason.zod.js +1 -1
- package/dist/membership/v1/generated/validators/paymentMethodSetupResult.zod.js +2 -4
- package/dist/membership/v1/generated/validators/paymentOption.zod.js +1 -1
- package/dist/membership/v1/generated/validators/paymentOptionMethod.zod.js +1 -1
- package/dist/membership/v1/generated/validators/paymentPreview.zod.js +4 -4
- package/dist/membership/v1/generated/validators/paymentResult.zod.js +5 -8
- package/dist/membership/v1/generated/validators/paymentStatus.zod.js +1 -1
- package/dist/membership/v1/generated/validators/placedOrder.zod.d.ts +0 -1
- package/dist/membership/v1/generated/validators/price.zod.d.ts +7 -5
- package/dist/membership/v1/generated/validators/price.zod.js +14 -11
- package/dist/membership/v1/generated/validators/priceList.zod.d.ts +7 -5
- package/dist/membership/v1/generated/validators/priceOption.zod.d.ts +7 -5
- package/dist/membership/v1/generated/validators/priceOption.zod.js +7 -3
- package/dist/membership/v1/generated/validators/priceType.zod.d.ts +14 -0
- package/dist/membership/v1/generated/validators/priceType.zod.js +11 -0
- package/dist/membership/v1/generated/validators/productID.zod.js +1 -1
- package/dist/membership/v1/generated/validators/projectAssignment.zod.js +2 -2
- package/dist/membership/v1/generated/validators/purchaseOperation.zod.js +1 -1
- package/dist/membership/v1/generated/validators/quote.zod.d.ts +6 -3
- package/dist/membership/v1/generated/validators/quote.zod.js +4 -4
- package/dist/membership/v1/generated/validators/quoteCancellation.zod.js +2 -2
- package/dist/membership/v1/generated/validators/quoteItem.zod.js +4 -4
- package/dist/membership/v1/generated/validators/quoteItemInput.zod.d.ts +5 -2
- package/dist/membership/v1/generated/validators/quoteItemInput.zod.js +8 -8
- package/dist/membership/v1/generated/validators/quoteRenewal.zod.js +1 -1
- package/dist/membership/v1/generated/validators/quoteRenewalResult.zod.js +2 -2
- package/dist/membership/v1/generated/validators/quoteRequest.zod.d.ts +5 -2
- package/dist/membership/v1/generated/validators/quoteRequest.zod.js +5 -5
- package/dist/membership/v1/generated/validators/quotedDiscount.zod.js +1 -1
- package/dist/membership/v1/generated/validators/rate.zod.d.ts +11 -0
- package/dist/membership/v1/generated/validators/rate.zod.js +14 -6
- package/dist/membership/v1/generated/validators/rateList.zod.d.ts +11 -0
- package/dist/membership/v1/generated/validators/refund.zod.js +3 -3
- package/dist/membership/v1/generated/validators/refundPolicy.zod.js +1 -1
- package/dist/membership/v1/generated/validators/refundReason.zod.js +1 -1
- package/dist/membership/v1/generated/validators/renewRequest.zod.js +2 -2
- package/dist/membership/v1/generated/validators/renewalOrderRequest.zod.js +2 -2
- package/dist/membership/v1/generated/validators/renewalPrice.zod.js +1 -1
- package/dist/membership/v1/generated/validators/scheduledChange.zod.js +2 -2
- package/dist/membership/v1/generated/validators/spendRow.zod.d.ts +8 -0
- package/dist/membership/v1/generated/validators/spendRow.zod.js +11 -0
- package/dist/membership/v1/generated/validators/spendRowList.zod.d.ts +8 -0
- package/dist/membership/v1/generated/validators/spendRowList.zod.js +1 -1
- package/dist/membership/v1/generated/validators/statement.zod.js +2 -2
- package/dist/membership/v1/generated/validators/statementItem.zod.d.ts +1 -0
- package/dist/membership/v1/generated/validators/statementItem.zod.js +4 -0
- package/dist/membership/v1/generated/validators/statementSummary.zod.d.ts +1 -0
- package/dist/membership/v1/generated/validators/statementType.zod.js +1 -1
- package/dist/membership/v1/generated/validators/subscription.zod.d.ts +7 -3
- package/dist/membership/v1/generated/validators/subscription.zod.js +20 -14
- package/dist/membership/v1/generated/validators/subscriptionCancellation.zod.js +2 -2
- package/dist/membership/v1/generated/validators/subscriptionList.zod.d.ts +7 -3
- package/dist/membership/v1/generated/validators/subscriptionRestriction.zod.js +1 -1
- package/dist/membership/v1/generated/validators/terminationPolicy.zod.js +1 -1
- package/dist/membership/v1/generated/validators/tier.zod.js +1 -1
- package/dist/membership/v1/generated/validators/topUp.zod.js +8 -8
- package/dist/membership/v1/generated/validators/topUpCreate.zod.js +4 -4
- package/dist/membership/v1/generated/validators/transaction.zod.js +6 -6
- package/dist/membership/v1/generated/validators/usageCharge.zod.js +4 -7
- package/dist/membership/v1/generated/validators/usageType.zod.d.ts +14 -0
- package/dist/membership/v1/generated/validators/usageType.zod.js +11 -0
- package/dist/membership/v1/generated/validators/withdrawal.zod.js +2 -2
- package/dist/membership/v1/generated/validators/withdrawalItem.zod.js +2 -2
- package/dist/membership/v1/generated/validators/withdrawalSource.zod.js +1 -1
- package/dist/routes.d.ts +4 -4
- package/dist/routes.js +4 -4
- package/package.json +1 -1
|
@@ -17,15 +17,13 @@ import { OrderCancel } from "./validators/orderCancel.zod.js";
|
|
|
17
17
|
import { PayInvoiceRequest } from "./validators/payInvoiceRequest.zod.js";
|
|
18
18
|
import { PayTogetherRequest } from "./validators/payTogetherRequest.zod.js";
|
|
19
19
|
import { PaymentMethodSetup } from "./validators/paymentMethodSetup.zod.js";
|
|
20
|
-
import { QuoteRequest } from "./validators/quoteRequest.zod.js";
|
|
21
20
|
import { RenewRequest } from "./validators/renewRequest.zod.js";
|
|
22
21
|
import { RenewalOrderRequest } from "./validators/renewalOrderRequest.zod.js";
|
|
23
22
|
import { SetProjectAssignmentRequest } from "./validators/setProjectAssignmentRequest.zod.js";
|
|
24
23
|
import { TopUpCreate } from "./validators/topUpCreate.zod.js";
|
|
25
24
|
import { WithdrawalCreate } from "./validators/withdrawalCreate.zod.js";
|
|
26
|
-
import { WithdrawalPreviewRequest } from "./validators/withdrawalPreviewRequest.zod.js";
|
|
27
25
|
/**
|
|
28
|
-
*
|
|
26
|
+
* The withdrawal's items and their outcomes. A failed item does not undo refunds completed through other items.
|
|
29
27
|
* @summary List withdrawal items
|
|
30
28
|
*/
|
|
31
29
|
export const ListWithdrawalItemsParams = zod.strictObject({
|
|
@@ -50,7 +48,7 @@ export const ListWithdrawalItemsQueryParams = zod.strictObject({
|
|
|
50
48
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
51
49
|
});
|
|
52
50
|
/**
|
|
53
|
-
*
|
|
51
|
+
* Withdrawals, newest first.
|
|
54
52
|
* @summary List withdrawals
|
|
55
53
|
*/
|
|
56
54
|
export const listWithdrawalsQueryPageDefault = 1;
|
|
@@ -73,24 +71,19 @@ export const ListWithdrawalsQueryParams = zod.strictObject({
|
|
|
73
71
|
billing_account_id: zod.int().optional(),
|
|
74
72
|
});
|
|
75
73
|
/**
|
|
76
|
-
* Withdraws the requested
|
|
74
|
+
* Withdraws the requested balance through the original top-ups, oldest first, with fees calculated per source. expected_items and expected_refund_amount must match the preview. Reusing the ID with different terms fails. Only successful items are charged a fee.
|
|
77
75
|
* @summary Create withdrawal
|
|
78
76
|
*/
|
|
79
77
|
export const CreateWithdrawalBody = WithdrawalCreate;
|
|
80
78
|
/**
|
|
81
|
-
*
|
|
82
|
-
* @summary Preview withdrawal
|
|
83
|
-
*/
|
|
84
|
-
export const PreviewWithdrawalBody = WithdrawalPreviewRequest;
|
|
85
|
-
/**
|
|
86
|
-
* Reads the accepted amounts and aggregate outcome of an authorized withdrawal. List its source items for each original-method refund result.
|
|
79
|
+
* A withdrawal with its accepted amounts and overall outcome; list its items for each refund result.
|
|
87
80
|
* @summary Get withdrawal
|
|
88
81
|
*/
|
|
89
82
|
export const GetWithdrawalParams = zod.strictObject({
|
|
90
83
|
withdrawalId: zod.uuid(),
|
|
91
84
|
});
|
|
92
85
|
/**
|
|
93
|
-
*
|
|
86
|
+
* Contacts of the billing account, inactive ones included. Returns 404 if the account does not exist.
|
|
94
87
|
* @summary List contacts
|
|
95
88
|
*/
|
|
96
89
|
export const ListContactsParams = zod.strictObject({
|
|
@@ -115,7 +108,7 @@ export const ListContactsQueryParams = zod.strictObject({
|
|
|
115
108
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
116
109
|
});
|
|
117
110
|
/**
|
|
118
|
-
* Creates a contact
|
|
111
|
+
* Creates a contact for the billing account. To use it on invoices, set the account's invoice_contact_id.
|
|
119
112
|
* @summary Create contact
|
|
120
113
|
*/
|
|
121
114
|
export const CreateContactParams = zod.strictObject({
|
|
@@ -123,7 +116,7 @@ export const CreateContactParams = zod.strictObject({
|
|
|
123
116
|
});
|
|
124
117
|
export const CreateContactBody = ContactCreate;
|
|
125
118
|
/**
|
|
126
|
-
*
|
|
119
|
+
* A contact of this billing account. Returns 404 if it does not exist in the account.
|
|
127
120
|
* @summary Get contact
|
|
128
121
|
*/
|
|
129
122
|
export const GetContactParams = zod.strictObject({
|
|
@@ -131,7 +124,7 @@ export const GetContactParams = zod.strictObject({
|
|
|
131
124
|
contactId: zod.uuid(),
|
|
132
125
|
});
|
|
133
126
|
/**
|
|
134
|
-
* Updates a contact
|
|
127
|
+
* Updates a contact of this billing account. Returns 404 if it does not exist in the account.
|
|
135
128
|
* @summary Update contact
|
|
136
129
|
*/
|
|
137
130
|
export const UpdateContactParams = zod.strictObject({
|
|
@@ -140,7 +133,7 @@ export const UpdateContactParams = zod.strictObject({
|
|
|
140
133
|
});
|
|
141
134
|
export const UpdateContactBody = ContactUpdate;
|
|
142
135
|
/**
|
|
143
|
-
* Deletes a contact
|
|
136
|
+
* Deletes a contact of this billing account; 404 if it does not exist in the account. A contact selected for invoices must be cleared or replaced first. Issued invoices keep their copy.
|
|
144
137
|
* @summary Delete contact
|
|
145
138
|
*/
|
|
146
139
|
export const DeleteContactParams = zod.strictObject({
|
|
@@ -148,8 +141,7 @@ export const DeleteContactParams = zod.strictObject({
|
|
|
148
141
|
contactId: zod.uuid(),
|
|
149
142
|
});
|
|
150
143
|
/**
|
|
151
|
-
*
|
|
152
|
-
* although accounts already opened in it keep working. Results are paginated.
|
|
144
|
+
* Currencies a new billing account can be opened in; retired currencies are not listed.
|
|
153
145
|
* @summary List currencies accounts can be opened in
|
|
154
146
|
*/
|
|
155
147
|
export const listCurrenciesQueryPageDefault = 1;
|
|
@@ -171,7 +163,7 @@ export const ListCurrenciesQueryParams = zod.strictObject({
|
|
|
171
163
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
172
164
|
});
|
|
173
165
|
/**
|
|
174
|
-
*
|
|
166
|
+
* Billing accounts owned by the authenticated user.
|
|
175
167
|
* @summary List billing accounts
|
|
176
168
|
*/
|
|
177
169
|
export const listBillingAccountsQueryPageDefault = 1;
|
|
@@ -193,24 +185,19 @@ export const ListBillingAccountsQueryParams = zod.strictObject({
|
|
|
193
185
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
194
186
|
});
|
|
195
187
|
/**
|
|
196
|
-
*
|
|
197
|
-
* account — prices, orders, invoices, balance — is denominated in it.
|
|
198
|
-
*
|
|
199
|
-
* One person may hold several accounts, for example a personal one and one for a team.
|
|
188
|
+
* Creates a billing account. Its currency is fixed: prices, orders, invoices and balance are all in it.
|
|
200
189
|
* @summary Create billing account
|
|
201
190
|
*/
|
|
202
191
|
export const CreateBillingAccountBody = BillingAccountCreate;
|
|
203
192
|
/**
|
|
204
|
-
*
|
|
193
|
+
* Your billing account with its currency, status and invoice contact. Returns 404 if it does not exist and 403 if it belongs to another user.
|
|
205
194
|
* @summary Get billing account
|
|
206
195
|
*/
|
|
207
196
|
export const GetBillingAccountParams = zod.strictObject({
|
|
208
197
|
accountId: zod.int(),
|
|
209
198
|
});
|
|
210
199
|
/**
|
|
211
|
-
*
|
|
212
|
-
* address and tax identifier are copied when an invoice is issued; issued snapshots are
|
|
213
|
-
* retained. Set invoice_contact_id to null to clear the selection. The currency cannot change.
|
|
200
|
+
* Selects an active contact of this account for future invoices; its legal name, address and tax identifier are copied when an invoice is issued. Set invoice_contact_id to null to clear it. The currency cannot change.
|
|
214
201
|
* @summary Update billing account
|
|
215
202
|
*/
|
|
216
203
|
export const UpdateBillingAccountParams = zod.strictObject({
|
|
@@ -218,17 +205,14 @@ export const UpdateBillingAccountParams = zod.strictObject({
|
|
|
218
205
|
});
|
|
219
206
|
export const UpdateBillingAccountBody = BillingAccountUpdate;
|
|
220
207
|
/**
|
|
221
|
-
*
|
|
208
|
+
* The balance of your account, with credit groups, unpaid invoice amounts, unbilled estimates and pending returns. Returns 404 for a missing account and 403 for another user's account.
|
|
222
209
|
* @summary Get account balance
|
|
223
210
|
*/
|
|
224
211
|
export const GetAccountBalanceParams = zod.strictObject({
|
|
225
212
|
accountId: zod.int(),
|
|
226
213
|
});
|
|
227
214
|
/**
|
|
228
|
-
*
|
|
229
|
-
* preferred gateway first. Top-ups and invoice payments must name a gateway and method listed here;
|
|
230
|
-
* others are refused. An empty result means no online payment is available for this account.
|
|
231
|
-
* Results are paginated.
|
|
215
|
+
* The payment gateways and methods currently accepting the account's currency, preferred gateway first. Top-ups and invoice payments must use one listed here. An empty result means online payment is unavailable for the account.
|
|
232
216
|
* @summary List payment options
|
|
233
217
|
*/
|
|
234
218
|
export const ListPaymentOptionsParams = zod.strictObject({
|
|
@@ -253,7 +237,7 @@ export const ListPaymentOptionsQueryParams = zod.strictObject({
|
|
|
253
237
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
254
238
|
});
|
|
255
239
|
/**
|
|
256
|
-
*
|
|
240
|
+
* Current project assignments to your billing accounts, filtered by billing_account_id or project_ids. Past charges keep the account they were assigned to.
|
|
257
241
|
* @summary List project assignments
|
|
258
242
|
*/
|
|
259
243
|
export const listProjectAssignmentsQueryPageDefault = 1;
|
|
@@ -280,28 +264,23 @@ export const ListProjectAssignmentsQueryParams = zod.strictObject({
|
|
|
280
264
|
.min(1)
|
|
281
265
|
.max(listProjectAssignmentsQueryProjectIdsMax)
|
|
282
266
|
.optional()
|
|
283
|
-
.describe("
|
|
267
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
284
268
|
});
|
|
285
269
|
/**
|
|
286
|
-
*
|
|
287
|
-
* no billing account is assigned; no resources can be created until one is assigned.
|
|
270
|
+
* The project's current assignment. Returns 404 when no billing account is assigned; the project cannot create resources until one is.
|
|
288
271
|
* @summary Get project assignment
|
|
289
272
|
*/
|
|
290
273
|
export const GetProjectAssignmentParams = zod.strictObject({
|
|
291
274
|
projectId: zod.uuid(),
|
|
292
275
|
});
|
|
293
276
|
/**
|
|
294
|
-
* Charges already incurred
|
|
295
|
-
* occurred
|
|
296
|
-
* the change.
|
|
297
|
-
*
|
|
298
|
-
*
|
|
299
|
-
* Orders keep the billing account they were placed with and are fulfilled as placed. Periods
|
|
300
|
-
* already paid for are unaffected; renewals are charged to the new billing account.
|
|
277
|
+
* Links the project to another billing account. Charges already incurred stay with the account linked when they
|
|
278
|
+
* occurred and are invoiced to it; metered resources are settled up to the moment of the change. Amounts the
|
|
279
|
+
* previous account owes do not prevent the change. Orders keep the account they were placed with; paid periods
|
|
280
|
+
* are unaffected, and renewals are charged to the new account.
|
|
301
281
|
*
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
* other than that of the new billing account.
|
|
282
|
+
* Refused once the project no longer accepts purchases because it is being deleted, and while a subscription or
|
|
283
|
+
* an in-progress order of the project uses a currency other than the new account's.
|
|
305
284
|
* @summary Set project assignment
|
|
306
285
|
*/
|
|
307
286
|
export const SetProjectAssignmentParams = zod.strictObject({
|
|
@@ -309,25 +288,14 @@ export const SetProjectAssignmentParams = zod.strictObject({
|
|
|
309
288
|
});
|
|
310
289
|
export const SetProjectAssignmentBody = SetProjectAssignmentRequest;
|
|
311
290
|
/**
|
|
312
|
-
* Ends the project's current assignment
|
|
313
|
-
*
|
|
314
|
-
* Permitted only when nothing in the project is still running or in progress: no metered
|
|
315
|
-
* resources, no subscriptions that have not ended, and no orders in progress, including
|
|
316
|
-
* changes scheduled for the end of a period. Orders are not modified by this request; wait
|
|
317
|
-
* for them to complete, and have the service that scheduled a change call it off.
|
|
318
|
-
*
|
|
319
|
-
* Charges already incurred remain with the billing account and are invoiced to it as usual.
|
|
320
|
-
* Amounts the billing account owes do not prevent unlinking.
|
|
321
|
-
*
|
|
322
|
-
* After this the project cannot make purchases until a billing account is linked again.
|
|
291
|
+
* Ends the project's current assignment; the assignment history is kept. Allowed only when the project has no metered resources, no subscriptions that have not ended and no orders in progress, including period-end changes; orders are not modified, so wait for them to complete. Charges already incurred stay with the billing account and are invoiced as usual; amounts it owes do not prevent unlinking. The project cannot make purchases until a billing account is linked again.
|
|
323
292
|
* @summary Unlink project billing account
|
|
324
293
|
*/
|
|
325
294
|
export const UnlinkProjectBillingAccountParams = zod.strictObject({
|
|
326
295
|
projectId: zod.uuid(),
|
|
327
296
|
});
|
|
328
297
|
/**
|
|
329
|
-
*
|
|
330
|
-
* created for a top-up. Items carry no `action`; read a pending top-up with get-top-up to continue its payment.
|
|
298
|
+
* Your top-ups, including pending, failed and canceled attempts. Items carry no `action`; read a pending top-up with get-top-up to continue its payment.
|
|
331
299
|
* @summary List top ups
|
|
332
300
|
*/
|
|
333
301
|
export const listTopUpsQueryPageDefault = 1;
|
|
@@ -350,46 +318,36 @@ export const ListTopUpsQueryParams = zod.strictObject({
|
|
|
350
318
|
billing_account_id: zod
|
|
351
319
|
.int()
|
|
352
320
|
.optional()
|
|
353
|
-
.describe("
|
|
321
|
+
.describe("Only this account of yours; all when omitted."),
|
|
354
322
|
});
|
|
355
323
|
/**
|
|
356
|
-
* Creates a top-up for an account
|
|
357
|
-
* The balance increases only after the payment gateway confirms receipt. A top-up has no invoice.
|
|
358
|
-
* Keep the supplied ID to query the original attempt after a lost response; duplicate creation conflicts.
|
|
324
|
+
* Creates a top-up for an account of the authenticated user and returns its payment information. The balance increases when the gateway confirms receipt. Keep the supplied ID to read the attempt after a lost response; creating it again conflicts.
|
|
359
325
|
* @summary Create top up
|
|
360
326
|
*/
|
|
361
327
|
export const CreateTopUpBody = TopUpCreate;
|
|
362
328
|
/**
|
|
363
|
-
*
|
|
364
|
-
* It is not an invoice.
|
|
365
|
-
*
|
|
366
|
-
* While the top-up is pending, the answer includes the customer's next step as the payment gateway
|
|
367
|
-
* currently reports it, so that a payment interrupted by a closed page can be continued. When the gateway
|
|
368
|
-
* cannot be reached, the top-up is returned without `action`; read it again later.
|
|
329
|
+
* A top-up of the authenticated user, with its outcome and unspent amount. While it is pending, `action` carries the customer's next step as the gateway reports it, so an interrupted payment can be continued; when the gateway cannot be reached, `action` is omitted.
|
|
369
330
|
* @summary Get top up
|
|
370
331
|
*/
|
|
371
332
|
export const GetTopUpParams = zod.strictObject({
|
|
372
333
|
topUpId: zod.uuid(),
|
|
373
334
|
});
|
|
374
335
|
/**
|
|
375
|
-
* Withdraws a pending top-up
|
|
376
|
-
* `
|
|
377
|
-
* top-up
|
|
378
|
-
*
|
|
379
|
-
* If the gateway has already collected the payment, nothing is withdrawn and the top-up is returned
|
|
380
|
-
* as `succeeded` with the balance increased. Check `status` in the answer rather than assuming the
|
|
381
|
-
* cancellation took effect.
|
|
336
|
+
* Withdraws a pending top-up of the authenticated user at the payment gateway. It becomes `canceled` with
|
|
337
|
+
* `cancellation_reason` `requested_by_customer`, and nothing is collected. Canceling a canceled top-up returns
|
|
338
|
+
* it unchanged. If the gateway has already collected the payment, the top-up is returned as `succeeded` with the
|
|
339
|
+
* balance increased; check `status` in the response.
|
|
382
340
|
*
|
|
383
|
-
* Fails with 409
|
|
384
|
-
*
|
|
385
|
-
*
|
|
341
|
+
* Fails with 409 `BILLING_TOPUP_NOT_CANCELABLE` when the top-up has succeeded or failed, with `status` naming
|
|
342
|
+
* the outcome, or while the gateway is processing the payment, with `status` `pending`; read the top-up again
|
|
343
|
+
* later.
|
|
386
344
|
* @summary Cancel top up
|
|
387
345
|
*/
|
|
388
346
|
export const CancelTopUpParams = zod.strictObject({
|
|
389
347
|
topUpId: zod.uuid(),
|
|
390
348
|
});
|
|
391
349
|
/**
|
|
392
|
-
*
|
|
350
|
+
* Saved payment methods of your billing accounts, optionally for one billing_account_id. Removed methods are not listed.
|
|
393
351
|
* @summary List payment methods
|
|
394
352
|
*/
|
|
395
353
|
export const listPaymentMethodsQueryPageDefault = 1;
|
|
@@ -412,68 +370,52 @@ export const ListPaymentMethodsQueryParams = zod.strictObject({
|
|
|
412
370
|
billing_account_id: zod
|
|
413
371
|
.int()
|
|
414
372
|
.optional()
|
|
415
|
-
.describe("
|
|
373
|
+
.describe("Only this account of yours; all when omitted."),
|
|
416
374
|
});
|
|
417
375
|
/**
|
|
418
|
-
* Returns what
|
|
419
|
-
* form. Nothing is charged, and the method appears in the list once the gateway
|
|
420
|
-
* confirms it.
|
|
421
|
-
*
|
|
422
|
-
* Card numbers are never sent to or stored by this service.
|
|
376
|
+
* Returns what the browser needs to open the payment gateway's card form. Nothing is charged; the method is listed once the gateway confirms it. Card numbers never reach this service.
|
|
423
377
|
* @summary Create payment method setup
|
|
424
378
|
*/
|
|
425
379
|
export const CreatePaymentMethodSetupBody = PaymentMethodSetup;
|
|
426
380
|
/**
|
|
427
|
-
*
|
|
381
|
+
* Makes an active saved payment method the default for its billing account and returns it. Expired or removed methods cannot be selected; selecting the current default changes nothing.
|
|
428
382
|
* @summary Set default payment method
|
|
429
383
|
*/
|
|
430
384
|
export const SetDefaultPaymentMethodParams = zod.strictObject({
|
|
431
385
|
paymentMethodId: zod.uuid(),
|
|
432
386
|
});
|
|
433
387
|
/**
|
|
434
|
-
* Refused when it is the only method
|
|
435
|
-
* as there would be nothing left to charge when the balance runs out.
|
|
388
|
+
* Refused when it is the only payment method of an account with metered resources.
|
|
436
389
|
* @summary Delete payment method
|
|
437
390
|
*/
|
|
438
391
|
export const DeletePaymentMethodParams = zod.strictObject({
|
|
439
392
|
paymentMethodId: zod.uuid(),
|
|
440
393
|
});
|
|
441
394
|
/**
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
* account funds fail without starting an online payment. Card and non-card methods use this same
|
|
445
|
-
* operation.
|
|
395
|
+
* Pays the invoice from eligible credit grants and balance as requested, and collects the remainder through the
|
|
396
|
+
* selected gateway and method. Without a gateway, insufficient funds fail and no online payment starts.
|
|
446
397
|
*
|
|
447
|
-
* The draft invoice of a deferred order is priced
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
* insufficient funds or a declined card: later attempts reuse them, and a different promotion_code
|
|
454
|
-
* is then refused with `BILLING_ORDER_CHECKOUT_CONFLICT`. A deferred period-end change can be paid
|
|
455
|
-
* once its first period is due to be invoiced; earlier attempts are refused with
|
|
398
|
+
* The draft invoice of a deferred order is priced on its first payment: promotion_code, or otherwise the best
|
|
399
|
+
* applicable account discount, is applied, the total is compared with expected_amount, and the invoice is issued
|
|
400
|
+
* before collection. An invalid or inapplicable code fails, and a total other than expected_amount fails with
|
|
401
|
+
* `BILLING_AMOUNT_CHANGED`; neither changes anything. Once fixed, the terms stay fixed even if collection does
|
|
402
|
+
* not complete, and a different promotion_code is refused with `BILLING_ORDER_CHECKOUT_CONFLICT`. A deferred
|
|
403
|
+
* period-end change can be paid only once its first period is due to be invoiced; earlier attempts fail with
|
|
456
404
|
* `BILLING_CHANGE_NOT_INVOICED`.
|
|
457
405
|
*
|
|
458
|
-
* Returns a payment action when customer
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
* charged. One the gateway is still processing is refused with `BILLING_PAYMENT_PENDING` and
|
|
464
|
-
* `meta.transaction_id`; wait for its outcome.
|
|
406
|
+
* Returns a payment action when the customer must act; requires_action and processing are not paid. An
|
|
407
|
+
* unresolved online payment with the same gateway, method and saved payment method is reused, and retries never
|
|
408
|
+
* apply credit grants or balance twice. Paying any other way first cancels that payment; if the gateway had
|
|
409
|
+
* already collected it, the invoice is paid by it and nothing more is charged. A payment the gateway is still
|
|
410
|
+
* processing fails with `BILLING_PAYMENT_PENDING` and `meta.transaction_id`.
|
|
465
411
|
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
* order
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
* `BILLING_INVOICE_NOT_PAYABLE`
|
|
472
|
-
*
|
|
473
|
-
* `subscription_ended` respectively. A usage invoice is billed to the smallest fraction a balance can
|
|
474
|
-
* hold, finer than a payment method can charge, so paying one online is refused with
|
|
475
|
-
* `BILLING_INVOICE_NOT_PAYABLE` and `meta.reason` `usage_invoice`; it is collected from credit grants
|
|
476
|
-
* and balance automatically, including right after a top-up.
|
|
412
|
+
* A paid invoice returns its existing result without another charge. Refused with `BILLING_INVOICE_NOT_PAYABLE`
|
|
413
|
+
* for a void invoice; `BILLING_ORDER_FAILED` or `BILLING_ORDER_CANCELED` for the invoice of a failed or canceled
|
|
414
|
+
* order; `BILLING_ORDER_EXPIRED` after the order's payment deadline; `BILLING_INVOICE_NOT_PAYABLE` with
|
|
415
|
+
* `meta.reason` `subscription_canceling`, `subscription_reclaiming` or `subscription_ended` for a renewal
|
|
416
|
+
* invoice whose subscription is being canceled, is being reclaimed or has ended; and
|
|
417
|
+
* `BILLING_INVOICE_NOT_PAYABLE` with `meta.reason` `usage_invoice` for a usage invoice, which is collected from
|
|
418
|
+
* credit grants and balance automatically, including right after a top-up.
|
|
477
419
|
* @summary Pay an invoice
|
|
478
420
|
*/
|
|
479
421
|
export const PayInvoiceParams = zod.strictObject({
|
|
@@ -504,7 +446,7 @@ export const PreviewInvoicePaymentQueryParams = zod.strictObject({
|
|
|
504
446
|
.min(1)
|
|
505
447
|
.max(previewInvoicePaymentQueryPromotionCodeMax)
|
|
506
448
|
.optional()
|
|
507
|
-
.describe("As in paying
|
|
449
|
+
.describe("As in paying; used only while the order's terms are not fixed."),
|
|
508
450
|
use_balance: zod
|
|
509
451
|
.boolean()
|
|
510
452
|
.default(previewInvoicePaymentQueryUseBalanceDefault)
|
|
@@ -515,41 +457,24 @@ export const PreviewInvoicePaymentQueryParams = zod.strictObject({
|
|
|
515
457
|
.describe("As in paying. True when omitted."),
|
|
516
458
|
});
|
|
517
459
|
/**
|
|
518
|
-
* Pays outstanding invoices, including
|
|
519
|
-
*
|
|
520
|
-
*
|
|
521
|
-
* account discount and is issued first, and stays issued if the payment fails; pay it on its own to
|
|
522
|
-
* apply a promotion code.
|
|
460
|
+
* Pays outstanding invoices, including those of the listed orders, from eligible credit grants and then balance,
|
|
461
|
+
* without a payment gateway. The draft invoice of a deferred order takes the best applicable account discount
|
|
462
|
+
* and is issued first, staying issued if payment fails; pay it alone to use a promotion code.
|
|
523
463
|
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
*
|
|
529
|
-
* `
|
|
530
|
-
* `BILLING_INVOICE_NOT_PAYABLE
|
|
531
|
-
* `
|
|
532
|
-
*
|
|
533
|
-
* passed with `BILLING_ORDER_EXPIRED`. A renewal invoice is refused with
|
|
534
|
-
* `BILLING_INVOICE_NOT_PAYABLE` while its subscription is being canceled, is being reclaimed or has
|
|
535
|
-
* ended, with `meta.reason` `subscription_canceling`, `subscription_reclaiming` or
|
|
536
|
-
* `subscription_ended` respectively.
|
|
464
|
+
* All invoices are paid or none: insufficient funds fail with `BILLING_INSUFFICIENT_FUNDS`, and a total other
|
|
465
|
+
* than expected_amount fails with `BILLING_AMOUNT_CHANGED`, charging nothing. Paid invoices are not charged
|
|
466
|
+
* again. An earlier online payment for one of the invoices is canceled first; one the gateway is still
|
|
467
|
+
* processing is refused with `BILLING_PAYMENT_PENDING` and `meta.transaction_id`. Also refused with
|
|
468
|
+
* `BILLING_INVOICE_NOT_PAYABLE` for a void invoice; `BILLING_CHANGE_NOT_INVOICED` for a period-end change not
|
|
469
|
+
* yet due; `BILLING_ORDER_FAILED`, `BILLING_ORDER_CANCELED` or `BILLING_ORDER_EXPIRED` for an order in that
|
|
470
|
+
* state; and `BILLING_INVOICE_NOT_PAYABLE` with `meta.reason` `subscription_canceling`,
|
|
471
|
+
* `subscription_reclaiming` or `subscription_ended` for a renewal invoice of a subscription being canceled,
|
|
472
|
+
* being reclaimed or ended.
|
|
537
473
|
* @summary Pay together
|
|
538
474
|
*/
|
|
539
475
|
export const PayTogetherBody = PayTogetherRequest;
|
|
540
476
|
/**
|
|
541
|
-
*
|
|
542
|
-
* invoice by invoice in the order they would be paid. It is computed as paying together computes
|
|
543
|
-
* it. Nothing is charged, reserved or created.
|
|
544
|
-
*
|
|
545
|
-
* Refused with the same errors as paying together, except that insufficient funds are not an
|
|
546
|
-
* error here: they show as a `gateway_amount` above zero, and paying together would then be
|
|
547
|
-
* refused with `BILLING_INSUFFICIENT_FUNDS`.
|
|
548
|
-
* @summary Preview paying together
|
|
549
|
-
*/
|
|
550
|
-
export const PreviewPayTogetherBody = PayTogetherRequest;
|
|
551
|
-
/**
|
|
552
|
-
* Paginated issued invoices belonging to owned billing accounts, filtered by billing_account_id, subscription_id, status and creation interval. Drafts are excluded, including the draft invoice of an order awaiting payment, which is reached through its order; top-ups do not create invoices.
|
|
477
|
+
* Issued invoices of your billing accounts. Drafts are not listed; an order's draft invoice is reached through its order. Top-ups have no invoices.
|
|
553
478
|
* @summary List invoices
|
|
554
479
|
*/
|
|
555
480
|
export const listInvoicesQueryPageDefault = 1;
|
|
@@ -572,27 +497,27 @@ export const ListInvoicesQueryParams = zod.strictObject({
|
|
|
572
497
|
billing_account_id: zod
|
|
573
498
|
.int()
|
|
574
499
|
.optional()
|
|
575
|
-
.describe("
|
|
500
|
+
.describe("Only this account of yours; all when omitted."),
|
|
576
501
|
status: zod
|
|
577
|
-
.enum(["draft", "open", "paid", "void"
|
|
502
|
+
.enum(["draft", "open", "paid", "void"])
|
|
578
503
|
.optional()
|
|
579
|
-
.describe("
|
|
504
|
+
.describe("`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."),
|
|
580
505
|
subscription_id: zod
|
|
581
506
|
.uuid()
|
|
582
507
|
.optional()
|
|
583
|
-
.describe("Only invoices
|
|
508
|
+
.describe("Only invoices with a charge from this subscription; amounts are for the whole invoice."),
|
|
584
509
|
from: zod.iso.datetime({ offset: true }).optional(),
|
|
585
510
|
to: zod.iso.datetime({ offset: true }).optional().describe("Exclusive."),
|
|
586
511
|
});
|
|
587
512
|
/**
|
|
588
|
-
*
|
|
513
|
+
* An invoice of your billing account, issued or an order's draft, with its amounts, tax lines and payment state. A missing invoice or another draft returns 404; an invoice of another user's account returns 403.
|
|
589
514
|
* @summary Get invoice
|
|
590
515
|
*/
|
|
591
516
|
export const GetInvoiceParams = zod.strictObject({
|
|
592
517
|
invoiceId: zod.uuid(),
|
|
593
518
|
});
|
|
594
519
|
/**
|
|
595
|
-
*
|
|
520
|
+
* Lines of an invoice of your billing account, issued or an order's draft, with their service periods and projects. A missing invoice or another draft returns 404; an invoice of another user's account returns 403.
|
|
596
521
|
* @summary List invoice items
|
|
597
522
|
*/
|
|
598
523
|
export const ListInvoiceItemsParams = zod.strictObject({
|
|
@@ -617,7 +542,7 @@ export const ListInvoiceItemsQueryParams = zod.strictObject({
|
|
|
617
542
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
618
543
|
});
|
|
619
544
|
/**
|
|
620
|
-
*
|
|
545
|
+
* Ledger entries of your billing accounts, filtered by billing_account_id and creation time.
|
|
621
546
|
* @summary List transactions
|
|
622
547
|
*/
|
|
623
548
|
export const listTransactionsQueryPageDefault = 1;
|
|
@@ -640,13 +565,12 @@ export const ListTransactionsQueryParams = zod.strictObject({
|
|
|
640
565
|
billing_account_id: zod
|
|
641
566
|
.int()
|
|
642
567
|
.optional()
|
|
643
|
-
.describe("
|
|
568
|
+
.describe("Only this account of yours; all when omitted."),
|
|
644
569
|
from: zod.iso.datetime({ offset: true }).optional(),
|
|
645
570
|
to: zod.iso.datetime({ offset: true }).optional().describe("Exclusive."),
|
|
646
571
|
});
|
|
647
572
|
/**
|
|
648
|
-
* Coupons
|
|
649
|
-
* entered. A coupon reached through a code is not listed here.
|
|
573
|
+
* Coupons held by the account, applied at checkout without a code. Coupons reached through a code are not listed.
|
|
650
574
|
* @summary List the coupons held on this account
|
|
651
575
|
*/
|
|
652
576
|
export const listAccountDiscountsQueryPageDefault = 1;
|
|
@@ -669,11 +593,10 @@ export const ListAccountDiscountsQueryParams = zod.strictObject({
|
|
|
669
593
|
billing_account_id: zod
|
|
670
594
|
.int()
|
|
671
595
|
.optional()
|
|
672
|
-
.describe("
|
|
596
|
+
.describe("Only this account of yours; all when omitted."),
|
|
673
597
|
});
|
|
674
598
|
/**
|
|
675
|
-
*
|
|
676
|
-
* and cannot be withdrawn.
|
|
599
|
+
* Credit grants with what remains and what each may pay for. Credit is spent before balance and cannot be withdrawn.
|
|
677
600
|
* @summary List credit grants
|
|
678
601
|
*/
|
|
679
602
|
export const listCreditGrantsQueryPageDefault = 1;
|
|
@@ -696,11 +619,11 @@ export const ListCreditGrantsQueryParams = zod.strictObject({
|
|
|
696
619
|
billing_account_id: zod
|
|
697
620
|
.int()
|
|
698
621
|
.optional()
|
|
699
|
-
.describe("
|
|
622
|
+
.describe("Only this account of yours; all when omitted."),
|
|
700
623
|
status: zod.enum(["active", "depleted", "expired", "voided"]).optional(),
|
|
701
624
|
});
|
|
702
625
|
/**
|
|
703
|
-
*
|
|
626
|
+
* Credit notes, newest first. Filters apply within the billing accounts you are authorized for.
|
|
704
627
|
* @summary List credit notes
|
|
705
628
|
*/
|
|
706
629
|
export const listCreditNotesQueryPageDefault = 1;
|
|
@@ -723,7 +646,7 @@ export const ListCreditNotesQueryParams = zod.strictObject({
|
|
|
723
646
|
billing_account_id: zod
|
|
724
647
|
.int()
|
|
725
648
|
.optional()
|
|
726
|
-
.describe("
|
|
649
|
+
.describe("Only this account of yours; all when omitted."),
|
|
727
650
|
invoice_id: zod.uuid().optional().describe("Only the notes for this invoice."),
|
|
728
651
|
});
|
|
729
652
|
/**
|
|
@@ -734,7 +657,7 @@ export const GetCreditNoteParams = zod.strictObject({
|
|
|
734
657
|
creditNoteId: zod.uuid(),
|
|
735
658
|
});
|
|
736
659
|
/**
|
|
737
|
-
* The
|
|
660
|
+
* The invoice lines this credit note reduced.
|
|
738
661
|
* @summary List credit note items
|
|
739
662
|
*/
|
|
740
663
|
export const ListCreditNoteItemsParams = zod.strictObject({
|
|
@@ -782,15 +705,15 @@ export const ListRefundsQueryParams = zod.strictObject({
|
|
|
782
705
|
billing_account_id: zod
|
|
783
706
|
.int()
|
|
784
707
|
.optional()
|
|
785
|
-
.describe("
|
|
708
|
+
.describe("Only this account of yours; all when omitted."),
|
|
786
709
|
invoice_id: zod.uuid().optional().describe("Only the refunds of this invoice."),
|
|
787
710
|
order_id: zod
|
|
788
711
|
.uuid()
|
|
789
712
|
.optional()
|
|
790
|
-
.describe("
|
|
713
|
+
.describe("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."),
|
|
791
714
|
});
|
|
792
715
|
/**
|
|
793
|
-
*
|
|
716
|
+
* Priced usage charges in the requested scope. Usage that had no price when it occurred is never charged later.
|
|
794
717
|
* @summary List usage charges
|
|
795
718
|
*/
|
|
796
719
|
export const listUsageChargesQueryPageDefault = 1;
|
|
@@ -816,14 +739,14 @@ export const ListUsageChargesQueryParams = zod.strictObject({
|
|
|
816
739
|
billing_account_id: zod
|
|
817
740
|
.int()
|
|
818
741
|
.optional()
|
|
819
|
-
.describe("
|
|
742
|
+
.describe("Only this account of yours; all when omitted."),
|
|
820
743
|
product_id: zod
|
|
821
744
|
.string()
|
|
822
745
|
.min(1)
|
|
823
746
|
.max(listUsageChargesQueryProductIdMax)
|
|
824
747
|
.regex(listUsageChargesQueryProductIdRegExp)
|
|
825
748
|
.optional()
|
|
826
|
-
.describe("
|
|
749
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
827
750
|
resource_id: zod.string().optional(),
|
|
828
751
|
invoice_item_id: zod
|
|
829
752
|
.uuid()
|
|
@@ -836,12 +759,12 @@ export const ListUsageChargesQueryParams = zod.strictObject({
|
|
|
836
759
|
.min(1)
|
|
837
760
|
.max(listUsageChargesQueryProjectIdsMax)
|
|
838
761
|
.optional()
|
|
839
|
-
.describe("
|
|
762
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
840
763
|
meter_id: zod.uuid().optional(),
|
|
841
764
|
statement_id: zod.uuid().optional(),
|
|
842
765
|
});
|
|
843
766
|
/**
|
|
844
|
-
*
|
|
767
|
+
* Subscriptions of the authorized billing account. Deleted subscriptions are not listed.
|
|
845
768
|
* @summary List subscriptions
|
|
846
769
|
*/
|
|
847
770
|
export const listSubscriptionsQueryPageDefault = 1;
|
|
@@ -866,50 +789,38 @@ export const ListSubscriptionsQueryParams = zod.strictObject({
|
|
|
866
789
|
billing_account_id: zod
|
|
867
790
|
.int()
|
|
868
791
|
.optional()
|
|
869
|
-
.describe("
|
|
792
|
+
.describe("Only this account of yours; all when omitted."),
|
|
870
793
|
project_ids: zod
|
|
871
794
|
.array(zod.uuid())
|
|
872
795
|
.min(1)
|
|
873
796
|
.max(listSubscriptionsQueryProjectIdsMax)
|
|
874
797
|
.optional()
|
|
875
|
-
.describe("
|
|
798
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
876
799
|
});
|
|
877
800
|
/**
|
|
878
|
-
*
|
|
801
|
+
* A subscription of the authorized billing account. Deleted subscriptions are reported as not found.
|
|
879
802
|
* @summary Get subscription
|
|
880
803
|
*/
|
|
881
804
|
export const GetSubscriptionParams = zod.strictObject({
|
|
882
805
|
subscriptionId: zod.uuid(),
|
|
883
806
|
});
|
|
884
807
|
/**
|
|
885
|
-
*
|
|
886
|
-
* list and detail. Your account access token must authorize the subscription's current billing
|
|
887
|
-
* account. Preserves commercial status, ended_at and billing and financial history. Completed
|
|
888
|
-
* cancellations and canceled unfulfilled purchases can be deleted directly, without termination.
|
|
889
|
-
* Pending, provisioning, active and suspended subscriptions are refused with 409
|
|
890
|
-
* BILLING_SUBSCRIPTION_NOT_ENDED and status in error params. A scheduled or releasing cancellation
|
|
891
|
-
* does not make a subscription canceled.
|
|
892
|
-
* There is no force, skip-cleanup or override option. Repeating deletion preserves the original
|
|
893
|
-
* deleted_at. Sends no cleanup command and creates no refund; outstanding cleanup continues.
|
|
808
|
+
* Hides a canceled or terminated subscription from your subscription list and detail by setting deleted_at; its status, ended_at and history are kept. The token must authorize the subscription's current billing account. A subscription that has not ended is refused with 409 `BILLING_SUBSCRIPTION_NOT_ENDED` and `status`. Repeating it keeps the original deleted_at. It sends no cleanup command and creates no refund.
|
|
894
809
|
* @summary Delete subscription
|
|
895
810
|
*/
|
|
896
811
|
export const DeleteSubscriptionParams = zod.strictObject({
|
|
897
812
|
subscriptionId: zod.uuid(),
|
|
898
813
|
});
|
|
899
814
|
/**
|
|
900
|
-
* Requests cancellation on the purchase's agreed terms
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
* Your account access token must authorize the subscription's current billing account.
|
|
815
|
+
* Requests cancellation on the purchase's agreed terms, with the same rules as creating a cancellation. Give the
|
|
816
|
+
* refund amount from a quote with this subscription in `cancellation.subscription_ids`. The token must authorize
|
|
817
|
+
* the subscription's current billing account.
|
|
904
818
|
*
|
|
905
|
-
* Immediate cancellation asks the owning service to
|
|
906
|
-
*
|
|
907
|
-
*
|
|
908
|
-
*
|
|
909
|
-
*
|
|
910
|
-
* Related subscriptions released together must be submitted as one group to create-cancellation.
|
|
911
|
-
* Pending or provisioning purchases are canceled through their order, not this operation.
|
|
912
|
-
* Repeating the same open cancellation returns it without another refund or command.
|
|
819
|
+
* Immediate cancellation asks the owning service to release the resources now; period-end cancellation keeps the
|
|
820
|
+
* subscription active or suspended until the paid term ends. The subscription becomes canceled when the service
|
|
821
|
+
* confirms the release; follow the returned cancellation. Subscriptions released together must be canceled
|
|
822
|
+
* together through create-cancellation, and pending or provisioning purchases through their order. Repeating the
|
|
823
|
+
* request while the cancellation is open returns it.
|
|
913
824
|
* @summary Cancel subscription
|
|
914
825
|
*/
|
|
915
826
|
export const CancelSubscriptionParams = zod.strictObject({
|
|
@@ -917,16 +828,7 @@ export const CancelSubscriptionParams = zod.strictObject({
|
|
|
917
828
|
});
|
|
918
829
|
export const CancelSubscriptionBody = CancelSubscriptionRequest;
|
|
919
830
|
/**
|
|
920
|
-
*
|
|
921
|
-
*
|
|
922
|
-
* Existing orders use their recorded purchase account and terms. Renewals and cancellations use the account currently paying for each subscription. Every target must belong to the requested account. A project association or project token does not authorize a quote.
|
|
923
|
-
*
|
|
924
|
-
* Use an existing order quote's total as expected_amount when paying the order's invoice. An order whose terms are fixed returns its recorded amounts; a different promotion code is refused. Requested future usage estimates are not collectible checkout amounts. An unknown delivery outcome is not proof of refund eligibility.
|
|
925
|
-
* @summary Create a quote
|
|
926
|
-
*/
|
|
927
|
-
export const CreateQuoteBody = QuoteRequest;
|
|
928
|
-
/**
|
|
929
|
-
* Newest first. Filter by `subscription_id` and `status=open` to find the cancellation now under way for a subscription.
|
|
831
|
+
* Newest first. Filter by `subscription_id` and `status=open` to find a subscription's cancellation in progress.
|
|
930
832
|
* @summary List cancellations
|
|
931
833
|
*/
|
|
932
834
|
export const listCancellationsQueryPageDefault = 1;
|
|
@@ -950,7 +852,7 @@ export const ListCancellationsQueryParams = zod.strictObject({
|
|
|
950
852
|
billing_account_id: zod
|
|
951
853
|
.int()
|
|
952
854
|
.optional()
|
|
953
|
-
.describe("
|
|
855
|
+
.describe("Only this account of yours; all when omitted."),
|
|
954
856
|
subscription_id: zod
|
|
955
857
|
.uuid()
|
|
956
858
|
.optional()
|
|
@@ -964,65 +866,51 @@ export const ListCancellationsQueryParams = zod.strictObject({
|
|
|
964
866
|
.min(1)
|
|
965
867
|
.max(listCancellationsQueryProjectIdsMax)
|
|
966
868
|
.optional()
|
|
967
|
-
.describe("
|
|
869
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
968
870
|
});
|
|
969
871
|
/**
|
|
970
|
-
* Ends
|
|
971
|
-
* subscription
|
|
972
|
-
* such as a server with the disks deleted along with it, or an address with its bandwidth.
|
|
872
|
+
* Ends subscriptions of one service together. Deleting a resource is an `immediate` cancellation of every
|
|
873
|
+
* subscription released with it, such as a server with its disks or an address with its bandwidth.
|
|
973
874
|
*
|
|
974
|
-
* The service
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
*
|
|
978
|
-
* amount confirmed here is the amount returned: prepaid service used while the resources are
|
|
979
|
-
* being released is not deducted from it. Usage of a postpaid subscription is charged until its
|
|
980
|
-
* resources are released, as usual.
|
|
875
|
+
* The owning service releases the resources at once for `immediate`, or at `scheduled_at`, the end of the paid
|
|
876
|
+
* term, for `period_end`. When release is confirmed, the unused value is returned to the original payment
|
|
877
|
+
* sources under each subscription's refund terms. For `immediate` the refund is computed as of `proration_date`
|
|
878
|
+
* and is not reduced by service used during release. Metered usage is charged until release.
|
|
981
879
|
*
|
|
982
|
-
* `mode` must be allowed for every subscription.
|
|
983
|
-
*
|
|
984
|
-
*
|
|
985
|
-
* not ended yet. For `period_end` the paid terms of all the subscriptions must end at the same
|
|
880
|
+
* `mode` must be allowed for every subscription. Metered and one-time subscriptions end only `immediate`. A
|
|
881
|
+
* licensed subscription ends `period_end` while its paid term lasts, and `immediate` unless its terms allow only
|
|
882
|
+
* the end of the paid term and that term has not ended. For `period_end` all paid terms must end at the same
|
|
986
883
|
* time.
|
|
987
884
|
*
|
|
988
885
|
* Refused with:
|
|
989
|
-
*
|
|
990
|
-
*
|
|
991
|
-
* account and currency;
|
|
886
|
+
*
|
|
887
|
+
* - 400 `BILLING_CANCELLATION_INVALID` when `subscription_ids` or `proration_date` is invalid (`meta.field`), or
|
|
888
|
+
* the subscriptions do not share one service, project, account and currency;
|
|
992
889
|
* - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
|
|
993
|
-
* - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed
|
|
994
|
-
*
|
|
995
|
-
*
|
|
996
|
-
* - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at
|
|
997
|
-
* different times;
|
|
890
|
+
* - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed, and `BILLING_CANCELLATION_TERMS_UNSET`
|
|
891
|
+
* when a licensed subscription has no termination terms, both with `meta.subscription_id`;
|
|
892
|
+
* - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at different times;
|
|
998
893
|
* - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
|
|
999
|
-
* (`meta.cancellation_id`) or reclaimed (`meta.reason` `reclaim_requested`), or has a paid
|
|
1000
|
-
*
|
|
1001
|
-
* - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for
|
|
1002
|
-
*
|
|
1003
|
-
* - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund is no longer
|
|
1004
|
-
* `expected_refundable_amount`; quote again.
|
|
894
|
+
* (`meta.cancellation_id`) or reclaimed (`meta.reason` `reclaim_requested`), or has a paid change waiting to
|
|
895
|
+
* switch (`meta.order_id`);
|
|
896
|
+
* - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online renewal payment for one of them is in progress;
|
|
897
|
+
* - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund no longer equals `expected_refundable_amount`.
|
|
1005
898
|
*
|
|
1006
|
-
*
|
|
1007
|
-
*
|
|
1008
|
-
*
|
|
1009
|
-
* every subscription in the set, for `period_end` as well as `immediate`.
|
|
899
|
+
* Repeating the request for the same subscriptions, mode and amount while the cancellation is open returns it
|
|
900
|
+
* with 200. Unpaid renewal orders are canceled with it, and automatic renewal is turned off for every
|
|
901
|
+
* subscription.
|
|
1010
902
|
* @summary Cancel subscriptions
|
|
1011
903
|
*/
|
|
1012
904
|
export const CreateCancellationBody = CancellationCreate;
|
|
1013
905
|
/**
|
|
1014
|
-
*
|
|
906
|
+
* A cancellation of your billing account with its schedule, expected refundable amount and the outcome for each subscription, including partial success.
|
|
1015
907
|
* @summary Get a cancellation
|
|
1016
908
|
*/
|
|
1017
909
|
export const GetCancellationParams = zod.strictObject({
|
|
1018
910
|
cancellationId: zod.uuid(),
|
|
1019
911
|
});
|
|
1020
912
|
/**
|
|
1021
|
-
* Withdraws the whole cancellation while
|
|
1022
|
-
* subscriptions continue as before, except that automatic renewal, turned off when the
|
|
1023
|
-
* cancellation was created, stays off until it is turned on again. After that it is refused with
|
|
1024
|
-
* 409 `BILLING_CANCELLATION_CONFLICT`. Withdrawing one that is already withdrawn returns it
|
|
1025
|
-
* unchanged.
|
|
913
|
+
* Withdraws the whole cancellation while no resource has begun to be released; afterwards it is refused with 409 `BILLING_CANCELLATION_CONFLICT`. The subscriptions continue, but automatic renewal, turned off when the cancellation was created, stays off until it is turned on again. Withdrawing a withdrawn cancellation returns it unchanged.
|
|
1026
914
|
* @summary Withdraw a cancellation
|
|
1027
915
|
*/
|
|
1028
916
|
export const WithdrawCancellationParams = zod.strictObject({
|
|
@@ -1054,17 +942,15 @@ export const ListRenewalPricesQueryParams = zod.strictObject({
|
|
|
1054
942
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
1055
943
|
});
|
|
1056
944
|
/**
|
|
1057
|
-
*
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
945
|
+
* Buys licensed periods from current_term_end at the agreed recurring amount and pays for them at once. A
|
|
946
|
+
* different interval selects the price currently sold for it and fixes new terms on the order, applied after
|
|
947
|
+
* fulfillment. Paid periods keep their value.
|
|
1060
948
|
*
|
|
1061
|
-
* Without `payment_method_id`, the renewal is paid from credit grants and
|
|
1062
|
-
* `
|
|
1063
|
-
*
|
|
1064
|
-
* and pay its invoice instead.
|
|
949
|
+
* Without `payment_method_id`, the renewal is paid from credit grants and balance as `use_credits` and
|
|
950
|
+
* `use_balance` allow; when they cannot cover it, the request fails with `BILLING_INSUFFICIENT_FUNDS` and no
|
|
951
|
+
* order is left. To pay another way, create a renewal order and pay its invoice.
|
|
1065
952
|
*
|
|
1066
|
-
*
|
|
1067
|
-
* creation conflicts.
|
|
953
|
+
* Keep order_id and read the order after an unknown outcome; creating it again conflicts.
|
|
1068
954
|
* @summary Renew subscription
|
|
1069
955
|
*/
|
|
1070
956
|
export const RenewSubscriptionParams = zod.strictObject({
|
|
@@ -1072,16 +958,14 @@ export const RenewSubscriptionParams = zod.strictObject({
|
|
|
1072
958
|
});
|
|
1073
959
|
export const RenewSubscriptionBody = RenewRequest;
|
|
1074
960
|
/**
|
|
1075
|
-
* Places a renewal order with a draft invoice, without applying a new discount or charging anything.
|
|
1076
|
-
*
|
|
1077
|
-
*
|
|
1078
|
-
*
|
|
1079
|
-
*
|
|
1080
|
-
*
|
|
1081
|
-
* order's terms are not fixed yet.
|
|
961
|
+
* Places a renewal order with a draft invoice, without applying a new discount or charging anything. Pay its
|
|
962
|
+
* invoice to renew; a promotion code can be applied when paying. Existing subscription discounts are kept.
|
|
963
|
+
* Periods and price are chosen as for renewing. The order can be paid until the current paid period ends, and
|
|
964
|
+
* never after the end of the first period it renews; unpaid by then, it is canceled. While auto-renew is on, the
|
|
965
|
+
* renewal due at the end of the period pays this order instead of placing another, applying an applicable
|
|
966
|
+
* account discount first if its terms are not fixed yet.
|
|
1082
967
|
*
|
|
1083
|
-
*
|
|
1084
|
-
* second time conflicts.
|
|
968
|
+
* Keep `order_id` and read the order after an unknown outcome; creating it again conflicts.
|
|
1085
969
|
* @summary Create renewal order
|
|
1086
970
|
*/
|
|
1087
971
|
export const CreateRenewalOrderParams = zod.strictObject({
|
|
@@ -1089,15 +973,7 @@ export const CreateRenewalOrderParams = zod.strictObject({
|
|
|
1089
973
|
});
|
|
1090
974
|
export const CreateRenewalOrderBody = RenewalOrderRequest;
|
|
1091
975
|
/**
|
|
1092
|
-
*
|
|
1093
|
-
* subscription cannot set this preference and returns 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE`. Disabling it does
|
|
1094
|
-
* not shorten current_term_end and still permits manual renewal. A postpaid subscription always continues until it is
|
|
1095
|
-
* canceled; setting it is refused with 409
|
|
1096
|
-
* `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED`.
|
|
1097
|
-
*
|
|
1098
|
-
* While the subscription has an open cancellation, turning it on or off is refused with 409
|
|
1099
|
-
* `BILLING_SUBSCRIPTION_OPERATION_PENDING` and `meta.cancellation_id`: creating the cancellation
|
|
1100
|
-
* turned it off, and withdrawing the cancellation does not turn it back on.
|
|
976
|
+
* Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on.
|
|
1101
977
|
* @summary Set auto renew
|
|
1102
978
|
*/
|
|
1103
979
|
export const SetAutoRenewParams = zod.strictObject({
|
|
@@ -1105,13 +981,7 @@ export const SetAutoRenewParams = zod.strictObject({
|
|
|
1105
981
|
});
|
|
1106
982
|
export const SetAutoRenewBody = AutoRenewSet;
|
|
1107
983
|
/**
|
|
1108
|
-
*
|
|
1109
|
-
* consumed before usage is charged. Lower priority values are consumed first, followed by earlier
|
|
1110
|
-
* expiry and earlier issuance.
|
|
1111
|
-
*
|
|
1112
|
-
* Unused quantity expires without a refund or carry-over. Promotional allowances apply to usage paid
|
|
1113
|
-
* by their holding account. Included allowances apply only to the associated subscription, including
|
|
1114
|
-
* after its project moves to another billing account.
|
|
984
|
+
* Remaining usage quantities, such as bytes, seconds or tokens. Applicable allowances are consumed before usage is charged: lower priority values first, then earlier expiry, then earlier issuance. Unused quantity expires without refund or carry-over. Promotional allowances apply to usage paid by their holding account; included allowances apply only to their subscription, also after its project moves to another billing account.
|
|
1115
985
|
* @summary List allowances
|
|
1116
986
|
*/
|
|
1117
987
|
export const listAllowancesQueryPageDefault = 1;
|
|
@@ -1137,7 +1007,7 @@ export const ListAllowancesQueryParams = zod.strictObject({
|
|
|
1137
1007
|
billing_account_id: zod
|
|
1138
1008
|
.int()
|
|
1139
1009
|
.optional()
|
|
1140
|
-
.describe("
|
|
1010
|
+
.describe("Only this account of yours; all when omitted."),
|
|
1141
1011
|
meter_id: zod.uuid().optional().describe("Filter by the meter UUID."),
|
|
1142
1012
|
status: zod.enum(["active", "depleted", "expired", "voided"]).optional(),
|
|
1143
1013
|
product_id: zod
|
|
@@ -1146,18 +1016,16 @@ export const ListAllowancesQueryParams = zod.strictObject({
|
|
|
1146
1016
|
.max(listAllowancesQueryProductIdMax)
|
|
1147
1017
|
.regex(listAllowancesQueryProductIdRegExp)
|
|
1148
1018
|
.optional()
|
|
1149
|
-
.describe("
|
|
1019
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
1150
1020
|
project_ids: zod
|
|
1151
1021
|
.array(zod.uuid())
|
|
1152
1022
|
.min(1)
|
|
1153
1023
|
.max(listAllowancesQueryProjectIdsMax)
|
|
1154
1024
|
.optional()
|
|
1155
|
-
.describe("
|
|
1025
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
1156
1026
|
});
|
|
1157
1027
|
/**
|
|
1158
|
-
*
|
|
1159
|
-
* its invoice shows whether it still needs payment. accepted means accepted, not delivered.
|
|
1160
|
-
* Pending orders can expire at expires_at.
|
|
1028
|
+
* Orders with their status and invoice amounts. A pending order is not yet accepted and can expire at expires_at; its invoice shows whether payment is needed. Accepted does not mean delivered.
|
|
1161
1029
|
* @summary List orders
|
|
1162
1030
|
*/
|
|
1163
1031
|
export const listOrdersQueryPageDefault = 1;
|
|
@@ -1181,11 +1049,11 @@ export const ListOrdersQueryParams = zod.strictObject({
|
|
|
1181
1049
|
billing_account_id: zod
|
|
1182
1050
|
.int()
|
|
1183
1051
|
.optional()
|
|
1184
|
-
.describe("
|
|
1052
|
+
.describe("Only this account of yours; all when omitted."),
|
|
1185
1053
|
status: zod
|
|
1186
1054
|
.enum(["pending", "accepted", "completed", "partially_completed", "failed", "canceled"])
|
|
1187
1055
|
.optional()
|
|
1188
|
-
.describe("Follows the items. `pending
|
|
1056
|
+
.describe("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."),
|
|
1189
1057
|
from: zod.iso.datetime({ offset: true }).optional(),
|
|
1190
1058
|
to: zod.iso.datetime({ offset: true }).optional().describe("Exclusive."),
|
|
1191
1059
|
project_ids: zod
|
|
@@ -1193,34 +1061,29 @@ export const ListOrdersQueryParams = zod.strictObject({
|
|
|
1193
1061
|
.min(1)
|
|
1194
1062
|
.max(listOrdersQueryProjectIdsMax)
|
|
1195
1063
|
.optional()
|
|
1196
|
-
.describe("
|
|
1064
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
1197
1065
|
});
|
|
1198
1066
|
/**
|
|
1199
|
-
*
|
|
1067
|
+
* An order of your billing account with its status and invoice. An unknown order returns 404; another user's order returns 403.
|
|
1200
1068
|
* @summary Get order
|
|
1201
1069
|
*/
|
|
1202
1070
|
export const GetOrderParams = zod.strictObject({
|
|
1203
1071
|
orderId: zod.uuid(),
|
|
1204
1072
|
});
|
|
1205
1073
|
/**
|
|
1206
|
-
* Cancels the selected
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1209
|
-
*
|
|
1210
|
-
* its existing pending phase while any item is still pending; its final outcome follows all
|
|
1211
|
-
* item outcomes. Previously failed items keep their failure outcome.
|
|
1074
|
+
* Cancels the selected undelivered items of an order that has not been accepted, without recording a delivery
|
|
1075
|
+
* failure. Omit order_item_ids to select every pending item. Delivered items stay delivered and are not
|
|
1076
|
+
* refunded; failed items keep their outcome. The order stays pending while any item is pending, and its final
|
|
1077
|
+
* status follows its items.
|
|
1212
1078
|
*
|
|
1213
|
-
*
|
|
1214
|
-
*
|
|
1215
|
-
*
|
|
1216
|
-
*
|
|
1217
|
-
*
|
|
1079
|
+
* Once the order's terms are fixed, the canceled items keep their agreed amounts and discounts: credit notes
|
|
1080
|
+
* reduce the issued invoice, and collected amounts return to their original payment sources, possibly
|
|
1081
|
+
* asynchronously. While a deferred order's terms are not fixed, the remaining items are priced again. An online
|
|
1082
|
+
* payment waiting for the payer is canceled with the order; one the gateway is processing is refused with
|
|
1083
|
+
* `BILLING_PAYMENT_PENDING` and `meta.transaction_id`. Repeating the cancellation does not refund twice.
|
|
1218
1084
|
*
|
|
1219
|
-
*
|
|
1220
|
-
*
|
|
1221
|
-
* subscription cancellation. Unknown delivery or payment outcomes are not refund evidence;
|
|
1222
|
-
* in-flight or unknown payments must be reconciled first. Scheduled changes continue to be
|
|
1223
|
-
* canceled through the owning service. Refund quotations use CreateQuote.refund.
|
|
1085
|
+
* An accepted order is canceled by its owning service, and delivered items through subscription cancellation.
|
|
1086
|
+
* Refunds are quoted with the quote operation's `refund` target.
|
|
1224
1087
|
* @summary Cancel order
|
|
1225
1088
|
*/
|
|
1226
1089
|
export const CancelOrderParams = zod.strictObject({
|
|
@@ -1253,13 +1116,7 @@ export const ListOrderItemsQueryParams = zod.strictObject({
|
|
|
1253
1116
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
1254
1117
|
});
|
|
1255
1118
|
/**
|
|
1256
|
-
* Capabilities
|
|
1257
|
-
* does not appear, so that "this does not exist" and "this has not been bought" cannot be
|
|
1258
|
-
* confused.
|
|
1259
|
-
*
|
|
1260
|
-
* Derived from live subscriptions and active feature grants rather than stored, so this always
|
|
1261
|
-
* agrees with what is being paid for and granted. It stops being listed as soon as the
|
|
1262
|
-
* subscription or grant providing it ends.
|
|
1119
|
+
* Capabilities granted by live subscriptions and active feature grants. A capability not held is not listed, and one stops being listed when the subscription or grant providing it ends.
|
|
1263
1120
|
* @summary List entitlements
|
|
1264
1121
|
*/
|
|
1265
1122
|
export const listEntitlementsQueryPageDefault = 1;
|
|
@@ -1285,25 +1142,23 @@ export const ListEntitlementsQueryParams = zod.strictObject({
|
|
|
1285
1142
|
billing_account_id: zod
|
|
1286
1143
|
.int()
|
|
1287
1144
|
.optional()
|
|
1288
|
-
.describe("
|
|
1145
|
+
.describe("Only this account of yours; all when omitted."),
|
|
1289
1146
|
project_ids: zod
|
|
1290
1147
|
.array(zod.uuid())
|
|
1291
1148
|
.min(1)
|
|
1292
1149
|
.max(listEntitlementsQueryProjectIdsMax)
|
|
1293
1150
|
.optional()
|
|
1294
|
-
.describe("
|
|
1151
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
1295
1152
|
product_id: zod
|
|
1296
1153
|
.string()
|
|
1297
1154
|
.min(1)
|
|
1298
1155
|
.max(listEntitlementsQueryProductIdMax)
|
|
1299
1156
|
.regex(listEntitlementsQueryProductIdRegExp)
|
|
1300
1157
|
.optional()
|
|
1301
|
-
.describe("
|
|
1158
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
1302
1159
|
});
|
|
1303
1160
|
/**
|
|
1304
|
-
*
|
|
1305
|
-
* is active, every project whose current billing account holds it has the feature, in addition to the
|
|
1306
|
-
* features of its own subscriptions.
|
|
1161
|
+
* Features held by a billing account for a period, for example through a membership. While a grant is active, every project whose current billing account holds it has the feature, in addition to its subscriptions' features.
|
|
1307
1162
|
* @summary List feature grants
|
|
1308
1163
|
*/
|
|
1309
1164
|
export const listFeatureGrantsQueryPageDefault = 1;
|
|
@@ -1328,27 +1183,21 @@ export const ListFeatureGrantsQueryParams = zod.strictObject({
|
|
|
1328
1183
|
billing_account_id: zod
|
|
1329
1184
|
.int()
|
|
1330
1185
|
.optional()
|
|
1331
|
-
.describe("
|
|
1186
|
+
.describe("Only this account of yours; all when omitted."),
|
|
1332
1187
|
product_id: zod
|
|
1333
1188
|
.string()
|
|
1334
1189
|
.min(1)
|
|
1335
1190
|
.max(listFeatureGrantsQueryProductIdMax)
|
|
1336
1191
|
.regex(listFeatureGrantsQueryProductIdRegExp)
|
|
1337
1192
|
.optional()
|
|
1338
|
-
.describe("
|
|
1193
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
1339
1194
|
status: zod
|
|
1340
1195
|
.enum(["scheduled", "active", "expired", "voided"])
|
|
1341
1196
|
.optional()
|
|
1342
1197
|
.describe("Derived from the validity period. scheduled means valid_from has not yet arrived."),
|
|
1343
1198
|
});
|
|
1344
1199
|
/**
|
|
1345
|
-
* Every
|
|
1346
|
-
*
|
|
1347
|
-
* `currency` is required: a plan has a price in each currency it is sold in, so "what does
|
|
1348
|
-
* this cost" has no answer without one.
|
|
1349
|
-
*
|
|
1350
|
-
* Archived prices are left out. Existing subscriptions keep the terms they were bought at, so
|
|
1351
|
-
* this is not the place to look up what an existing purchase is paying.
|
|
1200
|
+
* Every active price in the currency, one entry per plan and price. Archived prices are not listed; existing subscriptions keep the terms they were bought at.
|
|
1352
1201
|
* @summary List what is on sale, with prices
|
|
1353
1202
|
*/
|
|
1354
1203
|
export const listPricesQueryPageDefault = 1;
|
|
@@ -1383,20 +1232,18 @@ export const ListPricesQueryParams = zod.strictObject({
|
|
|
1383
1232
|
.max(listPricesQueryProductIdMax)
|
|
1384
1233
|
.regex(listPricesQueryProductIdRegExp)
|
|
1385
1234
|
.optional()
|
|
1386
|
-
.describe("
|
|
1387
|
-
type: zod
|
|
1388
|
-
|
|
1389
|
-
.optional()
|
|
1390
|
-
.describe("Narrows to one payment timing."),
|
|
1235
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
1236
|
+
type: zod.enum(["one_time", "recurring"]).optional().describe("Narrows to one price type."),
|
|
1237
|
+
usage_type: zod.enum(["licensed", "metered"]).optional().describe("Narrows to one usage type."),
|
|
1391
1238
|
});
|
|
1392
1239
|
export const ListPricesHeader = zod.strictObject({
|
|
1393
1240
|
"If-None-Match": zod
|
|
1394
1241
|
.string()
|
|
1395
1242
|
.optional()
|
|
1396
|
-
.describe("The `ETag`
|
|
1243
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1397
1244
|
});
|
|
1398
1245
|
/**
|
|
1399
|
-
*
|
|
1246
|
+
* Registered products. If-None-Match returns 304 for an unchanged page.
|
|
1400
1247
|
* @summary List catalog products
|
|
1401
1248
|
*/
|
|
1402
1249
|
export const listProductsQueryPageDefault = 1;
|
|
@@ -1421,11 +1268,10 @@ export const ListProductsHeader = zod.strictObject({
|
|
|
1421
1268
|
"If-None-Match": zod
|
|
1422
1269
|
.string()
|
|
1423
1270
|
.optional()
|
|
1424
|
-
.describe("The `ETag`
|
|
1271
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1425
1272
|
});
|
|
1426
1273
|
/**
|
|
1427
|
-
*
|
|
1428
|
-
* the terms of a credit — into something that can be displayed.
|
|
1274
|
+
* A product by its ID.
|
|
1429
1275
|
* @summary Get a service
|
|
1430
1276
|
*/
|
|
1431
1277
|
export const getProductPathProductIdMax = 64;
|
|
@@ -1436,17 +1282,16 @@ export const GetProductParams = zod.strictObject({
|
|
|
1436
1282
|
.min(1)
|
|
1437
1283
|
.max(getProductPathProductIdMax)
|
|
1438
1284
|
.regex(getProductPathProductIdRegExp)
|
|
1439
|
-
.describe("
|
|
1285
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
1440
1286
|
});
|
|
1441
1287
|
export const GetProductHeader = zod.strictObject({
|
|
1442
1288
|
"If-None-Match": zod
|
|
1443
1289
|
.string()
|
|
1444
1290
|
.optional()
|
|
1445
|
-
.describe("The `ETag`
|
|
1291
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1446
1292
|
});
|
|
1447
1293
|
/**
|
|
1448
|
-
*
|
|
1449
|
-
* no longer on sale: an existing purchase still refers to one.
|
|
1294
|
+
* A plan, including one no longer on sale.
|
|
1450
1295
|
* @summary Get a sellable item
|
|
1451
1296
|
*/
|
|
1452
1297
|
export const GetPlanParams = zod.strictObject({
|
|
@@ -1456,10 +1301,10 @@ export const GetPlanHeader = zod.strictObject({
|
|
|
1456
1301
|
"If-None-Match": zod
|
|
1457
1302
|
.string()
|
|
1458
1303
|
.optional()
|
|
1459
|
-
.describe("The `ETag`
|
|
1304
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1460
1305
|
});
|
|
1461
1306
|
/**
|
|
1462
|
-
*
|
|
1307
|
+
* A catalog price, archived prices included. The terms of past purchases are on their orders and subscriptions.
|
|
1463
1308
|
* @summary Get a price
|
|
1464
1309
|
*/
|
|
1465
1310
|
export const GetPriceParams = zod.strictObject({
|
|
@@ -1469,10 +1314,10 @@ export const GetPriceHeader = zod.strictObject({
|
|
|
1469
1314
|
"If-None-Match": zod
|
|
1470
1315
|
.string()
|
|
1471
1316
|
.optional()
|
|
1472
|
-
.describe("The `ETag`
|
|
1317
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1473
1318
|
});
|
|
1474
1319
|
/**
|
|
1475
|
-
*
|
|
1320
|
+
* Active plans of product_id with their features. An unknown product returns 404; If-None-Match returns 304 for an unchanged page.
|
|
1476
1321
|
* @summary List catalog plans
|
|
1477
1322
|
*/
|
|
1478
1323
|
export const listPlansQueryProductIdMax = 64;
|
|
@@ -1487,7 +1332,7 @@ export const ListPlansQueryParams = zod.strictObject({
|
|
|
1487
1332
|
.min(1)
|
|
1488
1333
|
.max(listPlansQueryProductIdMax)
|
|
1489
1334
|
.regex(listPlansQueryProductIdRegExp)
|
|
1490
|
-
.describe("
|
|
1335
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
1491
1336
|
page: zod
|
|
1492
1337
|
.int()
|
|
1493
1338
|
.min(1)
|
|
@@ -1505,11 +1350,10 @@ export const ListPlansHeader = zod.strictObject({
|
|
|
1505
1350
|
"If-None-Match": zod
|
|
1506
1351
|
.string()
|
|
1507
1352
|
.optional()
|
|
1508
|
-
.describe("The `ETag`
|
|
1353
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1509
1354
|
});
|
|
1510
1355
|
/**
|
|
1511
|
-
* Public list prices
|
|
1512
|
-
* it is never charged more.
|
|
1356
|
+
* Public list prices. An account with a negotiated agreement may be charged less, never more.
|
|
1513
1357
|
* @summary List catalog prices
|
|
1514
1358
|
*/
|
|
1515
1359
|
export const ListPricesByPlanParams = zod.strictObject({
|
|
@@ -1538,11 +1382,10 @@ export const ListPricesByPlanHeader = zod.strictObject({
|
|
|
1538
1382
|
"If-None-Match": zod
|
|
1539
1383
|
.string()
|
|
1540
1384
|
.optional()
|
|
1541
|
-
.describe("The `ETag`
|
|
1385
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1542
1386
|
});
|
|
1543
1387
|
/**
|
|
1544
|
-
*
|
|
1545
|
-
* and its identifier cannot be used to reach it.
|
|
1388
|
+
* Rules of a public rate card; contract cards are not readable here.
|
|
1546
1389
|
* @summary List catalog rates
|
|
1547
1390
|
*/
|
|
1548
1391
|
export const ListRatesParams = zod.strictObject({
|
|
@@ -1569,18 +1412,16 @@ export const ListRatesQueryParams = zod.strictObject({
|
|
|
1569
1412
|
at: zod.iso
|
|
1570
1413
|
.datetime({ offset: true })
|
|
1571
1414
|
.optional()
|
|
1572
|
-
.describe("
|
|
1415
|
+
.describe("Rates in effect at this moment; defaults to now."),
|
|
1573
1416
|
});
|
|
1574
1417
|
export const ListRatesHeader = zod.strictObject({
|
|
1575
1418
|
"If-None-Match": zod
|
|
1576
1419
|
.string()
|
|
1577
1420
|
.optional()
|
|
1578
|
-
.describe("The `ETag`
|
|
1421
|
+
.describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
|
|
1579
1422
|
});
|
|
1580
1423
|
/**
|
|
1581
|
-
*
|
|
1582
|
-
* describe machine runtime or health. Project filters narrow the authorized accounts; they do not
|
|
1583
|
-
* grant project-based access.
|
|
1424
|
+
* Continuous metering registrations paid for by your billing accounts. Their state does not describe the resource's runtime. Project filters only narrow the result.
|
|
1584
1425
|
* @summary List active resources
|
|
1585
1426
|
*/
|
|
1586
1427
|
export const listActiveResourcesQueryPageDefault = 1;
|
|
@@ -1607,13 +1448,13 @@ export const ListActiveResourcesQueryParams = zod.strictObject({
|
|
|
1607
1448
|
billing_account_id: zod
|
|
1608
1449
|
.int()
|
|
1609
1450
|
.optional()
|
|
1610
|
-
.describe("
|
|
1451
|
+
.describe("Only this account of yours; all when omitted."),
|
|
1611
1452
|
project_ids: zod
|
|
1612
1453
|
.array(zod.uuid())
|
|
1613
1454
|
.min(1)
|
|
1614
1455
|
.max(listActiveResourcesQueryProjectIdsMax)
|
|
1615
1456
|
.optional()
|
|
1616
|
-
.describe("
|
|
1457
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
1617
1458
|
meter_id: zod.uuid().optional(),
|
|
1618
1459
|
product_id: zod
|
|
1619
1460
|
.string()
|
|
@@ -1621,7 +1462,7 @@ export const ListActiveResourcesQueryParams = zod.strictObject({
|
|
|
1621
1462
|
.max(listActiveResourcesQueryProductIdMax)
|
|
1622
1463
|
.regex(listActiveResourcesQueryProductIdRegExp)
|
|
1623
1464
|
.optional()
|
|
1624
|
-
.describe("
|
|
1465
|
+
.describe("The platform service's fixed identifier, such as compute, canopy or assistant."),
|
|
1625
1466
|
status: zod.enum(["active", "suspended", "closing", "closed"]).optional(),
|
|
1626
1467
|
});
|
|
1627
1468
|
/**
|
|
@@ -1646,9 +1487,9 @@ export const ListSpendQueryParams = zod.strictObject({
|
|
|
1646
1487
|
.datetime({ offset: true })
|
|
1647
1488
|
.describe("Exclusive. One month is `[2026-09-01, 2026-10-01)`."),
|
|
1648
1489
|
group_by: zod
|
|
1649
|
-
.enum(["product", "plan", "resource"])
|
|
1490
|
+
.enum(["product", "plan", "resource", "meter"])
|
|
1650
1491
|
.default(listSpendQueryGroupByDefault)
|
|
1651
|
-
.describe("`plan` groups by the plan of the price each charge was priced with,
|
|
1492
|
+
.describe("`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."),
|
|
1652
1493
|
product_id: zod
|
|
1653
1494
|
.string()
|
|
1654
1495
|
.min(1)
|
|
@@ -1670,16 +1511,16 @@ export const ListSpendQueryParams = zod.strictObject({
|
|
|
1670
1511
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
1671
1512
|
billing_account_id: zod
|
|
1672
1513
|
.int()
|
|
1673
|
-
.describe("The
|
|
1514
|
+
.describe("The billing account whose currency and charges the report uses; it must be authorized."),
|
|
1674
1515
|
project_ids: zod
|
|
1675
1516
|
.array(zod.uuid())
|
|
1676
1517
|
.min(1)
|
|
1677
1518
|
.max(listSpendQueryProjectIdsMax)
|
|
1678
1519
|
.optional()
|
|
1679
|
-
.describe("
|
|
1520
|
+
.describe("Only records of these projects. Omit for all projects and account-level records. It does not grant access to other billing accounts."),
|
|
1680
1521
|
});
|
|
1681
1522
|
/**
|
|
1682
|
-
* Usage billing
|
|
1523
|
+
* Usage billing per UTC calendar month for your billing accounts, newest first. Each month combines its statements, the invoices they issued and how those were paid.
|
|
1683
1524
|
* @summary List monthly statements
|
|
1684
1525
|
*/
|
|
1685
1526
|
export const listMonthlyStatementsQueryPageDefault = 1;
|
|
@@ -1704,7 +1545,7 @@ export const ListMonthlyStatementsQueryParams = zod.strictObject({
|
|
|
1704
1545
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
1705
1546
|
});
|
|
1706
1547
|
/**
|
|
1707
|
-
*
|
|
1548
|
+
* Statements of your billing accounts, filtered by billing_account_id, open or closed and period start. A closed statement does not mean the month is complete.
|
|
1708
1549
|
* @summary List statements
|
|
1709
1550
|
*/
|
|
1710
1551
|
export const listStatementsQueryPageDefault = 1;
|
|
@@ -1730,14 +1571,14 @@ export const ListStatementsQueryParams = zod.strictObject({
|
|
|
1730
1571
|
.describe("Items per page. Defaults to 50; at most 200."),
|
|
1731
1572
|
});
|
|
1732
1573
|
/**
|
|
1733
|
-
*
|
|
1574
|
+
* A statement of your billing account with its period, estimated or closed amounts and invoice. Returns 404 for a missing statement and 403 for another user's account.
|
|
1734
1575
|
* @summary Get statement
|
|
1735
1576
|
*/
|
|
1736
1577
|
export const GetStatementParams = zod.strictObject({
|
|
1737
1578
|
statementId: zod.uuid(),
|
|
1738
1579
|
});
|
|
1739
1580
|
/**
|
|
1740
|
-
*
|
|
1581
|
+
* The statement's consumption, grouped by project, product or meter and filtered within the statement. Quantities are given only for meter groups; grouping by meter also splits by the meter's presentation dimensions.
|
|
1741
1582
|
* @summary Get grouped consumption
|
|
1742
1583
|
*/
|
|
1743
1584
|
export const GetStatementUsageParams = zod.strictObject({
|