@leaflow/sdk 0.102.0 → 0.103.0

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

@@ -59,10 +59,10 @@ export type CreatePaymentMethodSetupResult = operations["create-payment-method-s
 export type CreatePaymentMethodSetupBody = NonNullable<operations["create-payment-method-setup"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `PUT /account/v1/payment-methods/{paymentMethodId}/default`. */
 export type SetDefaultPaymentMethodResult = operations["set-default-payment-method"]["responses"][200]["content"]["application/json"];
-/** The success response body of `POST /account/v1/invoices/{invoiceId}/collect-payment`. */
-export type CollectInvoicePaymentResult = operations["collect-invoice-payment"]["responses"][200]["content"]["application/json"];
-/** The request body of `POST /account/v1/invoices/{invoiceId}/collect-payment`. */
-export type CollectInvoicePaymentBody = NonNullable<operations["collect-invoice-payment"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `POST /account/v1/invoices/{invoiceId}/pay`. */
+export type PayInvoiceResult = operations["pay-invoice"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /account/v1/invoices/{invoiceId}/pay`. */
+export type PayInvoiceBody = NonNullable<operations["pay-invoice"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `GET /account/v1/invoices/{invoiceId}/payment-preview`. */
 export type PreviewInvoicePaymentResult = operations["preview-invoice-payment"]["responses"][200]["content"]["application/json"];
 /** The query parameters of `GET /account/v1/invoices/{invoiceId}/payment-preview`. */
@@ -143,10 +143,6 @@ export type CreateRenewalOrderBody = NonNullable<operations["create-renewal-orde
 export type SetAutoRenewResult = operations["set-auto-renew"]["responses"][200]["content"]["application/json"];
 /** The request body of `PUT /account/v1/subscriptions/{subscriptionId}/auto-renew`. */
 export type SetAutoRenewBody = NonNullable<operations["set-auto-renew"]["requestBody"]>["content"]["application/json"];
-/** The success response body of `POST /account/v1/promotion-codes/preview`. */
-export type PreviewPromotionCodeResult = operations["preview-promotion-code"]["responses"][200]["content"]["application/json"];
-/** The request body of `POST /account/v1/promotion-codes/preview`. */
-export type PreviewPromotionCodeBody = NonNullable<operations["preview-promotion-code"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `GET /account/v1/allowances`. */
 export type ListAllowancesResult = operations["list-allowances"]["responses"][200]["content"]["application/json"];
 /** The query parameters of `GET /account/v1/allowances`. */

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

@@ -376,7 +376,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/account/v1/invoices/{invoiceId}/collect-payment": {
+    "/account/v1/invoices/{invoiceId}/pay": {
         parameters: {
             query?: never;
             header?: never;
@@ -388,7 +388,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Collect payment for an invoice
+         * Pay an invoice
          * @description Applies eligible credit grants and available balance as requested, then collects the remainder
          *     through the selected payment gateway and method. With no gateway selection, insufficient
          *     account funds fail without starting an online payment. Card and non-card methods use this same
@@ -404,7 +404,7 @@ export interface paths {
          *     canceled, with `BILLING_ORDER_FAILED` or `BILLING_ORDER_CANCELED`; and that of an order whose
          *     payment deadline has passed, with `BILLING_ORDER_EXPIRED`.
          */
-        post: operations["collect-invoice-payment"];
+        post: operations["pay-invoice"];
         delete?: never;
         options?: never;
         head?: never;
@@ -778,7 +778,7 @@ export interface paths {
          *     - 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`);
+         *       (`meta.cancellation_id`) or reclaimed (`meta.action_id`);
          *     - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for a renewal of one of them
          *       is in progress;
          *     - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund is no longer
@@ -953,27 +953,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/account/v1/promotion-codes/preview": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Preview promotion code
-         * @description Nothing is recorded and the code is not consumed. Use it to show the customer the effect
-         *     before they commit.
-         */
-        post: operations["preview-promotion-code"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/account/v1/allowances": {
         parameters: {
             query?: never;
@@ -1064,11 +1043,11 @@ export interface paths {
          *     A successful confirmation records the discount, including any recurring discount terms,
          *     reserves its redemption, moves pending_checkout to pending and finalizes the invoice when one
          *     is required. The reservation counts toward the code's limits and is consumed when the invoice
-         *     is paid, or at confirmation when nothing is due. Use collect-invoice-payment to collect
+         *     is paid, or at confirmation when nothing is due. Use pay-invoice to collect
          *     its outstanding amount from account funds or a payment gateway. No payment attempt or checkout
-         *     session is created by this operation. A purchase with nothing to collect can proceed to Billing
-         *     admission without a payment transaction. An absent invoice or zero immediate amount still
-         *     requires checkout confirmation; checkout alone does not confirm resource delivery.
+         *     session is created by this operation. An order whose total is zero completes checkout at
+         *     placement in either mode and does not need this operation; an order with an amount due, even
+         *     when credits would cover it, still does. Checkout alone does not confirm resource delivery.
          *
          *     Retrying with the same code and expected amount returns the existing order without another
          *     redemption. Omitting the code on a confirmed checkout retains its recorded discount. Changing
@@ -1178,34 +1157,41 @@ export interface components {
          */
         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.
+         * @description none refunds nothing. prorated refunds the amount paid for the current period minus the value of
+         *     the time used, never below zero and never more than what remains unrefunded. The time used runs
+         *     from the period start to the effective cancellation time and is valued at the plan's
+         *     shorter-period prices in the same currency, frozen at purchase as the order item's
+         *     refund_monthly_amount and refund_hourly_amount: each full calendar month at the one-month prepaid
+         *     price, the remainder at the postpaid hourly price or, without one, at the one-month price by the
+         *     second. When the plan has no prepaid period shorter than the one bought, the time used is valued
+         *     at the price paid, pro rata by the second. Discounts are not refunded, as they were never paid,
+         *     and setup fees are excluded. The refunded part returns to the payment sources it came from. Tax
+         *     paid is refunded in the same proportion as the amount it was paid on.
          * @enum {string}
          */
         RefundPolicy: "none" | "prorated";
-        /** @description Quote exactly one target. An existing order, a renewal list and a cancellation are mutually exclusive. */
-        QuoteRequest: components["schemas"]["OrderQuoteRequest"] | components["schemas"]["RenewalQuoteRequest"] | components["schemas"]["CancellationQuoteRequest"];
         /**
-         * @description Preview checkout of one existing order. Its recorded purchase terms supply every line.
-         *     Without a code, an applicable account discount is selected. A preview neither changes the
-         *     order nor reserves or consumes a redemption. A confirmed order returns its recorded amounts.
+         * @description Quote exactly one target: an existing `order_id`, `renewals` or a `cancellation`. Giving none or
+         *     more than one, or a `promotion_code` with `renewals` or a `cancellation`, fails with HTTP 400
+         *     `BILLING_PURCHASE_INVALID` and `meta.field` naming the offending field. Without a code, an
+         *     applicable account discount is selected. An explicit code is evaluated without reserving or
+         *     consuming a redemption and must be supplied again when confirming checkout through Billing.
          */
-        OrderQuoteRequest: {
-            /** Format: uuid */
-            order_id: string;
-            /** @description Code to evaluate for this order. Must be supplied again when confirming checkout. */
+        QuoteRequest: {
+            /**
+             * Format: uuid
+             * @description Preview checkout of this existing order. Its recorded purchase terms supply every line, and a
+             *     confirmed order returns its recorded amounts. A preview does not change the order.
+             */
+            order_id?: string;
+            /**
+             * @description Preview renewing these subscriptions, each at most once. Each entry represents a separate
+             *     renewal order. To preview a new promotion code, create a renewal order and quote it by order_id.
+             */
+            renewals?: components["schemas"]["QuoteRenewal"][];
+            cancellation?: components["schemas"]["QuoteCancellation"];
             promotion_code?: string;
         };
-        /**
-         * @description Preview renewing subscriptions, each at most once. Each entry represents a separate renewal
-         *     order. To preview a new promotion code, create a renewal order and quote it by order_id.
-         */
-        RenewalQuoteRequest: {
-            renewals: components["schemas"]["QuoteRenewal"][];
-        };
-        /** @description Preview one cancellation without combining it with a purchase, renewal or promotion code. */
-        CancellationQuoteRequest: {
-            cancellation: components["schemas"]["QuoteCancellation"];
-        };
         CheckoutOrderRequest: {
             /**
              * @description The code to apply, evaluated again at confirmation. Omit to select an applicable account
@@ -1221,7 +1207,9 @@ export interface components {
         /**
          * @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.
+         *     the current term, or giving neither, renews at the agreed amount. A term sold at several
+         *     prices that differ in termination policy is refused with 409
+         *     `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` or `price_id` is given.
          */
         QuoteRenewal: {
             /** Format: uuid */
@@ -1231,6 +1219,8 @@ export interface components {
             /** @enum {string} */
             interval?: "day" | "month" | "year";
             interval_count?: number;
+            /** @description With `interval` and `interval_count`, chooses among prices of that term that differ in termination policy. */
+            termination_policy?: components["schemas"]["TerminationPolicy"];
             /**
              * @description How many consecutive periods to renew for.
              * @default 1
@@ -1391,8 +1381,8 @@ export interface components {
          * @description What the cancellation would return, subscription by subscription and in total, as of now. Give
          *     `proration_date` and `refundable_amount` when creating the cancellation.
          *
-         *     - `unused_amount`: before tax, the value of the paid service still unused, whatever the refund
-         *       terms say.
+         *     - `unused_amount`: before tax, the amount paid for the current periods minus the value of the
+         *       time used, valued as refund policy `prorated` describes, 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.
@@ -1603,30 +1593,6 @@ export interface components {
         };
         /** @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.
-         *
-         *     Charges for future usage are not estimated here; the service that sells the product quotes
-         *     them with its purchase.
-         */
-        QuoteLine: {
-            price_lookup_key?: string;
-            plan_lookup_key?: string;
-            /** Format: uuid */
-            price_id?: string;
-            product_id?: components["schemas"]["ProductID"];
-            /** Format: uuid */
-            plan_id?: 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;
-        };
         BillingAccount: {
             /** Format: int64 */
             id: number;
@@ -1978,7 +1944,7 @@ export interface components {
          *     An unresolved channel payment is reused; retries do not apply the grant or balance portions twice.
          *     Without a gateway selection, insufficient account funds fail without starting an online payment.
          */
-        CollectInvoicePaymentRequest: {
+        PayInvoiceRequest: {
             /** @description Required to collect an online remainder. An existing attempt keeps its original gateway. */
             payment_gateway?: string;
             /** @description Required with payment_gateway; for example card, wechat_pay or alipay. */
@@ -2169,6 +2135,8 @@ export interface components {
             /** @description Subtotal less discount plus tax. Balance and credit grants are payment sources, not reductions of the receivable. */
             total: components["schemas"]["Money"];
             amount_paid?: components["schemas"]["Money"];
+            /** @description What is still collectible after applied credits and successful payments; never below zero. A draft order invoice is not collectible until checkout confirms it, and a paid or void invoice has none. */
+            amount_due: components["schemas"]["Money"];
             /** Format: date-time */
             period_start?: string | null;
             /**
@@ -2414,7 +2382,10 @@ export interface components {
          *     - `subscription_canceled`: the subscription was canceled and its unused value returned under
          *       its refund terms.
          *     - `future_period_canceled`: a renewal that had not started yet was withdrawn.
-         *     - `downgrade_difference`: the unused value above the new price after a downgrade.
+         *     - `downgrade_difference`: after a downgrade, the remaining value of what was paid, valued as refund
+         *       policy `prorated` describes, minus the new configuration's cost for the remaining time at the
+         *       change item's `refund_monthly_amount` and `refund_hourly_amount`. Nothing is refunded when that is
+         *       zero or less.
          *     - `usage_true_up`: usage priced again over the whole month cost less than was charged.
          *     - `payment_not_applied`: a payment arrived after its invoice could no longer be paid.
          *     - `operator`: made by the platform operator.
@@ -2488,14 +2459,15 @@ export interface components {
          *     through checkout and delivery. One order may create several subscriptions, such as an instance,
          *     its system disk and its address; it has no single subscription ID.
          *
-         *     Pending does not grant service or accrue usage. Payment confirmation and order acceptance do
-         *     not activate a service-owned subscription. It becomes active when the owning service confirms
-         *     delivery, with started_at set to the confirmed effective time. Prepaid service periods start
+         *     Pending and provisioning do not grant service or accrue usage. A service-owned subscription
+         *     becomes provisioning when the owning service accepts the order, and active when the service
+         *     confirms delivery, with started_at set to the confirmed effective time; payment changes neither. Prepaid service periods start
          *     then; postpaid usage starts only when the service reports actual delivery and metering.
          *
          *     One-time delivery may omit a subscription. Renewals reference and extend existing subscriptions
-         *     rather than creating another; changes may create pending replacements. Canceling or failing an
-         *     unfulfilled purchase closes its pending subscriptions without starting a service period.
+         *     rather than creating another; a change keeps the subscription ID and switches its terms when it
+         *     takes effect. Canceling or failing an
+         *     unfulfilled purchase closes its pending or provisioning subscriptions without starting a service period.
          *     Fixed renewals use the agreed recurring_amount and interval; already paid periods retain their
          *     original value. Technical state belongs to the owning service.
          *
@@ -2521,7 +2493,10 @@ export interface components {
             refund_policy?: components["schemas"]["RefundPolicy"];
             /** Format: uuid */
             order_item_id?: string;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description Present only on subscriptions created by an earlier change that replaced the subscription. A change now keeps the subscription ID.
+             */
             replaces_subscription_id?: string;
             /** Format: uuid */
             coupon_id?: string;
@@ -2569,20 +2544,21 @@ export interface components {
             quantity: string;
             /**
              * Format: date-time
-             * @description End of the prepaid service already activated. Null for a new pending subscription, even
-             *     when its purchase has been paid, and for postpaid subscriptions with no prepaid end date.
+             * @description End of the prepaid service already activated. Null until a new subscription becomes active,
+             *     even when its purchase has been paid, and for postpaid subscriptions with no prepaid end date.
              */
             paid_until?: string | null;
             auto_renew: boolean;
             /**
-             * @description pending means the purchase relationship exists but service has not started. For a
-             *     service-owned purchase, only confirmed delivery moves it to active; paying alone does not.
+             * @description pending means the purchase relationship exists but its order has not been accepted.
+             *     provisioning means the service accepted the order and is delivering. For a service-owned
+             *     purchase, only confirmed delivery moves it to active; paying alone does not.
              * @enum {string}
              */
-            status: "pending" | "active" | "suspended" | "canceled" | "terminated";
+            status: "pending" | "provisioning" | "active" | "suspended" | "canceled" | "terminated";
             /**
              * Format: date-time
-             * @description Confirmed start of service. Null for a new pending subscription, including after payment.
+             * @description Confirmed start of service. Null until a new subscription becomes active, including after payment.
              */
             started_at?: string | null;
             /** Format: date-time */
@@ -2631,7 +2607,9 @@ export interface components {
              *
              *     Leaving both out renews at the price this item already bills at, which a later price
              *     change does not affect. Naming a term that differs from the current one is a fresh
-             *     choice, so it is bought at today's price. Naming the current term changes nothing.
+             *     choice, so it is bought at today's price. Naming the current term changes nothing. A
+             *     term sold at several prices that differ in termination policy is refused with 409
+             *     `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` is given.
              *
              *     List the terms on offer with the renewal prices operation.
              */
@@ -2641,6 +2619,8 @@ export interface components {
              * @enum {string}
              */
             interval?: "day" | "month" | "year";
+            /** @description With `interval` and `interval_count`, chooses among prices of that term that differ in termination policy. */
+            termination_policy?: components["schemas"]["TerminationPolicy"];
             /** Format: uuid */
             payment_method_id?: string;
             /**
@@ -2679,8 +2659,9 @@ export interface components {
             auto_renew: boolean;
         };
         /**
-         * @description pending_checkout has recorded purchase terms but no confirmed checkout. An absent invoice
-         *     or zero total does not permit acceptance. Confirmation moves it to pending. Both pending_checkout
+         * @description pending_checkout has recorded purchase terms but no confirmed checkout; only a deferred order
+         *     with an amount due reaches it, since a zero-total order completes checkout at placement.
+         *     Confirmation moves it to pending. Both pending_checkout
          *     and pending can expire or be canceled; neither establishes service delivery.
          *
          *     Follows the items. `pending` has confirmed checkout, is not yet accepted and may be paid or unpaid. `active` is
@@ -2798,75 +2779,6 @@ export interface components {
             brand?: string;
             last4?: string;
         };
-        /** @description Specify lines to check whether the promotion code applies to new purchases and to estimate its discount. Without lines, the response contains the code terms without a purchase-specific applicability decision. */
-        PromotionCodePreviewRequest: {
-            /** Format: int64 */
-            billing_account_id: number;
-            promotion_code: string;
-            /** @description New purchases to test against, in the same shape as a quote. */
-            lines?: components["schemas"]["QuoteLine"][];
-        };
-        /** @description Describes a usable promotion code and its applicability to the requested purchase. Invalid codes return an error response. */
-        PromotionCodePreview: {
-            min_amount?: string;
-            /** @enum {string} */
-            type?: "percentage" | "fixed_amount" | "price_override" | "free_setup";
-            recurring?: boolean;
-            recurring_cycles?: number;
-            name?: string;
-            /** @description For a fixed-amount discount. */
-            amount?: components["schemas"]["Money"];
-            /** @description For a percentage discount. */
-            percent_off?: string;
-            max_discount?: components["schemas"]["Money"];
-            currency?: string;
-            /**
-             * @description What it may be used for. Present whether or not a purchase was given, so that the
-             *     terms can be shown before anything is chosen.
-             */
-            applies_to?: components["schemas"]["Applicability"];
-            /**
-             * @description The terms in one sentence, ready to display — for example "Compute, new purchases
-             *     only, from 100.00" or "No restriction on product or purchase type".
-             */
-            summary?: string;
-            /** Format: date-time */
-            valid_until?: string | null;
-            /**
-             * @description Whether it applies to the purchase given in `lines`. Absent when no purchase was
-             *     given.
-             */
-            applicable?: boolean;
-            applicable_reason?: components["schemas"]["PromotionCodeRejection"];
-            /**
-             * @description The total of the lines that match the restrictions. This is what the threshold is
-             *     measured against, not the order total.
-             */
-            qualifying_amount?: components["schemas"]["Money"];
-            /**
-             * @description How much more of a qualifying purchase is needed to reach the threshold. `"0"` once
-             *     it is met.
-             */
-            shortfall?: components["schemas"]["Money"];
-            /**
-             * @description What it would take off this purchase. An estimate: the discount is confirmed during
-             *     order checkout. Use CreateQuote for the purchase's complete total, including tax.
-             */
-            estimated_discount?: components["schemas"]["Money"];
-        };
-        /**
-         * @description Why a code cannot be used. `none` when it can.
-         *
-         *     `operation_not_covered` means the code is limited to certain purchase actions — a
-         *     first-purchase code presented for a renewal, for example.
-         *
-         *     `term_not_covered` means the code is limited to certain term lengths. A purchase with
-         *     no term, such as metered usage, is reported the same way.
-         *
-         *     `below_minimum` is accompanied by `shortfall`.
-         * @enum {string}
-         */
-        PromotionCodeRejection: "none" | "not_found" | "expired" | "not_yet_valid" | "exhausted" | "already_redeemed" | "currency_mismatch" | "product_not_covered" | "plan_not_covered" | "price_not_covered" | "price_type_not_covered" | "operation_not_covered" | "term_not_covered" | "not_first_purchase" | "below_minimum";
         /**
          * @description Which purchase this applies to. `upgrade` and `downgrade` are told apart by money: a change
          *     that costs more for the remainder of the period is an upgrade, one that returns money
@@ -2918,7 +2830,7 @@ export interface components {
             items: components["schemas"]["Discount"][];
             pagination: components["schemas"]["OffsetPagination"];
         };
-        /** @description A price's display terms, including retired prices referenced by an applicability list. */
+        /** @description A price's display terms, including archived prices referenced by an applicability list. */
         PriceOption: {
             product: components["schemas"]["Product"];
             plan: components["schemas"]["ObjectIdentity"];
@@ -2969,8 +2881,8 @@ export interface components {
             /**
              * Format: uuid
              * @description Stable Billing subscription ID. A new prepaid or postpaid service purchase returns the
-             *     pending subscription here; renewals reference the existing subscription and changes the
-             *     replacement. Absent for delivery without a subscription. This is not a business resource ID.
+             *     pending subscription here; renewals and changes reference the existing subscription, which
+             *     keeps its ID. Absent for delivery without a subscription. This is not a business resource ID.
              */
             subscription_id?: string;
             /** @enum {string} */
@@ -2978,6 +2890,17 @@ export interface components {
             interval_count?: number;
             termination_policy?: components["schemas"]["TerminationPolicy"];
             refund_policy?: components["schemas"]["RefundPolicy"];
+            /**
+             * @description Prepaid items only: the plan's one-month prepaid price for this item's quantity before tax, frozen
+             *     at purchase, used to value time used under a prorated refund or a downgrade. Null when the plan has
+             *     no prepaid period shorter than the one bought.
+             */
+            refund_monthly_amount?: string | null;
+            /**
+             * @description Prepaid items only: the plan's postpaid hourly price for this item's quantity before tax, frozen at
+             *     purchase, used for time used short of a full month. Null when the plan has no postpaid price.
+             */
+            refund_hourly_amount?: string | null;
             completes_on_payment: boolean;
             recurring_amount?: string;
             setup_amount?: string;
@@ -3012,14 +2935,16 @@ export interface components {
             quantity: string;
             /**
              * @description The unit amount of the price this line is charged under. Absent for a tiered price, which has no
-             *     single unit amount, and for a change that takes effect at once, which is charged the prorated
-             *     difference.
+             *     single unit amount, and for a change that takes effect at once, which is charged as `gross_amount`
+             *     describes.
              */
             unit_amount?: components["schemas"]["Money"];
             /**
              * @description Before discounts: the price applied to the quantity, which for a per-unit price is `unit_amount`
-             *     times `quantity`; a minimum charge can make it higher. For a change that takes effect at once it is
-             *     the prorated difference. The setup fee is not part of it; see `setup_amount`.
+             *     times `quantity`; a minimum charge can make it higher. For an upgrade that takes effect at once it is
+             *     the new price minus the old price for the time left in the paid period, both at the subscription's
+             *     own period price, and the period end does not move; a downgrade charges nothing and may refund the
+             *     difference instead. A change between equal period prices charges and refunds nothing. The setup fee is not part of it; see `setup_amount`.
              *
              *     Under an inclusive tax rate it includes tax, as the price does, and the included part is
              *     `tax_included_amount`. A renewal at the agreed terms is the exception: the agreed amount excludes
@@ -3131,6 +3056,8 @@ export interface components {
             tax_amount: string;
             total: string;
             amount_paid: string;
+            /** @description What is still collectible after applied credits and successful payments; never below zero. */
+            amount_due: string;
             amount_refunded: string;
             /** Format: date-time */
             due_at?: string;
@@ -3733,7 +3660,7 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
-    "collect-invoice-payment": {
+    "pay-invoice": {
         parameters: {
             query?: never;
             header?: never;
@@ -3744,7 +3671,7 @@ export interface operations {
         };
         requestBody?: {
             content: {
-                "application/json": components["schemas"]["CollectInvoicePaymentRequest"];
+                "application/json": components["schemas"]["PayInvoiceRequest"];
             };
         };
         responses: {
@@ -4398,31 +4325,6 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
-    "preview-promotion-code": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["PromotionCodePreviewRequest"];
-            };
-        };
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["PromotionCodePreview"];
-                };
-            };
-            default: components["responses"]["Error"];
-        };
-    };
     "list-allowances": {
         parameters: {
             query?: {

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

@@ -17,8 +17,8 @@ export interface paths {
          *     `currency` is required: a plan has a price in each currency it is sold in, so "what does
          *     this cost" has no answer without one.
          *
-         *     Retired prices are left out. Existing subscriptions still reference them, so this is not
-         *     the place to look up what an existing purchase is paying.
+         *     Archived prices are left out. Existing subscriptions keep the terms they were bought at, so
+         *     this is not the place to look up what an existing purchase is paying.
          */
         get: operations["list-prices"];
         put?: never;
@@ -103,7 +103,7 @@ export interface paths {
         };
         /**
          * Get a price
-         * @description Returns the catalog price, including retired prices. Fixed purchase history and renewal agreements are shown on orders and subscriptions rather than reconstructed from today's catalog.
+         * @description Returns the catalog price, including archived prices. Fixed purchase history and renewal agreements are shown on orders and subscriptions rather than reconstructed from today's catalog.
          */
         get: operations["get-price"];
         put?: never;
@@ -216,7 +216,16 @@ export interface components {
          */
         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.
+         * @description none refunds nothing. prorated refunds the amount paid for the current period minus the value of
+         *     the time used, never below zero and never more than what remains unrefunded. The time used runs
+         *     from the period start to the effective cancellation time and is valued at the plan's
+         *     shorter-period prices in the same currency, frozen at purchase as the order item's
+         *     refund_monthly_amount and refund_hourly_amount: each full calendar month at the one-month prepaid
+         *     price, the remainder at the postpaid hourly price or, without one, at the one-month price by the
+         *     second. When the plan has no prepaid period shorter than the one bought, the time used is valued
+         *     at the price paid, pro rata by the second. Discounts are not refunded, as they were never paid,
+         *     and setup fees are excluded. The refunded part returns to the payment sources it came from. Tax
+         *     paid is refunded in the same proportion as the amount it was paid on.
          * @enum {string}
          */
         RefundPolicy: "none" | "prorated";
@@ -245,7 +254,8 @@ export interface components {
             pagination: components["schemas"]["OffsetPagination"];
         };
         Plan: {
-            enabled: boolean;
+            /** @description False once archived. An archived plan cannot be bought until it is active again. */
+            active: boolean;
             lookup_key?: string;
             product: components["schemas"]["Product"];
             features: components["schemas"]["PlanFeature"][];
@@ -268,7 +278,8 @@ export interface components {
             meter_id?: string;
             meter?: components["schemas"]["ObjectIdentity"];
             unit_quantity: string;
-            enabled?: boolean;
+            /** @description False once archived. An archived price cannot be bought until it is active again. */
+            active: boolean;
             termination_policy?: components["schemas"]["TerminationPolicy"];
             refund_policy?: components["schemas"]["RefundPolicy"];
             product_id?: components["schemas"]["ProductID"];