@leaflow/sdk 0.106.0 → 0.108.0

package/dist/billing/account/v1/generated/schemas.zod.js

@@ -0,0 +1,994 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing Account API
+ * The caller's billing accounts, purchases and payments.
+ * Query accepted financial operations by their original IDs after an unknown outcome.
+ * Public prices and estimates are served under `/catalog/v1/` and require no credentials.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { AutoRenewSet } from "./validators/autoRenewSet.zod.js";
+import { BillingAccountCreate } from "./validators/billingAccountCreate.zod.js";
+import { BillingAccountUpdate } from "./validators/billingAccountUpdate.zod.js";
+import { CancellationCreate } from "./validators/cancellationCreate.zod.js";
+import { CheckoutOrderRequest } from "./validators/checkoutOrderRequest.zod.js";
+import { PayInvoiceRequest } from "./validators/payInvoiceRequest.zod.js";
+import { PayTogetherRequest } from "./validators/payTogetherRequest.zod.js";
+import { PaymentMethodSetup } from "./validators/paymentMethodSetup.zod.js";
+import { QuoteRequest } from "./validators/quoteRequest.zod.js";
+import { RenewRequest } from "./validators/renewRequest.zod.js";
+import { RenewalOrderRequest } from "./validators/renewalOrderRequest.zod.js";
+import { SetProjectAssignmentRequest } from "./validators/setProjectAssignmentRequest.zod.js";
+import { TopUpCreate } from "./validators/topUpCreate.zod.js";
+/**
+ * The currencies a new billing account can be opened in. A retired currency is not listed,
+ * although accounts already opened in it keep working. Results are paginated.
+ * @summary List currencies accounts can be opened in
+ */
+export const listCurrenciesQueryPageMax = 2147483647;
+export const listCurrenciesQueryPageSizeMax = 100;
+export const ListCurrenciesQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listCurrenciesQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listCurrenciesQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+});
+/**
+ * @summary List billing accounts
+ */
+export const listBillingAccountsQueryPageMax = 2147483647;
+export const listBillingAccountsQueryPageSizeMax = 100;
+export const ListBillingAccountsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listBillingAccountsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listBillingAccountsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+});
+/**
+ * The currency is chosen here and cannot be changed afterwards. Everything charged to the
+ * account — prices, orders, invoices, balance — is denominated in it.
+ *
+ * One person may hold several accounts, for example a personal one and one for a team.
+ * @summary Create billing account
+ */
+export const CreateBillingAccountBody = BillingAccountCreate;
+/**
+ * @summary Get billing account
+ */
+export const GetBillingAccountParams = zod.strictObject({
+    accountId: zod.int(),
+});
+/**
+ * The legal name, address and tax identifier are copied onto each invoice when it is
+ * issued. Changing them here affects invoices issued afterwards, not those already sent.
+ *
+ * The currency cannot be changed.
+ * @summary Update billing account
+ */
+export const UpdateBillingAccountParams = zod.strictObject({
+    accountId: zod.int(),
+});
+export const UpdateBillingAccountBody = BillingAccountUpdate;
+/**
+ * @summary Get account balance
+ */
+export const GetAccountBalanceParams = zod.strictObject({
+    accountId: zod.int(),
+});
+/**
+ * Whether the account has anything billed by usage, and what that usage has cost over the last
+ * seven days. Usage is paid from the balance, so this tells how much of the balance it is likely
+ * to need: the balance divided by `average_daily_amount` is roughly how many days it lasts.
+ * @summary Get account metered usage
+ */
+export const GetAccountMeteredUsageParams = zod.strictObject({
+    accountId: zod.int(),
+});
+/**
+ * Lists the payment gateways and methods that currently accept payment in this account's currency, the
+ * preferred gateway first. Top-ups and invoice payments must name a gateway and method listed here;
+ * others are refused. An empty result means no online payment is available for this account.
+ * Results are paginated.
+ * @summary List payment options
+ */
+export const ListPaymentOptionsParams = zod.strictObject({
+    accountId: zod.int(),
+});
+export const listPaymentOptionsQueryPageMax = 2147483647;
+export const listPaymentOptionsQueryPageSizeMax = 100;
+export const ListPaymentOptionsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listPaymentOptionsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listPaymentOptionsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+});
+/**
+ * @summary List project assignments
+ */
+export const listProjectAssignmentsQueryPageMax = 2147483647;
+export const listProjectAssignmentsQueryPageSizeMax = 100;
+export const ListProjectAssignmentsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listProjectAssignmentsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listProjectAssignmentsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod.int().optional(),
+});
+/**
+ * Returns 404 when the project has no billing account. No resources can be created until one is linked.
+ * @summary Get project assignment
+ */
+export const GetProjectAssignmentParams = zod.strictObject({
+    projectId: zod.uuid(),
+});
+/**
+ * Charges already incurred remain with the billing account that was linked when they
+ * occurred, and are still invoiced to it. Metered resources are settled up to the moment of
+ * the change. Amounts owed by the previous billing account remain owed by it and do not
+ * prevent the change.
+ *
+ * Orders keep the billing account they were placed with and are fulfilled as placed. Periods
+ * already paid for are unaffected; renewals are charged to the new billing account.
+ *
+ * The request is refused once the project no longer accepts purchases because it is being
+ * deleted, and while a subscription or an order in progress in the project uses a currency
+ * other than that of the new billing account.
+ * @summary Set project assignment
+ */
+export const SetProjectAssignmentParams = zod.strictObject({
+    projectId: zod.uuid(),
+});
+export const SetProjectAssignmentBody = SetProjectAssignmentRequest;
+/**
+ * Permitted only when nothing in the project is still running or in progress: no metered
+ * resources, no subscriptions that have not ended, and no orders in progress, including
+ * changes scheduled for the end of a period. Orders are not modified by this request; wait
+ * for them to complete, and have the service that scheduled a change call it off.
+ *
+ * Charges already incurred remain with the billing account and are invoiced to it as usual.
+ * Amounts the billing account owes do not prevent unlinking.
+ *
+ * After this the project cannot make purchases until a billing account is linked again.
+ * @summary Unlink project billing account
+ */
+export const UnlinkProjectBillingAccountParams = zod.strictObject({
+    projectId: zod.uuid(),
+});
+/**
+ * Lists only the authenticated user's top-ups. Includes pending, failed and canceled attempts; no invoice is
+ * created for a top-up. Items carry no `action`; read a pending top-up with get-top-up to continue its payment.
+ * @summary List top ups
+ */
+export const listTopUpsQueryPageMax = 2147483647;
+export const listTopUpsQueryPageSizeMax = 100;
+export const ListTopUpsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listTopUpsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listTopUpsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+});
+/**
+ * Creates a top-up for an account owned by the authenticated user and returns its payment information.
+ * The balance increases only after the payment gateway confirms receipt. A top-up has no invoice.
+ * Keep the supplied ID to query the original attempt after a lost response; duplicate creation conflicts.
+ * @summary Create top up
+ */
+export const CreateTopUpBody = TopUpCreate;
+/**
+ * Reads a top-up owned by the authenticated user, including its outcome and the part of it not yet spent.
+ * It is not an invoice.
+ *
+ * While the top-up is pending, the answer includes the customer's next step as the payment gateway
+ * currently reports it, so that a payment interrupted by a closed page can be continued. When the gateway
+ * cannot be reached, the top-up is returned without `action`; read it again later.
+ * @summary Get top up
+ */
+export const GetTopUpParams = zod.strictObject({
+    topUpId: zod.uuid(),
+});
+/**
+ * Withdraws a pending top-up owned by the authenticated user at the payment gateway. It becomes
+ * `canceled` with `cancellation_reason` `requested_by_customer`, and no money is collected for it. Canceling a
+ * top-up that is already canceled returns it unchanged.
+ *
+ * If the gateway has already collected the payment, nothing is withdrawn and the top-up is returned
+ * as `succeeded` with the balance increased. Check `status` in the answer rather than assuming the
+ * cancellation took effect.
+ *
+ * Fails with 409 and BILLING_TOPUP_NOT_CANCELABLE when the top-up has already succeeded or failed,
+ * with `status` naming that outcome, and while the gateway is processing the payment and can no
+ * longer withdraw it, with `status` set to `pending`; read the top-up again later in that case.
+ * @summary Cancel top up
+ */
+export const CancelTopUpParams = zod.strictObject({
+    topUpId: zod.uuid(),
+});
+/**
+ * @summary List payment methods
+ */
+export const listPaymentMethodsQueryPageMax = 2147483647;
+export const listPaymentMethodsQueryPageSizeMax = 100;
+export const ListPaymentMethodsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listPaymentMethodsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listPaymentMethodsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+});
+/**
+ * Returns what is needed to hand the browser over to the payment gateway's own card
+ * form. Nothing is charged, and the method appears in the list once the gateway
+ * confirms it.
+ *
+ * Card numbers are never sent to or stored by this service.
+ * @summary Create payment method setup
+ */
+export const CreatePaymentMethodSetupBody = PaymentMethodSetup;
+/**
+ * @summary Set default payment method
+ */
+export const SetDefaultPaymentMethodParams = zod.strictObject({
+    paymentMethodId: zod.uuid(),
+});
+/**
+ * Refused when it is the only method on an account that has resources billed by the hour,
+ * as there would be nothing left to charge when the balance runs out.
+ * @summary Delete payment method
+ */
+export const DeletePaymentMethodParams = zod.strictObject({
+    paymentMethodId: zod.uuid(),
+});
+/**
+ * Applies eligible credit grants and available balance as requested, then collects the remainder
+ * through the selected payment gateway and method. With no gateway selection, insufficient
+ * account funds fail without starting an online payment. Card and non-card methods use this same
+ * operation. Promotion codes are confirmed by checkout, before collecting payment.
+ *
+ * Returns a payment action when customer interaction is required. requires_action and processing
+ * do not mean paid; the invoice is marked paid after payment is confirmed. An unresolved payment
+ * attempt is reused, and retries do not apply credit grants or balance twice.
+ *
+ * Calling this on an invoice that is already paid returns the existing payment result without
+ * another charge. A draft order invoice must first be confirmed through checkout. It and a void
+ * invoice are refused with `BILLING_INVOICE_NOT_PAYABLE`; the invoice of an order that has failed or was
+ * canceled, with `BILLING_ORDER_FAILED` or `BILLING_ORDER_CANCELED`; and that of an order whose
+ * payment deadline has passed, with `BILLING_ORDER_EXPIRED`.
+ * @summary Pay an invoice
+ */
+export const PayInvoiceParams = zod.strictObject({
+    invoiceId: zod.uuid(),
+});
+export const PayInvoiceBody = PayInvoiceRequest;
+/**
+ * What paying this invoice now would take from credit grants, from the balance and, for the rest,
+ * from a payment gateway. It is computed as paying computes it, so paying with the same options
+ * straight afterwards takes exactly these amounts unless the account's funds change in between.
+ * Nothing is charged, reserved or created.
+ *
+ * Refused with the same errors as paying, except that insufficient funds are not an error here:
+ * they show as a `gateway_amount` above zero.
+ * @summary Preview invoice payment
+ */
+export const PreviewInvoicePaymentParams = zod.strictObject({
+    invoiceId: zod.uuid(),
+});
+export const previewInvoicePaymentQueryUseBalanceDefault = true;
+export const previewInvoicePaymentQueryUseCreditsDefault = true;
+export const PreviewInvoicePaymentQueryParams = zod.strictObject({
+    use_balance: zod
+        .boolean()
+        .default(previewInvoicePaymentQueryUseBalanceDefault)
+        .describe("As in paying. True when omitted."),
+    use_credits: zod
+        .boolean()
+        .default(previewInvoicePaymentQueryUseCreditsDefault)
+        .describe("As in paying. True when omitted."),
+});
+/**
+ * Pays outstanding invoices, including the invoices of the listed orders, from the account's
+ * eligible credit grants and then its balance. No payment gateway is used; an invoice to be
+ * paid online is paid on its own.
+ *
+ * Either every invoice is paid or none is. When the credit grants and balance cannot cover
+ * them all, the request fails with `BILLING_INSUFFICIENT_FUNDS` and nothing is charged.
+ * Invoices that are already paid are not charged again. An invoice with an online payment
+ * still in progress is refused with `BILLING_PAYMENT_PENDING`, a draft order invoice or void invoice with
+ * `BILLING_INVOICE_NOT_PAYABLE`, an order that has failed or was canceled with
+ * `BILLING_ORDER_FAILED` or `BILLING_ORDER_CANCELED`, and an order whose payment deadline has
+ * passed with `BILLING_ORDER_EXPIRED`.
+ * @summary Pay together
+ */
+export const PayTogetherBody = PayTogetherRequest;
+/**
+ * What paying these invoices together now would take from credit grants and from the balance,
+ * invoice by invoice in the order they would be paid. It is computed as paying together computes
+ * it. Nothing is charged, reserved or created.
+ *
+ * Refused with the same errors as paying together, except that insufficient funds are not an
+ * error here: they show as a `gateway_amount` above zero, and paying together would then be
+ * refused with `BILLING_INSUFFICIENT_FUNDS`.
+ * @summary Preview paying together
+ */
+export const PreviewPayTogetherBody = PayTogetherRequest;
+/**
+ * @summary List invoices
+ */
+export const listInvoicesQueryPageMax = 2147483647;
+export const listInvoicesQueryPageSizeMax = 100;
+export const ListInvoicesQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listInvoicesQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listInvoicesQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    status: zod
+        .enum(["draft", "open", "paid", "refunded", "void", "uncollectible"])
+        .optional()
+        .describe("An order invoice stays `draft` until checkout confirms its discount and final amounts. It\ncannot be collected while draft. Confirmation makes it `open`, or `paid` when its total is zero\nwithout creating a payment transaction. A quote never changes this status.\n\nA usage invoice stays `draft` through its month: each charge is added to it as it is priced\nand paid from credits and balance as it goes. It is issued at the end of the month, becoming\n`paid` when everything was covered and `open` when something is still owed.\n\n`refunded` means the invoice was paid and has since been refunded in full; a partial refund\nleaves it `paid`, with the refunded part in `amount_refunded`.\n\n`void` means the invoice will not be paid and holds no money: nothing was paid, or its order\nfailed or was canceled and everything paid toward it has been returned, as `amount_paid` and\n`amount_refunded` show."),
+    from: zod.iso.datetime({ offset: true }).optional(),
+    to: zod.iso.datetime({ offset: true }).optional().describe("Exclusive."),
+});
+/**
+ * @summary Get invoice
+ */
+export const GetInvoiceParams = zod.strictObject({
+    invoiceId: zod.uuid(),
+});
+/**
+ * @summary List invoice items
+ */
+export const ListInvoiceItemsParams = zod.strictObject({
+    invoiceId: zod.uuid(),
+});
+export const listInvoiceItemsQueryPageMax = 2147483647;
+export const listInvoiceItemsQueryPageSizeMax = 100;
+export const ListInvoiceItemsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listInvoiceItemsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listInvoiceItemsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+});
+/**
+ * @summary List transactions
+ */
+export const listTransactionsQueryPageMax = 2147483647;
+export const listTransactionsQueryPageSizeMax = 100;
+export const ListTransactionsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listTransactionsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listTransactionsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    from: zod.iso.datetime({ offset: true }).optional(),
+    to: zod.iso.datetime({ offset: true }).optional().describe("Exclusive."),
+});
+/**
+ * Coupons placed on the account directly, which apply at checkout without a code being
+ * entered. A coupon reached through a code is not listed here.
+ * @summary List the coupons held on this account
+ */
+export const listAccountDiscountsQueryPageMax = 2147483647;
+export const listAccountDiscountsQueryPageSizeMax = 100;
+export const ListAccountDiscountsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listAccountDiscountsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listAccountDiscountsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+});
+/**
+ * Each grant shows what remains and what it may be used for. Credit is spent before the balance
+ * and cannot be withdrawn.
+ * @summary List credit grants
+ */
+export const listCreditGrantsQueryPageMax = 2147483647;
+export const listCreditGrantsQueryPageSizeMax = 100;
+export const ListCreditGrantsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listCreditGrantsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listCreditGrantsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    status: zod.enum(["active", "depleted", "expired", "voided"]).optional(),
+});
+/**
+ * Newest first.
+ * @summary List refunds
+ */
+export const listRefundsQueryPageMax = 2147483647;
+export const listRefundsQueryPageSizeMax = 100;
+export const ListRefundsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listRefundsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listRefundsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    invoice_id: zod.uuid().optional().describe("Only the refunds of this invoice."),
+    order_id: zod
+        .uuid()
+        .optional()
+        .describe("Only the refunds that belong to this order: those of its invoice, such as the refund of a\npurchase that could not be delivered, and those it caused on an earlier invoice, such as\nthe difference returned after a downgrade."),
+});
+/**
+ * Each charge is added to the month's usage invoice as it is priced, summed into one line per
+ * subscription, project, resource, meter and rate. Filter by `invoice_item_id` to see the
+ * charges behind a line. Charges still waiting to be priced are included too.
+ * @summary List usage charges
+ */
+export const listUsageChargesQueryPageMax = 2147483647;
+export const listUsageChargesQueryPageSizeMax = 100;
+export const listUsageChargesQueryProductIdMax = 64;
+export const listUsageChargesQueryProductIdRegExp = new RegExp("^[a-z][a-z0-9]*(-[a-z0-9]+)*$");
+export const ListUsageChargesQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listUsageChargesQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listUsageChargesQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    project_id: zod.uuid().optional(),
+    product_id: zod
+        .string()
+        .min(1)
+        .max(listUsageChargesQueryProductIdMax)
+        .regex(listUsageChargesQueryProductIdRegExp)
+        .optional()
+        .describe("Immutable platform service identifier, such as compute, canopy or assistant."),
+    resource_id: zod.string().optional(),
+    invoice_item_id: zod
+        .uuid()
+        .optional()
+        .describe("Only the charges summed into this usage invoice line."),
+    from: zod.iso.datetime({ offset: true }).optional(),
+    to: zod.iso.datetime({ offset: true }).optional().describe("Exclusive."),
+});
+/**
+ * @summary List subscriptions
+ */
+export const listSubscriptionsQueryPageMax = 2147483647;
+export const listSubscriptionsQueryPageSizeMax = 100;
+export const ListSubscriptionsQueryParams = zod.strictObject({
+    expiring_before: zod.iso.datetime({ offset: true }).optional(),
+    page: zod
+        .int()
+        .min(1)
+        .max(listSubscriptionsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listSubscriptionsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    project_id: zod.uuid().optional(),
+});
+/**
+ * @summary Get subscription
+ */
+export const GetSubscriptionParams = zod.strictObject({
+    subscriptionId: zod.uuid(),
+});
+/**
+ * Computes a price preview without creating a resource or saving a quote. Nothing is charged,
+ * reserved or applied to an order, and no discount redemption is consumed. The response has no
+ * quote ID and does not guarantee a price or reserve a promotion code.
+ *
+ * With order_id, uses that order's recorded purchase terms and billing account. An optional
+ * promotion_code previews one code; without it, Billing selects an applicable account discount.
+ * An invalid or inapplicable explicit code is refused rather than silently replaced. Give total
+ * as expected_amount when confirming checkout; eligibility and availability are checked again.
+ * An order already checked out returns its confirmed amounts, without reapplying its discount;
+ * a different code is refused with BILLING_ORDER_CHECKOUT_CONFLICT.
+ *
+ * A renewal is priced exactly as renewing would charge it: at the agreed amount or the price
+ * named, with the discounts the account holds, and with tax. A renewal list does not accept a
+ * promotion code because its entries create separate orders. To use a new code on a renewal,
+ * first create a renewal order and quote its checkout by order_id. Prices and discount eligibility
+ * may change between preview and confirmation.
+ *
+ * A cancellation is quoted as creating it would compute the refund, as of now and under the refund
+ * terms agreed when each subscription was bought. It is quoted on its own: combined with another target
+ * the request is refused with HTTP 400 `BILLING_PURCHASE_INVALID` and `meta.field`
+ * `cancellation`. It is refused with the same errors as creating the cancellation, except that the
+ * amount is not checked. Give the returned `cancellation.proration_date` and
+ * `cancellation.refundable_amount` when creating it.
+ *
+ * Orders must belong to one of your billing accounts. Every subscription in a renewal or cancellation
+ * quote must be paid for by the same one of your billing accounts; otherwise the
+ * request is refused with HTTP 400 `BILLING_PURCHASE_INVALID`. Returns 404 when a subscription does
+ * not exist, and 403 `BILLING_ACCOUNT_FORBIDDEN` when it is paid for by an account you do not own.
+ * @summary Quote order checkout, renewals or a cancellation
+ */
+export const CreateQuoteBody = QuoteRequest;
+/**
+ * Ends a set of subscriptions of one service together, at one time. Deleting a resource that a
+ * subscription pays for is an `immediate` cancellation of every subscription released with it,
+ * such as a server with the disks deleted along with it, or an address with its bandwidth.
+ *
+ * The service that provides the resources releases them: at once for `immediate`, or at
+ * `scheduled_at`, the end of the paid term, for `period_end`. When release is confirmed, the
+ * unused value is returned the way it was paid, under the refund terms agreed when each
+ * subscription was bought. For `immediate` the refund is computed as of `proration_date`, so the
+ * amount confirmed here is the amount returned: prepaid service used while the resources are
+ * being released is not deducted from it. Usage of a postpaid subscription is charged until its
+ * resources are released, as usual.
+ *
+ * `mode` must be allowed for every subscription. Postpaid and one-time subscriptions end only
+ * `immediate`. A prepaid subscription ends `period_end` while its paid term lasts, and
+ * `immediate` unless its termination terms allow only the end of the paid term and that term has
+ * not ended yet. For `period_end` the paid terms of all the subscriptions must end at the same
+ * time.
+ *
+ * Refused with:
+ * - 400 `BILLING_CANCELLATION_INVALID` when `subscription_ids` or `proration_date` is not
+ *   acceptable (`meta.field`), or the subscriptions do not all belong to one service, project,
+ *   account and currency;
+ * - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
+ * - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed for a subscription, and
+ *   `BILLING_CANCELLATION_TERMS_UNSET` when a prepaid subscription has no termination terms;
+ *   both carry `meta.subscription_id`;
+ * - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at
+ *   different times;
+ * - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
+ *   (`meta.cancellation_id`) or reclaimed (`meta.action_id`);
+ * - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for a renewal of one of them
+ *   is in progress;
+ * - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund is no longer
+ *   `expected_refundable_amount`; quote again.
+ *
+ * Sending the same request again, for the same subscriptions, mode and amount while that
+ * cancellation is still open, returns it with 200 rather than creating another. Renewal orders
+ * still waiting for payment are canceled along with it, and automatic renewal is turned off for
+ * every subscription in the set, for `period_end` as well as `immediate`.
+ * @summary Cancel subscriptions
+ */
+export const CreateCancellationBody = CancellationCreate;
+/**
+ * Newest first. Filter by `subscription_id` and `status=open` to find the cancellation now under way for a subscription.
+ * @summary List cancellations
+ */
+export const listCancellationsQueryPageMax = 2147483647;
+export const listCancellationsQueryPageSizeMax = 100;
+export const ListCancellationsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listCancellationsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listCancellationsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    subscription_id: zod
+        .uuid()
+        .optional()
+        .describe("Only cancellations that include this subscription."),
+    status: zod
+        .enum(["open", "requested", "scheduled", "releasing", "completed", "canceled", "failed"])
+        .optional()
+        .describe("Only cancellations in this status. `open` means requested, scheduled or releasing."),
+});
+/**
+ * @summary Get a cancellation
+ */
+export const GetCancellationParams = zod.strictObject({
+    cancellationId: zod.uuid(),
+});
+/**
+ * Withdraws the whole cancellation while none of its resources has begun to be released; the
+ * subscriptions continue as before, except that automatic renewal, turned off when the
+ * cancellation was created, stays off until it is turned on again. After that it is refused with
+ * 409 `BILLING_CANCELLATION_CONFLICT`. Withdrawing one that is already withdrawn returns it
+ * unchanged.
+ * @summary Withdraw a cancellation
+ */
+export const WithdrawCancellationParams = zod.strictObject({
+    cancellationId: zod.uuid(),
+});
+/**
+ * Lists the current renewal agreement and available intervals. The current option preserves recurring_amount; other options use current prices. Amounts cover the whole subscription quantity and exclude tax.
+ * @summary List the terms this item can be renewed for
+ */
+export const ListRenewalPricesParams = zod.strictObject({
+    subscriptionId: zod.uuid(),
+});
+export const listRenewalPricesQueryPageMax = 2147483647;
+export const listRenewalPricesQueryPageSizeMax = 100;
+export const ListRenewalPricesQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listRenewalPricesQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listRenewalPricesQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+});
+/**
+ * Purchases prepaid periods from paid_until using the agreed recurring amount, and pays for them at
+ * once. A changed interval selects a current price and freezes new terms on the order, applied
+ * only after fulfillment. Existing paid periods keep their value.
+ *
+ * Without `payment_method_id`, the renewal is paid from credit grants and the balance as
+ * `use_credits` and `use_balance` allow; when they cannot pay it all, the renewal is refused with
+ * `BILLING_INSUFFICIENT_FUNDS` and no order is left. To pay another way, create a renewal order
+ * and pay its invoice instead.
+ *
+ * Save order_id before submitting and query the order after an unknown outcome; duplicate
+ * creation conflicts.
+ * @summary Renew subscription
+ */
+export const RenewSubscriptionParams = zod.strictObject({
+    subscriptionId: zod.uuid(),
+});
+export const RenewSubscriptionBody = RenewRequest;
+/**
+ * Places a renewal order with a draft invoice, without applying a new discount or charging anything.
+ * Quote and confirm its checkout before collecting payment to renew. Existing subscription
+ * discount commitments are retained. The periods and price are chosen as for renewing. The order
+ * can be paid until the current paid period ends, and never after the end of the first period it renews; unpaid by
+ * then, it is canceled. While auto-renew is on, the renewal due at the end of the period pays
+ * this order instead of placing another, confirming checkout with an applicable account discount
+ * first if it has not already been confirmed.
+ *
+ * Save `order_id` before submitting and read the order after an unknown outcome; creating it a
+ * second time conflicts.
+ * @summary Create renewal order
+ */
+export const CreateRenewalOrderParams = zod.strictObject({
+    subscriptionId: zod.uuid(),
+});
+export const CreateRenewalOrderBody = RenewalOrderRequest;
+/**
+ * Controls automatic prepaid renewal. Disabling it does not shorten paid_until and still permits
+ * manual renewal. Postpaid subscriptions do not renew and keep this false.
+ *
+ * While the subscription has an open cancellation, turning it on or off is refused with 409
+ * `BILLING_SUBSCRIPTION_OPERATION_PENDING` and `meta.cancellation_id`: creating the cancellation
+ * turned it off, and withdrawing the cancellation does not turn it back on.
+ * @summary Set auto renew
+ */
+export const SetAutoRenewParams = zod.strictObject({
+    subscriptionId: zod.uuid(),
+});
+export const SetAutoRenewBody = AutoRenewSet;
+/**
+ * Lists remaining usage quantities, such as bytes, seconds or tokens. Applicable allowances are
+ * consumed before usage is charged. Lower priority values are consumed first, followed by earlier
+ * expiry and earlier issuance.
+ *
+ * Unused quantity expires without a refund or carry-over. Promotional allowances apply to usage paid
+ * by their holding account. Included allowances apply only to the associated subscription, including
+ * after its project moves to another billing account.
+ * @summary List allowances
+ */
+export const listAllowancesQueryPageMax = 2147483647;
+export const listAllowancesQueryPageSizeMax = 100;
+export const listAllowancesQueryProductIdMax = 64;
+export const listAllowancesQueryProductIdRegExp = new RegExp("^[a-z][a-z0-9]*(-[a-z0-9]+)*$");
+export const ListAllowancesQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listAllowancesQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listAllowancesQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    meter_id: zod.uuid().optional().describe("Filter by the meter UUID."),
+    status: zod.enum(["active", "depleted", "expired", "voided"]).optional(),
+    product_id: zod
+        .string()
+        .min(1)
+        .max(listAllowancesQueryProductIdMax)
+        .regex(listAllowancesQueryProductIdRegExp)
+        .optional()
+        .describe("Immutable platform service identifier, such as compute, canopy or assistant."),
+});
+/**
+ * Lists acceptance status and associated invoice amounts. pending_checkout awaits confirmation; pending has confirmed checkout and may be unpaid or paid. active means accepted, not delivered. pending_checkout and pending orders can expire at expires_at.
+ * @summary List orders
+ */
+export const listOrdersQueryPageMax = 2147483647;
+export const listOrdersQueryPageSizeMax = 100;
+export const ListOrdersQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listOrdersQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listOrdersQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    project_id: zod.uuid().optional(),
+    status: zod
+        .enum([
+        "pending_checkout",
+        "pending",
+        "active",
+        "completed",
+        "partially_completed",
+        "failed",
+        "canceled",
+    ])
+        .optional()
+        .describe("pending_checkout has recorded purchase terms but no confirmed checkout; only a deferred order\nwith an amount due reaches it, since a zero-total order completes checkout at placement.\nConfirmation moves it to pending. Both pending_checkout\nand pending can expire or be canceled; neither establishes service delivery.\n\nFollows the items. `pending` has confirmed checkout, is not yet accepted and may be paid or unpaid. `active` is\naccepted with items still being set up. `completed` means every item was set up.\n`partially_completed` means some items were set up and the others failed and were\nrefunded to their original payment sources. `failed` means every item failed and the\nwhole order was refunded. `canceled` means the order was withdrawn before payment and\nnothing was charged."),
+    from: zod.iso.datetime({ offset: true }).optional(),
+    to: zod.iso.datetime({ offset: true }).optional().describe("Exclusive."),
+});
+/**
+ * @summary Get order
+ */
+export const GetOrderParams = zod.strictObject({
+    orderId: zod.uuid(),
+});
+/**
+ * Confirms the purchase's final amount and discount. Supply the same promotion_code used for the
+ * preview, or omit it to select an applicable account discount. At most one new coupon is applied
+ * to an order; existing subscription discount commitments are not stacked with a new coupon on
+ * the same line. Promotion codes are evaluated against the order, not client-supplied line amounts.
+ *
+ * Rechecks eligibility and redemption availability. A different total fails with
+ * BILLING_AMOUNT_CHANGED. An invalid or inapplicable code fails rather than collecting full price.
+ * A failed confirmation leaves the invoice draft and reserves no discount redemption.
+ *
+ * A successful confirmation records the discount, including any recurring discount terms,
+ * reserves its redemption, moves pending_checkout to pending and finalizes the invoice when one
+ * is required. The reservation counts toward the code's limits and is consumed when the invoice
+ * is paid, or at confirmation when nothing is due. Use pay-invoice to collect
+ * its outstanding amount from account funds or a payment gateway. No payment attempt or checkout
+ * session is created by this operation. An order whose total is zero completes checkout at
+ * placement in either mode and does not need this operation; an order with an amount due, even
+ * when credits would cover it, still does. Checkout alone does not confirm resource delivery.
+ *
+ * Retrying with the same code and expected amount returns the existing order without another
+ * redemption. Omitting the code on a confirmed checkout retains its recorded discount. Changing
+ * that code is refused with BILLING_ORDER_CHECKOUT_CONFLICT. Payment retries reuse the confirmed
+ * terms. Cancellation, expiry or complete fulfillment failure releases the reservation or returns
+ * the consumed redemption; a refund alone does not.
+ *
+ * The order must belong to one of your billing accounts. A canceled, failed or expired order
+ * cannot be checked out. A period-end change cannot be checked out before its renewal invoice is
+ * available. Orders retain their billing account and currency after a project is linked elsewhere;
+ * discounts from another account cannot be used for them.
+ * @summary Confirm order checkout
+ */
+export const CheckoutOrderParams = zod.strictObject({
+    orderId: zod.uuid(),
+});
+export const CheckoutOrderBody = CheckoutOrderRequest;
+/**
+ * Withdraws an order that is not paid in full, and tells the service that placed it, so that
+ * nothing is delivered. An order with nothing paid becomes `canceled` and its invoice is voided.
+ * What was already paid toward it, from credit grants or the balance, is returned the way it was
+ * paid, and the order becomes `failed`; its invoice is voided once everything paid has been
+ * returned. Either way `cancel_reason` is `requested_by_customer`.
+ * Canceling an order that is already canceled or failed returns it unchanged.
+ *
+ * Refused with 409 and `BILLING_PAID_ORDER_NOT_CANCELABLE` once the invoice is paid in full,
+ * `BILLING_ORDER_ALREADY_ACCEPTED` once the order has been accepted,
+ * `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for it is in progress, and
+ * `BILLING_SCHEDULED_CHANGE_NOT_CANCELABLE` for a change that takes effect at the end of the
+ * period, which only the service that placed it can call off.
+ * @summary Cancel order
+ */
+export const CancelOrderParams = zod.strictObject({
+    orderId: zod.uuid(),
+});
+/**
+ * One entry per item bought, with the price charged and the period it covers.
+ * @summary List order items
+ */
+export const ListOrderItemsParams = zod.strictObject({
+    orderId: zod.uuid(),
+});
+export const listOrderItemsQueryPageMax = 2147483647;
+export const listOrderItemsQueryPageSizeMax = 100;
+export const ListOrderItemsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listOrderItemsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listOrderItemsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+});
+/**
+ * Capabilities that come with what has been bought. A capability that is not held simply
+ * does not appear, so that "this does not exist" and "this has not been bought" cannot be
+ * confused.
+ *
+ * Derived from live subscriptions rather than stored, so this always agrees with what is
+ * being paid for. It stops being listed as soon as the subscription providing it ends.
+ * @summary List entitlements
+ */
+export const listEntitlementsQueryPageMax = 2147483647;
+export const listEntitlementsQueryPageSizeMax = 100;
+export const ListEntitlementsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listEntitlementsQueryPageMax)
+        .optional()
+        .describe("1-based page number; the first page when omitted."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listEntitlementsQueryPageSizeMax)
+        .optional()
+        .describe("How many per page, 100 at most."),
+    billing_account_id: zod
+        .int()
+        .optional()
+        .describe("Restrict to one of your accounts. All of them when omitted."),
+    project_id: zod
+        .uuid()
+        .optional()
+        .describe("Restrict to one project. Anything bought at account level, such as a membership,\nappears regardless."),
+});