@leaflow/sdk 0.0.0-dev.23.g7fcf334 → 0.0.0-dev.232.g18ca775

package/dist/billing/project/v1/schema.d.ts

@@ -0,0 +1,1443 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/api/v1/projects/{projectId}/billing-account": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get project billing account
+         * @description Returns the billing account's identity, its currency, and how much can still be spent. Cards,
+         *     invoices and transaction history are not included; they belong to the account owner
+         *     and are reached through `/account/v1/`.
+         *
+         *     Returns 404 when the project has no billing account. Resources cannot be created in that
+         *     state.
+         */
+        get: operations["get-project-billing-account"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/spend": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List project spend
+         * @description Covers a closed time range. Both bounds are required: a total without a stated period
+         *     cannot be reconciled against an invoice.
+         *
+         *     Includes usage that has not been invoiced yet.
+         */
+        get: operations["list-project-spend"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/usage-charges": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List project usage charges
+         * @description The individual charges behind the figures in `/spend`. Amounts here sum to the totals
+         *     reported there over the same period.
+         */
+        get: operations["list-project-usage-charges"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/subscriptions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /** List project subscriptions */
+        get: operations["list-project-subscriptions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/subscriptions/{subscriptionId}/auto-renew": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                subscriptionId: components["parameters"]["SubscriptionId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Set project auto renew
+         * @description Automatic renewal draws on the project billing account's balance, which a project member may
+         *     commit. Paying by card requires the account owner and is done from the billing centre.
+         */
+        put: operations["set-project-auto-renew"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/orders": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List project orders
+         * @description An order awaiting payment shows what is outstanding. Paying it is done from the billing
+         *     centre by the account owner.
+         */
+        get: operations["list-project-orders"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/orders/{orderId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                orderId: components["parameters"]["OrderId"];
+            };
+            cookie?: never;
+        };
+        /** Get project order */
+        get: operations["get-project-order"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/active-resources": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List project active resources
+         * @description A resource that is running but does not appear here is not being charged for.
+         */
+        get: operations["list-project-active-resources"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/quotes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Quote for a project
+         * @description Priced in the project billing account's currency, and at any rate negotiated for that account.
+         *     Nothing is reserved and nothing is recorded, so this may be called as often as required.
+         *
+         *     Prices may change between quoting and ordering. An order is charged at the price in
+         *     effect when it is placed, so a quote should be refreshed before a final confirmation is
+         *     shown.
+         *
+         *     A renewal is priced exactly as renewing would charge it: at the agreed amount or the price
+         *     named, with the discounts the account holds, and with tax.
+         *
+         *     Returns 404 when the project has no billing account, or when a subscription to be renewed
+         *     does not belong to this project.
+         */
+        post: operations["create-project-quote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/orders/{orderId}/items": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                orderId: components["parameters"]["OrderId"];
+            };
+            cookie?: never;
+        };
+        /** List project order items */
+        get: operations["list-project-order-items"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/allowances": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List project allowances
+         * @description These belong to the project's billing account and are shared with every other project linked to it,
+         *     so what is left here may be consumed elsewhere.
+         */
+        get: operations["list-project-allowances"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/entitlements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List project entitlements
+         * @description Includes capabilities bought for this project and those the project's billing account holds at
+         *     account level.
+         *
+         *     Where a capability counts uses, `remaining_quantity` states how much is left. Whether
+         *     exceeding it refuses the request or simply continues to be charged for is decided by
+         *     the service that owns the capability.
+         */
+        get: operations["list-project-entitlements"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * @description Whether a fulfilled purchase may end immediately or only after its paid term. Does not grant a refund. When absent, the terms are not configured and termination requires review.
+         * @enum {string}
+         */
+        TerminationPolicy: "immediate" | "period_end";
+        /**
+         * @description Prorated returns the unused value of paid service periods using integer-second duration ratios. Setup fees are excluded. Tax and funds follow the original invoice and payment sources.
+         * @enum {string}
+         */
+        RefundPolicy: "none" | "prorated";
+        /** @description A cancellation request for the original purchase. scheduled_at is the intended time; effective_at is the confirmed end of service. The request alone does not stop metering or issue a refund. */
+        CancellationRequest: {
+            reason?: string;
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            subscription_id: string;
+            /** @enum {string} */
+            status: "requested" | "scheduled" | "releasing" | "failed" | "completed" | "canceled";
+            /** @enum {string} */
+            mode: "immediate" | "period_end";
+            /** Format: date-time */
+            requested_at: string;
+            /** Format: date-time */
+            scheduled_at?: string;
+            /** Format: date-time */
+            effective_at?: string;
+            /** Format: date-time */
+            completed_at?: string;
+            /** Format: date-time */
+            release_started_at?: string;
+            /** Format: date-time */
+            canceled_at?: string;
+            forfeit_remaining_value: boolean;
+            failure_code?: string;
+            failure_reason?: string;
+        };
+        Error: {
+            code?: string;
+            message: string;
+            /**
+             * @description What a given `code` carries alongside the message. The keys depend on the code,
+             *     and a client that does not recognise one ignores it.
+             */
+            meta?: {
+                [key: string]: unknown;
+            };
+            /** Format: int64 */
+            status: number;
+        };
+        Product: {
+            id: components["schemas"]["ProductID"];
+            name: string;
+            description?: string;
+        };
+        /** @description Immutable platform service identifier, such as compute, canopy or assistant. */
+        ProductID: string;
+        /**
+         * @description Identify a price directly, or select a price for a plan. For each resource give its ID or lookup key, never both. Lookup keys require product_id.
+         *
+         *     A line that gives a meter, `dimensions` or `duration_seconds` estimates usage and is
+         *     priced only at a postpaid price. Such a line is refused with HTTP 400
+         *     `BILLING_PURCHASE_INVALID` when `price_type` is `prepaid` or `one_time`, or when the price
+         *     it names is not postpaid; `meta.field` is `price_type`, `price_id` or `price_lookup_key`
+         *     accordingly. When the plan has no postpaid price, the line is returned unpriced with
+         *     `no_price`.
+         */
+        QuoteLine: {
+            price_lookup_key?: string;
+            plan_lookup_key?: string;
+            meter_lookup_key?: string;
+            /** Format: uuid */
+            price_id?: string;
+            product_id?: components["schemas"]["ProductID"];
+            /** Format: uuid */
+            plan_id?: string;
+            /** Format: uuid */
+            meter_id?: string;
+            /**
+             * @description The attributes the price depends on — region, instance type, token class.
+             *
+             *     Required when the price draws its rates from a price list, which is how anything
+             *     sold by region or by machine type is priced. A price that carries a single unit
+             *     amount, or a ladder, has no attributes to give and takes none.
+             *
+             *     Every attribute the meter declares must be present. A combination with no rate
+             *     covering it is refused rather than priced at zero.
+             */
+            dimensions?: {
+                [key: string]: string;
+            };
+            /**
+             * @description Narrows the selection when a plan offers more than one billing type.
+             * @enum {string}
+             */
+            price_type?: "postpaid" | "prepaid" | "one_time";
+            /** @enum {string} */
+            interval?: "none" | "day" | "month" | "year";
+            interval_count?: number;
+            quantity: string;
+            /**
+             * Format: int64
+             * @description For metered items, how long to price for. This allows an estimate such as "about
+             *     this much per month" to be shown before anything exists. The priced quantity is
+             *     `quantity` multiplied by this duration.
+             */
+            duration_seconds?: number;
+        };
+        /**
+         * @description Price renewing a prepaid subscription. Give `price_id`, or `interval` with
+         *     `interval_count`, to renew for another term at the price currently sold for it. Naming
+         *     the current term, or giving neither, renews at the agreed amount.
+         */
+        QuoteRenewal: {
+            /** Format: uuid */
+            subscription_id: string;
+            /** Format: uuid */
+            price_id?: string;
+            /** @enum {string} */
+            interval?: "day" | "month" | "year";
+            interval_count?: number;
+            /**
+             * @description How many consecutive periods to renew for.
+             * @default 1
+             */
+            periods?: number;
+        };
+        /** @description Specify lines for new purchases and renewals for existing subscriptions. The total includes all requested items. */
+        QuoteRequest: {
+            lines?: components["schemas"]["QuoteLine"][];
+            renewals?: components["schemas"]["QuoteRenewal"][];
+        };
+        QuoteLineResult: {
+            /** @description Tax included in the account quote. Absent in public catalogue estimates. */
+            tax_amount?: components["schemas"]["Money"];
+            /** @description Tax already included in the displayed price. */
+            tax_included_amount?: components["schemas"]["Money"];
+            /** @description Which line of the request this answers. */
+            index: number;
+            /**
+             * @description Whether a price was found for this line. Read this before anything else.
+             *
+             *     A single item with no price no longer fails the whole request. A catalogue
+             *     almost always has something not yet priced, and refusing the request would
+             *     leave no way to render a list in which a few entries are simply not on sale.
+             *
+             *     When false, `price_id`, `unit_amount` and `amount` are absent and
+             *     `unpriced_reason` states what is missing.
+             */
+            priced: boolean;
+            /**
+             * @description Why no price was found; `none` while `priced` is true.
+             *
+             *     The last four are told apart because their remedies differ: the price points
+             *     at no price list, the list holds no rate for that meter, that exact combination
+             *     of attributes is not configured, or it is configured but nothing is in effect
+             *     at the moment asked about.
+             * @enum {string}
+             */
+            unpriced_reason?: "none" | "no_price" | "no_rate_card" | "no_meter" | "no_dimensions" | "no_effective_rule";
+            /**
+             * Format: uuid
+             * @description The price selected. Returned whenever `priced` is true, including when the
+             *     request identified the item indirectly, so that the choice can be confirmed.
+             */
+            price_id?: string;
+            plan_name?: string;
+            unit_amount?: components["schemas"]["Money"];
+            /**
+             * @description The quantity actually priced. When `duration_seconds` is given, it is the requested
+             *     `quantity` multiplied by that duration.
+             */
+            quantity?: string;
+            /** @description Not rounded. Round only for display. */
+            amount?: components["schemas"]["Money"];
+            currency: string;
+        };
+        /**
+         * @description What renewing would charge. Renewing the same subscription for the same term and number
+         *     of periods charges exactly `total`, unless prices or the discounts the account holds
+         *     change in between.
+         */
+        QuoteRenewalResult: {
+            /** @description Which renewal of the request this answers. */
+            index: number;
+            /** Format: uuid */
+            subscription_id: string;
+            /**
+             * Format: uuid
+             * @description The price the renewal is charged under.
+             */
+            price_id: string;
+            /** @enum {string} */
+            interval: "day" | "month" | "year";
+            interval_count: number;
+            periods: number;
+            /**
+             * @description The price of the periods before the discounts the account holds. A discount the
+             *     subscription already carries is reflected here. Contains tax only where the price
+             *     itself includes it.
+             */
+            amount: components["schemas"]["Money"];
+            /** @description The reduction from a discount the account holds. */
+            discount_amount: components["schemas"]["Money"];
+            /** @description Tax on the discounted amount. */
+            tax_amount: components["schemas"]["Money"];
+            /** @description The part of `tax_amount` already contained in `amount`. */
+            tax_included_amount: components["schemas"]["Money"];
+            /**
+             * @description What renewing would charge: `amount` less `discount_amount`, plus `tax_amount`, less
+             *     `tax_included_amount`.
+             */
+            total: components["schemas"]["Money"];
+        };
+        Quote: {
+            lines?: components["schemas"]["QuoteLineResult"][];
+            renewals?: components["schemas"]["QuoteRenewalResult"][];
+            /**
+             * @description What would be owed in total, renewals included. Amounts to be returned are not netted
+             *     off it.
+             *
+             *     Null when any line could not be priced. What would be owed is not knowable then, and a
+             *     total that silently left the unpriced lines out would read as a smaller bill rather than
+             *     an incomplete one — the per-line `priced` flag is easy to skip, a missing total is not.
+             */
+            total?: components["schemas"]["Money"] | null;
+            currency: string;
+        };
+        /**
+         * @description A narrow view of the project's billing account, restricted to what a project member needs in order
+         *     to know whether the project's resources will keep running.
+         */
+        ProjectBillingAccount: {
+            /**
+             * Format: int64
+             * @description Identifies the billing account. Use it to link into the billing centre.
+             */
+            billing_account_id: number;
+            name: string;
+            /**
+             * @description Everything this project is charged is in this currency, and it cannot change while
+             *     the account exists.
+             */
+            currency: string;
+            /**
+             * @description What remains to be spent. It already accounts for this month's uninvoiced usage, so
+             *     it is what will be available at checkout rather than the balance shown in the
+             *     billing centre. It goes negative when usage has exceeded the balance.
+             */
+            spendable_amount: components["schemas"]["Money"];
+            /**
+             * @description `active` — nothing is owed. `past_due` — the account owes money and resources are
+             *     still running. `suspended` — resources have been stopped for non-payment.
+             * @enum {string}
+             */
+            status: "active" | "past_due" | "suspended";
+            /**
+             * Format: date-time
+             * @description When this project's resources will be stopped unless the account is topped up.
+             *     Absent while `status` is `active`.
+             */
+            suspends_at?: string | null;
+        };
+        AccountIdentity: {
+            /** Format: int64 */
+            id: number;
+            name: string;
+            currency: string;
+        };
+        /**
+         * @description `refunded` means the invoice was paid and has since been refunded in full; a partial refund
+         *     leaves it `paid`, with the refunded part in `amount_refunded`.
+         *
+         *     `void` means the invoice will not be paid and holds no money: nothing was paid, or its order
+         *     failed or was canceled and everything paid toward it has been returned.
+         * @enum {string}
+         */
+        InvoiceStatus: "draft" | "open" | "paid" | "refunded" | "void" | "uncollectible";
+        UsageCharge: {
+            /** Format: uuid */
+            subscription_id?: string;
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            project_id?: string;
+            /**
+             * @description The project and its current name, for display. Absent when the project no longer exists or its
+             *     details cannot be read at the moment; `project_id` still identifies it.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
+            product: components["schemas"]["Product"];
+            /** @description Which resource this was charged for. Empty for charges not tied to one. */
+            resource_id?: string;
+            meter: components["schemas"]["ObjectIdentity"];
+            unit?: string;
+            /** @description The attributes the rate was chosen by, such as region and machine type. */
+            dimensions?: {
+                [key: string]: string;
+            };
+            /** Format: date-time */
+            window_start: string;
+            /**
+             * Format: date-time
+             * @description Exclusive.
+             */
+            window_end: string;
+            /** @description How much was used, before any included allowance. */
+            gross_quantity?: string;
+            /** @description How much of that was covered by an allowance. */
+            deducted_quantity?: string;
+            /** @description What was charged for — the gross quantity less the part covered. */
+            quantity: string;
+            unit_amount?: components["schemas"]["Money"];
+            amount?: components["schemas"]["Money"];
+            currency: string;
+            /**
+             * Format: uuid
+             * @description Absent until the period is invoiced.
+             */
+            invoice_id?: string | null;
+        };
+        UsageChargeList: {
+            items: components["schemas"]["UsageCharge"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        SpendRow: {
+            product?: components["schemas"]["Product"];
+            /** Format: uuid */
+            plan_id?: string;
+            plan_name?: string;
+            /** @description Present only when grouped by resource. */
+            resource_id?: string;
+            amount: components["schemas"]["Money"];
+            currency: string;
+        };
+        SpendRowList: {
+            items: components["schemas"]["SpendRow"][];
+            /** @description The sum over the whole period, not only the page returned. */
+            total: components["schemas"]["Money"];
+            currency: string;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        SubscriptionList: {
+            items: components["schemas"]["Subscription"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        /** @description An independently billed purchase. Fixed renewals use the agreed recurring_amount and interval; already paid periods retain their original value. Technical state belongs to the owning service. */
+        Subscription: {
+            currency: string;
+            /** @enum {string} */
+            billing_type: "postpaid" | "prepaid" | "one_time";
+            /** @enum {string} */
+            interval: "none" | "day" | "month" | "year";
+            interval_count?: number;
+            /** @description Whole-subscription prepaid renewal amount, after continuing discounts and before tax. Absent for other billing types. */
+            recurring_amount?: string;
+            termination_policy?: components["schemas"]["TerminationPolicy"];
+            refund_policy?: components["schemas"]["RefundPolicy"];
+            /** Format: uuid */
+            order_item_id?: string;
+            /** Format: uuid */
+            replaces_subscription_id?: string;
+            /** Format: uuid */
+            coupon_id?: string;
+            coupon?: components["schemas"]["ObjectIdentity"];
+            discounted_renewals_remaining?: number;
+            suspend_reason?: string;
+            /** Format: date-time */
+            billing_cycle_anchor?: string;
+            cancellation_request?: components["schemas"]["CancellationRequest"];
+            /**
+             * @description How the purchase, or the latest renewal paid with a saved card, was paid. Automatic renewal
+             *     tries this card after the account's balance and credits, and the account's default card after
+             *     that.
+             */
+            paid_with?: components["schemas"]["PaidWith"];
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: uuid */
+            id: string;
+            /**
+             * Format: int64
+             * @description The billing account that made the purchase. Renewals of a project subscription are charged to the project's current billing account.
+             */
+            billing_account_id: number;
+            account: components["schemas"]["AccountIdentity"];
+            product_id: components["schemas"]["ProductID"];
+            /**
+             * Format: uuid
+             * @description Which project this is for. Absent when it was bought at account level, such as a
+             *     membership, which belongs to no single project.
+             */
+            project_id?: string | null;
+            /**
+             * @description The project and its current name, for display. Absent for a purchase at account level,
+             *     and when the project no longer exists or its details cannot be read at the moment;
+             *     `project_id` still identifies it then.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
+            product: components["schemas"]["Product"];
+            /** Format: uuid */
+            plan_id: string;
+            plan_name: string;
+            /** Format: uuid */
+            price_id: string;
+            quantity: string;
+            /**
+             * Format: date-time
+             * @description Present for prepaid items. Absent for metered ones, which have no end date.
+             */
+            paid_until?: string | null;
+            auto_renew: boolean;
+            /** @enum {string} */
+            status: "pending" | "active" | "suspended" | "canceled" | "terminated";
+            /** Format: date-time */
+            started_at?: string | null;
+            /** Format: date-time */
+            ended_at?: string | null;
+        };
+        AutoRenewSet: {
+            auto_renew: boolean;
+        };
+        /** @description A resource currently accruing charges by the second. */
+        ActiveResource: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            ended_at?: string;
+            /** Format: date-time */
+            suspended_at?: string;
+            /** Format: date-time */
+            state_changed_at?: string;
+            /**
+             * Format: uuid
+             * @description The postpaid subscription charged for this metering record, including shared services.
+             */
+            subscription_id: string;
+            resource_id: string;
+            product: components["schemas"]["Product"];
+            /** @description What it is, as its own service names it. */
+            resource_type?: string;
+            meter: components["schemas"]["ObjectIdentity"];
+            unit?: string;
+            /** @description How much is held — cores, MiB, cards. Not how much has been used. */
+            quantity: string;
+            dimensions?: {
+                [key: string]: string;
+            };
+            /** @enum {string} */
+            status: "active" | "suspended" | "closing" | "completed";
+            /** Format: date-time */
+            started_at: string;
+            /**
+             * Format: date-time
+             * @description Usage has been generated up to this boundary; it does not imply invoicing or payment.
+             */
+            metered_until: string;
+        };
+        ActiveResourceList: {
+            items: components["schemas"]["ActiveResource"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        /**
+         * @description Follows the items. `pending` is not yet accepted and may be paid or unpaid. `active` is
+         *     accepted with items still being set up. `completed` means every item was set up.
+         *     `partially_completed` means some items were set up and the others failed and were
+         *     refunded to their original payment sources. `failed` means every item failed and the
+         *     whole order was refunded. `canceled` means the order was withdrawn before payment and
+         *     nothing was charged.
+         * @enum {string}
+         */
+        OrderStatus: "pending" | "active" | "completed" | "partially_completed" | "failed" | "canceled";
+        /**
+         * @description `pending` is waiting to be set up. `completed` was confirmed by the service.
+         *     `failed` was not set up and its amount was refunded to the original payment sources.
+         *     `canceled` was withdrawn with its unpaid order. A completed item is ended by canceling
+         *     its subscription.
+         * @enum {string}
+         */
+        OrderItemStatus: "pending" | "completed" | "failed" | "canceled";
+        Order: {
+            /** Format: uuid */
+            coupon_id?: string;
+            coupon?: components["schemas"]["ObjectIdentity"];
+            /** Format: uuid */
+            promotion_code_id?: string;
+            /** @description Code text frozen when this order applied the coupon. */
+            promotion_code?: string;
+            invoice?: components["schemas"]["InvoiceSummary"];
+            /** @description How the order was paid. Absent until it is paid. */
+            paid_with?: components["schemas"]["PaidWith"];
+            account?: components["schemas"]["AccountIdentity"];
+            cancel_reason?: string;
+            /** Format: date-time */
+            change_effective_at?: string;
+            /** Format: uuid */
+            id: string;
+            /**
+             * Format: uuid
+             * @description Which project it was bought for. Absent for a purchase made at account level, such
+             *     as a membership.
+             */
+            project_id?: string | null;
+            /**
+             * @description The project and its current name, for display. Absent for a purchase at account level,
+             *     and when the project no longer exists or its details cannot be read at the moment;
+             *     `project_id` still identifies it then.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
+            /**
+             * Format: int64
+             * @description The billing account the order was placed with. It does not change when the project is later
+             *     linked to another billing account. While this account is suspended or closed the order cannot
+             *     be accepted, and a change scheduled for the end of a period is not invoiced and is called off
+             *     when the current period ends; such requests fail with BILLING_ACCOUNT_UNAVAILABLE.
+             */
+            billing_account_id?: number;
+            currency: string;
+            /**
+             * @description `adopt` brings a resource that already existed under billing. It charges nothing at
+             *     the time and starts billing from the moment agreed.
+             * @enum {string}
+             */
+            type: "purchase" | "renew" | "change" | "adopt";
+            status: components["schemas"]["OrderStatus"];
+            /**
+             * @description When a plan change takes effect. `none` on anything that is not a change.
+             *
+             *     `period_end` orders stay pending until the first period at the new price is paid. That period
+             *     is invoiced shortly before the current paid period ends and starts when it ends; if the
+             *     invoice is still unpaid by then, the order is canceled and the subscription renews or ends as
+             *     usual. Renewing in the meantime moves all of this along with it.
+             * @enum {string}
+             */
+            change_effective?: "none" | "immediate" | "period_end";
+            /**
+             * Format: date-time
+             * @description Acceptance deadline. Only pending orders expire automatically.
+             */
+            expires_at?: string | null;
+            /** Format: date-time */
+            created_at: string;
+            /**
+             * @description What was bought. Present on a single order and on every order in a list, so a list
+             *     can be rendered without a further request per row.
+             */
+            items: components["schemas"]["OrderItem"][];
+        };
+        OrderList: {
+            items: components["schemas"]["Order"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        /**
+         * @description How it was paid, as recorded at the time. It is kept as it was: removing the card afterwards
+         *     does not change it, and `payment_method_id` may then name a card that no longer exists.
+         */
+        PaidWith: {
+            /**
+             * @description `balance` when the account's balance and credits covered it in full. Otherwise the method used
+             *     with the gateway, such as `card`.
+             */
+            method_type: string;
+            /** @description The gateway that collected it. Absent when `method_type` is `balance`. */
+            payment_gateway?: string;
+            /**
+             * Format: uuid
+             * @description The saved payment method that was charged, when one was.
+             */
+            payment_method_id?: string;
+            brand?: string;
+            last4?: string;
+        };
+        /** @description Frozen purchase terms. Monetary fields come from related invoice-line snapshots and are absent when there is no immediate invoice. Later catalog changes do not reprice this line. */
+        OrderItem: {
+            position?: number;
+            configuration?: {
+                [key: string]: unknown;
+            };
+            /** Format: uuid */
+            subscription_id?: string;
+            /** @enum {string} */
+            interval: "none" | "day" | "month" | "year";
+            interval_count?: number;
+            termination_policy?: components["schemas"]["TerminationPolicy"];
+            refund_policy?: components["schemas"]["RefundPolicy"];
+            completes_on_payment: boolean;
+            recurring_amount?: string;
+            setup_amount?: string;
+            /**
+             * @description The payment timing of the selected price.
+             * @enum {string}
+             */
+            billing_type: "postpaid" | "prepaid" | "one_time";
+            /** @description Total tax after discounts, including any tax already included in the price. */
+            tax_amount?: string;
+            /** @description The part of tax_amount already included in gross_amount; it is not charged again. */
+            tax_included_amount?: string;
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            order_id?: string;
+            /** Format: uuid */
+            price_id: string;
+            /** @description Which service this line belongs to. */
+            product_id?: components["schemas"]["ProductID"];
+            product?: components["schemas"]["Product"];
+            /**
+             * Format: uuid
+             * @description Which plan was bought.
+             */
+            plan_id: string;
+            /**
+             * @description What it was called when bought. It does not follow later catalogue renames and is
+             *     not translated.
+             */
+            plan_name: string;
+            quantity: string;
+            unit_amount?: components["schemas"]["Money"];
+            gross_amount?: components["schemas"]["Money"];
+            discount_amount?: components["schemas"]["Money"];
+            amount?: components["schemas"]["Money"];
+            currency: string;
+            /** Format: date-time */
+            period_start?: string | null;
+            /** Format: date-time */
+            period_end?: string | null;
+            status: components["schemas"]["OrderItemStatus"];
+        };
+        OrderItemList: {
+            items: components["schemas"]["OrderItem"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        Allowance: {
+            /** @description Optional issuance key, unique within this billing account. */
+            idempotency_key?: string;
+            /** Format: uuid */
+            subscription_id?: string;
+            /** Format: uuid */
+            id: string;
+            /** Format: int64 */
+            billing_account_id?: number;
+            product: components["schemas"]["Product"];
+            meter: components["schemas"]["ObjectIdentity"];
+            /** @description The unit it is counted in, such as `MiB`. */
+            unit?: string;
+            /**
+             * @description `included` came with a recurring purchase and ends with its subscription, `promotional` was
+             *     granted.
+             * @enum {string}
+             */
+            source_type: "included" | "promotional";
+            name: string;
+            /** @description How much was granted. */
+            quantity: string;
+            /** @description How much is left. */
+            remaining_quantity: string;
+            /**
+             * @description Lower values are consumed first. At equal priority, earlier expiry and then earlier issuance take
+             *     precedence.
+             */
+            priority?: number;
+            /** @enum {string} */
+            status: "active" | "depleted" | "expired" | "voided";
+            /** Format: date-time */
+            valid_from: string;
+            /**
+             * Format: date-time
+             * @description When it lapses. Anything unused at that point is lost; it is not refunded and does
+             *     not carry over. Absent when it does not expire on its own.
+             */
+            valid_until?: string | null;
+        };
+        AllowanceList: {
+            items: components["schemas"]["Allowance"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        Entitlement: {
+            product: components["schemas"]["Product"];
+            feature: components["schemas"]["ObjectIdentity"];
+            name?: string;
+            enabled: boolean;
+            /**
+             * Format: date-time
+             * @description When the subscription providing it ends. Absent for a metered subscription, which
+             *     has no end date.
+             */
+            expires_at?: string | null;
+        };
+        EntitlementList: {
+            items: components["schemas"]["Entitlement"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        /** @description Purchase-related invoice amounts, without account contact details or payment methods. Absent on an order with no immediate invoice. */
+        InvoiceSummary: {
+            /** Format: uuid */
+            id: string;
+            number?: string;
+            currency: string;
+            status: components["schemas"]["InvoiceStatus"];
+            /**
+             * @description Sum of the line amounts before discounts. Where prices include tax, the tax contained in
+             *     each line's discounted amount is taken out here, so that total = subtotal -
+             *     discount_amount + tax_amount always holds.
+             */
+            subtotal: string;
+            /** @description Sum of the line discounts, taken off before tax. */
+            discount_amount: string;
+            tax_amount: string;
+            total: string;
+            amount_paid: string;
+            amount_refunded: string;
+            /** Format: date-time */
+            due_at?: string;
+        };
+        /** @description A catalog object inlined for display. */
+        ObjectIdentity: {
+            lookup_key?: string;
+            /** Format: uuid */
+            id: string;
+            name: string;
+        };
+        /**
+         * @description A decimal string, in the currency stated alongside it.
+         *
+         *     **The currency is not part of this type.** It is carried by a `currency` field next to the
+         *     amount, or by the account the amount belongs to. Reading an amount without that field is
+         *     reading a number with no unit.
+         *
+         *     It is a string rather than a JSON number because a JSON number is a float in most parsers,
+         *     and a float loses precision on the first arithmetic. Nothing on this platform puts an amount
+         *     through a float.
+         * @example 10.2500000000
+         */
+        Money: string;
+        /**
+         * @description Which object this is, together with what a person currently calls it.
+         *
+         *     The name is for display. It is chosen by whoever owns the object, it changes, it is not unique
+         *     between objects, and it may be empty when nobody has named it yet — so it must not be used to
+         *     address, match or deduplicate anything. Addressing is by id.
+         *
+         *     This differs from an identity carrying a lookup key: a lookup key is written once by an operator,
+         *     is unique, and can be used to fetch the object. A name cannot.
+         */
+        NamedIdentity: {
+            /** Format: uuid */
+            id: string;
+            name: string;
+        };
+    };
+    responses: {
+        /** @description Error */
+        Error: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+    };
+    parameters: {
+        /** @description 1-based page number; the first page when omitted. */
+        Page: number;
+        /** @description How many per page, 100 at most. */
+        PageSize: number;
+        From: string;
+        /** @description Exclusive. */
+        To: string;
+        ProjectId: string;
+        OrderId: string;
+        SubscriptionId: string;
+        FromRequired: string;
+        /** @description Exclusive. One month is `[2026-09-01, 2026-10-01)`. */
+        ToRequired: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    "get-project-billing-account": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectBillingAccount"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-spend": {
+        parameters: {
+            query: {
+                from: components["parameters"]["FromRequired"];
+                /** @description Exclusive. One month is `[2026-09-01, 2026-10-01)`. */
+                to: components["parameters"]["ToRequired"];
+                /**
+                 * @description `resource` groups by the resource each charge names. Items billed under their own
+                 *     identifier — a disk, a public address — appear as their own rows rather than under
+                 *     the machine they are attached to, since the relationship between them is known to
+                 *     the owning service and not here.
+                 */
+                group_by?: "product" | "plan" | "resource";
+                /** @description Filter by the fixed platform service ID. */
+                product_id?: components["schemas"]["ProductID"];
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SpendRowList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-usage-charges": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                resource_id?: string;
+                product_id?: components["schemas"]["ProductID"];
+                /** @description Filter by the meter UUID. */
+                meter_id?: string;
+                from?: components["parameters"]["From"];
+                /** @description Exclusive. */
+                to?: components["parameters"]["To"];
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UsageChargeList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-subscriptions": {
+        parameters: {
+            query?: {
+                expiring_before?: string;
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SubscriptionList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "set-project-auto-renew": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                subscriptionId: components["parameters"]["SubscriptionId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AutoRenewSet"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Subscription"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-orders": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                status?: components["schemas"]["OrderStatus"];
+                from?: components["parameters"]["From"];
+                /** @description Exclusive. */
+                to?: components["parameters"]["To"];
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrderList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "get-project-order": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                orderId: components["parameters"]["OrderId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Order"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-active-resources": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                resource_id?: string;
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ActiveResourceList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "create-project-quote": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["QuoteRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Quote"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-order-items": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                orderId: components["parameters"]["OrderId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrderItemList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-allowances": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                meter_id?: string;
+                product_id?: components["schemas"]["ProductID"];
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllowanceList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-entitlements": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                product_id?: components["schemas"]["ProductID"];
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EntitlementList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+}