@leaflow/sdk 0.0.0-dev.232.g18ca775 → 0.0.0-dev.234.gce19274

package/dist/billing/account/v1/index.d.ts

@@ -105,6 +105,22 @@ export type CreateCancellationRequestBody = NonNullable<operations["create-cance
 export type GetCancellationRequestResult = operations["get-cancellation-request"]["responses"][200]["content"]["application/json"];
 /** The success response body of `POST /account/v1/cancellation-requests/{cancellationRequestId}/cancel`. */
 export type CancelCancellationRequestResult = operations["cancel-cancellation-request"]["responses"][200]["content"]["application/json"];
+/** The success response body of `POST /account/v1/cancellations/preview`. */
+export type CreateCancellationPreviewResult = operations["create-cancellation-preview"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /account/v1/cancellations/preview`. */
+export type CreateCancellationPreviewBody = NonNullable<operations["create-cancellation-preview"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `POST /account/v1/cancellations`. */
+export type CreateCancellationResult = operations["create-cancellation"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /account/v1/cancellations`. */
+export type CreateCancellationBody = NonNullable<operations["create-cancellation"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `GET /account/v1/cancellations`. */
+export type ListCancellationsResult = operations["list-cancellations"]["responses"][200]["content"]["application/json"];
+/** The query parameters of `GET /account/v1/cancellations`. */
+export type ListCancellationsQuery = operations["list-cancellations"]["parameters"]["query"];
+/** The success response body of `GET /account/v1/cancellations/{cancellationId}`. */
+export type GetCancellationResult = operations["get-cancellation"]["responses"][200]["content"]["application/json"];
+/** The success response body of `POST /account/v1/cancellations/{cancellationId}/withdraw`. */
+export type WithdrawCancellationResult = operations["withdraw-cancellation"]["responses"][200]["content"]["application/json"];
 /** The success response body of `GET /account/v1/subscriptions/{subscriptionId}/renewal-prices`. */
 export type ListRenewalPricesResult = operations["list-renewal-prices"]["responses"][200]["content"]["application/json"];
 /** The success response body of `POST /account/v1/subscriptions/{subscriptionId}/renew`. */

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

@@ -694,7 +694,10 @@ export interface paths {
         };
         /**
          * Preview cancellation
+         * @deprecated
          * @description Reads confirmed terms and paid-period value without recording a request or locking a refund amount.
+         *
+         *     Use create-cancellation-preview, which previews the subscriptions released together.
          */
         get: operations["preview-cancellation"];
         put?: never;
@@ -718,7 +721,10 @@ export interface paths {
         put?: never;
         /**
          * Request subscription cancellation
+         * @deprecated
          * @description Ends the whole subscription under confirmed terms. The request does not itself stop service; actual end is confirmed by the owning service. Refund processing is separate.
+         *
+         *     Use create-cancellation, which ends the subscriptions released together and checks the refund.
          */
         post: operations["create-cancellation-request"];
         delete?: never;
@@ -736,7 +742,11 @@ export interface paths {
             };
             cookie?: never;
         };
-        /** Get cancellation request */
+        /**
+         * Get cancellation request
+         * @deprecated
+         * @description Use get-cancellation.
+         */
         get: operations["get-cancellation-request"];
         put?: never;
         post?: never;
@@ -759,7 +769,10 @@ export interface paths {
         put?: never;
         /**
          * Cancel a cancellation request
+         * @deprecated
          * @description Allowed only before release starts. Does not resume a previously suspended subscription.
+         *
+         *     Use withdraw-cancellation, which withdraws the whole cancellation.
          */
         post: operations["cancel-cancellation-request"];
         delete?: never;
@@ -768,6 +781,136 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/cancellations/preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Preview a cancellation
+         * @description What canceling these subscriptions together would return, computed now under the refund terms
+         *     agreed when each was bought. This request does not create a resource: nothing is recorded or
+         *     reserved.
+         *
+         *     It is refused with the same errors as creating the cancellation, except that the amount is not
+         *     checked. Give the returned `proration_date` and `refundable_amount` when creating it.
+         */
+        post: operations["create-cancellation-preview"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/cancellations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List cancellations
+         * @description Newest first. Filter by `subscription_id` and `status=open` to find the cancellation now under way for a subscription.
+         */
+        get: operations["list-cancellations"];
+        put?: never;
+        /**
+         * Cancel subscriptions
+         * @description Ends a set of subscriptions of one service together, at one time. Deleting a resource that a
+         *     subscription pays for is an `immediate` cancellation of every subscription released with it,
+         *     such as a server with the disks deleted along with it, or an address with its bandwidth.
+         *
+         *     The service that provides the resources releases them: at once for `immediate`, or at
+         *     `scheduled_at`, the end of the paid term, for `period_end`. When release is confirmed, the
+         *     unused value is returned the way it was paid, under the refund terms agreed when each
+         *     subscription was bought. For `immediate` the refund is computed as of `proration_date`, so the
+         *     amount confirmed here is the amount returned: prepaid service used while the resources are
+         *     being released is not deducted from it. Usage of a postpaid subscription is charged until its
+         *     resources are released, as usual.
+         *
+         *     `mode` must be allowed for every subscription. Postpaid and one-time subscriptions end only
+         *     `immediate`. A prepaid subscription ends `period_end` while its paid term lasts, and
+         *     `immediate` unless its termination terms allow only the end of the paid term and that term has
+         *     not ended yet. For `period_end` the paid terms of all the subscriptions must end at the same
+         *     time.
+         *
+         *     Refused with:
+         *     - 400 `BILLING_CANCELLATION_INVALID` when `subscription_ids` or `proration_date` is not
+         *       acceptable (`meta.field`), or the subscriptions do not all belong to one service, project,
+         *       account and currency;
+         *     - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
+         *     - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed for a subscription, and
+         *       `BILLING_CANCELLATION_TERMS_UNSET` when a prepaid subscription has no termination terms;
+         *       both carry `meta.subscription_id`;
+         *     - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at
+         *       different times;
+         *     - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
+         *       (`meta.cancellation_id`) or reclaimed (`meta.job_id`);
+         *     - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for a renewal of one of them
+         *       is in progress;
+         *     - 422 `BILLING_CANCELLATION_UNSUPPORTED` when the service cannot yet be canceled here;
+         *     - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund is no longer
+         *       `expected_refundable_amount`; preview again.
+         *
+         *     Sending the same request again, for the same subscriptions, mode and amount while that
+         *     cancellation is still open, returns it with 200 rather than creating another. Renewal orders
+         *     still waiting for payment are canceled along with it.
+         */
+        post: operations["create-cancellation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/cancellations/{cancellationId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        /** Get a cancellation */
+        get: operations["get-cancellation"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/cancellations/{cancellationId}/withdraw": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Withdraw a cancellation
+         * @description Withdraws the whole cancellation while none of its resources has begun to be released; the
+         *     subscriptions continue as before. After that it is refused with 409
+         *     `BILLING_CANCELLATION_CONFLICT`. Withdrawing one that is already withdrawn returns it unchanged.
+         */
+        post: operations["withdraw-cancellation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/subscriptions/{subscriptionId}/renewal-prices": {
         parameters: {
             query?: never;
@@ -1053,6 +1196,157 @@ export interface components {
          * @enum {string}
          */
         RefundPolicy: "none" | "prorated";
+        CancellationPreviewRequest: {
+            /** @description The subscriptions to end together, all of one service. Every subscription released with a resource must be included. */
+            subscription_ids: string[];
+            mode: components["schemas"]["TerminationPolicy"];
+        };
+        /**
+         * @description What the cancellation would return, subscription by subscription and in total, as of now.
+         *
+         *     - `unused_amount`: before tax, the value of the paid service still unused, whatever the refund
+         *       terms say.
+         *     - `refundable_amount`: what is returned the way it was paid, including the tax paid on it;
+         *       `refund_amount` plus `credit_amount`.
+         *     - `refund_amount`: the part returned to the balance or to the payment method.
+         *     - `credit_amount`: the part restored to the credit grants that paid.
+         *     - `tax_amount`: the tax included in `refundable_amount`.
+         *     - `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.
+         *
+         *     Postpaid and one-time subscriptions show zero; usage until release is charged as usual.
+         */
+        CancellationRefundPreview: {
+            mode: components["schemas"]["TerminationPolicy"];
+            /**
+             * Format: date-time
+             * @description For `period_end`, when release begins, the end of the paid terms.
+             */
+            scheduled_at?: string;
+            /**
+             * Format: date-time
+             * @description For `immediate`, the second the refund is computed as of. Give it when creating the cancellation.
+             */
+            proration_date?: string;
+            currency: string;
+            unused_amount: components["schemas"]["Money"];
+            refundable_amount: components["schemas"]["Money"];
+            refund_amount: components["schemas"]["Money"];
+            credit_amount: components["schemas"]["Money"];
+            tax_amount: components["schemas"]["Money"];
+            forfeited_amount: components["schemas"]["Money"];
+            items: components["schemas"]["CancellationRefundPreviewItem"][];
+        };
+        /** @description One subscription of the preview. The amounts mean what they mean in the preview. */
+        CancellationRefundPreviewItem: {
+            /** Format: uuid */
+            subscription_id: string;
+            /** Format: uuid */
+            plan_id: string;
+            plan_name: string;
+            /** @description The project and its current name, for display. Absent for a purchase at account level, and when the project details cannot be read at the moment. */
+            project?: components["schemas"]["NamedIdentity"] | null;
+            /** @enum {string} */
+            billing_type: "postpaid" | "prepaid" | "one_time";
+            unused_amount: components["schemas"]["Money"];
+            refundable_amount: components["schemas"]["Money"];
+            refund_amount: components["schemas"]["Money"];
+            credit_amount: components["schemas"]["Money"];
+            tax_amount: components["schemas"]["Money"];
+            forfeited_amount: components["schemas"]["Money"];
+        };
+        CancellationCreate: {
+            /** @description As in the preview. */
+            subscription_ids: string[];
+            mode: components["schemas"]["TerminationPolicy"];
+            /**
+             * Format: date-time
+             * @description For `immediate`, the `proration_date` of the preview: a whole second, not in the future and
+             *     at most ten minutes old. The refund is computed as of it. Now when omitted.
+             */
+            proration_date?: string;
+            /** @description The `refundable_amount` of the preview. The cancellation is refused when the refund differs. */
+            expected_refundable_amount: string;
+            /** @description A note from the account holder. It is kept with the cancellation and not shown elsewhere. */
+            reason?: string;
+        };
+        /**
+         * @description One cancellation of a set of subscriptions of one service, released together at one time.
+         *
+         *     - `requested`: `immediate`, release has not begun.
+         *     - `scheduled`: `period_end`, waiting for `scheduled_at`.
+         *     - `releasing`: release has begun; it can no longer be withdrawn.
+         *     - `completed`: every subscription has ended and its refund has been made.
+         *     - `canceled`: withdrawn before release began; the subscriptions continue.
+         *     - `failed`: the service could not carry it out, for the reason in `failure_code`; the
+         *       subscriptions continue and can be canceled again.
+         */
+        Cancellation: {
+            /** Format: uuid */
+            id: string;
+            /** @enum {string} */
+            status: "requested" | "scheduled" | "releasing" | "completed" | "canceled" | "failed";
+            mode: components["schemas"]["TerminationPolicy"];
+            /** Format: date-time */
+            scheduled_at?: string;
+            /**
+             * Format: date-time
+             * @description For `immediate`, the second the refund is computed as of.
+             */
+            proration_date?: string;
+            /**
+             * @description Who asked for it. `project_deletion` means the project was deleted.
+             * @enum {string}
+             */
+            origin: "customer" | "operator" | "project_deletion";
+            currency: string;
+            /** @description The refund confirmed when it was created. Absent when the platform created it. */
+            expected_refundable_amount?: components["schemas"]["Money"];
+            /**
+             * @description Present with `failed`. A code of the service that provides the resources, such as a disk
+             *     that can only be released with its server. Clients map it to their own wording.
+             */
+            failure_code?: string;
+            /** Format: date-time */
+            requested_at: string;
+            /** Format: date-time */
+            completed_at?: string;
+            /** Format: date-time */
+            canceled_at?: string;
+            items: components["schemas"]["CancellationItem"][];
+        };
+        /** @description One subscription of the cancellation. */
+        CancellationItem: {
+            /**
+             * Format: uuid
+             * @description The cancellation request of this subscription, the same as `Subscription.cancellation_request.id`.
+             */
+            id: string;
+            /** Format: uuid */
+            subscription_id: string;
+            /** Format: uuid */
+            plan_id: string;
+            plan_name: string;
+            /** @enum {string} */
+            status: "requested" | "scheduled" | "releasing" | "completed" | "canceled" | "failed";
+            /** Format: date-time */
+            release_started_at?: string;
+            /**
+             * Format: date-time
+             * @description When the service ended, as confirmed by the service that provides it.
+             */
+            effective_at?: string;
+            /** @description Present with `completed`. The part of the refund returned to the account balance. */
+            balance_amount?: components["schemas"]["Money"];
+            /** @description Present with `completed`. The part restored to the credit grants that paid. */
+            credit_amount?: components["schemas"]["Money"];
+            /** @description Present with `completed`. The part returned to the payment method it was paid with. */
+            gateway_amount?: components["schemas"]["Money"];
+        };
+        CancellationList: {
+            items: components["schemas"]["Cancellation"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
         CancellationPreview: {
             /** Format: uuid */
             subscription_id: string;
@@ -1071,6 +1365,11 @@ export interface components {
         /** @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
+             * @description The cancellation this request belongs to, with the other subscriptions released together.
+             */
+            cancellation_id?: string;
             /** Format: uuid */
             id: string;
             /** Format: uuid */
@@ -1950,7 +2249,7 @@ export interface components {
          *     - `provisioning_failed`: the purchase could not be delivered.
          *     - `order_expired`: the order expired after part of it had been paid.
          *     - `order_canceled`: the account holder canceled the order after part of it had been paid.
-         *     - `change_canceled`: a scheduled change was withdrawn after it had been paid.
+         *     - `change_canceled`: a scheduled change was withdrawn after part of it had been paid.
          *     - `change_expired`: a scheduled change could not take effect before its time passed.
          *     - `subscription_canceled`: the subscription was canceled and its unused value returned under
          *       its refund terms.
@@ -2677,6 +2976,7 @@ export interface components {
         ProjectId: string;
         InvoiceId: string;
         OrderId: string;
+        CancellationId: string;
         CancellationRequestId: string;
         SubscriptionId: string;
         PaymentMethodId: string;
@@ -3678,6 +3978,143 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
+    "create-cancellation-preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CancellationPreviewRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CancellationRefundPreview"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-cancellations": {
+        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 Restrict to one of your accounts. All of them when omitted. */
+                billing_account_id?: components["parameters"]["AccountIdQuery"];
+                /** @description Only cancellations that include this subscription. */
+                subscription_id?: string;
+                /** @description Only cancellations in this status. `open` means requested, scheduled or releasing. */
+                status?: "open" | "requested" | "scheduled" | "releasing" | "completed" | "canceled" | "failed";
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CancellationList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "create-cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CancellationCreate"];
+            };
+        };
+        responses: {
+            /** @description The same cancellation, already open */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "get-cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "withdraw-cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
     "list-renewal-prices": {
         parameters: {
             query?: never;

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

@@ -19,6 +19,22 @@ export type ListProjectSubscriptionsQuery = operations["list-project-subscriptio
 export type SetProjectAutoRenewResult = operations["set-project-auto-renew"]["responses"][200]["content"]["application/json"];
 /** The request body of `PUT /api/v1/projects/{projectId}/subscriptions/{subscriptionId}/auto-renew`. */
 export type SetProjectAutoRenewBody = NonNullable<operations["set-project-auto-renew"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `POST /api/v1/projects/{projectId}/cancellations/preview`. */
+export type CreateProjectCancellationPreviewResult = operations["create-project-cancellation-preview"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /api/v1/projects/{projectId}/cancellations/preview`. */
+export type CreateProjectCancellationPreviewBody = NonNullable<operations["create-project-cancellation-preview"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `POST /api/v1/projects/{projectId}/cancellations`. */
+export type CreateProjectCancellationResult = operations["create-project-cancellation"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /api/v1/projects/{projectId}/cancellations`. */
+export type CreateProjectCancellationBody = NonNullable<operations["create-project-cancellation"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `GET /api/v1/projects/{projectId}/cancellations`. */
+export type ListProjectCancellationsResult = operations["list-project-cancellations"]["responses"][200]["content"]["application/json"];
+/** The query parameters of `GET /api/v1/projects/{projectId}/cancellations`. */
+export type ListProjectCancellationsQuery = operations["list-project-cancellations"]["parameters"]["query"];
+/** The success response body of `GET /api/v1/projects/{projectId}/cancellations/{cancellationId}`. */
+export type GetProjectCancellationResult = operations["get-project-cancellation"]["responses"][200]["content"]["application/json"];
+/** The success response body of `POST /api/v1/projects/{projectId}/cancellations/{cancellationId}/withdraw`. */
+export type WithdrawProjectCancellationResult = operations["withdraw-project-cancellation"]["responses"][200]["content"]["application/json"];
 /** The success response body of `GET /api/v1/projects/{projectId}/orders`. */
 export type ListProjectOrdersResult = operations["list-project-orders"]["responses"][200]["content"]["application/json"];
 /** The query parameters of `GET /api/v1/projects/{projectId}/orders`. */

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

@@ -121,6 +121,142 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/projects/{projectId}/cancellations/preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Preview a cancellation
+         * @description What canceling these subscriptions together would return, computed now under the refund terms
+         *     agreed when each was bought. This request does not create a resource: nothing is recorded or
+         *     reserved.
+         *
+         *     It is refused with the same errors as creating the cancellation, except that the amount is not
+         *     checked. Give the returned `proration_date` and `refundable_amount` when creating it.
+         */
+        post: operations["create-project-cancellation-preview"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/cancellations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List cancellations
+         * @description Newest first. Filter by `subscription_id` and `status=open` to find the cancellation now under way for a subscription.
+         */
+        get: operations["list-project-cancellations"];
+        put?: never;
+        /**
+         * Cancel subscriptions
+         * @description Ends a set of subscriptions of one service together, at one time. Deleting a resource that a
+         *     subscription pays for is an `immediate` cancellation of every subscription released with it,
+         *     such as a server with the disks deleted along with it, or an address with its bandwidth.
+         *
+         *     The service that provides the resources releases them: at once for `immediate`, or at
+         *     `scheduled_at`, the end of the paid term, for `period_end`. When release is confirmed, the
+         *     unused value is returned the way it was paid, under the refund terms agreed when each
+         *     subscription was bought. For `immediate` the refund is computed as of `proration_date`, so the
+         *     amount confirmed here is the amount returned: prepaid service used while the resources are
+         *     being released is not deducted from it. Usage of a postpaid subscription is charged until its
+         *     resources are released, as usual.
+         *
+         *     `mode` must be allowed for every subscription. Postpaid and one-time subscriptions end only
+         *     `immediate`. A prepaid subscription ends `period_end` while its paid term lasts, and
+         *     `immediate` unless its termination terms allow only the end of the paid term and that term has
+         *     not ended yet. For `period_end` the paid terms of all the subscriptions must end at the same
+         *     time.
+         *
+         *     Refused with:
+         *     - 400 `BILLING_CANCELLATION_INVALID` when `subscription_ids` or `proration_date` is not
+         *       acceptable (`meta.field`), or the subscriptions do not all belong to one service, project,
+         *       account and currency;
+         *     - 409 `BILLING_CANCELLATION_CONFLICT` when a subscription has not started or has ended;
+         *     - 422 `BILLING_CANCELLATION_MODE_FIXED` when `mode` is not allowed for a subscription, and
+         *       `BILLING_CANCELLATION_TERMS_UNSET` when a prepaid subscription has no termination terms;
+         *       both carry `meta.subscription_id`;
+         *     - 409 `BILLING_CANCELLATION_SCHEDULES_DIFFER` when, for `period_end`, the paid terms end at
+         *       different times;
+         *     - 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled
+         *       (`meta.cancellation_id`) or reclaimed (`meta.job_id`);
+         *     - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for a renewal of one of them
+         *       is in progress;
+         *     - 422 `BILLING_CANCELLATION_UNSUPPORTED` when the service cannot yet be canceled here;
+         *     - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund is no longer
+         *       `expected_refundable_amount`; preview again.
+         *
+         *     Sending the same request again, for the same subscriptions, mode and amount while that
+         *     cancellation is still open, returns it with 200 rather than creating another. Renewal orders
+         *     still waiting for payment are canceled along with it.
+         */
+        post: operations["create-project-cancellation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/cancellations/{cancellationId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        /** Get a cancellation */
+        get: operations["get-project-cancellation"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/projects/{projectId}/cancellations/{cancellationId}/withdraw": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Withdraw a cancellation
+         * @description Withdraws the whole cancellation while none of its resources has begun to be released; the
+         *     subscriptions continue as before. After that it is refused with 409
+         *     `BILLING_CANCELLATION_CONFLICT`. Withdrawing one that is already withdrawn returns it unchanged.
+         */
+        post: operations["withdraw-project-cancellation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/projects/{projectId}/orders": {
         parameters: {
             query?: never;
@@ -303,9 +439,165 @@ export interface components {
          * @enum {string}
          */
         RefundPolicy: "none" | "prorated";
+        CancellationPreviewRequest: {
+            /** @description The subscriptions to end together, all of one service. Every subscription released with a resource must be included. */
+            subscription_ids: string[];
+            mode: components["schemas"]["TerminationPolicy"];
+        };
+        /**
+         * @description What the cancellation would return, subscription by subscription and in total, as of now.
+         *
+         *     - `unused_amount`: before tax, the value of the paid service still unused, whatever the refund
+         *       terms say.
+         *     - `refundable_amount`: what is returned the way it was paid, including the tax paid on it;
+         *       `refund_amount` plus `credit_amount`.
+         *     - `refund_amount`: the part returned to the balance or to the payment method.
+         *     - `credit_amount`: the part restored to the credit grants that paid.
+         *     - `tax_amount`: the tax included in `refundable_amount`.
+         *     - `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.
+         *
+         *     Postpaid and one-time subscriptions show zero; usage until release is charged as usual.
+         */
+        CancellationRefundPreview: {
+            mode: components["schemas"]["TerminationPolicy"];
+            /**
+             * Format: date-time
+             * @description For `period_end`, when release begins, the end of the paid terms.
+             */
+            scheduled_at?: string;
+            /**
+             * Format: date-time
+             * @description For `immediate`, the second the refund is computed as of. Give it when creating the cancellation.
+             */
+            proration_date?: string;
+            currency: string;
+            unused_amount: components["schemas"]["Money"];
+            refundable_amount: components["schemas"]["Money"];
+            refund_amount: components["schemas"]["Money"];
+            credit_amount: components["schemas"]["Money"];
+            tax_amount: components["schemas"]["Money"];
+            forfeited_amount: components["schemas"]["Money"];
+            items: components["schemas"]["CancellationRefundPreviewItem"][];
+        };
+        /** @description One subscription of the preview. The amounts mean what they mean in the preview. */
+        CancellationRefundPreviewItem: {
+            /** Format: uuid */
+            subscription_id: string;
+            /** Format: uuid */
+            plan_id: string;
+            plan_name: string;
+            /** @description The project and its current name, for display. Absent for a purchase at account level, and when the project details cannot be read at the moment. */
+            project?: components["schemas"]["NamedIdentity"] | null;
+            /** @enum {string} */
+            billing_type: "postpaid" | "prepaid" | "one_time";
+            unused_amount: components["schemas"]["Money"];
+            refundable_amount: components["schemas"]["Money"];
+            refund_amount: components["schemas"]["Money"];
+            credit_amount: components["schemas"]["Money"];
+            tax_amount: components["schemas"]["Money"];
+            forfeited_amount: components["schemas"]["Money"];
+        };
+        CancellationCreate: {
+            /** @description As in the preview. */
+            subscription_ids: string[];
+            mode: components["schemas"]["TerminationPolicy"];
+            /**
+             * Format: date-time
+             * @description For `immediate`, the `proration_date` of the preview: a whole second, not in the future and
+             *     at most ten minutes old. The refund is computed as of it. Now when omitted.
+             */
+            proration_date?: string;
+            /** @description The `refundable_amount` of the preview. The cancellation is refused when the refund differs. */
+            expected_refundable_amount: string;
+            /** @description A note from the account holder. It is kept with the cancellation and not shown elsewhere. */
+            reason?: string;
+        };
+        /**
+         * @description One cancellation of a set of subscriptions of one service, released together at one time.
+         *
+         *     - `requested`: `immediate`, release has not begun.
+         *     - `scheduled`: `period_end`, waiting for `scheduled_at`.
+         *     - `releasing`: release has begun; it can no longer be withdrawn.
+         *     - `completed`: every subscription has ended and its refund has been made.
+         *     - `canceled`: withdrawn before release began; the subscriptions continue.
+         *     - `failed`: the service could not carry it out, for the reason in `failure_code`; the
+         *       subscriptions continue and can be canceled again.
+         */
+        Cancellation: {
+            /** Format: uuid */
+            id: string;
+            /** @enum {string} */
+            status: "requested" | "scheduled" | "releasing" | "completed" | "canceled" | "failed";
+            mode: components["schemas"]["TerminationPolicy"];
+            /** Format: date-time */
+            scheduled_at?: string;
+            /**
+             * Format: date-time
+             * @description For `immediate`, the second the refund is computed as of.
+             */
+            proration_date?: string;
+            /**
+             * @description Who asked for it. `project_deletion` means the project was deleted.
+             * @enum {string}
+             */
+            origin: "customer" | "operator" | "project_deletion";
+            currency: string;
+            /** @description The refund confirmed when it was created. Absent when the platform created it. */
+            expected_refundable_amount?: components["schemas"]["Money"];
+            /**
+             * @description Present with `failed`. A code of the service that provides the resources, such as a disk
+             *     that can only be released with its server. Clients map it to their own wording.
+             */
+            failure_code?: string;
+            /** Format: date-time */
+            requested_at: string;
+            /** Format: date-time */
+            completed_at?: string;
+            /** Format: date-time */
+            canceled_at?: string;
+            items: components["schemas"]["CancellationItem"][];
+        };
+        /** @description One subscription of the cancellation. */
+        CancellationItem: {
+            /**
+             * Format: uuid
+             * @description The cancellation request of this subscription, the same as `Subscription.cancellation_request.id`.
+             */
+            id: string;
+            /** Format: uuid */
+            subscription_id: string;
+            /** Format: uuid */
+            plan_id: string;
+            plan_name: string;
+            /** @enum {string} */
+            status: "requested" | "scheduled" | "releasing" | "completed" | "canceled" | "failed";
+            /** Format: date-time */
+            release_started_at?: string;
+            /**
+             * Format: date-time
+             * @description When the service ended, as confirmed by the service that provides it.
+             */
+            effective_at?: string;
+            /** @description Present with `completed`. The part of the refund returned to the account balance. */
+            balance_amount?: components["schemas"]["Money"];
+            /** @description Present with `completed`. The part restored to the credit grants that paid. */
+            credit_amount?: components["schemas"]["Money"];
+            /** @description Present with `completed`. The part returned to the payment method it was paid with. */
+            gateway_amount?: components["schemas"]["Money"];
+        };
+        CancellationList: {
+            items: components["schemas"]["Cancellation"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
         /** @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
+             * @description The cancellation this request belongs to, with the other subscriptions released together.
+             */
+            cancellation_id?: string;
             /** Format: uuid */
             id: string;
             /** Format: uuid */
@@ -1063,6 +1355,7 @@ export interface components {
         };
     };
     parameters: {
+        CancellationId: string;
         /** @description 1-based page number; the first page when omitted. */
         Page: number;
         /** @description How many per page, 100 at most. */
@@ -1238,6 +1531,149 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
+    "create-project-cancellation-preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CancellationPreviewRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CancellationRefundPreview"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-project-cancellations": {
+        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 Only cancellations that include this subscription. */
+                subscription_id?: string;
+                /** @description Only cancellations in this status. `open` means requested, scheduled or releasing. */
+                status?: "open" | "requested" | "scheduled" | "releasing" | "completed" | "canceled" | "failed";
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CancellationList"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "create-project-cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CancellationCreate"];
+            };
+        };
+        responses: {
+            /** @description The same cancellation, already open */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "get-project-cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "withdraw-project-cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+                cancellationId: components["parameters"]["CancellationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Cancellation"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
     "list-project-orders": {
         parameters: {
             query?: {

package/dist/compute/v1/schema.d.ts

@@ -46,7 +46,7 @@ export interface paths {
          * Delete a backup
          * @description Independent of the source disk: deletion succeeds whether or not that disk still exists.
          *
-         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the backup, including a pay-as-you-go subscription. `meta.resource_id` names the backup. It is released when its subscription ends.
+         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the backup, including a pay-as-you-go subscription. `meta.resource_id` names the backup. It is released by canceling the subscriptions listed in `meta.subscription_ids` through Billing, the same set as its `release_subscription_ids`.
          */
         delete: operations["delete-backup"];
         options?: never;
@@ -240,7 +240,7 @@ export interface paths {
          * Delete a disk
          * @description Deletion is rejected while the disk is attached, or while snapshots created from it still exist.
          *
-         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the disk, including a pay-as-you-go subscription. `meta.resource_id` names the disk. It is released when its subscription ends.
+         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the disk, including a pay-as-you-go subscription. `meta.resource_id` names the disk. It is released by canceling the subscriptions listed in `meta.subscription_ids` through Billing, the same set as its `release_subscription_ids`.
          */
         delete: operations["delete-disk"];
         options?: never;
@@ -342,7 +342,7 @@ export interface paths {
          * Release a floating IP
          * @description Releases the floating IP after unbinding it. Completion is reported by the returned task.
          *
-         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the address or for its bandwidth, including a pay-as-you-go subscription. `meta.resource_id` names the floating IP. It is released when its subscriptions end.
+         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the address or for its bandwidth, including a pay-as-you-go subscription. `meta.resource_id` names the floating IP. It is released by canceling the subscriptions listed in `meta.subscription_ids` through Billing, the same set as its `release_subscription_ids`.
          */
         delete: operations["release-floating-ip"];
         options?: never;
@@ -443,7 +443,7 @@ export interface paths {
          *
          *     An instance being captured as a private image cannot be released. Wait for the capture to finish, or delete that image first.
          *
-         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the instance, or for a disk that is deleted with it, including a pay-as-you-go subscription. `meta.resource_id` names that resource. It is released when its subscription ends.
+         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the instance, or for a disk that is deleted with it, including a pay-as-you-go subscription. `meta.resource_id` names that resource. The instance is released by canceling the subscriptions listed in `meta.subscription_ids` through Billing, the same set as its `release_subscription_ids`.
          */
         delete: operations["delete-instance"];
         options?: never;
@@ -955,7 +955,7 @@ export interface paths {
          *
          *     An image whose capture has not finished can be deleted; the capture is aborted.
          *
-         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the image, including a pay-as-you-go subscription. `meta.resource_id` names the image. It is released when its subscription ends.
+         *     Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the image, including a pay-as-you-go subscription. `meta.resource_id` names the image. It is released by canceling the subscriptions listed in `meta.subscription_ids` through Billing, the same set as its `release_subscription_ids`.
          */
         delete: operations["delete-private-image"];
         options?: never;
@@ -1256,7 +1256,7 @@ export interface paths {
         post?: never;
         /**
          * Delete a snapshot
-         * @description Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the snapshot, including a pay-as-you-go subscription. `meta.resource_id` names the snapshot. It is released when its subscription ends.
+         * @description Refused with `COMPUTE_RESOURCE_SUBSCRIBED` while a subscription pays for the snapshot, including a pay-as-you-go subscription. `meta.resource_id` names the snapshot. It is released by canceling the subscriptions listed in `meta.subscription_ids` through Billing, the same set as its `release_subscription_ids`.
          */
         delete: operations["delete-snapshot"];
         options?: never;
@@ -1451,6 +1451,8 @@ export interface components {
             price_id: string | null;
             /** Format: uuid */
             subscription_item_id: string | null;
+            /** @description The subscriptions a cancellation through Billing has to cover to release this backup: its own. Subscriptions that have ended are not listed, and the list is empty when no subscription pays for any of them. */
+            release_subscription_ids: string[];
             /** @enum {string|null} */
             access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
             task: components["schemas"]["Task"] | null;
@@ -1533,6 +1535,8 @@ export interface components {
             price_id: string | null;
             /** Format: uuid */
             subscription_item_id: string | null;
+            /** @description The subscriptions a cancellation through Billing has to cover to release this disk: its own and those of its snapshots. A system disk is released only with its instance, so for a system disk the list is that of the instance. Subscriptions that have ended are not listed, and the list is empty when no subscription pays for any of them. */
+            release_subscription_ids: string[];
             /** @enum {string|null} */
             access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
             task: components["schemas"]["Task"] | null;
@@ -1765,6 +1769,8 @@ export interface components {
             price_id: string | null;
             /** Format: uuid */
             subscription_item_id: string | null;
+            /** @description The subscriptions a cancellation through Billing has to cover to release this address: the subscriptions of the address and of its bandwidth. Subscriptions that have ended are not listed, and the list is empty when no subscription pays for any of them. */
+            release_subscription_ids: string[];
             /** @enum {string|null} */
             access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
             task: components["schemas"]["Task"] | null;
@@ -1891,6 +1897,8 @@ export interface components {
             price_id: string | null;
             /** Format: uuid */
             subscription_item_id: string | null;
+            /** @description The subscriptions a cancellation through Billing has to cover to release this instance: its own, those of the disks deleted with it, and those of the snapshots of those disks. Subscriptions that have ended are not listed, and the list is empty when no subscription pays for any of them. */
+            release_subscription_ids: string[];
             /** @enum {string|null} */
             access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
             /**
@@ -2187,6 +2195,8 @@ export interface components {
             price_id: string | null;
             /** Format: uuid */
             subscription_item_id: string | null;
+            /** @description The subscriptions a cancellation through Billing has to cover to release this private image: its own. Subscriptions that have ended are not listed, and the list is empty when no subscription pays for any of them. */
+            release_subscription_ids: string[];
             /** @enum {string|null} */
             access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
             task: components["schemas"]["Task"] | null;
@@ -2406,6 +2416,8 @@ export interface components {
             price_id: string | null;
             /** Format: uuid */
             subscription_item_id: string | null;
+            /** @description The subscriptions a cancellation through Billing has to cover to release this snapshot: its own. Subscriptions that have ended are not listed, and the list is empty when no subscription pays for any of them. */
+            release_subscription_ids: string[];
             /** @enum {string|null} */
             access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
             task: components["schemas"]["Task"] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.0.0-dev.232.g18ca775",
+  "version": "0.0.0-dev.234.gce19274",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {