@leaflow/sdk 0.163.1 → 0.165.0

package/dist/billing/v1/generated/functions.js

@@ -82,7 +82,7 @@ export const createWithdrawal = async (withdrawalCreate, options, fetchFn) => {
     return { data, status: res.status, headers: res.headers };
 };
 export const getPreviewWithdrawalUrl = () => {
-    return `https://billing.leaflow.cloud/api/v1/withdrawals/preview`;
+    return `https://billing.leaflow.cloud/api/v1/withdrawals:preview`;
 };
 /**
  * Previews the balance deduction, fees and refund split by original top-up. Omit amount to preview all available balance. Nothing is created or reserved. Fails when a selected source has no refund route or its original processing cost is not yet known.
@@ -386,7 +386,7 @@ export const updateBillingAccount = async (accountId, billingAccountUpdate, opti
     return { data, status: res.status, headers: res.headers };
 };
 export const getSuspendBillingAccountUrl = (accountId) => {
-    return `https://billing.leaflow.cloud/api/v1/billing-accounts/${encodeURIComponent(String(accountId))}/suspend`;
+    return `https://billing.leaflow.cloud/api/v1/billing-accounts/${encodeURIComponent(String(accountId))}:suspend`;
 };
 /**
  * Suspends your active billing account without closing it, also while it is in arrears. While suspended, it
@@ -406,7 +406,7 @@ export const suspendBillingAccount = async (accountId, options, fetchFn) => {
     return { data, status: res.status, headers: res.headers };
 };
 export const getResumeBillingAccountUrl = (accountId) => {
-    return `https://billing.leaflow.cloud/api/v1/billing-accounts/${encodeURIComponent(String(accountId))}/resume`;
+    return `https://billing.leaflow.cloud/api/v1/billing-accounts/${encodeURIComponent(String(accountId))}:resume`;
 };
 /**
  * Resumes a billing account you suspended. Refused with `BILLING_ACCOUNT_SUSPENDED_BY_OPERATOR` when Leaflow
@@ -656,7 +656,7 @@ export const getTopUp = async (topUpId, options, fetchFn) => {
     return { data, status: res.status, headers: res.headers };
 };
 export const getCancelTopUpUrl = (topUpId) => {
-    return `https://billing.leaflow.cloud/api/v1/top-ups/${encodeURIComponent(String(topUpId))}/cancel`;
+    return `https://billing.leaflow.cloud/api/v1/top-ups/${encodeURIComponent(String(topUpId))}:cancel`;
 };
 /**
  * Withdraws a pending top-up of the authenticated user at the payment gateway. It becomes `canceled` with
@@ -769,7 +769,7 @@ export const deletePaymentMethod = async (paymentMethodId, options, fetchFn) =>
     return { data, status: res.status, headers: res.headers };
 };
 export const getPayInvoiceUrl = (invoiceId) => {
-    return `https://billing.leaflow.cloud/api/v1/invoices/${encodeURIComponent(String(invoiceId))}/pay`;
+    return `https://billing.leaflow.cloud/api/v1/invoices/${encodeURIComponent(String(invoiceId))}:pay`;
 };
 /**
  * Pays the invoice from eligible credit grants and balance as requested, and collects the remainder through the
@@ -831,8 +831,8 @@ export const getPreviewInvoicePaymentUrl = (invoiceId, params) => {
     });
     const stringifiedParams = normalizedParams.toString();
     return stringifiedParams.length > 0
-        ? `https://billing.leaflow.cloud/api/v1/invoices/${encodeURIComponent(String(invoiceId))}/payment-preview?${stringifiedParams}`
-        : `https://billing.leaflow.cloud/api/v1/invoices/${encodeURIComponent(String(invoiceId))}/payment-preview`;
+        ? `https://billing.leaflow.cloud/api/v1/invoices/${encodeURIComponent(String(invoiceId))}:previewPayment?${stringifiedParams}`
+        : `https://billing.leaflow.cloud/api/v1/invoices/${encodeURIComponent(String(invoiceId))}:previewPayment`;
 };
 /**
  * What paying this invoice now would take from credit grants, from the balance and, for the rest,
@@ -897,7 +897,7 @@ export const payTogether = async (payTogetherRequest, options, fetchFn) => {
     return { data, status: res.status, headers: res.headers };
 };
 export const getPreviewPayTogetherUrl = () => {
-    return `https://billing.leaflow.cloud/api/v1/payments/preview`;
+    return `https://billing.leaflow.cloud/api/v1/payments:preview`;
 };
 /**
  * What paying these invoices together now would take from credit grants and from the balance, per invoice in payment order, calculated as paying together does. Nothing is charged, reserved or created. Refused with the same errors as paying together, except that insufficient funds show as a `gateway_amount` above zero instead of an error.
@@ -1244,7 +1244,7 @@ export const deleteSubscription = async (subscriptionId, options, fetchFn) => {
     return { data, status: res.status, headers: res.headers };
 };
 export const getCancelSubscriptionUrl = (subscriptionId) => {
-    return `https://billing.leaflow.cloud/api/v1/subscriptions/${encodeURIComponent(String(subscriptionId))}/cancel`;
+    return `https://billing.leaflow.cloud/api/v1/subscriptions/${encodeURIComponent(String(subscriptionId))}:cancel`;
 };
 /**
  * Requests cancellation on the purchase's agreed terms, with the same rules as creating a cancellation. Give the
@@ -1290,7 +1290,8 @@ export const getGetQuoteUrl = () => {
 };
 /**
  * Calculates what a proposed purchase, a change of your subscriptions or their renewal would invoice now, and
- * what each purchased or changed line renews at. Nothing is saved, reserved or redeemed.
+ * what each purchased or changed line renews at, or what ending subscriptions would return. Nothing is saved,
+ * reserved, redeemed or canceled.
  *
  * With `billing_account_id`, the quote is for that billing account: its currency, account discounts,
  * tax and funds apply, changes and renewals use the account currently paying for each subscription, and an
@@ -1457,39 +1458,6 @@ export const createCancellation = async (cancellationCreate, options, fetchFn) =
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
-export const getPreviewCancellationUrl = () => {
-    return `https://billing.leaflow.cloud/api/v1/cancellations/preview`;
-};
-/**
- * What creating the cancellation now would return, per subscription and in total. Nothing is canceled, ended or refunded. Open to the owner of the subscriptions' current billing account and to members of their project; refused for the same states as creating it.
- * @summary Preview a cancellation
- */
-export const previewCancellation = async (cancellationPreviewRequest, options, fetchFn) => {
-    const getHeaders = (h) => {
-        if (!h)
-            return {};
-        if (h instanceof Headers)
-            return Object.fromEntries(h.entries());
-        if (Symbol.iterator in h) {
-            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
-        }
-        const headers = {};
-        for (const [name, value] of Object.entries(h)) {
-            if (value !== undefined)
-                headers[name] = value;
-        }
-        return headers;
-    };
-    const res = await (fetchFn ?? fetch)(getPreviewCancellationUrl(), {
-        ...options,
-        method: "QUERY",
-        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
-        body: JSON.stringify(cancellationPreviewRequest),
-    });
-    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
-    const data = body ? JSON.parse(body) : {};
-    return { data, status: res.status, headers: res.headers };
-};
 export const getGetCancellationUrl = (cancellationId) => {
     return `https://billing.leaflow.cloud/api/v1/cancellations/${encodeURIComponent(String(cancellationId))}`;
 };
@@ -1507,7 +1475,7 @@ export const getCancellation = async (cancellationId, options, fetchFn) => {
     return { data, status: res.status, headers: res.headers };
 };
 export const getWithdrawCancellationUrl = (cancellationId) => {
-    return `https://billing.leaflow.cloud/api/v1/cancellations/${encodeURIComponent(String(cancellationId))}/withdraw`;
+    return `https://billing.leaflow.cloud/api/v1/cancellations/${encodeURIComponent(String(cancellationId))}:withdraw`;
 };
 /**
  * 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. Open to the owner of the subscriptions' current billing account and to members of their project with the project permission `billing:finance.manage`.
@@ -1548,7 +1516,7 @@ export const listRenewalPrices = async (subscriptionId, params, options, fetchFn
     return { data, status: res.status, headers: res.headers };
 };
 export const getRenewSubscriptionUrl = (subscriptionId) => {
-    return `https://billing.leaflow.cloud/api/v1/subscriptions/${encodeURIComponent(String(subscriptionId))}/renew`;
+    return `https://billing.leaflow.cloud/api/v1/subscriptions/${encodeURIComponent(String(subscriptionId))}:renew`;
 };
 /**
  * Buys licensed periods from current_term_end at the agreed recurring amount and pays for them at once. A
@@ -1791,7 +1759,7 @@ export const getCheckoutSessionQuote = async (checkoutSessionId, params, options
     return { data, status: res.status, headers: res.headers };
 };
 export const getConfirmCheckoutSessionUrl = (checkoutSessionId) => {
-    return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}/confirm`;
+    return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}:confirm`;
 };
 /**
  * Completes an open session: applies `promotion_code`, or otherwise the best applicable account discount, checks
@@ -1834,7 +1802,7 @@ export const confirmCheckoutSession = async (checkoutSessionId, checkoutSessionC
     return { data, status: res.status, headers: res.headers };
 };
 export const getExpireCheckoutSessionUrl = (checkoutSessionId) => {
-    return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}/expire`;
+    return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}:expire`;
 };
 /**
  * Ends an open session without an order; the service that created it releases what it was holding for the purchase. An expired session is returned unchanged. Open to the owner of the session's billing account and to members of its project.
@@ -1899,8 +1867,8 @@ export const getPreviewOrderRefundUrl = (orderId, params) => {
     });
     const stringifiedParams = normalizedParams.toString();
     return stringifiedParams.length > 0
-        ? `https://billing.leaflow.cloud/api/v1/orders/${encodeURIComponent(String(orderId))}/refund-preview?${stringifiedParams}`
-        : `https://billing.leaflow.cloud/api/v1/orders/${encodeURIComponent(String(orderId))}/refund-preview`;
+        ? `https://billing.leaflow.cloud/api/v1/orders/${encodeURIComponent(String(orderId))}:previewRefund?${stringifiedParams}`
+        : `https://billing.leaflow.cloud/api/v1/orders/${encodeURIComponent(String(orderId))}:previewRefund`;
 };
 /**
  * What canceling the listed items, or the whole order, would refund to the original payment sources. Nothing is canceled or refunded. Open to the owner of the order's billing account and to members of its project.
@@ -1916,7 +1884,7 @@ export const previewOrderRefund = async (orderId, params, options, fetchFn) => {
     return { data, status: res.status, headers: res.headers };
 };
 export const getCancelOrderUrl = (orderId) => {
-    return `https://billing.leaflow.cloud/api/v1/orders/${encodeURIComponent(String(orderId))}/cancel`;
+    return `https://billing.leaflow.cloud/api/v1/orders/${encodeURIComponent(String(orderId))}:cancel`;
 };
 /**
  * Cancels the selected undelivered items of an order that has not been accepted, without recording a delivery

package/dist/billing/v1/generated/models.d.ts

@@ -290,29 +290,6 @@ export interface QuotedDiscount {
     /** `confirmed`: every condition of the discount holds for the billing account. `unverified`: a quote without an account, where conditions that depend on the account, such as a first purchase or a per-account limit, are checked only when a Checkout Session is completed. */
     eligibility: QuotedDiscountEligibility;
 }
-/**
- * A complete calculation in `currency`; nothing is saved or reserved. The request fails if any item cannot be priced. A Checkout Session quote gives what completing the session would invoice.
- */
-export interface Quote {
-    /** Account funds for the quoted purchase. Null without an account. */
-    funds: Funds | null;
-    subtotal: Money;
-    discount_amount: Money;
-    tax_amount: Money;
-    /** The discount a purchase would get, not yet applied. Null when there is none, and for renewals. */
-    discount: QuotedDiscount | null;
-    items: QuoteItem[];
-    renewals: QuoteRenewalResult[];
-    total: Money;
-    currency: string;
-    /**
-     * Immediate changes only; null otherwise. The instant the change is priced from; pass it when confirming the Checkout Session so it is priced from the same instant.
-     * @nullable
-     */
-    proration_date: string | null;
-    /** `complete`: tax is calculated for the billing account's invoice contact, or for `address` without an account. `requires_location_inputs`: a quote without an account or `address`, which leaves out tax that would be added; tax already contained in a price is included. */
-    tax_status: QuoteTaxStatus;
-}
 /**
  * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
  * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
@@ -325,23 +302,6 @@ export declare const CancellationMode: {
     readonly immediate: "immediate";
     readonly period_end: "period_end";
 };
-/**
- * What ending these subscriptions together would return, for one mode; preview `immediate` and `period_end` separately to compare. Refused with 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled (`meta.cancellation_id`), is being reclaimed (`meta.reason` `reclaim_requested`) or has a paid change waiting to switch (`meta.order_id`).
- */
-export interface CancellationPreviewRequest {
-    /**
-     * A billing account you own that currently pays for every subscription.
-     * @minimum 1
-     */
-    billing_account_id: number;
-    /**
-     * The subscriptions to end together, all of one service, including every subscription released with a resource.
-     * @minItems 1
-     * @maxItems 50
-     */
-    subscription_ids: string[];
-    mode: CancellationMode;
-}
 /**
  * Which object this is, together with what a person currently calls it.
  *
@@ -358,9 +318,9 @@ export interface NamedIdentity {
     name: string;
 }
 /**
- * One subscription of the previewed cancellation.
+ * One subscription of the quoted cancellation.
  */
-export interface CancellationRefundPreviewItem {
+export interface QuoteCancellationItem {
     subscription_id: string;
     plan_id: string;
     plan_name: string;
@@ -379,8 +339,8 @@ export interface CancellationRefundPreviewItem {
     forfeited_amount: Money;
 }
 /**
- * What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and
- * `refundable_amount` when creating the cancellation.
+ * What the cancellation would return, per subscription and in total, as of the quote's `proration_date` for
+ * `immediate`. Give that `proration_date` and `refundable_amount` when creating the cancellation.
  *
  * - `unused_amount`: before tax, the amount paid for the current periods in proportion to the time remaining.
  * - `short_rate_surcharge_amount`: before tax, the part of `forfeited_amount` due to the short rate of the
@@ -394,13 +354,10 @@ export interface CancellationRefundPreviewItem {
  *
  * Metered and one-time subscriptions show zero; their usage until release is charged as usual.
  */
-export interface CancellationRefundPreview {
+export interface QuoteCancellationResult {
     mode: CancellationMode;
     /** For `period_end`, when release begins, the end of the paid terms. */
     scheduled_at?: string;
-    /** For `immediate`, the second the refund is computed as of. Give it when creating the cancellation. */
-    proration_date?: string;
-    currency: string;
     unused_amount: Money;
     short_rate_surcharge_amount: Money;
     refundable_amount: Money;
@@ -408,7 +365,48 @@ export interface CancellationRefundPreview {
     credit_amount: Money;
     tax_amount: Money;
     forfeited_amount: Money;
-    items: CancellationRefundPreviewItem[];
+    items: QuoteCancellationItem[];
+}
+/**
+ * A complete calculation in `currency`; nothing is saved or reserved. The request fails if any item cannot be priced. A Checkout Session quote gives what completing the session would invoice.
+ */
+export interface Quote {
+    /** Account funds for the quoted purchase. Null without an account, and for a cancellation. */
+    funds: Funds | null;
+    subtotal: Money;
+    discount_amount: Money;
+    tax_amount: Money;
+    /** The discount a purchase would get, not yet applied. Null when there is none, and for renewals and a cancellation. */
+    discount: QuotedDiscount | null;
+    items: QuoteItem[];
+    renewals: QuoteRenewalResult[];
+    /** What the cancellation would return. Null unless the request quotes a cancellation. */
+    cancellation: QuoteCancellationResult | null;
+    total: Money;
+    currency: string;
+    /**
+     * Immediate changes and immediate cancellations only; null otherwise. The instant the change or the refund is priced from; pass it when confirming the Checkout Session or creating the cancellation so it is priced from the same instant.
+     * @nullable
+     */
+    proration_date: string | null;
+    /** `complete`: tax is calculated for the billing account's invoice contact, or for `address` without an account. `requires_location_inputs`: a quote without an account or `address`, which leaves out tax that would be added; tax already contained in a price is included. */
+    tax_status: QuoteTaxStatus;
+}
+/**
+ * Preview ending these subscriptions together in one mode; quote `immediate` and `period_end` separately to
+ * compare. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account
+ * or a member of the subscriptions' project. Refused as creating the cancellation would be, including 409
+ * `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled (`meta.cancellation_id`),
+ * is being reclaimed (`meta.reason` `reclaim_requested`) or has a paid change waiting to switch (`meta.order_id`).
+ */
+export interface QuoteCancellation {
+    /**
+     * The subscriptions to end together, all of one service, including every subscription released with a resource.
+     * @minItems 1
+     * @maxItems 50
+     */
+    subscription_ids: string[];
+    mode: CancellationMode;
 }
 export interface CancellationCreate {
     /**
@@ -420,7 +418,7 @@ export interface CancellationCreate {
     mode: CancellationMode;
     /** For `immediate`, the quote's `proration_date`: a whole second, not in the future and at most ten minutes old; the refund is computed as of it. Now when omitted. */
     proration_date?: string;
-    /** The quote's `refundable_amount`; the cancellation is refused when the refund differs. */
+    /** The quote's `cancellation.refundable_amount`; the cancellation is refused when the refund differs. */
     expected_refundable_amount: Money & string;
     /**
      * A note from the account holder, kept with the cancellation.
@@ -2848,11 +2846,11 @@ export interface QuoteAddress {
     state?: string;
 }
 /**
- * Quote proposed items, changes or renewals: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes and renewals need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.
+ * Quote proposed items, changes, renewals or a cancellation: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes, renewals and a cancellation need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.
  */
 export interface QuoteRequest {
     /**
-     * The billing account to price for; it must be yours or currently pay for a project you are a member of, and an access token is required. Renewals must currently be paid by it.
+     * The billing account to price for; it must be yours or currently pay for a project you are a member of, and an access token is required. Renewals and a cancellation must currently be paid by it.
      * @minimum 1
      */
     billing_account_id?: number;
@@ -2880,6 +2878,7 @@ export interface QuoteRequest {
      * @maxItems 100
      */
     changes?: QuoteChangeInput[];
+    cancellation?: QuoteCancellation;
     /** When the changes take effect; defaults to `immediate`. `immediate` prices the rest of the paid period from `proration_date`, charging an upgrade the difference and showing what a downgrade refunds. `period_end` prices the first period at the new terms, which replaces the renewal when the paid period ends. */
     change_effective?: QuoteRequestChangeEffective;
     /** Only with `currency`. Where the customer is, to include the tax that would be added there for a customer who is not tax exempt; `tax_status` is then `complete`. Refused with `billing_account_id`, whose invoice contact decides tax. */

package/dist/billing/v1/generated/validators/cancellationCreate.zod.js

@@ -22,7 +22,7 @@ export const CancellationCreate = zod.strictObject({
         .datetime({ offset: true })
         .optional()
         .describe("For `immediate`, the quote's `proration_date`: a whole second, not in the future and at most ten minutes old; the refund is computed as of it. Now when omitted."),
-    expected_refundable_amount: Money.and(zod.string().regex(cancellationCreateExpectedRefundableAmountTwoRegExp)).describe("The quote's `refundable_amount`; the cancellation is refused when the refund differs."),
+    expected_refundable_amount: Money.and(zod.string().regex(cancellationCreateExpectedRefundableAmountTwoRegExp)).describe("The quote's `cancellation.refundable_amount`; the cancellation is refused when the refund differs."),
     reason: zod
         .string()
         .max(cancellationCreateReasonMax)

package/dist/billing/v1/generated/validators/quote.zod.d.ts

@@ -93,6 +93,45 @@ export declare const Quote: zod.ZodObject<{
         tax_included_amount: zod.ZodString;
         total: zod.ZodString;
     }, zod.z.core.$strict>>;
+    cancellation: zod.ZodUnion<readonly [zod.ZodObject<{
+        mode: zod.ZodEnum<{
+            immediate: "immediate";
+            period_end: "period_end";
+        }>;
+        scheduled_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+        unused_amount: zod.ZodString;
+        short_rate_surcharge_amount: zod.ZodString;
+        refundable_amount: zod.ZodString;
+        refund_amount: zod.ZodString;
+        credit_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        forfeited_amount: zod.ZodString;
+        items: zod.ZodArray<zod.ZodObject<{
+            subscription_id: zod.ZodUUID;
+            plan_id: zod.ZodUUID;
+            plan_name: zod.ZodString;
+            project: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+                id: zod.ZodUUID;
+                name: zod.ZodString;
+            }, zod.z.core.$strict>, zod.ZodNull]>>;
+            type: zod.ZodEnum<{
+                one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
+            }>;
+            auto_renew: zod.ZodBoolean;
+            unused_amount: zod.ZodString;
+            short_rate_surcharge_amount: zod.ZodString;
+            refundable_amount: zod.ZodString;
+            refund_amount: zod.ZodString;
+            credit_amount: zod.ZodString;
+            tax_amount: zod.ZodString;
+            forfeited_amount: zod.ZodString;
+        }, zod.z.core.$strict>>;
+    }, zod.z.core.$strict>, zod.ZodNull]>;
     total: zod.ZodString;
     currency: zod.ZodString;
     proration_date: zod.ZodNullable<zod.z.ZodISODateTime>;

package/dist/billing/v1/generated/validators/quote.zod.js

@@ -8,6 +8,7 @@
 import * as zod from "zod";
 import { Funds } from "./funds.zod.js";
 import { Money } from "./money.zod.js";
+import { QuoteCancellationResult } from "./quoteCancellationResult.zod.js";
 import { QuotedDiscount } from "./quotedDiscount.zod.js";
 import { QuoteItem } from "./quoteItem.zod.js";
 import { QuoteRenewalResult } from "./quoteRenewalResult.zod.js";
@@ -15,21 +16,24 @@ export const Quote = zod
     .strictObject({
     funds: zod
         .union([Funds, zod.null()])
-        .describe("Account funds for the quoted purchase. Null without an account."),
+        .describe("Account funds for the quoted purchase. Null without an account, and for a cancellation."),
     subtotal: Money,
     discount_amount: Money,
     tax_amount: Money,
     discount: zod
         .union([QuotedDiscount, zod.null()])
-        .describe("The discount a purchase would get, not yet applied. Null when there is none, and for renewals."),
+        .describe("The discount a purchase would get, not yet applied. Null when there is none, and for renewals and a cancellation."),
     items: zod.array(QuoteItem),
     renewals: zod.array(QuoteRenewalResult),
+    cancellation: zod
+        .union([QuoteCancellationResult, zod.null()])
+        .describe("What the cancellation would return. Null unless the request quotes a cancellation."),
     total: Money,
     currency: zod.string(),
     proration_date: zod.iso
         .datetime({ offset: true })
         .nullable()
-        .describe("Immediate changes only; null otherwise. The instant the change is priced from; pass it when confirming the Checkout Session so it is priced from the same instant."),
+        .describe("Immediate changes and immediate cancellations only; null otherwise. The instant the change or the refund is priced from; pass it when confirming the Checkout Session or creating the cancellation so it is priced from the same instant."),
     tax_status: zod
         .enum(["complete", "requires_location_inputs"])
         .describe("`complete`: tax is calculated for the billing account's invoice contact, or for `address` without an account. `requires_location_inputs`: a quote without an account or `address`, which leaves out tax that would be added; tax already contained in a price is included."),

package/dist/billing/v1/generated/validators/{cancellationPreviewRequest.zod.d.ts → quoteCancellation.zod.d.ts}

@@ -6,14 +6,13 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export declare const cancellationPreviewRequestSubscriptionIdsMax = 50;
-export declare const CancellationPreviewRequest: zod.ZodObject<{
-    billing_account_id: zod.ZodInt;
+export declare const quoteCancellationSubscriptionIdsMax = 50;
+export declare const QuoteCancellation: zod.ZodObject<{
     subscription_ids: zod.ZodArray<zod.ZodUUID>;
     mode: zod.ZodEnum<{
         immediate: "immediate";
         period_end: "period_end";
     }>;
 }, zod.z.core.$strict>;
-export type CancellationPreviewRequest = zod.input<typeof CancellationPreviewRequest>;
-export type CancellationPreviewRequestOutput = zod.output<typeof CancellationPreviewRequest>;
+export type QuoteCancellation = zod.input<typeof QuoteCancellation>;
+export type QuoteCancellationOutput = zod.output<typeof QuoteCancellation>;

package/dist/billing/v1/generated/validators/{cancellationPreviewRequest.zod.js → quoteCancellation.zod.js}

@@ -7,18 +7,14 @@
  */
 import * as zod from "zod";
 import { CancellationMode } from "./cancellationMode.zod.js";
-export const cancellationPreviewRequestSubscriptionIdsMax = 50;
-export const CancellationPreviewRequest = zod
+export const quoteCancellationSubscriptionIdsMax = 50;
+export const QuoteCancellation = zod
     .strictObject({
-    billing_account_id: zod
-        .int()
-        .min(1)
-        .describe("A billing account you own that currently pays for every subscription."),
     subscription_ids: zod
         .array(zod.uuid())
         .min(1)
-        .max(cancellationPreviewRequestSubscriptionIdsMax)
+        .max(quoteCancellationSubscriptionIdsMax)
         .describe("The subscriptions to end together, all of one service, including every subscription released with a resource."),
     mode: CancellationMode,
 })
-    .describe("What ending these subscriptions together would return, for one mode; preview `immediate` and `period_end` separately to compare. Refused with 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled (`meta.cancellation_id`), is being reclaimed (`meta.reason` `reclaim_requested`) or has a paid change waiting to switch (`meta.order_id`).");
+    .describe("Preview ending these subscriptions together in one mode; quote `immediate` and `period_end` separately to\ncompare. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account\nor a member of the subscriptions' project. Refused as creating the cancellation would be, including 409\n`BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled (`meta.cancellation_id`),\nis being reclaimed (`meta.reason` `reclaim_requested`) or has a paid change waiting to switch (`meta.order_id`).");

package/dist/billing/v1/generated/validators/{cancellationRefundPreviewItem.zod.d.ts → quoteCancellationItem.zod.d.ts}

@@ -6,7 +6,7 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export declare const CancellationRefundPreviewItem: zod.ZodObject<{
+export declare const QuoteCancellationItem: zod.ZodObject<{
     subscription_id: zod.ZodUUID;
     plan_id: zod.ZodUUID;
     plan_name: zod.ZodString;
@@ -31,5 +31,5 @@ export declare const CancellationRefundPreviewItem: zod.ZodObject<{
     tax_amount: zod.ZodString;
     forfeited_amount: zod.ZodString;
 }, zod.z.core.$strict>;
-export type CancellationRefundPreviewItem = zod.input<typeof CancellationRefundPreviewItem>;
-export type CancellationRefundPreviewItemOutput = zod.output<typeof CancellationRefundPreviewItem>;
+export type QuoteCancellationItem = zod.input<typeof QuoteCancellationItem>;
+export type QuoteCancellationItemOutput = zod.output<typeof QuoteCancellationItem>;

package/dist/billing/v1/generated/validators/{cancellationRefundPreviewItem.zod.js → quoteCancellationItem.zod.js}

@@ -10,7 +10,7 @@ import { Money } from "./money.zod.js";
 import { NamedIdentity } from "./namedIdentity.zod.js";
 import { PriceType } from "./priceType.zod.js";
 import { UsageType } from "./usageType.zod.js";
-export const CancellationRefundPreviewItem = zod
+export const QuoteCancellationItem = zod
     .strictObject({
     subscription_id: zod.uuid(),
     plan_id: zod.uuid(),
@@ -32,4 +32,4 @@ export const CancellationRefundPreviewItem = zod
     tax_amount: Money,
     forfeited_amount: Money,
 })
-    .describe("One subscription of the previewed cancellation.");
+    .describe("One subscription of the quoted cancellation.");

package/dist/billing/v1/generated/validators/{cancellationRefundPreview.zod.d.ts → quoteCancellationResult.zod.d.ts}

@@ -6,14 +6,12 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export declare const CancellationRefundPreview: zod.ZodObject<{
+export declare const QuoteCancellationResult: zod.ZodObject<{
     mode: zod.ZodEnum<{
         immediate: "immediate";
         period_end: "period_end";
     }>;
     scheduled_at: zod.ZodOptional<zod.z.ZodISODateTime>;
-    proration_date: zod.ZodOptional<zod.z.ZodISODateTime>;
-    currency: zod.ZodString;
     unused_amount: zod.ZodString;
     short_rate_surcharge_amount: zod.ZodString;
     refundable_amount: zod.ZodString;
@@ -47,5 +45,5 @@ export declare const CancellationRefundPreview: zod.ZodObject<{
         forfeited_amount: zod.ZodString;
     }, zod.z.core.$strict>>;
 }, zod.z.core.$strict>;
-export type CancellationRefundPreview = zod.input<typeof CancellationRefundPreview>;
-export type CancellationRefundPreviewOutput = zod.output<typeof CancellationRefundPreview>;
+export type QuoteCancellationResult = zod.input<typeof QuoteCancellationResult>;
+export type QuoteCancellationResultOutput = zod.output<typeof QuoteCancellationResult>;

package/dist/billing/v1/generated/validators/{cancellationRefundPreview.zod.js → quoteCancellationResult.zod.js}

@@ -7,20 +7,15 @@
  */
 import * as zod from "zod";
 import { CancellationMode } from "./cancellationMode.zod.js";
-import { CancellationRefundPreviewItem } from "./cancellationRefundPreviewItem.zod.js";
 import { Money } from "./money.zod.js";
-export const CancellationRefundPreview = zod
+import { QuoteCancellationItem } from "./quoteCancellationItem.zod.js";
+export const QuoteCancellationResult = zod
     .strictObject({
     mode: CancellationMode,
     scheduled_at: zod.iso
         .datetime({ offset: true })
         .optional()
         .describe("For `period_end`, when release begins, the end of the paid terms."),
-    proration_date: zod.iso
-        .datetime({ offset: true })
-        .optional()
-        .describe("For `immediate`, the second the refund is computed as of. Give it when creating the cancellation."),
-    currency: zod.string(),
     unused_amount: Money,
     short_rate_surcharge_amount: Money,
     refundable_amount: Money,
@@ -28,6 +23,6 @@ export const CancellationRefundPreview = zod
     credit_amount: Money,
     tax_amount: Money,
     forfeited_amount: Money,
-    items: zod.array(CancellationRefundPreviewItem),
+    items: zod.array(QuoteCancellationItem),
 })
-    .describe("What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and\n`refundable_amount` when creating the cancellation.\n\n- `unused_amount`: before tax, the amount paid for the current periods in proportion to the time remaining.\n- `short_rate_surcharge_amount`: before tax, the part of `forfeited_amount` due to the short rate of the\n  refund policy.\n- `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus\n  `credit_amount`.\n- `refund_amount`: the part returned to the balance or the payment method.\n- `credit_amount`: the part restored to the credit grants that paid.\n- `tax_amount`: the tax included in `refundable_amount`.\n- `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.\n\nMetered and one-time subscriptions show zero; their usage until release is charged as usual.");
+    .describe("What the cancellation would return, per subscription and in total, as of the quote's `proration_date` for\n`immediate`. Give that `proration_date` and `refundable_amount` when creating the cancellation.\n\n- `unused_amount`: before tax, the amount paid for the current periods in proportion to the time remaining.\n- `short_rate_surcharge_amount`: before tax, the part of `forfeited_amount` due to the short rate of the\n  refund policy.\n- `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus\n  `credit_amount`.\n- `refund_amount`: the part returned to the balance or the payment method.\n- `credit_amount`: the part restored to the credit grants that paid.\n- `tax_amount`: the tax included in `refundable_amount`.\n- `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.\n\nMetered and one-time subscriptions show zero; their usage until release is charged as usual.");

package/dist/billing/v1/generated/validators/quoteRequest.zod.d.ts

@@ -87,6 +87,13 @@ export declare const QuoteRequest: zod.ZodObject<{
         quantity: zod.ZodString;
         dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
     }, zod.z.core.$strict>>>;
+    cancellation: zod.ZodOptional<zod.ZodObject<{
+        subscription_ids: zod.ZodArray<zod.ZodUUID>;
+        mode: zod.ZodEnum<{
+            immediate: "immediate";
+            period_end: "period_end";
+        }>;
+    }, zod.z.core.$strict>>;
     change_effective: zod.ZodOptional<zod.ZodEnum<{
         immediate: "immediate";
         period_end: "period_end";

package/dist/billing/v1/generated/validators/quoteRequest.zod.js

@@ -7,6 +7,7 @@
  */
 import * as zod from "zod";
 import { QuoteAddress } from "./quoteAddress.zod.js";
+import { QuoteCancellation } from "./quoteCancellation.zod.js";
 import { QuoteChangeInput } from "./quoteChangeInput.zod.js";
 import { QuoteItemInput } from "./quoteItemInput.zod.js";
 import { QuoteRenewal } from "./quoteRenewal.zod.js";
@@ -22,7 +23,7 @@ export const QuoteRequest = zod
         .int()
         .min(1)
         .optional()
-        .describe("The billing account to price for; it must be yours or currently pay for a project you are a member of, and an access token is required. Renewals must currently be paid by it."),
+        .describe("The billing account to price for; it must be yours or currently pay for a project you are a member of, and an access token is required. Renewals and a cancellation must currently be paid by it."),
     currency: zod
         .string()
         .min(quoteRequestCurrencyMin)
@@ -47,6 +48,7 @@ export const QuoteRequest = zod
         .max(quoteRequestChangesMax)
         .optional()
         .describe("Preview changing these subscriptions in one order, each at most once. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account or a member of the subscription's project; all must belong to the same project, or all to no project."),
+    cancellation: QuoteCancellation.optional(),
     change_effective: zod
         .enum(["immediate", "period_end"])
         .optional()
@@ -54,4 +56,4 @@ export const QuoteRequest = zod
     address: QuoteAddress.optional().describe("Only with `currency`. Where the customer is, to include the tax that would be added there for a customer who is not tax exempt; `tax_status` is then `complete`. Refused with `billing_account_id`, whose invoice contact decides tax."),
     promotion_code: zod.string().min(1).max(quoteRequestPromotionCodeMax).optional(),
 })
-    .describe("Quote proposed items, changes or renewals: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes and renewals need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.");
+    .describe("Quote proposed items, changes, renewals or a cancellation: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes, renewals and a cancellation need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.");