@leaflow/sdk 0.160.0 → 0.162.0

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Cancellation Types
+ * Shared cancellation choices for services that end subscriptions through Billing. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Cancellation Types
+ * Shared cancellation choices for services that end subscriptions through Billing. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

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

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Cancellation Types
+ * Shared cancellation choices for services that end subscriptions through Billing. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+/**
+ * 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
+ * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+ * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+ * BILLING_CANCELLATION_MODE_FIXED.
+ */
+export type CancellationMode = (typeof CancellationMode)[keyof typeof CancellationMode];
+export declare const CancellationMode: {
+    readonly immediate: "immediate";
+    readonly period_end: "period_end";
+};

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

@@ -0,0 +1,4 @@
+export const CancellationMode = {
+    immediate: "immediate",
+    period_end: "period_end",
+};

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Cancellation Types
+ * Shared cancellation choices for services that end subscriptions through Billing. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Cancellation Types
+ * Shared cancellation choices for services that end subscriptions through Billing. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

package/dist/billing/type/cancellation/v1/generated/validators/cancellationMode.zod.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Cancellation Types
+ * Shared cancellation choices for services that end subscriptions through Billing. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const CancellationMode: zod.ZodEnum<{
+    immediate: "immediate";
+    period_end: "period_end";
+}>;
+export type CancellationMode = zod.input<typeof CancellationMode>;
+export type CancellationModeOutput = zod.output<typeof CancellationMode>;

package/dist/billing/type/cancellation/v1/generated/validators/cancellationMode.zod.js

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Cancellation Types
+ * Shared cancellation choices for services that end subscriptions through Billing. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export const CancellationMode = zod
+    .enum(["immediate", "period_end"])
+    .describe("When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end\nends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which\nmodes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the\nend of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422\nBILLING_CANCELLATION_MODE_FIXED.");

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

@@ -2,7 +2,7 @@
  * 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.
+ * 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, quote purchases, changes, renewals and cancellations, and, with the project permission `billing:finance.manage` granted in IAM, renew, cancel and turn automatic renewal of its subscriptions on or off, change its billing account and read its costs. 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, 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";
@@ -502,7 +502,7 @@ export type setProjectAssignmentResponse = setProjectAssignmentResponseSuccess |
 export declare const getSetProjectAssignmentUrl: (projectId: string) => string;
 /**
  * Links the project to a billing account you own; you need the project permission
- * `billing:project_assignment.write`. A project without one is linked directly. Moving it to another
+ * `billing:finance.manage`. A project without one is linked directly. Moving it to another
  * account has the same requirements as unlinking: you own both accounts, the project has no metered resources,
  * no subscriptions that have not ended and no orders in progress, and the current account has no unpaid
  * invoices. Nothing moves with the project; charges already incurred stay with the account linked when they
@@ -529,7 +529,7 @@ export type unlinkProjectBillingAccountResponseError = unlinkProjectBillingAccou
 export type unlinkProjectBillingAccountResponse = unlinkProjectBillingAccountResponseSuccess | unlinkProjectBillingAccountResponseError;
 export declare const getUnlinkProjectBillingAccountUrl: (projectId: string) => string;
 /**
- * Ends the project's current assignment; the assignment history is kept. You need to own the account and hold the project permission `billing:project_assignment.write`. Allowed only when the project has no metered resources, no subscriptions that have not ended and no orders in progress, including period-end changes, and the billing account has no unpaid invoices; invoices of orders awaiting payment do not count. Orders are not modified, so wait for them to complete. Charges already incurred stay with the billing account and are invoiced as usual. The project cannot make purchases until a billing account is linked again.
+ * Ends the project's current assignment; the assignment history is kept. You need to own the account and hold the project permission `billing:finance.manage`. Allowed only when the project has no metered resources, no subscriptions that have not ended and no orders in progress, including period-end changes, and the billing account has no unpaid invoices; invoices of orders awaiting payment do not count. Orders are not modified, so wait for them to complete. Charges already incurred stay with the billing account and are invoiced as usual. The project cannot make purchases until a billing account is linked again.
  * @summary Unlink project billing account
  */
 export declare const unlinkProjectBillingAccount: (projectId: string, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<unlinkProjectBillingAccountResponse>;
@@ -1060,7 +1060,7 @@ export type listUsageChargesResponseError = listUsageChargesResponseDefault & {
 export type listUsageChargesResponse = listUsageChargesResponseSuccess | listUsageChargesResponseError;
 export declare const getListUsageChargesUrl: (params?: ListUsageChargesParams) => string;
 /**
- * Priced usage charges in the requested scope; members with the project permission `billing:cost.read` list a project's charges with `project_ids`. Usage that had no price when it occurred is never charged later.
+ * Priced usage charges in the requested scope; members with the project permission `billing:finance.manage` list a project's charges with `project_ids`. Usage that had no price when it occurred is never charged later.
  * @summary List usage charges
  */
 export declare const listUsageCharges: (params?: ListUsageChargesParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listUsageChargesResponse>;
@@ -1147,7 +1147,7 @@ export declare const getCancelSubscriptionUrl: (subscriptionId: string) => strin
  * Requests cancellation on the purchase's agreed terms, with the same rules as creating a cancellation. Give the
  * refund amount from a quote with this subscription in `cancellation.subscription_ids`. Open to the owner of the
  * subscription's current billing account and to members of its project with the project permission
- * `billing:subscription.write`.
+ * `billing:finance.manage`.
  *
  * Immediate cancellation asks the owning service to release the resources now; period-end cancellation keeps the
  * subscription active or suspended until the paid term ends. The subscription becomes canceled when the service
@@ -1261,7 +1261,7 @@ export declare const getCreateCancellationUrl: () => string;
  * Ends subscriptions of one service together. Deleting a resource is an `immediate` cancellation of every
  * subscription released with it, such as a server with its disks or an address with its bandwidth. Open to the
  * owner of the subscriptions' current billing account and to members of their project with the project
- * permission `billing:subscription.write`.
+ * permission `billing:finance.manage`.
  *
  * The owning service releases the resources 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 to the original payment
@@ -1310,7 +1310,7 @@ export type previewCancellationResponseError = previewCancellationResponseDefaul
 export type previewCancellationResponse = previewCancellationResponseSuccess | previewCancellationResponseError;
 export declare const getPreviewCancellationUrl: () => string;
 /**
- * What creating the cancellation now would return, per subscription and in total. Nothing is canceled, ended or refunded. Open to the same callers and refused as creating it would be, except that nothing is recorded.
+ * 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 declare const previewCancellation: (cancellationPreviewRequest: CancellationPreviewRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<previewCancellationResponse>;
@@ -1352,7 +1352,7 @@ export type withdrawCancellationResponseError = withdrawCancellationResponseDefa
 export type withdrawCancellationResponse = withdrawCancellationResponseSuccess | withdrawCancellationResponseError;
 export declare const getWithdrawCancellationUrl: (cancellationId: string) => string;
 /**
- * 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:subscription.write`.
+ * 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`.
  * @summary Withdraw a cancellation
  */
 export declare const withdrawCancellation: (cancellationId: string, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<withdrawCancellationResponse>;
@@ -1407,7 +1407,7 @@ export declare const getRenewSubscriptionUrl: (subscriptionId: string) => string
  * order is left. To apply a promotion code or pay later, create a renewal Checkout Session.
  *
  * Open to the owner of the subscription's current billing account and to members of its project with the
- * project permission `billing:subscription.write`. Only the owner can pay with `payment_method_id`.
+ * project permission `billing:finance.manage`. Only the owner can pay with `payment_method_id`.
  *
  * Keep order_id and read the order after an unknown outcome; creating it again conflicts.
  * @summary Renew subscription
@@ -1430,7 +1430,7 @@ export type setAutoRenewResponseError = setAutoRenewResponseDefault & {
 export type setAutoRenewResponse = setAutoRenewResponseSuccess | setAutoRenewResponseError;
 export declare const getSetAutoRenewUrl: (subscriptionId: string) => string;
 /**
- * Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on. Open to the owner of the subscription's current billing account and to members of its project with the project permission `billing:subscription.write`.
+ * Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on. Open to the owner of the subscription's current billing account and to members of its project with the project permission `billing:finance.manage`.
  * @summary Set auto renew
  */
 export declare const setAutoRenew: (subscriptionId: string, autoRenewSet: AutoRenewSet, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<setAutoRenewResponse>;
@@ -1504,7 +1504,7 @@ export declare const getCreateCheckoutSessionUrl: () => string;
  * that service.
  *
  * Open to the owner of the subscription's current billing account and to members of its project with the
- * project permission `billing:subscription.write`. Keep `checkout_session_id` and read the session after an
+ * project permission `billing:finance.manage`. Keep `checkout_session_id` and read the session after an
  * unknown outcome; creating it again conflicts.
  * @summary Create a renewal Checkout Session
  */
@@ -2095,7 +2095,7 @@ export declare const getListSpendUrl: (params: ListSpendParams) => string;
  * Project filters use the account recorded on each charge, including charges for projects later
  * assigned to another account. The total covers all matching groups, not just the returned page.
  *
- * Open to the owner of the account and to members with the project permission `billing:cost.read` of each
+ * Open to the owner of the account and to members with the project permission `billing:finance.manage` of each
  * project in `project_ids`, which must then be given and currently assigned to the account.
  * @summary List account spend
  */
@@ -2180,7 +2180,7 @@ export type getStatementUsageResponseError = getStatementUsageResponseDefault &
 export type getStatementUsageResponse = getStatementUsageResponseSuccess | getStatementUsageResponseError;
 export declare const getGetStatementUsageUrl: (statementId: string, params?: GetStatementUsageParams) => string;
 /**
- * The statement's consumption, grouped by project, product or meter and filtered within the statement. Quantities are given only for meter groups; grouping by meter also splits by the meter's presentation dimensions. Open to the owner of the statement's account and to members with the project permission `billing:cost.read` of each project in `project_ids`, which must then be given and currently assigned to that account.
+ * The statement's consumption, grouped by project, product or meter and filtered within the statement. Quantities are given only for meter groups; grouping by meter also splits by the meter's presentation dimensions. Open to the owner of the statement's account and to members with the project permission `billing:finance.manage` of each project in `project_ids`, which must then be given and currently assigned to that account.
  * @summary Get grouped consumption
  */
 export declare const getStatementUsage: (statementId: string, params?: GetStatementUsageParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getStatementUsageResponse>;

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

@@ -530,7 +530,7 @@ export const getSetProjectAssignmentUrl = (projectId) => {
 };
 /**
  * Links the project to a billing account you own; you need the project permission
- * `billing:project_assignment.write`. A project without one is linked directly. Moving it to another
+ * `billing:finance.manage`. A project without one is linked directly. Moving it to another
  * account has the same requirements as unlinking: you own both accounts, the project has no metered resources,
  * no subscriptions that have not ended and no orders in progress, and the current account has no unpaid
  * invoices. Nothing moves with the project; charges already incurred stay with the account linked when they
@@ -569,7 +569,7 @@ export const getUnlinkProjectBillingAccountUrl = (projectId) => {
     return `https://billing.leaflow.cloud/api/v1/assignments/${encodeURIComponent(String(projectId))}`;
 };
 /**
- * Ends the project's current assignment; the assignment history is kept. You need to own the account and hold the project permission `billing:project_assignment.write`. Allowed only when the project has no metered resources, no subscriptions that have not ended and no orders in progress, including period-end changes, and the billing account has no unpaid invoices; invoices of orders awaiting payment do not count. Orders are not modified, so wait for them to complete. Charges already incurred stay with the billing account and are invoiced as usual. The project cannot make purchases until a billing account is linked again.
+ * Ends the project's current assignment; the assignment history is kept. You need to own the account and hold the project permission `billing:finance.manage`. Allowed only when the project has no metered resources, no subscriptions that have not ended and no orders in progress, including period-end changes, and the billing account has no unpaid invoices; invoices of orders awaiting payment do not count. Orders are not modified, so wait for them to complete. Charges already incurred stay with the billing account and are invoiced as usual. The project cannot make purchases until a billing account is linked again.
  * @summary Unlink project billing account
  */
 export const unlinkProjectBillingAccount = async (projectId, options, fetchFn) => {
@@ -1174,7 +1174,7 @@ export const getListUsageChargesUrl = (params) => {
         : `https://billing.leaflow.cloud/api/v1/usage-charges`;
 };
 /**
- * Priced usage charges in the requested scope; members with the project permission `billing:cost.read` list a project's charges with `project_ids`. Usage that had no price when it occurred is never charged later.
+ * Priced usage charges in the requested scope; members with the project permission `billing:finance.manage` list a project's charges with `project_ids`. Usage that had no price when it occurred is never charged later.
  * @summary List usage charges
  */
 export const listUsageCharges = async (params, options, fetchFn) => {
@@ -1250,7 +1250,7 @@ export const getCancelSubscriptionUrl = (subscriptionId) => {
  * Requests cancellation on the purchase's agreed terms, with the same rules as creating a cancellation. Give the
  * refund amount from a quote with this subscription in `cancellation.subscription_ids`. Open to the owner of the
  * subscription's current billing account and to members of its project with the project permission
- * `billing:subscription.write`.
+ * `billing:finance.manage`.
  *
  * Immediate cancellation asks the owning service to release the resources now; period-end cancellation keeps the
  * subscription active or suspended until the paid term ends. The subscription becomes canceled when the service
@@ -1400,7 +1400,7 @@ export const getCreateCancellationUrl = () => {
  * Ends subscriptions of one service together. Deleting a resource is an `immediate` cancellation of every
  * subscription released with it, such as a server with its disks or an address with its bandwidth. Open to the
  * owner of the subscriptions' current billing account and to members of their project with the project
- * permission `billing:subscription.write`.
+ * permission `billing:finance.manage`.
  *
  * The owning service releases the resources 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 to the original payment
@@ -1461,7 +1461,7 @@ 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 same callers and refused as creating it would be, except that nothing is recorded.
+ * 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) => {
@@ -1510,7 +1510,7 @@ export const getWithdrawCancellationUrl = (cancellationId) => {
     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:subscription.write`.
+ * 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`.
  * @summary Withdraw a cancellation
  */
 export const withdrawCancellation = async (cancellationId, options, fetchFn) => {
@@ -1560,7 +1560,7 @@ export const getRenewSubscriptionUrl = (subscriptionId) => {
  * order is left. To apply a promotion code or pay later, create a renewal Checkout Session.
  *
  * Open to the owner of the subscription's current billing account and to members of its project with the
- * project permission `billing:subscription.write`. Only the owner can pay with `payment_method_id`.
+ * project permission `billing:finance.manage`. Only the owner can pay with `payment_method_id`.
  *
  * Keep order_id and read the order after an unknown outcome; creating it again conflicts.
  * @summary Renew subscription
@@ -1595,7 +1595,7 @@ export const getSetAutoRenewUrl = (subscriptionId) => {
     return `https://billing.leaflow.cloud/api/v1/subscriptions/${encodeURIComponent(String(subscriptionId))}/auto-renew`;
 };
 /**
- * Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on. Open to the owner of the subscription's current billing account and to members of its project with the project permission `billing:subscription.write`.
+ * Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on. Open to the owner of the subscription's current billing account and to members of its project with the project permission `billing:finance.manage`.
  * @summary Set auto renew
  */
 export const setAutoRenew = async (subscriptionId, autoRenewSet, options, fetchFn) => {
@@ -1685,7 +1685,7 @@ export const getCreateCheckoutSessionUrl = () => {
  * that service.
  *
  * Open to the owner of the subscription's current billing account and to members of its project with the
- * project permission `billing:subscription.write`. Keep `checkout_session_id` and read the session after an
+ * project permission `billing:finance.manage`. Keep `checkout_session_id` and read the session after an
  * unknown outcome; creating it again conflicts.
  * @summary Create a renewal Checkout Session
  */
@@ -2451,7 +2451,7 @@ export const getListSpendUrl = (params) => {
  * Project filters use the account recorded on each charge, including charges for projects later
  * assigned to another account. The total covers all matching groups, not just the returned page.
  *
- * Open to the owner of the account and to members with the project permission `billing:cost.read` of each
+ * Open to the owner of the account and to members with the project permission `billing:finance.manage` of each
  * project in `project_ids`, which must then be given and currently assigned to the account.
  * @summary List account spend
  */
@@ -2550,7 +2550,7 @@ export const getGetStatementUsageUrl = (statementId, params) => {
         : `https://billing.leaflow.cloud/api/v1/statements/${encodeURIComponent(String(statementId))}/usage-summary`;
 };
 /**
- * The statement's consumption, grouped by project, product or meter and filtered within the statement. Quantities are given only for meter groups; grouping by meter also splits by the meter's presentation dimensions. Open to the owner of the statement's account and to members with the project permission `billing:cost.read` of each project in `project_ids`, which must then be given and currently assigned to that account.
+ * The statement's consumption, grouped by project, product or meter and filtered within the statement. Quantities are given only for meter groups; grouping by meter also splits by the meter's presentation dimensions. Open to the owner of the statement's account and to members with the project permission `billing:finance.manage` of each project in `project_ids`, which must then be given and currently assigned to that account.
  * @summary Get grouped consumption
  */
 export const getStatementUsage = async (statementId, params, options, fetchFn) => {

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

@@ -2,7 +2,7 @@
  * 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.
+ * 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, quote purchases, changes, renewals and cancellations, and, with the project permission `billing:finance.manage` granted in IAM, renew, cancel and turn automatic renewal of its subscriptions on or off, change its billing account and read its costs. 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
  */
 /**
@@ -313,6 +313,18 @@ export interface Quote {
     /** `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
+ * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+ * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+ * BILLING_CANCELLATION_MODE_FIXED.
+ */
+export type CancellationMode = (typeof CancellationMode)[keyof typeof CancellationMode];
+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`).
  */
@@ -328,7 +340,7 @@ export interface CancellationPreviewRequest {
      * @maxItems 50
      */
     subscription_ids: string[];
-    mode: CancellationPolicy;
+    mode: CancellationMode;
 }
 /**
  * Which object this is, together with what a person currently calls it.
@@ -383,7 +395,7 @@ export interface CancellationRefundPreviewItem {
  * Metered and one-time subscriptions show zero; their usage until release is charged as usual.
  */
 export interface CancellationRefundPreview {
-    mode: CancellationPolicy;
+    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. */
@@ -405,7 +417,7 @@ export interface CancellationCreate {
      * @maxItems 50
      */
     subscription_ids: string[];
-    mode: CancellationPolicy;
+    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. */
@@ -485,7 +497,7 @@ export interface CancellationItem {
 export interface Cancellation {
     id: string;
     status: CancellationStatus;
-    mode: CancellationPolicy;
+    mode: CancellationMode;
     scheduled_at?: string;
     /** For `immediate`, the second the refund is computed as of. */
     proration_date?: string;
@@ -527,11 +539,6 @@ export declare const SubscriptionCancellationStatus: {
     readonly completed: "completed";
     readonly canceled: "canceled";
 };
-export type SubscriptionCancellationMode = (typeof SubscriptionCancellationMode)[keyof typeof SubscriptionCancellationMode];
-export declare const SubscriptionCancellationMode: {
-    readonly immediate: "immediate";
-    readonly period_end: "period_end";
-};
 /**
  * The latest cancellation including the subscription, with this subscription's item: `id` is the item and `cancellation_id` the cancellation. scheduled_at is the intended time and effective_at the confirmed end of service.
  */
@@ -542,7 +549,7 @@ export interface SubscriptionCancellation {
     id: string;
     subscription_id: string;
     status: SubscriptionCancellationStatus;
-    mode: SubscriptionCancellationMode;
+    mode: CancellationMode;
     requested_at: string;
     scheduled_at?: string;
     effective_at?: string;
@@ -2864,7 +2871,7 @@ export interface QuoteRequest {
      */
     items?: QuoteItemInput[];
     /**
-     * Preview renewing these subscriptions, each at most once; each entry is a separate renewal order. To apply a promotion code, create a renewal Checkout Session and quote it.
+     * Preview renewing these subscriptions, each at most once; each entry is a separate renewal order. 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. To apply a promotion code, create a renewal Checkout Session and quote it.
      * @minItems 1
      * @maxItems 100
      */
@@ -3157,6 +3164,12 @@ export interface PriceSearch {
      * @maxLength 3
      */
     currency: string;
+    /**
+     * Only these prices, such as the prices another service names.
+     * @minItems 1
+     * @maxItems 200
+     */
+    ids?: string[];
     /**
      * Only prices of these plans.
      * @minItems 1
@@ -3212,7 +3225,7 @@ export interface RateSearch {
     page_size?: number;
 }
 export interface CancelSubscriptionRequest {
-    mode: CancellationPolicy;
+    mode: CancellationMode;
     /** For immediate cancellation, the quoted whole-second refund basis. Now when omitted. */
     proration_date?: string;
     /** The cancellation quote's refundable amount, including an explicit zero. */

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

@@ -48,6 +48,10 @@ export const QuotedDiscountEligibility = {
     confirmed: "confirmed",
     unverified: "unverified",
 };
+export const CancellationMode = {
+    immediate: "immediate",
+    period_end: "period_end",
+};
 export const CancellationStatus = {
     requested: "requested",
     scheduled: "scheduled",
@@ -77,10 +81,6 @@ export const SubscriptionCancellationStatus = {
     completed: "completed",
     canceled: "canceled",
 };
-export const SubscriptionCancellationMode = {
-    immediate: "immediate",
-    period_end: "period_end",
-};
 export const BillingAccountStatus = {
     active: "active",
     suspended: "suspended",

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

@@ -2,7 +2,7 @@
  * 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.
+ * 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, quote purchases, changes, renewals and cancellations, and, with the project permission `billing:finance.manage` granted in IAM, renew, cancel and turn automatic renewal of its subscriptions on or off, change its billing account and read its costs. 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";
@@ -243,7 +243,7 @@ export declare const GetProjectAssignmentParams: zod.ZodObject<{
 }, zod.z.core.$strict>;
 /**
  * Links the project to a billing account you own; you need the project permission
- * `billing:project_assignment.write`. A project without one is linked directly. Moving it to another
+ * `billing:finance.manage`. A project without one is linked directly. Moving it to another
  * account has the same requirements as unlinking: you own both accounts, the project has no metered resources,
  * no subscriptions that have not ended and no orders in progress, and the current account has no unpaid
  * invoices. Nothing moves with the project; charges already incurred stay with the account linked when they
@@ -259,7 +259,7 @@ export declare const SetProjectAssignmentBody: zod.ZodObject<{
     billing_account_id: zod.ZodInt;
 }, zod.z.core.$strict>;
 /**
- * Ends the project's current assignment; the assignment history is kept. You need to own the account and hold the project permission `billing:project_assignment.write`. Allowed only when the project has no metered resources, no subscriptions that have not ended and no orders in progress, including period-end changes, and the billing account has no unpaid invoices; invoices of orders awaiting payment do not count. Orders are not modified, so wait for them to complete. Charges already incurred stay with the billing account and are invoiced as usual. The project cannot make purchases until a billing account is linked again.
+ * Ends the project's current assignment; the assignment history is kept. You need to own the account and hold the project permission `billing:finance.manage`. Allowed only when the project has no metered resources, no subscriptions that have not ended and no orders in progress, including period-end changes, and the billing account has no unpaid invoices; invoices of orders awaiting payment do not count. Orders are not modified, so wait for them to complete. Charges already incurred stay with the billing account and are invoiced as usual. The project cannot make purchases until a billing account is linked again.
  * @summary Unlink project billing account
  */
 export declare const UnlinkProjectBillingAccountParams: zod.ZodObject<{
@@ -563,7 +563,7 @@ export declare const ListRefundsQueryParams: zod.ZodObject<{
     order_id: zod.ZodOptional<zod.ZodUUID>;
 }, zod.z.core.$strict>;
 /**
- * Priced usage charges in the requested scope; members with the project permission `billing:cost.read` list a project's charges with `project_ids`. Usage that had no price when it occurred is never charged later.
+ * Priced usage charges in the requested scope; members with the project permission `billing:finance.manage` list a project's charges with `project_ids`. Usage that had no price when it occurred is never charged later.
  * @summary List usage charges
  */
 export declare const listUsageChargesQueryPageDefault = 1;
@@ -620,7 +620,7 @@ export declare const DeleteSubscriptionParams: zod.ZodObject<{
  * Requests cancellation on the purchase's agreed terms, with the same rules as creating a cancellation. Give the
  * refund amount from a quote with this subscription in `cancellation.subscription_ids`. Open to the owner of the
  * subscription's current billing account and to members of its project with the project permission
- * `billing:subscription.write`.
+ * `billing:finance.manage`.
  *
  * Immediate cancellation asks the owning service to release the resources now; period-end cancellation keeps the
  * subscription active or suspended until the paid term ends. The subscription becomes canceled when the service
@@ -670,7 +670,7 @@ export declare const ListCancellationsQueryParams: zod.ZodObject<{
  * Ends subscriptions of one service together. Deleting a resource is an `immediate` cancellation of every
  * subscription released with it, such as a server with its disks or an address with its bandwidth. Open to the
  * owner of the subscriptions' current billing account and to members of their project with the project
- * permission `billing:subscription.write`.
+ * permission `billing:finance.manage`.
  *
  * The owning service releases the resources 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 to the original payment
@@ -719,7 +719,7 @@ export declare const GetCancellationParams: zod.ZodObject<{
     cancellationId: zod.ZodUUID;
 }, zod.z.core.$strict>;
 /**
- * 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:subscription.write`.
+ * 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`.
  * @summary Withdraw a cancellation
  */
 export declare const WithdrawCancellationParams: zod.ZodObject<{
@@ -750,7 +750,7 @@ export declare const ListRenewalPricesQueryParams: zod.ZodObject<{
  * order is left. To apply a promotion code or pay later, create a renewal Checkout Session.
  *
  * Open to the owner of the subscription's current billing account and to members of its project with the
- * project permission `billing:subscription.write`. Only the owner can pay with `payment_method_id`.
+ * project permission `billing:finance.manage`. Only the owner can pay with `payment_method_id`.
  *
  * Keep order_id and read the order after an unknown outcome; creating it again conflicts.
  * @summary Renew subscription
@@ -777,7 +777,7 @@ export declare const RenewSubscriptionBody: zod.ZodObject<{
     return_url: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
 /**
- * Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on. Open to the owner of the subscription's current billing account and to members of its project with the project permission `billing:subscription.write`.
+ * Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on. Open to the owner of the subscription's current billing account and to members of its project with the project permission `billing:finance.manage`.
  * @summary Set auto renew
  */
 export declare const SetAutoRenewParams: zod.ZodObject<{
@@ -839,7 +839,7 @@ export declare const ListCheckoutSessionsQueryParams: zod.ZodObject<{
  * that service.
  *
  * Open to the owner of the subscription's current billing account and to members of its project with the
- * project permission `billing:subscription.write`. Keep `checkout_session_id` and read the session after an
+ * project permission `billing:finance.manage`. Keep `checkout_session_id` and read the session after an
  * unknown outcome; creating it again conflicts.
  * @summary Create a renewal Checkout Session
  */
@@ -1224,7 +1224,7 @@ export declare const ListActiveResourcesQueryParams: zod.ZodObject<{
  * Project filters use the account recorded on each charge, including charges for projects later
  * assigned to another account. The total covers all matching groups, not just the returned page.
  *
- * Open to the owner of the account and to members with the project permission `billing:cost.read` of each
+ * Open to the owner of the account and to members with the project permission `billing:finance.manage` of each
  * project in `project_ids`, which must then be given and currently assigned to the account.
  * @summary List account spend
  */
@@ -1293,7 +1293,7 @@ export declare const GetStatementParams: zod.ZodObject<{
     statementId: zod.ZodUUID;
 }, zod.z.core.$strict>;
 /**
- * The statement's consumption, grouped by project, product or meter and filtered within the statement. Quantities are given only for meter groups; grouping by meter also splits by the meter's presentation dimensions. Open to the owner of the statement's account and to members with the project permission `billing:cost.read` of each project in `project_ids`, which must then be given and currently assigned to that account.
+ * The statement's consumption, grouped by project, product or meter and filtered within the statement. Quantities are given only for meter groups; grouping by meter also splits by the meter's presentation dimensions. Open to the owner of the statement's account and to members with the project permission `billing:finance.manage` of each project in `project_ids`, which must then be given and currently assigned to that account.
  * @summary Get grouped consumption
  */
 export declare const GetStatementUsageParams: zod.ZodObject<{