@leaflow/sdk 0.125.1 → 0.127.0

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

@@ -2874,13 +2874,47 @@ export interface StatementAmounts {
     tax_amount: Money;
     total: Money;
 }
+/**
+ * One billing account's usage billing for one UTC calendar month, summed over the month's statements. It is a summary, not something to pay; each closing's invoice is collected on its own.
+ */
+export interface MonthlyStatement {
+    billing_account_id: number;
+    currency: string;
+    period_start: string;
+    period_end: string;
+    /** True after the period's final closing, which applies minimum charges for the whole month. Usage priced later is still billed in supplement statements and added here. */
+    finalized: boolean;
+    finalized_at?: string;
+    /** Statements of the period, including the open one. */
+    statement_count: number;
+    billed: StatementAmounts;
+    credited_amount: Money;
+    unbilled?: StatementAmounts;
+    credit_applied: Money;
+    amount_paid: Money;
+    amount_due: Money;
+    amount_refunded: Money;
+}
+export interface MonthlyStatementList {
+    items: MonthlyStatement[];
+    pagination: OffsetPagination;
+}
 export type StatementStatus = (typeof StatementStatus)[keyof typeof StatementStatus];
 export declare const StatementStatus: {
     readonly open: "open";
     readonly closed: "closed";
 };
 /**
- * An account's consumption for one billing period, collected at one closing. The first statement of a period (sequence 1) closes after the period ends. Usage priced after that closing is collected in a later statement for the same period, which closes and invoices separately; a closed statement is never rewritten. Payments apply to issued invoices.
+ * interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.
+ */
+export type StatementType = (typeof StatementType)[keyof typeof StatementType];
+export declare const StatementType: {
+    readonly interim: "interim";
+    readonly final: "final";
+    readonly supplement: "supplement";
+};
+/**
+ * An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.
  */
 export interface Statement {
     id: string;
@@ -2888,10 +2922,11 @@ export interface Statement {
     currency: string;
     period_start: string;
     period_end: string;
-    /** 1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing. */
+    /** Increases with each closing of the period. */
     sequence: number;
     status: StatementStatus;
-    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
+    type: StatementType;
+    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
     estimated: boolean;
     amounts: StatementAmounts;
     closed_at?: string;

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

@@ -352,6 +352,11 @@ export const StatementStatus = {
     open: "open",
     closed: "closed",
 };
+export const StatementType = {
+    interim: "interim",
+    final: "final",
+    supplement: "supplement",
+};
 export const StatementSummaryGroupBy = {
     project: "project",
     product: "product",

package/dist/billing/type/order/v1/generated/validators/monthlyStatement.zod.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const MonthlyStatement: zod.ZodObject<{
+    billing_account_id: zod.ZodInt;
+    currency: zod.ZodString;
+    period_start: zod.z.ZodISODateTime;
+    period_end: zod.z.ZodISODateTime;
+    finalized: zod.ZodBoolean;
+    finalized_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+    statement_count: zod.ZodInt;
+    billed: zod.ZodObject<{
+        subtotal: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        total: zod.ZodString;
+    }, zod.z.core.$strict>;
+    credited_amount: zod.ZodString;
+    unbilled: zod.ZodOptional<zod.ZodObject<{
+        subtotal: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        total: zod.ZodString;
+    }, zod.z.core.$strict>>;
+    credit_applied: zod.ZodString;
+    amount_paid: zod.ZodString;
+    amount_due: zod.ZodString;
+    amount_refunded: zod.ZodString;
+}, zod.z.core.$strict>;
+export type MonthlyStatement = zod.input<typeof MonthlyStatement>;
+export type MonthlyStatementOutput = zod.output<typeof MonthlyStatement>;

package/dist/billing/type/order/v1/generated/validators/monthlyStatement.zod.js

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { Money } from "./money.zod.js";
+import { StatementAmounts } from "./statementAmounts.zod.js";
+export const MonthlyStatement = zod
+    .strictObject({
+    billing_account_id: zod.int(),
+    currency: zod.string(),
+    period_start: zod.iso.datetime({ offset: true }),
+    period_end: zod.iso.datetime({ offset: true }),
+    finalized: zod
+        .boolean()
+        .describe("True after the period's final closing, which applies minimum charges for the whole month. Usage priced later is still billed in supplement statements and added here."),
+    finalized_at: zod.iso.datetime({ offset: true }).optional(),
+    statement_count: zod.int().describe("Statements of the period, including the open one."),
+    billed: StatementAmounts,
+    credited_amount: Money,
+    unbilled: StatementAmounts.optional(),
+    credit_applied: Money,
+    amount_paid: Money,
+    amount_due: Money,
+    amount_refunded: Money,
+})
+    .describe("One billing account's usage billing for one UTC calendar month, summed over the month's statements. It is a summary, not something to pay; each closing's invoice is collected on its own.");

package/dist/billing/type/order/v1/generated/validators/monthlyStatementList.zod.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const MonthlyStatementList: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        billing_account_id: zod.ZodInt;
+        currency: zod.ZodString;
+        period_start: zod.z.ZodISODateTime;
+        period_end: zod.z.ZodISODateTime;
+        finalized: zod.ZodBoolean;
+        finalized_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+        statement_count: zod.ZodInt;
+        billed: zod.ZodObject<{
+            subtotal: zod.ZodString;
+            discount_amount: zod.ZodString;
+            tax_amount: zod.ZodString;
+            total: zod.ZodString;
+        }, zod.z.core.$strict>;
+        credited_amount: zod.ZodString;
+        unbilled: zod.ZodOptional<zod.ZodObject<{
+            subtotal: zod.ZodString;
+            discount_amount: zod.ZodString;
+            tax_amount: zod.ZodString;
+            total: zod.ZodString;
+        }, zod.z.core.$strict>>;
+        credit_applied: zod.ZodString;
+        amount_paid: zod.ZodString;
+        amount_due: zod.ZodString;
+        amount_refunded: zod.ZodString;
+    }, zod.z.core.$strict>>;
+    pagination: zod.ZodObject<{
+        page: zod.ZodInt;
+        page_size: zod.ZodInt;
+        total_count: zod.ZodOptional<zod.ZodInt>;
+    }, zod.z.core.$strict>;
+}, zod.z.core.$strict>;
+export type MonthlyStatementList = zod.input<typeof MonthlyStatementList>;
+export type MonthlyStatementListOutput = zod.output<typeof MonthlyStatementList>;

package/dist/billing/type/order/v1/generated/validators/monthlyStatementList.zod.js

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { MonthlyStatement } from "./monthlyStatement.zod.js";
+import { OffsetPagination } from "./offsetPagination.zod.js";
+export const MonthlyStatementList = zod.strictObject({
+    items: zod.array(MonthlyStatement),
+    pagination: OffsetPagination,
+});

package/dist/billing/type/order/v1/generated/validators/statement.zod.d.ts

@@ -17,6 +17,11 @@ export declare const Statement: zod.ZodObject<{
         open: "open";
         closed: "closed";
     }>;
+    type: zod.ZodEnum<{
+        interim: "interim";
+        final: "final";
+        supplement: "supplement";
+    }>;
     estimated: zod.ZodBoolean;
     amounts: zod.ZodObject<{
         subtotal: zod.ZodString;

package/dist/billing/type/order/v1/generated/validators/statement.zod.js

@@ -9,6 +9,7 @@ import * as zod from "zod";
 import { Money } from "./money.zod.js";
 import { StatementAmounts } from "./statementAmounts.zod.js";
 import { StatementStatus } from "./statementStatus.zod.js";
+import { StatementType } from "./statementType.zod.js";
 export const Statement = zod
     .strictObject({
     id: zod.uuid(),
@@ -16,13 +17,12 @@ export const Statement = zod
     currency: zod.string(),
     period_start: zod.iso.datetime({ offset: true }),
     period_end: zod.iso.datetime({ offset: true }),
-    sequence: zod
-        .int()
-        .describe("1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing."),
+    sequence: zod.int().describe("Increases with each closing of the period."),
     status: StatementStatus,
+    type: StatementType,
     estimated: zod
         .boolean()
-        .describe("True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing."),
+        .describe("True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing."),
     amounts: StatementAmounts,
     closed_at: zod.iso.datetime({ offset: true }).optional(),
     invoice_id: zod
@@ -33,4 +33,4 @@ export const Statement = zod
     calculated_at: zod.iso.datetime({ offset: true }).optional(),
     credited_amount: Money,
 })
-    .describe("An account's consumption for one billing period, collected at one closing. The first statement of a period (sequence 1) closes after the period ends. Usage priced after that closing is collected in a later statement for the same period, which closes and invoices separately; a closed statement is never rewritten. Payments apply to issued invoices.");
+    .describe("An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.");

package/dist/billing/type/order/v1/generated/validators/statementList.zod.d.ts

@@ -18,6 +18,11 @@ export declare const StatementList: zod.ZodObject<{
             open: "open";
             closed: "closed";
         }>;
+        type: zod.ZodEnum<{
+            interim: "interim";
+            final: "final";
+            supplement: "supplement";
+        }>;
         estimated: zod.ZodBoolean;
         amounts: zod.ZodObject<{
             subtotal: zod.ZodString;

package/dist/billing/type/order/v1/generated/validators/statementType.zod.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const StatementType: zod.ZodEnum<{
+    interim: "interim";
+    final: "final";
+    supplement: "supplement";
+}>;
+export type StatementType = zod.input<typeof StatementType>;
+export type StatementTypeOutput = zod.output<typeof StatementType>;

package/dist/billing/type/order/v1/generated/validators/statementType.zod.js

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export const StatementType = zod
+    .enum(["interim", "final", "supplement"])
+    .describe("interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.");

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

@@ -5,7 +5,7 @@
  * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
  * OpenAPI spec version: v1
  */
-import type { AccountBalance, ActiveResourceList, AllowanceList, AutoRenewSet, BillingAccount, BillingAccountCreate, BillingAccountList, BillingAccountUpdate, CancelSubscriptionRequest, Cancellation, CancellationCreate, CancellationList, Contact, ContactCreate, ContactList, ContactUpdate, CreditGrantList, CreditNote, CreditNoteItemList, CreditNoteList, CurrencyList, DiscountList, EntitlementList, Error, ErrorResponse, FeatureGrantList, GetPlanHeaders, GetPriceHeaders, GetProductHeaders, GetStatementUsageParams, Invoice, InvoiceItemList, InvoiceList, ListAccountDiscountsParams, ListActiveResourcesParams, ListAllowancesParams, ListBillingAccountsParams, ListCancellationsParams, ListContactsParams, ListCreditGrantsParams, ListCreditNoteItemsParams, ListCreditNotesParams, ListCurrenciesParams, ListEntitlementsParams, ListFeatureGrantsParams, ListInvoiceItemsParams, ListInvoicesParams, ListOrderItemsParams, ListOrdersParams, ListPaymentMethodsParams, ListPaymentOptionsParams, ListPlansHeaders, ListPlansParams, ListPricesByPlanHeaders, ListPricesByPlanParams, ListPricesHeaders, ListPricesParams, ListProductsHeaders, ListProductsParams, ListProjectAssignmentsParams, ListRatesHeaders, ListRatesParams, ListRefundsParams, ListRenewalPricesParams, ListSpendParams, ListStatementsParams, ListSubscriptionsParams, ListTopUpsParams, ListTransactionsParams, ListUsageChargesParams, NotModifiedResponse, Order, OrderCancel, OrderItemList, OrderList, PayInvoiceRequest, PayTogetherRequest, PaymentMethod, PaymentMethodList, PaymentMethodSetup, PaymentMethodSetupResult, PaymentOptionList, PaymentPreview, PaymentResult, Plan, PlanList, PreviewInvoicePaymentParams, Price, PriceList, Product, ProductID, ProductList, ProjectAssignment, ProjectAssignmentList, Quote, QuoteRequest, RateList, RefundList, RenewRequest, RenewalOrderRequest, RenewalPriceList, SetProjectAssignmentRequest, SpendRowList, Statement, StatementList, StatementSummary, Subscription, SubscriptionList, TopUp, TopUpCreate, TopUpList, TransactionList, UsageChargeList } from "./models.js";
+import type { AccountBalance, ActiveResourceList, AllowanceList, AutoRenewSet, BillingAccount, BillingAccountCreate, BillingAccountList, BillingAccountUpdate, CancelSubscriptionRequest, Cancellation, CancellationCreate, CancellationList, Contact, ContactCreate, ContactList, ContactUpdate, CreditGrantList, CreditNote, CreditNoteItemList, CreditNoteList, CurrencyList, DiscountList, EntitlementList, Error, ErrorResponse, FeatureGrantList, GetPlanHeaders, GetPriceHeaders, GetProductHeaders, GetStatementUsageParams, Invoice, InvoiceItemList, InvoiceList, ListAccountDiscountsParams, ListActiveResourcesParams, ListAllowancesParams, ListBillingAccountsParams, ListCancellationsParams, 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, MonthlyStatementList, NotModifiedResponse, Order, OrderCancel, OrderItemList, OrderList, PayInvoiceRequest, PayTogetherRequest, PaymentMethod, PaymentMethodList, PaymentMethodSetup, PaymentMethodSetupResult, PaymentOptionList, PaymentPreview, PaymentResult, Plan, PlanList, PreviewInvoicePaymentParams, Price, PriceList, Product, ProductID, ProductList, ProjectAssignment, ProjectAssignmentList, Quote, QuoteRequest, RateList, RefundList, RenewRequest, RenewalOrderRequest, RenewalPriceList, SetProjectAssignmentRequest, SpendRowList, Statement, StatementList, StatementSummary, Subscription, SubscriptionList, TopUp, TopUpCreate, TopUpList, TransactionList, UsageChargeList } 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;
@@ -617,7 +617,10 @@ export declare const getPayInvoiceUrl: (invoiceId: string) => string;
  * payment deadline has passed, with `BILLING_ORDER_EXPIRED`. A renewal invoice is also refused with
  * `BILLING_INVOICE_NOT_PAYABLE` while its subscription is being canceled, is being reclaimed or has
  * ended, with `meta.reason` `subscription_canceling`, `subscription_reclaiming` or
- * `subscription_ended` respectively.
+ * `subscription_ended` respectively. A usage invoice is billed to the smallest fraction a balance can
+ * hold, finer than a payment method can charge, so paying one online is refused with
+ * `BILLING_INVOICE_NOT_PAYABLE` and `meta.reason` `usage_invoice`; it is collected from credit grants
+ * and balance automatically, including right after a top-up.
  * @summary Pay an invoice
  */
 export declare const payInvoice: (invoiceId: string, payInvoiceRequest?: PayInvoiceRequest, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<payInvoiceResponse>;
@@ -1767,6 +1770,27 @@ export declare const getListSpendUrl: (params: ListSpendParams) => string;
  * @summary List account spend
  */
 export declare const listSpend: (params: ListSpendParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listSpendResponse>;
+export type listMonthlyStatementsResponse200 = {
+    data: MonthlyStatementList;
+    status: 200;
+};
+export type listMonthlyStatementsResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type listMonthlyStatementsResponseSuccess = listMonthlyStatementsResponse200 & {
+    headers: Headers;
+};
+export type listMonthlyStatementsResponseError = listMonthlyStatementsResponseDefault & {
+    headers: Headers;
+};
+export type listMonthlyStatementsResponse = listMonthlyStatementsResponseSuccess | listMonthlyStatementsResponseError;
+export declare const getListMonthlyStatementsUrl: (params?: ListMonthlyStatementsParams) => string;
+/**
+ * Usage billing by UTC calendar month for owned billing accounts, newest first. Each period combines its statements, the invoices they issued and how those invoices were paid; usage is billed about hourly, so a month holds many statements. Filter by billing_account_id and by period start.
+ * @summary List monthly statements
+ */
+export declare const listMonthlyStatements: (params?: ListMonthlyStatementsParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listMonthlyStatementsResponse>;
 export type listStatementsResponse200 = {
     data: StatementList;
     status: 200;

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

@@ -648,7 +648,10 @@ export const getPayInvoiceUrl = (invoiceId) => {
  * payment deadline has passed, with `BILLING_ORDER_EXPIRED`. A renewal invoice is also refused with
  * `BILLING_INVOICE_NOT_PAYABLE` while its subscription is being canceled, is being reclaimed or has
  * ended, with `meta.reason` `subscription_canceling`, `subscription_reclaiming` or
- * `subscription_ended` respectively.
+ * `subscription_ended` respectively. A usage invoice is billed to the smallest fraction a balance can
+ * hold, finer than a payment method can charge, so paying one online is refused with
+ * `BILLING_INVOICE_NOT_PAYABLE` and `meta.reason` `usage_invoice`; it is collected from credit grants
+ * and balance automatically, including right after a top-up.
  * @summary Pay an invoice
  */
 export const payInvoice = async (invoiceId, payInvoiceRequest, options, fetchFn) => {
@@ -2061,6 +2064,31 @@ export const listSpend = async (params, options, fetchFn) => {
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
+export const getListMonthlyStatementsUrl = (params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? "null" : String(value));
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0
+        ? `https://billing.leaflow.cloud/api/v1/monthly-statements?${stringifiedParams}`
+        : `https://billing.leaflow.cloud/api/v1/monthly-statements`;
+};
+/**
+ * Usage billing by UTC calendar month for owned billing accounts, newest first. Each period combines its statements, the invoices they issued and how those invoices were paid; usage is billed about hourly, so a month holds many statements. Filter by billing_account_id and by period start.
+ * @summary List monthly statements
+ */
+export const listMonthlyStatements = async (params, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getListMonthlyStatementsUrl(params), {
+        ...options,
+        method: "GET",
+    });
+    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 getListStatementsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {

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

@@ -2858,13 +2858,47 @@ export interface StatementAmounts {
     tax_amount: Money;
     total: Money;
 }
+/**
+ * One billing account's usage billing for one UTC calendar month, summed over the month's statements. It is a summary, not something to pay; each closing's invoice is collected on its own.
+ */
+export interface MonthlyStatement {
+    billing_account_id: number;
+    currency: string;
+    period_start: string;
+    period_end: string;
+    /** True after the period's final closing, which applies minimum charges for the whole month. Usage priced later is still billed in supplement statements and added here. */
+    finalized: boolean;
+    finalized_at?: string;
+    /** Statements of the period, including the open one. */
+    statement_count: number;
+    billed: StatementAmounts;
+    credited_amount: Money;
+    unbilled?: StatementAmounts;
+    credit_applied: Money;
+    amount_paid: Money;
+    amount_due: Money;
+    amount_refunded: Money;
+}
+export interface MonthlyStatementList {
+    items: MonthlyStatement[];
+    pagination: OffsetPagination;
+}
 export type StatementStatus = (typeof StatementStatus)[keyof typeof StatementStatus];
 export declare const StatementStatus: {
     readonly open: "open";
     readonly closed: "closed";
 };
 /**
- * An account's consumption for one billing period, collected at one closing. The first statement of a period (sequence 1) closes after the period ends. Usage priced after that closing is collected in a later statement for the same period, which closes and invoices separately; a closed statement is never rewritten. Payments apply to issued invoices.
+ * interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.
+ */
+export type StatementType = (typeof StatementType)[keyof typeof StatementType];
+export declare const StatementType: {
+    readonly interim: "interim";
+    readonly final: "final";
+    readonly supplement: "supplement";
+};
+/**
+ * An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.
  */
 export interface Statement {
     id: string;
@@ -2872,10 +2906,11 @@ export interface Statement {
     currency: string;
     period_start: string;
     period_end: string;
-    /** 1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing. */
+    /** Increases with each closing of the period. */
     sequence: number;
     status: StatementStatus;
-    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
+    type: StatementType;
+    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
     estimated: boolean;
     amounts: StatementAmounts;
     closed_at?: string;
@@ -3740,6 +3775,29 @@ export declare const ListSpendGroupBy: {
     readonly plan: "plan";
     readonly resource: "resource";
 };
+export type ListMonthlyStatementsParams = {
+    billing_account_id?: number;
+    /**
+     * Earliest period start, inclusive.
+     */
+    from?: string;
+    /**
+     * Latest period start, exclusive.
+     */
+    to?: string;
+    /**
+     * 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 ListStatementsParams = {
     billing_account_id?: number;
     status?: StatementStatus;

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

@@ -352,6 +352,11 @@ export const StatementStatus = {
     open: "open",
     closed: "closed",
 };
+export const StatementType = {
+    interim: "interim",
+    final: "final",
+    supplement: "supplement",
+};
 export const StatementSummaryGroupBy = {
     project: "project",
     product: "product",

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

@@ -344,7 +344,10 @@ export declare const DeletePaymentMethodParams: zod.ZodObject<{
  * payment deadline has passed, with `BILLING_ORDER_EXPIRED`. A renewal invoice is also refused with
  * `BILLING_INVOICE_NOT_PAYABLE` while its subscription is being canceled, is being reclaimed or has
  * ended, with `meta.reason` `subscription_canceling`, `subscription_reclaiming` or
- * `subscription_ended` respectively.
+ * `subscription_ended` respectively. A usage invoice is billed to the smallest fraction a balance can
+ * hold, finer than a payment method can charge, so paying one online is refused with
+ * `BILLING_INVOICE_NOT_PAYABLE` and `meta.reason` `usage_invoice`; it is collected from credit grants
+ * and balance automatically, including right after a top-up.
  * @summary Pay an invoice
  */
 export declare const PayInvoiceParams: zod.ZodObject<{
@@ -1270,6 +1273,21 @@ export declare const ListSpendQueryParams: zod.ZodObject<{
     billing_account_id: zod.ZodInt;
     project_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
 }, zod.z.core.$strict>;
+/**
+ * Usage billing by UTC calendar month for owned billing accounts, newest first. Each period combines its statements, the invoices they issued and how those invoices were paid; usage is billed about hourly, so a month holds many statements. Filter by billing_account_id and by period start.
+ * @summary List monthly statements
+ */
+export declare const listMonthlyStatementsQueryPageDefault = 1;
+export declare const listMonthlyStatementsQueryPageMax = 2147483647;
+export declare const listMonthlyStatementsQueryPageSizeDefault = 50;
+export declare const listMonthlyStatementsQueryPageSizeMax = 200;
+export declare const ListMonthlyStatementsQueryParams: zod.ZodObject<{
+    billing_account_id: zod.ZodOptional<zod.ZodInt>;
+    from: zod.ZodOptional<zod.z.ZodISODateTime>;
+    to: zod.ZodOptional<zod.z.ZodISODateTime>;
+    page: zod.ZodDefault<zod.ZodInt>;
+    page_size: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
 /**
  * Paginated consumption statement batches for owned billing accounts, filtered by billing_account_id, open or closed state and period-start interval. A closed batch is not proof that the whole month has finished.
  * @summary List statements

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

@@ -399,7 +399,10 @@ export const DeletePaymentMethodParams = zod.strictObject({
  * payment deadline has passed, with `BILLING_ORDER_EXPIRED`. A renewal invoice is also refused with
  * `BILLING_INVOICE_NOT_PAYABLE` while its subscription is being canceled, is being reclaimed or has
  * ended, with `meta.reason` `subscription_canceling`, `subscription_reclaiming` or
- * `subscription_ended` respectively.
+ * `subscription_ended` respectively. A usage invoice is billed to the smallest fraction a balance can
+ * hold, finer than a payment method can charge, so paying one online is refused with
+ * `BILLING_INVOICE_NOT_PAYABLE` and `meta.reason` `usage_invoice`; it is collected from credit grants
+ * and balance automatically, including right after a top-up.
  * @summary Pay an invoice
  */
 export const PayInvoiceParams = zod.strictObject({
@@ -1597,6 +1600,31 @@ export const ListSpendQueryParams = zod.strictObject({
         .optional()
         .describe("Restrict the account-authorized results to these projects. Omit for all projects and account-level records. This filter does not grant access to another billing account."),
 });
+/**
+ * Usage billing by UTC calendar month for owned billing accounts, newest first. Each period combines its statements, the invoices they issued and how those invoices were paid; usage is billed about hourly, so a month holds many statements. Filter by billing_account_id and by period start.
+ * @summary List monthly statements
+ */
+export const listMonthlyStatementsQueryPageDefault = 1;
+export const listMonthlyStatementsQueryPageMax = 2147483647;
+export const listMonthlyStatementsQueryPageSizeDefault = 50;
+export const listMonthlyStatementsQueryPageSizeMax = 200;
+export const ListMonthlyStatementsQueryParams = zod.strictObject({
+    billing_account_id: zod.int().optional(),
+    from: zod.iso.datetime({ offset: true }).optional().describe("Earliest period start, inclusive."),
+    to: zod.iso.datetime({ offset: true }).optional().describe("Latest period start, exclusive."),
+    page: zod
+        .int()
+        .min(1)
+        .max(listMonthlyStatementsQueryPageMax)
+        .default(listMonthlyStatementsQueryPageDefault)
+        .describe("1-based page number. Defaults to 1."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listMonthlyStatementsQueryPageSizeMax)
+        .default(listMonthlyStatementsQueryPageSizeDefault)
+        .describe("Items per page. Defaults to 50; at most 200."),
+});
 /**
  * Paginated consumption statement batches for owned billing accounts, filtered by billing_account_id, open or closed state and period-start interval. A closed batch is not proof that the whole month has finished.
  * @summary List statements

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

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const listMonthlyStatementsParamsPageDefault = 1;
+export declare const listMonthlyStatementsParamsPageMax = 2147483647;
+export declare const listMonthlyStatementsParamsPageSizeDefault = 50;
+export declare const listMonthlyStatementsParamsPageSizeMax = 200;
+export declare const ListMonthlyStatementsParams: zod.ZodObject<{
+    billing_account_id: zod.ZodOptional<zod.ZodInt>;
+    from: zod.ZodOptional<zod.z.ZodISODateTime>;
+    to: zod.ZodOptional<zod.z.ZodISODateTime>;
+    page: zod.ZodDefault<zod.ZodInt>;
+    page_size: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
+export type ListMonthlyStatementsParams = zod.input<typeof ListMonthlyStatementsParams>;
+export type ListMonthlyStatementsParamsOutput = zod.output<typeof ListMonthlyStatementsParams>;

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

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export const listMonthlyStatementsParamsPageDefault = 1;
+export const listMonthlyStatementsParamsPageMax = 2147483647;
+export const listMonthlyStatementsParamsPageSizeDefault = 50;
+export const listMonthlyStatementsParamsPageSizeMax = 200;
+export const ListMonthlyStatementsParams = zod.strictObject({
+    billing_account_id: zod.int().optional(),
+    from: zod.iso.datetime({ offset: true }).optional(),
+    to: zod.iso.datetime({ offset: true }).optional(),
+    page: zod
+        .int()
+        .min(1)
+        .max(listMonthlyStatementsParamsPageMax)
+        .default(listMonthlyStatementsParamsPageDefault),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listMonthlyStatementsParamsPageSizeMax)
+        .default(listMonthlyStatementsParamsPageSizeDefault),
+});