@leaflow/sdk 0.0.0-dev.387.ga9cbec4 → 0.0.0-dev.389.g87f5860

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

@@ -5,7 +5,7 @@
  * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, and, with project permissions granted in IAM, change its subscriptions (`billing:subscription.write`), change its billing account (`billing:project_assignment.write`) and read its costs (`billing:cost.read`). A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
  * OpenAPI spec version: v1
  */
-import type { AccountBalance, AccountDeletionReadiness, ActiveResourceList, AllowanceList, AutoRenewSet, BillingAccount, BillingAccountCreate, BillingAccountList, BillingAccountUpdate, CancelSubscriptionRequest, Cancellation, CancellationCreate, CancellationList, CancellationPreviewRequest, CancellationRefundPreview, CheckoutSession, CheckoutSessionConfirm, CheckoutSessionCreate, CheckoutSessionItemList, CheckoutSessionList, CheckoutSessionResult, Contact, ContactCreate, ContactList, ContactUpdate, CreditGrantList, CreditNote, CreditNoteItemList, CreditNoteList, CurrencyList, DiscountList, EntitlementList, Error, ErrorResponse, FeatureGrantList, GetCheckoutSessionQuoteParams, GetPlanHeaders, GetPriceHeaders, GetProductHeaders, GetStatementUsageParams, Invoice, InvoiceItemList, InvoiceList, ListAccountDiscountsParams, ListActiveResourcesParams, ListAllowancesParams, ListBillingAccountsParams, ListCancellationsParams, ListCheckoutSessionItemsParams, ListCheckoutSessionsParams, ListContactsParams, ListCreditGrantsParams, ListCreditNoteItemsParams, ListCreditNotesParams, ListCurrenciesParams, ListEntitlementsParams, ListFeatureGrantsParams, ListInvoiceItemsParams, ListInvoicesParams, ListMonthlyStatementsParams, ListOrderItemsParams, ListOrdersParams, ListPaymentMethodsParams, ListPaymentOptionsParams, ListPlansHeaders, ListPlansParams, ListPricesByPlanHeaders, ListPricesByPlanParams, ListPricesHeaders, ListPricesParams, ListProductsHeaders, ListProductsParams, ListProjectAssignmentsParams, ListRatesHeaders, ListRatesParams, ListRefundsParams, ListRenewalPricesParams, ListSpendParams, ListStatementsParams, ListSubscriptionsParams, ListTopUpsParams, ListTransactionsParams, ListUsageChargesParams, ListWithdrawalItemsParams, ListWithdrawalsParams, MonthlyStatementList, NotModifiedResponse, Order, OrderCancel, OrderItemList, OrderList, OrderRefundPreview, PayInvoiceRequest, PayTogetherRequest, PaymentMethod, PaymentMethodList, PaymentMethodSetup, PaymentMethodSetupResult, PaymentOptionList, PaymentPreview, PaymentResult, Plan, PlanList, PreviewInvoicePaymentParams, PreviewOrderRefundParams, Price, PriceList, Product, ProductID, ProductList, ProjectAssignment, ProjectAssignmentList, Quote, QuoteRequest, RateList, RefundList, RenewRequest, RenewalPriceList, SetProjectAssignmentRequest, SpendRowList, Statement, StatementList, StatementSummary, Subscription, SubscriptionList, TopUp, TopUpCreate, TopUpList, TransactionList, UsageChargeList, UsageEstimate, UsageEstimateRequest, Withdrawal, WithdrawalCreate, WithdrawalItemList, WithdrawalList, WithdrawalPreview, WithdrawalPreviewRequest } from "./models.js";
+import type { AccountBalance, AccountDeletionReadiness, ActiveResourceList, AllowanceList, AutoRenewSet, BillingAccount, BillingAccountCreate, BillingAccountList, BillingAccountUpdate, CancelSubscriptionRequest, Cancellation, CancellationCreate, CancellationList, CancellationPreviewRequest, CancellationRefundPreview, CheckoutSession, CheckoutSessionConfirm, CheckoutSessionCreate, CheckoutSessionItemList, CheckoutSessionList, CheckoutSessionResult, Contact, ContactCreate, ContactList, ContactUpdate, CreditGrantList, CreditNote, CreditNoteItemList, CreditNoteList, CurrencyList, DiscountList, EntitlementList, Error, ErrorResponse, FeatureGrantList, GetCheckoutSessionQuoteParams, GetPlanHeaders, GetPriceHeaders, GetProductHeaders, GetStatementUsageParams, Invoice, InvoiceItemList, InvoiceList, ListAccountDiscountsParams, ListActiveResourcesParams, ListAllowancesParams, ListBillingAccountsParams, ListCancellationsParams, ListCheckoutSessionItemsParams, ListCheckoutSessionsParams, ListContactsParams, ListCreditGrantsParams, ListCreditNoteItemsParams, ListCreditNotesParams, ListCurrenciesParams, ListEntitlementsParams, ListFeatureGrantsParams, ListInvoiceItemsParams, ListInvoicesParams, ListMonthlyStatementsParams, ListOrderItemsParams, ListOrdersParams, ListPaymentMethodsParams, ListPaymentOptionsParams, ListPlansHeaders, ListPlansParams, ListPricesByPlanHeaders, ListPricesByPlanParams, ListPricesHeaders, ListPricesParams, ListProductsHeaders, ListProductsParams, ListProjectAssignmentsParams, ListRatesHeaders, ListRatesParams, ListRefundsParams, ListRenewalPricesParams, ListSpendParams, ListStatementsParams, ListSubscriptionsParams, ListTopUpsParams, ListTransactionsParams, ListUsageChargesParams, ListWithdrawalItemsParams, ListWithdrawalsParams, MonthlyStatementList, NotModifiedResponse, Order, OrderCancel, OrderItemList, OrderList, OrderRefundPreview, PayInvoiceRequest, PayTogetherRequest, PaymentMethod, PaymentMethodList, PaymentMethodSetup, PaymentMethodSetupResult, PaymentOptionList, PaymentPreview, PaymentResult, Plan, PlanList, PreviewInvoicePaymentParams, PreviewOrderRefundParams, Price, PriceList, PriceSearch, Product, ProductID, ProductList, ProjectAssignment, ProjectAssignmentList, Quote, QuoteRequest, RateList, RateSearch, RefundList, RenewRequest, RenewalPriceList, SetProjectAssignmentRequest, SpendRowList, Statement, StatementList, StatementSummary, Subscription, SubscriptionList, TopUp, TopUpCreate, TopUpList, TransactionList, UsageChargeList, UsageEstimate, UsageEstimateRequest, Withdrawal, WithdrawalCreate, WithdrawalItemList, WithdrawalList, WithdrawalPreview, WithdrawalPreviewRequest } from "./models.js";
 export type HTTPStatusCode1xx = 100 | 101 | 102 | 103;
 export type HTTPStatusCode2xx = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207;
 export type HTTPStatusCode3xx = 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308;
@@ -1174,14 +1174,17 @@ export type getQuoteResponseError = getQuoteResponseDefault & {
 export type getQuoteResponse = getQuoteResponseSuccess | getQuoteResponseError;
 export declare const getGetQuoteUrl: () => string;
 /**
- * Calculates what a proposed purchase, or the renewal of your subscriptions, would invoice now, and what each
- * purchased line renews at. Nothing is saved, reserved or redeemed.
+ * 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.
  *
  * With `billing_account_id`, the quote is for that billing account: its currency, account discounts,
- * tax and funds apply, renewals use the account currently paying for each subscription, and an access token
- * is required. The account must be yours or currently pay for a project you are a member of. Without it,
- * proposed items are priced in `currency` for anyone, signed in or not: no account discount or funds apply, and
- * `tax_status` is `requires_location_inputs`.
+ * tax and funds apply, changes and renewals use the account currently paying for each subscription, and an
+ * access token is required. The account must be yours or currently pay for a project you are a member of.
+ * Without it, proposed items are priced in `currency` for anyone, signed in or not: no account discount or funds
+ * apply, and tax that would be added is included only for the customer's `address`.
+ *
+ * A change is priced as the service that owns the subscription would order it: pass the returned `total` as the
+ * expected amount and, for an immediate change, `proration_date` to that service when making the change.
  *
  * A promotion code is evaluated without being applied. It is applied only when a Checkout Session is completed
  * with it; conditions that depend on the account, such as a first purchase, are checked only with an account
@@ -1825,6 +1828,30 @@ export declare const getListPricesUrl: (params: ListPricesParams) => string;
  * @summary List what is on sale, with prices
  */
 export declare const listPrices: (params: ListPricesParams, headers?: ListPricesHeaders, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listPricesResponse>;
+export type searchPricesResponse200 = {
+    data: PriceList;
+    status: 200;
+};
+export type searchPricesResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type searchPricesResponseSuccess = searchPricesResponse200 & {
+    headers: Headers;
+};
+export type searchPricesResponseError = searchPricesResponseDefault & {
+    headers: Headers;
+};
+export type searchPricesResponse = searchPricesResponseSuccess | searchPricesResponseError;
+export declare const getSearchPricesUrl: () => string;
+/**
+ * Lists the active prices in `currency` that meet every condition in the body, as `list-prices` lists them, for
+ * anyone, signed in or not. Use it for conditions a query string cannot hold, such as the plans of a whole
+ * catalog page. A price that delegates to a rate card has no amount of its own; read its rates with
+ * `search-rates`.
+ * @summary Search what is on sale, with prices
+ */
+export declare const searchPrices: (priceSearch: PriceSearch, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<searchPricesResponse>;
 export type listProductsResponse200 = {
     data: ProductList;
     status: 200;
@@ -2000,6 +2027,30 @@ export declare const getListRatesUrl: (rateCardId: string, params?: ListRatesPar
  * @summary List catalog rates
  */
 export declare const listRates: (rateCardId: string, params?: ListRatesParams, headers?: ListRatesHeaders, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listRatesResponse>;
+export type searchRatesResponse200 = {
+    data: RateList;
+    status: 200;
+};
+export type searchRatesResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type searchRatesResponseSuccess = searchRatesResponse200 & {
+    headers: Headers;
+};
+export type searchRatesResponseError = searchRatesResponseDefault & {
+    headers: Headers;
+};
+export type searchRatesResponse = searchRatesResponseSuccess | searchRatesResponseError;
+export declare const getSearchRatesUrl: (rateCardId: string) => string;
+/**
+ * Rules of a public rate card that meet every condition in the body, as `list-rates` lists them, for anyone,
+ * signed in or not; contract cards are not readable here. Use it to read the rates at the dimension values of the
+ * items on a page, such as each region and machine type offered, and match each rate to its price by meter,
+ * usage type, interval and dimensions.
+ * @summary Search catalog rates
+ */
+export declare const searchRates: (rateCardId: string, rateSearch: RateSearch, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<searchRatesResponse>;
 export type listActiveResourcesResponse200 = {
     data: ActiveResourceList;
     status: 200;

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

@@ -1289,14 +1289,17 @@ export const getGetQuoteUrl = () => {
     return `https://billing.leaflow.cloud/api/v1/quotes`;
 };
 /**
- * Calculates what a proposed purchase, or the renewal of your subscriptions, would invoice now, and what each
- * purchased line renews at. Nothing is saved, reserved or redeemed.
+ * 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.
  *
  * With `billing_account_id`, the quote is for that billing account: its currency, account discounts,
- * tax and funds apply, renewals use the account currently paying for each subscription, and an access token
- * is required. The account must be yours or currently pay for a project you are a member of. Without it,
- * proposed items are priced in `currency` for anyone, signed in or not: no account discount or funds apply, and
- * `tax_status` is `requires_location_inputs`.
+ * tax and funds apply, changes and renewals use the account currently paying for each subscription, and an
+ * access token is required. The account must be yours or currently pay for a project you are a member of.
+ * Without it, proposed items are priced in `currency` for anyone, signed in or not: no account discount or funds
+ * apply, and tax that would be added is included only for the customer's `address`.
+ *
+ * A change is priced as the service that owns the subscription would order it: pass the returned `total` as the
+ * expected amount and, for an immediate change, `proration_date` to that service when making the change.
  *
  * A promotion code is evaluated without being applied. It is applied only when a Checkout Session is completed
  * with it; conditions that depend on the account, such as a first purchase, are checked only with an account
@@ -2072,6 +2075,42 @@ export const listPrices = async (params, headers, options, fetchFn) => {
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
+export const getSearchPricesUrl = () => {
+    return `https://billing.leaflow.cloud/api/v1/prices`;
+};
+/**
+ * Lists the active prices in `currency` that meet every condition in the body, as `list-prices` lists them, for
+ * anyone, signed in or not. Use it for conditions a query string cannot hold, such as the plans of a whole
+ * catalog page. A price that delegates to a rate card has no amount of its own; read its rates with
+ * `search-rates`.
+ * @summary Search what is on sale, with prices
+ */
+export const searchPrices = async (priceSearch, 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)(getSearchPricesUrl(), {
+        ...options,
+        method: "QUERY",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(priceSearch),
+    });
+    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 getListProductsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -2332,6 +2371,42 @@ export const listRates = async (rateCardId, params, headers, options, fetchFn) =
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
+export const getSearchRatesUrl = (rateCardId) => {
+    return `https://billing.leaflow.cloud/api/v1/rate-cards/${encodeURIComponent(String(rateCardId))}/rules`;
+};
+/**
+ * Rules of a public rate card that meet every condition in the body, as `list-rates` lists them, for anyone,
+ * signed in or not; contract cards are not readable here. Use it to read the rates at the dimension values of the
+ * items on a page, such as each region and machine type offered, and match each rate to its price by meter,
+ * usage type, interval and dimensions.
+ * @summary Search catalog rates
+ */
+export const searchRates = async (rateCardId, rateSearch, 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)(getSearchRatesUrl(rateCardId), {
+        ...options,
+        method: "QUERY",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(rateSearch),
+    });
+    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 getListActiveResourcesUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {

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

@@ -155,6 +155,15 @@ export declare const UsageType: {
     readonly licensed: "licensed";
     readonly metered: "metered";
 };
+/**
+ * What an immediate downgrade would refund, estimated as of `proration_date`. The refund itself is determined when the change takes effect.
+ */
+export interface QuoteDowngradeRefund {
+    /** Returned to the original payment sources, tax paid on it included. */
+    refundable_amount: Money;
+    /** Before tax, the part of the excess that the subscription's refund terms do not return. */
+    forfeited_amount: Money;
+}
 /**
  * One fully calculated purchase line. An item with no immediate charge, such as a metered purchase, has zero checkout amounts.
  */
@@ -162,10 +171,15 @@ export interface QuoteItem {
     tax_amount: Money;
     tax_included_amount: Money;
     /**
-     * The zero-based request line index, or the item's position for a Checkout Session quote.
+     * The zero-based index of the item or change in the request, or the item's position for a Checkout Session quote.
      * @minimum 0
      */
     index: number;
+    /**
+     * The subscription changed; null for a new purchase.
+     * @nullable
+     */
+    subscription_id: string | null;
     product_id: ProductID;
     plan_id: string;
     /** The selected price, also when the request identified it indirectly. */
@@ -194,11 +208,17 @@ export interface QuoteItem {
     /** Amount before discounts and including any setup charge. */
     amount: Money;
     discount_amount: Money;
+    /** Immediate changes only; null otherwise. Before tax, the new terms for the time from `proration_date` to the end of the paid period. An upgrade invoices `remaining_amount` minus `unused_amount`. */
+    remaining_amount: Money | null;
+    /** Immediate changes only; null otherwise. Before tax, for an upgrade or an unchanged period price, the amount paid for that time, up to the new terms' value for the same time; for a downgrade, the remaining value of what was paid, under the refund terms of each paid period. */
+    unused_amount: Money | null;
+    /** Immediate downgrades only, when `unused_amount` exceeds `remaining_amount`; null otherwise. */
+    downgrade_refund: QuoteDowngradeRefund | null;
     total: Money;
     currency: string;
 }
 /**
- * `complete`: tax is calculated for the billing account's invoice contact. `requires_location_inputs`: a quote without an account, which leaves out tax that would be added; tax already contained in a price is included.
+ * `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.
  */
 export type QuoteTaxStatus = (typeof QuoteTaxStatus)[keyof typeof QuoteTaxStatus];
 export declare const QuoteTaxStatus: {
@@ -290,7 +310,7 @@ export interface Quote {
      * @nullable
      */
     proration_date: string | null;
-    /** `complete`: tax is calculated for the billing account's invoice contact. `requires_location_inputs`: a quote without an account, which leaves out tax that would be added; tax already contained in a price is included. */
+    /** `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;
 }
 /**
@@ -2754,7 +2774,76 @@ export interface UsageEstimate {
     items: UsageEstimateItem[];
 }
 /**
- * Quote proposed items or renewals, not both. Give exactly one of `billing_account_id` and `currency`; renewals need the account. Promotion codes apply only to proposed items. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.
+ * 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.
+ */
+export type QuoteRequestChangeEffective = (typeof QuoteRequestChangeEffective)[keyof typeof QuoteRequestChangeEffective];
+export declare const QuoteRequestChangeEffective: {
+    readonly immediate: "immediate";
+    readonly period_end: "period_end";
+};
+export type QuoteChangeInputInterval = (typeof QuoteChangeInputInterval)[keyof typeof QuoteChangeInputInterval];
+export declare const QuoteChangeInputInterval: {
+    readonly none: "none";
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * The dimension values after the change, given in full; omit to keep the subscription's.
+ */
+export type QuoteChangeInputDimensions = {
+    [key: string]: string;
+};
+/**
+ * The new terms of one subscription. Identify the price, or the plan to select one from, as for a proposed item. Without a price or billing terms, the plan's price with the subscription's price type, usage type, interval, interval count and cancellation policy is selected. Omitted dimensions keep the subscription's.
+ */
+export interface QuoteChangeInput {
+    subscription_id: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    price_lookup_key?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    plan_lookup_key?: string;
+    price_id?: string;
+    product_id?: ProductID;
+    plan_id?: string;
+    /** Selects the price type instead of keeping the subscription's. */
+    price_type?: PriceType;
+    /** Selects the usage type instead of keeping the subscription's. */
+    usage_type?: UsageType;
+    interval?: QuoteChangeInputInterval;
+    /** @minimum 1 */
+    interval_count?: number;
+    /** Selects among licensed prices with otherwise identical billing terms. */
+    cancellation_policy?: CancellationPolicy;
+    /**
+     * The quantity after the change.
+     * @pattern ^(?:(?:[1-9][0-9]{0,27}|0(?:[1-9][0-9]{0,26}|0(?:[1-9][0-9]{0,25}|0(?:[1-9][0-9]{0,24}|0(?:[1-9][0-9]{0,23}|0(?:[1-9][0-9]{0,22}|0(?:[1-9][0-9]{0,21}|0(?:[1-9][0-9]{0,20}|0(?:[1-9][0-9]{0,19}|0(?:[1-9][0-9]{0,18}|0(?:[1-9][0-9]{0,17}|0(?:[1-9][0-9]{0,16}|0(?:[1-9][0-9]{0,15}|0(?:[1-9][0-9]{0,14}|0(?:[1-9][0-9]{0,13}|0(?:[1-9][0-9]{0,12}|0(?:[1-9][0-9]{0,11}|0(?:[1-9][0-9]{0,10}|0(?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9])))))))))))))))))))))))))))([.][0-9]{1,10})?|0{1,28}[.](?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9]))))))))))$
+     */
+    quantity: string;
+    /** The dimension values after the change, given in full; omit to keep the subscription's. */
+    dimensions?: QuoteChangeInputDimensions;
+}
+export interface QuoteAddress {
+    /**
+     * ISO 3166-1 alpha-2, two uppercase letters.
+     * @pattern ^[A-Z]{2}$
+     */
+    country: string;
+    /**
+     * The state or province, as the tax rates name it.
+     * @minLength 1
+     * @maxLength 128
+     */
+    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.
  */
 export interface QuoteRequest {
     /**
@@ -2780,6 +2869,16 @@ export interface QuoteRequest {
      * @maxItems 100
      */
     renewals?: QuoteRenewal[];
+    /**
+     * 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.
+     * @minItems 1
+     * @maxItems 100
+     */
+    changes?: QuoteChangeInput[];
+    /** 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. */
+    address?: QuoteAddress;
     /**
      * @minLength 1
      * @maxLength 64
@@ -3048,6 +3147,70 @@ export interface ContactList {
     items: Contact[];
     pagination: OffsetPagination;
 }
+/**
+ * Conditions combined with AND.
+ */
+export interface PriceSearch {
+    /**
+     * ISO 4217, three uppercase letters.
+     * @minLength 3
+     * @maxLength 3
+     */
+    currency: string;
+    /**
+     * Only prices of these plans.
+     * @minItems 1
+     * @maxItems 200
+     */
+    plan_ids?: string[];
+    product_id?: ProductID;
+    /** Narrows to one price type. */
+    type?: PriceType;
+    /** Narrows to one usage type. */
+    usage_type?: UsageType;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+}
+export type RateSearchDimensionsItem = {
+    [key: string]: string;
+};
+/**
+ * Conditions combined with AND.
+ */
+export interface RateSearch {
+    /** Only rates on this meter. */
+    meter_id?: string;
+    /** Rates in effect at this moment; defaults to now. */
+    at?: string;
+    /**
+     * Only rates whose dimension values are exactly one of these sets, given as on order lines and usage. A set no rate has matches nothing.
+     * @minItems 1
+     * @maxItems 200
+     */
+    dimensions?: RateSearchDimensionsItem[];
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+}
 export interface CancelSubscriptionRequest {
     mode: CancellationPolicy;
     /** For immediate cancellation, the quoted whole-second refund basis. Now when omitted. */

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

@@ -369,6 +369,16 @@ export const ActiveResourceStatus = {
     closing: "closing",
     closed: "closed",
 };
+export const QuoteRequestChangeEffective = {
+    immediate: "immediate",
+    period_end: "period_end",
+};
+export const QuoteChangeInputInterval = {
+    none: "none",
+    day: "day",
+    month: "month",
+    year: "year",
+};
 export const WithdrawalItemStatus = {
     pending: "pending",
     succeeded: "succeeded",

package/dist/billing/v1/generated/schemas.zod.d.ts

@@ -1181,6 +1181,16 @@ export declare const ListRatesQueryParams: zod.ZodObject<{
 export declare const ListRatesHeader: zod.ZodObject<{
     "If-None-Match": zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
+/**
+ * Rules of a public rate card that meet every condition in the body, as `list-rates` lists them, for anyone,
+ * signed in or not; contract cards are not readable here. Use it to read the rates at the dimension values of the
+ * items on a page, such as each region and machine type offered, and match each rate to its price by meter,
+ * usage type, interval and dimensions.
+ * @summary Search catalog rates
+ */
+export declare const SearchRatesParams: zod.ZodObject<{
+    rateCardId: zod.ZodUUID;
+}, zod.z.core.$strict>;
 /**
  * Continuous metering registrations paid for by your billing accounts; members of a project list its registrations with `project_ids`. Their state does not describe the resource's runtime.
  * @summary List active resources

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

@@ -1561,6 +1561,16 @@ export const ListRatesHeader = zod.strictObject({
         .optional()
         .describe("The `ETag` of an earlier response. When the catalogue has not changed since, the response is `304` with no body."),
 });
+/**
+ * Rules of a public rate card that meet every condition in the body, as `list-rates` lists them, for anyone,
+ * signed in or not; contract cards are not readable here. Use it to read the rates at the dimension values of the
+ * items on a page, such as each region and machine type offered, and match each rate to its price by meter,
+ * usage type, interval and dimensions.
+ * @summary Search catalog rates
+ */
+export const SearchRatesParams = zod.strictObject({
+    rateCardId: zod.uuid(),
+});
 /**
  * Continuous metering registrations paid for by your billing accounts; members of a project list its registrations with `project_ids`. Their state does not describe the resource's runtime.
  * @summary List active resources

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

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, and, with project permissions granted in IAM, change its subscriptions (`billing:subscription.write`), change its billing account (`billing:project_assignment.write`) and read its costs (`billing:cost.read`). A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const priceSearchCurrencyMin = 3;
+export declare const priceSearchCurrencyMax = 3;
+export declare const priceSearchPlanIdsMax = 200;
+export declare const priceSearchPageMax = 2147483647;
+export declare const priceSearchPageSizeMax = 200;
+export declare const PriceSearch: zod.ZodObject<{
+    currency: zod.ZodString;
+    plan_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
+    product_id: zod.ZodOptional<zod.ZodString>;
+    type: zod.ZodOptional<zod.ZodEnum<{
+        one_time: "one_time";
+        recurring: "recurring";
+    }>>;
+    usage_type: zod.ZodOptional<zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
+    }>>;
+    page: zod.ZodOptional<zod.ZodInt>;
+    page_size: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+export type PriceSearch = zod.input<typeof PriceSearch>;
+export type PriceSearchOutput = zod.output<typeof PriceSearch>;

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

@@ -0,0 +1,46 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, and, with project permissions granted in IAM, change its subscriptions (`billing:subscription.write`), change its billing account (`billing:project_assignment.write`) and read its costs (`billing:cost.read`). A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { PriceType } from "./priceType.zod.js";
+import { ProductID } from "./productID.zod.js";
+import { UsageType } from "./usageType.zod.js";
+export const priceSearchCurrencyMin = 3;
+export const priceSearchCurrencyMax = 3;
+export const priceSearchPlanIdsMax = 200;
+export const priceSearchPageMax = 2147483647;
+export const priceSearchPageSizeMax = 200;
+export const PriceSearch = zod
+    .strictObject({
+    currency: zod
+        .string()
+        .min(priceSearchCurrencyMin)
+        .max(priceSearchCurrencyMax)
+        .describe("ISO 4217, three uppercase letters."),
+    plan_ids: zod
+        .array(zod.uuid())
+        .min(1)
+        .max(priceSearchPlanIdsMax)
+        .optional()
+        .describe("Only prices of these plans."),
+    product_id: ProductID.optional(),
+    type: PriceType.optional().describe("Narrows to one price type."),
+    usage_type: UsageType.optional().describe("Narrows to one usage type."),
+    page: zod
+        .int()
+        .min(1)
+        .max(priceSearchPageMax)
+        .optional()
+        .describe("1-based page number. Defaults to 1."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(priceSearchPageSizeMax)
+        .optional()
+        .describe("Items per page. Defaults to 50; at most 200."),
+})
+    .describe("Conditions combined with AND.");

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

@@ -40,6 +40,7 @@ export declare const Quote: zod.ZodObject<{
         tax_amount: zod.ZodString;
         tax_included_amount: zod.ZodString;
         index: zod.ZodInt;
+        subscription_id: zod.ZodNullable<zod.ZodUUID>;
         product_id: zod.ZodString;
         plan_id: zod.ZodUUID;
         price_id: zod.ZodUUID;
@@ -66,6 +67,12 @@ export declare const Quote: zod.ZodObject<{
         quantity: zod.ZodString;
         amount: zod.ZodString;
         discount_amount: zod.ZodString;
+        remaining_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+        unused_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+        downgrade_refund: zod.ZodUnion<readonly [zod.ZodObject<{
+            refundable_amount: zod.ZodString;
+            forfeited_amount: zod.ZodString;
+        }, zod.z.core.$strict>, zod.ZodNull]>;
         total: zod.ZodString;
         currency: zod.ZodString;
     }, zod.z.core.$strict>>;

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

@@ -32,6 +32,6 @@ export const Quote = zod
         .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."),
     tax_status: zod
         .enum(["complete", "requires_location_inputs"])
-        .describe("`complete`: tax is calculated for the billing account's invoice contact. `requires_location_inputs`: a quote without an account, which leaves out tax that would be added; tax already contained in a price is included."),
+        .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."),
 })
     .describe("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.");

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

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, and, with project permissions granted in IAM, change its subscriptions (`billing:subscription.write`), change its billing account (`billing:project_assignment.write`) and read its costs (`billing:cost.read`). A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const quoteAddressCountryRegExp: RegExp;
+export declare const quoteAddressStateMax = 128;
+export declare const QuoteAddress: zod.ZodObject<{
+    country: zod.ZodString;
+    state: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type QuoteAddress = zod.input<typeof QuoteAddress>;
+export type QuoteAddressOutput = zod.output<typeof QuoteAddress>;

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

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, and, with project permissions granted in IAM, change its subscriptions (`billing:subscription.write`), change its billing account (`billing:project_assignment.write`) and read its costs (`billing:cost.read`). A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export const quoteAddressCountryRegExp = new RegExp("^[A-Z]{2}$");
+export const quoteAddressStateMax = 128;
+export const QuoteAddress = zod.strictObject({
+    country: zod
+        .string()
+        .regex(quoteAddressCountryRegExp)
+        .describe("ISO 3166-1 alpha-2, two uppercase letters."),
+    state: zod
+        .string()
+        .min(1)
+        .max(quoteAddressStateMax)
+        .optional()
+        .describe("The state or province, as the tax rates name it."),
+});