@leaflow/sdk 0.0.0-dev.535.g1eeb8a5 → 0.0.0-dev.538.g0285c19

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

@@ -2,7 +2,7 @@
  * Generated by orval 🍺
  * Do not edit manually.
  * Leaflow Billing API
- * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, quote purchases, changes and renewals, preview cancellations, and, with the project permission `billing:finance.manage` granted in IAM, renew, cancel and turn automatic renewal of its subscriptions on or off, change its billing account and read its costs. A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
+ * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and checkout previews are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, preview the checkout of purchases, changes and renewals, preview cancellations, and, with the project permission `billing:finance.manage` granted in IAM, renew, cancel and turn automatic renewal of its subscriptions on or off, change its billing account and read its costs. A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
  * OpenAPI spec version: v1
  */
 /**
@@ -43,293 +43,6 @@ export interface OrderCancel {
      */
     order_item_ids?: string[];
 }
-export type QuoteRenewalInterval = (typeof QuoteRenewalInterval)[keyof typeof QuoteRenewalInterval];
-export declare const QuoteRenewalInterval: {
-    readonly day: "day";
-    readonly month: "month";
-    readonly year: "year";
-};
-/**
- * Price renewing a whole subscription: every continuing licensed item. Give `interval` with
- * `interval_count` to renew for another term at the price each item currently sells it for, with
- * its own cancellation policy or the only price of that term. Naming the current term, or giving
- * neither, renews every item at its agreed amount. A term an item does not sell is refused with
- * 409 `BILLING_RENEWAL_PRICE_UNAVAILABLE` and `meta.subscription_item_id`; prices the rule cannot
- * choose between, with 409 `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.
- */
-export interface QuoteRenewal {
-    subscription_id: string;
-    interval?: QuoteRenewalInterval;
-    /** @minimum 1 */
-    interval_count?: number;
-    /** With `interval` and `interval_count`, renews every item at its price of that term with this cancellation policy. */
-    cancellation_policy?: CancellationPolicy;
-    /**
-     * How many consecutive periods to renew for.
-     * @minimum 1
-     * @maximum 100
-     */
-    periods?: number;
-}
-export type QuoteRenewalResultInterval = (typeof QuoteRenewalResultInterval)[keyof typeof QuoteRenewalResultInterval];
-export declare const QuoteRenewalResultInterval: {
-    readonly day: "day";
-    readonly month: "month";
-    readonly year: "year";
-};
-/**
- * A decimal string, in the currency stated alongside it.
- *
- * **The currency is not part of this type.** It is carried by a `currency` field next to the
- * amount, or by the account the amount belongs to. Reading an amount without that field is
- * reading a number with no unit.
- *
- * It is a string rather than a JSON number because a JSON number is a float in most parsers,
- * and a float loses precision on the first arithmetic. Nothing on this platform puts an amount
- * through a float.
- */
-export type Money = string;
-/**
- * One item of a quoted renewal.
- */
-export interface QuoteRenewalItem {
-    subscription_item_id: string;
-    plan_id: string;
-    plan_name: string;
-    /** The price the item is charged under. */
-    price_id: string;
-    /** The price of the periods for this item before the account's discounts. */
-    amount: Money;
-}
-/**
- * What renewing one subscription would charge as part of the quoted renewal order.
- */
-export interface QuoteRenewalResult {
-    /** Which renewal of the request this answers. */
-    index: number;
-    subscription_id: string;
-    /** Each item the renewal covers, with the price it is charged under. */
-    items: QuoteRenewalItem[];
-    interval: QuoteRenewalResultInterval;
-    interval_count: number;
-    periods: number;
-    /** The price of the periods for every item before the account's discounts, with any discount the items carry already reflected; includes tax only where the price does. */
-    amount: Money;
-    /** The reduction from a discount the account holds. */
-    discount_amount: Money;
-    /** Tax on the discounted amount. */
-    tax_amount: Money;
-    /** The part of `tax_amount` already contained in `amount`. */
-    tax_included_amount: Money;
-    /**
-     * What renewing would charge: `amount` less `discount_amount`, plus `tax_amount`, less
-     * `tax_included_amount`.
-     */
-    total: Money;
-}
-/**
- * The billing period of a recurring licensed line; `none` otherwise.
- */
-export type QuoteItemInterval = (typeof QuoteItemInterval)[keyof typeof QuoteItemInterval];
-export declare const QuoteItemInterval: {
-    readonly none: "none";
-    readonly day: "day";
-    readonly month: "month";
-    readonly year: "year";
-};
-/**
- * The dimension values the line is priced at.
- */
-export type QuoteItemDimensions = {
-    [key: string]: string;
-};
-/**
- * The platform service's fixed identifier, such as compute, canopy or assistant.
- * @minLength 1
- * @maxLength 64
- * @pattern ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
- */
-export type ProductId = string;
-/**
- * `one_time` charges once when bought. `recurring` charges again for every period, or for usage as it is settled.
- */
-export type PriceType = (typeof PriceType)[keyof typeof PriceType];
-export declare const PriceType: {
-    readonly one_time: "one_time";
-    readonly recurring: "recurring";
-};
-/**
- * `licensed` charges for the quantity bought, each period paid before it starts. `metered` charges for the usage
- * reported, after it is settled; a metered subscription lasts until it is canceled. A one-time price is licensed.
- */
-export type UsageType = (typeof UsageType)[keyof typeof UsageType];
-export declare const UsageType: {
-    readonly licensed: "licensed";
-    readonly metered: "metered";
-};
-/**
- * What an immediate downgrade would refund, estimated as of `proration_date`. The refund itself is determined when the change takes effect.
- */
-export interface QuoteDowngradeRefund {
-    /** Returned to the original payment sources, tax paid on it included. */
-    refundable_amount: Money;
-    /** Before tax, the part of the excess that the item's refund terms do not return. */
-    forfeited_amount: Money;
-}
-/**
- * One fully calculated purchase line. An item with no immediate charge, such as a metered purchase, has zero checkout amounts.
- */
-export interface QuoteItem {
-    tax_amount: Money;
-    tax_included_amount: Money;
-    /**
-     * The zero-based index of the item or change in the request, or the item's position for a Checkout Session quote.
-     * @minimum 0
-     */
-    index: number;
-    /**
-     * The subscription the line belongs to when it changes an item or is added to an existing subscription; null when it opens a new one.
-     * @nullable
-     */
-    subscription_id: string | null;
-    /**
-     * The subscription item changed; null for a new line.
-     * @nullable
-     */
-    subscription_item_id: string | null;
-    product_id: ProductId;
-    plan_id: string;
-    /** The selected price, also when the request identified it indirectly. */
-    price_id: string;
-    plan_name: string;
-    type: PriceType;
-    usage_type: UsageType;
-    /** The billing period of a recurring licensed line; `none` otherwise. */
-    interval: QuoteItemInterval;
-    /**
-     * Periods per billing cycle of a recurring licensed line; null otherwise.
-     * @minimum 1
-     * @nullable
-     */
-    interval_count: number | null;
-    /** The dimension values the line is priced at. */
-    dimensions: QuoteItemDimensions;
-    /** The setup charge already included in `amount`; null when none applies. */
-    setup_amount: Money | null;
-    /** Recurring licensed lines only; null otherwise. What each later period renews at, before discounts and tax, which differs from `amount` when the first period is priced differently. `discount` says whether its discount continues on renewals. */
-    recurring_amount: Money | null;
-    /** Unit price before discounts. Null when no single unit price applies, such as tiered or multiple-rate pricing. */
-    unit_amount: Money | null;
-    /** The quantity priced. */
-    quantity: string;
-    /** Amount before discounts and including any setup charge. */
-    amount: Money;
-    discount_amount: Money;
-    /** Immediate changes only; null otherwise. Before tax, the new terms for the time from `proration_date` to the end of the paid period. An upgrade invoices `remaining_amount` minus `unused_amount`. */
-    remaining_amount: Money | null;
-    /** Immediate changes only; null otherwise. Before tax, for an upgrade or an unchanged period price, the amount paid for that time, up to the new terms' value for the same time; for a downgrade, the remaining value of what was paid, under the refund terms of each paid period. */
-    unused_amount: Money | null;
-    /** Immediate downgrades only, when `unused_amount` exceeds `remaining_amount`; null otherwise. */
-    downgrade_refund: QuoteDowngradeRefund | null;
-    total: Money;
-    currency: string;
-}
-/**
- * `complete`: tax is calculated for the billing account's invoice contact, or for `address` without an account. `requires_location_inputs`: a quote without an account or `address`, which leaves out tax that would be added; tax already contained in a price is included.
- */
-export type QuoteTaxStatus = (typeof QuoteTaxStatus)[keyof typeof QuoteTaxStatus];
-export declare const QuoteTaxStatus: {
-    readonly complete: "complete";
-    readonly requires_location_inputs: "requires_location_inputs";
-};
-/**
- * Account funding for this purchase, calculated by Billing. Amounts use the enclosing response currency.
- * Credit eligibility and all purchase requirements are already evaluated. Nothing is charged or reserved.
- * A licensed purchase may instead be paid with an online payment method.
- */
-export interface Funds {
-    /** Spendable balance after pending returns. */
-    available_balance_amount: Money;
-    /** Currently effective credits eligible for the quoted purchases or metered usage. Each grant is counted once. */
-    usable_credit_amount: Money;
-    /** Currently effective credits that cannot fund any quoted purchase or metered target. Unused eligible credits are not restricted. */
-    restricted_credit_amount: Money;
-    /** Minimum spendable balance needed after eligible credits, covering immediate charges and every new metered purchase's admission requirement. */
-    required_balance_amount: Money;
-    /** Additional balance needed now. Zero means account funds satisfy this quote. No funds are reserved. */
-    balance_shortfall_amount: Money;
-    /** Minimum recharge that covers the shortfall, respecting the currency minimum recharge and currency precision. Zero when no additional balance is needed. */
-    required_top_up_amount: Money;
-}
-export type QuotedDiscountType = (typeof QuotedDiscountType)[keyof typeof QuotedDiscountType];
-export declare const QuotedDiscountType: {
-    readonly promotion_code: "promotion_code";
-    readonly account_discount: "account_discount";
-};
-/**
- * Whether the discount continues on renewals of what is bought: `once` applies only to this purchase, `recurring` for `frequency_duration` periods including the first, `forever` on every renewal.
- */
-export type QuotedDiscountFrequency = (typeof QuotedDiscountFrequency)[keyof typeof QuotedDiscountFrequency];
-export declare const QuotedDiscountFrequency: {
-    readonly once: "once";
-    readonly recurring: "recurring";
-    readonly forever: "forever";
-};
-/**
- * `confirmed`: every condition of the discount holds for the billing account. `unverified`: a quote without an account, where conditions that depend on the account, such as a first purchase or a per-account limit, are checked only when a Checkout Session is completed.
- */
-export type QuotedDiscountEligibility = (typeof QuotedDiscountEligibility)[keyof typeof QuotedDiscountEligibility];
-export declare const QuotedDiscountEligibility: {
-    readonly confirmed: "confirmed";
-    readonly unverified: "unverified";
-};
-/**
- * The discount selected for this calculation, not applied and not reserved. Amounts are on the quote and its lines.
- */
-export interface QuotedDiscount {
-    type: QuotedDiscountType;
-    name: string;
-    /**
-     * Code text for a promotion_code discount; null for an account_discount.
-     * @minLength 1
-     * @maxLength 64
-     * @nullable
-     */
-    promotion_code: string | null;
-    /** Whether the discount continues on renewals of what is bought: `once` applies only to this purchase, `recurring` for `frequency_duration` periods including the first, `forever` on every renewal. */
-    frequency: QuotedDiscountFrequency;
-    /**
-     * For `recurring`, the periods the discount lasts; null otherwise.
-     * @minimum 1
-     * @nullable
-     */
-    frequency_duration: number | null;
-    /** `confirmed`: every condition of the discount holds for the billing account. `unverified`: a quote without an account, where conditions that depend on the account, such as a first purchase or a per-account limit, are checked only when a Checkout Session is completed. */
-    eligibility: QuotedDiscountEligibility;
-}
-/**
- * A complete calculation in `currency`; nothing is saved or reserved. The request fails if any item cannot be priced. A Checkout Session quote gives what completing the session would invoice.
- */
-export interface Quote {
-    /** Account funds for the quoted purchase. Null without an account. */
-    funds: Funds | null;
-    subtotal: Money;
-    discount_amount: Money;
-    tax_amount: Money;
-    /** The discount a purchase would get, not yet applied. Null when there is none, and for renewals. */
-    discount: QuotedDiscount | null;
-    items: QuoteItem[];
-    renewals: QuoteRenewalResult[];
-    total: Money;
-    currency: string;
-    /**
-     * Immediate changes and items added to an existing subscription only; null otherwise. The instant they are priced from; pass it when confirming the Checkout Session so it is priced from the same instant.
-     * @nullable
-     */
-    proration_date: string | null;
-    /** `complete`: tax is calculated for the billing account's invoice contact, or for `address` without an account. `requires_location_inputs`: a quote without an account or `address`, which leaves out tax that would be added; tax already contained in a price is included. */
-    tax_status: QuoteTaxStatus;
-}
 /**
  * One subscription item to end, each at most once.
  */
@@ -365,6 +78,18 @@ export interface CancellationPreviewRequest {
     items: CancellationItemInput[];
     mode: CancellationMode;
 }
+/**
+ * A decimal string, in the currency stated alongside it.
+ *
+ * **The currency is not part of this type.** It is carried by a `currency` field next to the
+ * amount, or by the account the amount belongs to. Reading an amount without that field is
+ * reading a number with no unit.
+ *
+ * It is a string rather than a JSON number because a JSON number is a float in most parsers,
+ * and a float loses precision on the first arithmetic. Nothing on this platform puts an amount
+ * through a float.
+ */
+export type Money = string;
 /**
  * Which object this is, together with what a person currently calls it.
  *
@@ -380,6 +105,23 @@ export interface NamedIdentity {
     /** @maxLength 255 */
     name: string;
 }
+/**
+ * `one_time` charges once when bought. `recurring` charges again for every period, or for usage as it is settled.
+ */
+export type PriceType = (typeof PriceType)[keyof typeof PriceType];
+export declare const PriceType: {
+    readonly one_time: "one_time";
+    readonly recurring: "recurring";
+};
+/**
+ * `licensed` charges for the quantity bought, each period paid before it starts. `metered` charges for the usage
+ * reported, after it is settled; a metered subscription lasts until it is canceled. A one-time price is licensed.
+ */
+export type UsageType = (typeof UsageType)[keyof typeof UsageType];
+export declare const UsageType: {
+    readonly licensed: "licensed";
+    readonly metered: "metered";
+};
 /**
  * One subscription item of the previewed cancellation.
  */
@@ -647,6 +389,13 @@ export interface ErrorStatus {
 export interface Error {
     error: ErrorStatus;
 }
+/**
+ * The platform service's fixed identifier, such as compute, canopy or assistant.
+ * @minLength 1
+ * @maxLength 64
+ * @pattern ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
+ */
+export type ProductId = string;
 export interface Product {
     id: ProductId;
     name: string;
@@ -1133,6 +882,25 @@ export interface PaymentPreviewInvoice {
     credit_applied: Money;
     balance_applied: Money;
 }
+/**
+ * Account funding for this purchase, calculated by Billing. Amounts use the enclosing response currency.
+ * Credit eligibility and all purchase requirements are already evaluated. Nothing is charged or reserved.
+ * A licensed purchase may instead be paid with an online payment method.
+ */
+export interface Funds {
+    /** Spendable balance after pending returns. */
+    available_balance_amount: Money;
+    /** Currently effective credits eligible for the purchases being checked out or metered usage. Each grant is counted once. */
+    usable_credit_amount: Money;
+    /** Currently effective credits that cannot fund any purchase being checked out or metered target. Unused eligible credits are not restricted. */
+    restricted_credit_amount: Money;
+    /** Minimum spendable balance needed after eligible credits, covering immediate charges and every new metered purchase's admission requirement. */
+    required_balance_amount: Money;
+    /** Additional balance needed now. Zero means account funds satisfy this purchase. No funds are reserved. */
+    balance_shortfall_amount: Money;
+    /** Minimum recharge that covers the shortfall, respecting the currency minimum recharge and currency precision. Zero when no additional balance is needed. */
+    required_top_up_amount: Money;
+}
 /**
  * What paying would take, calculated as paying does. Nothing is charged or reserved.
  */
@@ -1655,7 +1423,7 @@ export interface UsageChargeList {
     pagination: OffsetPagination;
 }
 /**
- * `pending`: the order has not been accepted. `provisioning`: the owning service accepted the order and is delivering. `active`: delivery was confirmed; payment alone does not make a subscription active. `trialing`: in a free trial, in service and not charged until `trial_end`. `suspended`: service is stopped while a lien restricts its use. `canceled`: cancellation of every item completed, or an undelivered purchase was canceled or failed. `terminated`: an operator or the owning service ended it immediately.
+ * `pending`: the order has not been accepted. `provisioning`: the owning service accepted the order and is delivering. `active`: delivery was confirmed; payment alone does not make a subscription active. `trialing`: in a free trial, in service, with its licensed items not charged until `trial_end`; metered usage is charged as usual. `suspended`: service is stopped while a lien restricts its use. `canceled`: cancellation of every item completed, or an undelivered purchase was canceled or failed. `terminated`: an operator or the owning service ended it immediately.
  */
 export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus];
 export declare const SubscriptionStatus: {
@@ -1853,7 +1621,7 @@ export interface Subscription {
     /** Whether the subscription renews automatically, or converts to paid when its free trial ends. Without licensed items it continues until it is canceled; then this is true until a cancellation is requested, and cannot be set. */
     auto_renew: boolean;
     /**
-     * Start of the free trial; null without one.
+     * Start of the free trial; null without one. During the trial the licensed items are free, while metered usage is charged as usual.
      * @nullable
      */
     trial_start?: string | null;
@@ -1980,7 +1748,9 @@ export interface SubscriptionUpdate {
     auto_renew?: boolean;
 }
 /**
- * `open`: waiting for you to complete checkout; nothing is ordered, invoiced or reserved. `complete`: the order and its issued invoice exist; read the order for payment and delivery. `expired`: ended without an order.
+ * "`open`: waiting for you to complete checkout; nothing is ordered, invoiced or reserved. `complete`:
+ * the order and its issued invoice exist; read the order for payment and delivery. `expired`: ended without an
+ * order."
  */
 export type CheckoutSessionStatus = (typeof CheckoutSessionStatus)[keyof typeof CheckoutSessionStatus];
 export declare const CheckoutSessionStatus: {
@@ -1989,7 +1759,8 @@ export declare const CheckoutSessionStatus: {
     readonly expired: "expired";
 };
 /**
- * `new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or billing terms.
+ * "`new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or
+ * billing terms."
  */
 export type CheckoutSessionType = (typeof CheckoutSessionType)[keyof typeof CheckoutSessionType];
 export declare const CheckoutSessionType: {
@@ -2007,9 +1778,19 @@ export declare const CheckoutSessionChangeEffective: {
     readonly period_end: "period_end";
 };
 /**
- * automatic completes checkout with the purchase: the best applicable account discount is applied, and the
- * order is created with its invoice issued and paid from eligible credit grants and available balance.
- * Insufficient funds fail the purchase with HTTP 422 BILLING_INSUFFICIENT_FUNDS; no Billing order, charge or
+ * "`complete`: tax is calculated for the billing account's invoice contact, or for `address` in a preview
+ * without an account. `requires_location_inputs`: a preview without an account or `address`, which leaves out
+ * tax that would be added; tax already contained in a price is included."
+ */
+export type CheckoutSessionTaxStatus = (typeof CheckoutSessionTaxStatus)[keyof typeof CheckoutSessionTaxStatus];
+export declare const CheckoutSessionTaxStatus: {
+    readonly complete: "complete";
+    readonly requires_location_inputs: "requires_location_inputs";
+};
+/**
+ * automatic completes checkout with the purchase: the best applicable account discount is applied, and the
+ * order is created with its invoice issued and paid from eligible credit grants and available balance.
+ * Insufficient funds fail the purchase with HTTP 422 BILLING_INSUFFICIENT_FUNDS; no Billing order, charge or
  * discount redemption is committed.
  * deferred creates an open Billing Checkout Session and charges nothing, even for a zero total. The customer
  * completes it through Billing, where a promotion code can be applied, and then pays the issued invoice; a
@@ -2045,114 +1826,627 @@ export interface CheckoutOptions {
     return_url?: string;
     /**
      * Turns on automatic renewal of every subscription with licensed items that the purchase opens. Off
-     * when omitted. It must be the customer's own choice.
+     * when omitted. It must be the customer's own choice. For a free trial, it converts the trial to paid
+     * when the trial ends.
+     */
+    auto_renew?: boolean;
+    /**
+     * A free trial grant of the paying billing account that the customer chose to use. The first new
+     * subscription of the purchase whose lines the grant's offer all covers, and that has a licensed line and
+     * no trial of its own, opens with the offer's free trial. Accepted only in automatic mode; with deferred it is refused with
+     * HTTP 400, and the grant is chosen when completing the checkout through Billing. Refused with
+     * BILLING_TRIAL_GRANT_INAPPLICABLE when no subscription qualifies or the grant cannot be used now.
+     */
+    trial_grant_id?: string;
+}
+export type CheckoutSessionDiscountType = (typeof CheckoutSessionDiscountType)[keyof typeof CheckoutSessionDiscountType];
+export declare const CheckoutSessionDiscountType: {
+    readonly promotion_code: "promotion_code";
+    readonly account_discount: "account_discount";
+};
+/**
+ * "Whether the discount continues on renewals of what is bought: `once` applies only to this
+ * purchase, `recurring` for `frequency_duration` periods including the first, `forever` on every renewal."
+ */
+export type CheckoutSessionDiscountFrequency = (typeof CheckoutSessionDiscountFrequency)[keyof typeof CheckoutSessionDiscountFrequency];
+export declare const CheckoutSessionDiscountFrequency: {
+    readonly once: "once";
+    readonly recurring: "recurring";
+    readonly forever: "forever";
+};
+/**
+ * "`confirmed`: every condition of the discount holds for the billing account. `unverified`: a preview
+ * without an account, where conditions that depend on the account, such as a first purchase or a per-account
+ * limit, are checked only when a session is completed."
+ */
+export type CheckoutSessionDiscountEligibility = (typeof CheckoutSessionDiscountEligibility)[keyof typeof CheckoutSessionDiscountEligibility];
+export declare const CheckoutSessionDiscountEligibility: {
+    readonly confirmed: "confirmed";
+    readonly unverified: "unverified";
+};
+/**
+ * The discount a session gets. It is redeemed only when the session completes.
+ */
+export interface CheckoutSessionDiscount {
+    type: CheckoutSessionDiscountType;
+    name: string;
+    /**
+     * Code text for a promotion_code discount; null for an account_discount.
+     * @minLength 1
+     * @maxLength 64
+     * @nullable
+     */
+    promotion_code: string | null;
+    /**
+     * "Whether the discount continues on renewals of what is bought: `once` applies only to this
+     * purchase, `recurring` for `frequency_duration` periods including the first, `forever` on every renewal."
+     */
+    frequency: CheckoutSessionDiscountFrequency;
+    /**
+     * For `recurring`, the periods the discount lasts; null otherwise.
+     * @minimum 1
+     * @nullable
+     */
+    frequency_duration: number | null;
+    /**
+     * "`confirmed`: every condition of the discount holds for the billing account. `unverified`: a preview
+     * without an account, where conditions that depend on the account, such as a first purchase or a per-account
+     * limit, are checked only when a session is completed."
+     */
+    eligibility: CheckoutSessionDiscountEligibility;
+}
+/**
+ * The terms of a free trial. The licensed items of the subscription it is used for are free for `trial_period_days`, while metered usage is charged as usual. When the trial ends it converts to paid if automatic renewal is on; otherwise `trial_settings` applies.
+ */
+export interface TrialOffer {
+    id: string;
+    name: string;
+    description: string;
+    /**
+     * @minimum 1
+     * @maximum 730
+     */
+    trial_period_days: number;
+    trial_settings: TrialSettings;
+    /** The purchases it can be used for. Every line of the subscription must be covered. */
+    applies_to: Applicability;
+}
+/**
+ * `scheduled` before valid_from, `available` to be chosen at checkout, `redeemed` once used for a subscription, `expired` after valid_until without being used, or `voided` once withdrawn.
+ */
+export type TrialGrantStatus = (typeof TrialGrantStatus)[keyof typeof TrialGrantStatus];
+export declare const TrialGrantStatus: {
+    readonly scheduled: "scheduled";
+    readonly available: "available";
+    readonly redeemed: "redeemed";
+    readonly expired: "expired";
+    readonly voided: "voided";
+};
+/**
+ * One free trial held by a billing account for a period. It is used for one subscription; if the order it was used for is canceled or fails, it can be used again while it is valid.
+ */
+export interface TrialGrant {
+    id: string;
+    billing_account_id: number;
+    trial_offer: TrialOffer;
+    status: TrialGrantStatus;
+    valid_from: string;
+    /**
+     * Null when the grant does not expire.
+     * @nullable
+     */
+    valid_until: string | null;
+    /** @nullable */
+    voided_at: string | null;
+    /**
+     * The order the grant was used for; null until it is used.
+     * @nullable
+     */
+    order_id: string | null;
+    /**
+     * The subscription the grant was used for; null until it is used.
+     * @nullable
+     */
+    subscription_id: string | null;
+    /** @nullable */
+    redeemed_at: string | null;
+}
+/**
+ * Settings of a subscription a purchase opens, as Stripe Checkout's subscription_data.
+ */
+export interface SubscriptionData {
+    /**
+     * A free trial of this many days; null without one or when given as `trial_end`.
+     * @minimum 1
+     * @maximum 730
+     * @nullable
+     */
+    trial_period_days: number | null;
+    /**
+     * The end of the free trial; null without one or when given in days.
+     * @nullable
+     */
+    trial_end: string | null;
+    /** How the free trial ends; null without a trial. */
+    trial_settings: TrialSettings | null;
+}
+/**
+ * A free trial a subscription opens with. Its licensed items are free until `trial_end`; metered usage is
+ * charged as usual. For an open session the times are as if it were completed now.
+ */
+export interface CheckoutSessionTrial {
+    trial_start: string;
+    trial_end: string;
+    trial_settings: TrialSettings;
+}
+/**
+ * The term every item of the subscription renews for, for renewals; `none` otherwise.
+ */
+export type CheckoutSessionSubscriptionInterval = (typeof CheckoutSessionSubscriptionInterval)[keyof typeof CheckoutSessionSubscriptionInterval];
+export declare const CheckoutSessionSubscriptionInterval: {
+    readonly none: "none";
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * The billing period of a recurring licensed price; `none` otherwise, and when `price_id` is null.
+ */
+export type CheckoutSessionItemInterval = (typeof CheckoutSessionItemInterval)[keyof typeof CheckoutSessionItemInterval];
+export declare const CheckoutSessionItemInterval: {
+    readonly none: "none";
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * What an immediate downgrade would refund, estimated as of `proration_date`. The refund itself is determined
+ * when the change takes effect.
+ */
+export interface CheckoutSessionItemDowngradeRefund {
+    /** Returned to the original payment sources, tax paid on it included. */
+    refundable_amount: Money;
+    /** Before tax, the part of the excess that the item's refund terms do not return. */
+    forfeited_amount: Money;
+}
+/**
+ * The dimension values of what is bought, such as region and instance type.
+ */
+export type CheckoutSessionItemDimensions = {
+    [key: string]: string;
+};
+/**
+ * One item of the session; it becomes the order item at the same position. Its price is selected as when
+ * checkout completes, and amounts are this item's share of the session's.
+ */
+export interface CheckoutSessionItem {
+    /**
+     * Counted across the session's subscriptions in order, starting from zero.
+     * @minimum 0
+     */
+    position: number;
+    /**
+     * The subscription item changed or renewed. Null for an item the purchase adds.
+     * @nullable
+     */
+    subscription_item_id: string | null;
+    product_id: ProductId;
+    plan_id: string;
+    plan_name: string;
+    /**
+     * The price the item is charged under: the one it named, or the one selected by billing terms or from the
+     * subscription item changed or renewed. Null for an expired session whose item did not name one.
+     * @nullable
+     */
+    price_id: string | null;
+    /** The price type; null when `price_id` is. */
+    type: PriceType | null;
+    /** The usage type; null when `price_id` is. */
+    usage_type: UsageType | null;
+    /** The billing period of a recurring licensed price; `none` otherwise, and when `price_id` is null. */
+    interval: CheckoutSessionItemInterval;
+    /**
+     * Periods per billing cycle of a recurring licensed price; null otherwise.
+     * @minimum 1
+     * @nullable
+     */
+    interval_count: number | null;
+    quantity: string;
+    /** The dimension values of what is bought, such as region and instance type. */
+    dimensions: CheckoutSessionItemDimensions;
+    /**
+     * Renewals only; null otherwise. How many consecutive periods are renewed.
+     * @minimum 1
+     * @nullable
+     */
+    periods: number | null;
+    /** Unit price before discounts. Null when no single unit price applies, such as tiered or multiple-rate pricing. */
+    unit_amount: Money | null;
+    /** The setup charge already included in `amount`; null when none applies. */
+    setup_amount: Money | null;
+    /**
+     * Recurring licensed items only; null otherwise. What each later period renews at, before discounts and
+     * tax, which differs from `amount` when the first period is priced differently, such as in a free trial. The
+     * session's `discount` says whether its discount continues on renewals.
+     */
+    recurring_amount: Money | null;
+    /** Amount before discounts, including any setup charge. */
+    amount: Money | null;
+    /** Total reduction on this item, including any continuing renewal discount. */
+    discount_amount: Money | null;
+    /** Tax on the discounted amount, including any tax already contained in that amount. */
+    tax_amount: Money | null;
+    /** The part of tax_amount already contained in amount minus discount_amount. */
+    tax_included_amount: Money | null;
+    /** amount minus discount_amount plus tax_amount minus tax_included_amount. */
+    total: Money | null;
+    /**
+     * Immediate changes only; null otherwise. Before tax, the new terms for the time from `proration_date` to
+     * the end of the paid period. An upgrade invoices `remaining_amount` minus `unused_amount`.
+     */
+    remaining_amount: Money | null;
+    /**
+     * Immediate changes only; null otherwise. Before tax, for an upgrade or an unchanged period price, the
+     * amount paid for that time, up to the new terms' value for the same time; for a downgrade, the remaining value
+     * of what was paid, under the refund terms of each paid period.
+     */
+    unused_amount: Money | null;
+    /** Immediate downgrades only, when `unused_amount` exceeds `remaining_amount`; null otherwise. */
+    downgrade_refund: CheckoutSessionItemDowngradeRefund | null;
+}
+/**
+ * One subscription of the session and its items, with its share of the session's amounts.
+ */
+export interface CheckoutSessionSubscription {
+    /**
+     * The existing subscription renewed or changed, or that new items are added to. Null for a subscription the purchase opens.
+     * @nullable
+     */
+    subscription_id: string | null;
+    /** The settings the owning service gave a subscription the purchase opens; null without any. */
+    subscription_data: SubscriptionData | null;
+    /**
+     * The free trial grant this subscription uses, saved on an open session or used by a complete one; null otherwise.
+     * @nullable
+     */
+    trial_grant_id: string | null;
+    /** The free trial the subscription opens with, from `subscription_data` or the trial grant. Null without one, and for an expired session. */
+    trial: CheckoutSessionTrial | null;
+    /** The term every item of the subscription renews for, for renewals; `none` otherwise. */
+    interval: CheckoutSessionSubscriptionInterval;
+    /**
+     * Renewals only; null otherwise.
+     * @minimum 1
+     * @nullable
+     */
+    interval_count: number | null;
+    /**
+     * Renewals only; null otherwise. How many consecutive terms are renewed.
+     * @minimum 1
+     * @nullable
+     */
+    periods: number | null;
+    /** The items' amounts before discounts, including any setup charge. */
+    amount: Money | null;
+    discount_amount: Money | null;
+    /** Tax on the discounted amount, including any tax already contained in it. */
+    tax_amount: Money | null;
+    /** The part of `tax_amount` already contained in `amount` minus `discount_amount`. */
+    tax_included_amount: Money | null;
+    /** amount minus discount_amount plus tax_amount minus tax_included_amount; this subscription's share of the session's `total`. */
+    total: Money | null;
+    /** The subscription's items, in order. */
+    items: CheckoutSessionItem[];
+}
+/**
+ * A purchase, a change of subscriptions or their renewal, waiting for checkout to be completed, and what
+ * completing it invoices. Completing it applies the choices saved on it and creates the order with its invoice
+ * issued; the order carries the session's ID. A preview returns the same object without saving it.
+ *
+ * Amounts are what completing an open session would invoice at the time it is read, and for a complete session
+ * those of its order's invoice. An expired session has no amounts; they are null.
+ */
+export interface CheckoutSession {
+    /**
+     * Null in a preview.
+     * @nullable
+     */
+    id: string | null;
+    product_id: ProductId;
+    /**
+     * Null in a preview without an account.
+     * @nullable
+     */
+    billing_account_id: number | null;
+    /** Null in a preview without an account. */
+    account: AccountIdentity | null;
+    /**
+     * The project the purchase is for. Null for an account-level purchase, such as a membership, and in a preview.
+     * @nullable
+     */
+    project_id: string | null;
+    /**
+     * The project and its current name. Null when `project_id` is, or when the project cannot be read;
+     * `project_id` still identifies it.
+     */
+    project: NamedIdentity | null;
+    /**
+     * "`new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or
+     * billing terms."
+     */
+    type: CheckoutSessionType;
+    /** When a change takes effect, as on the order it creates; `none` for anything that is not a change. */
+    change_effective: CheckoutSessionChangeEffective;
+    /** `open` in a preview. */
+    status: CheckoutSessionStatus;
+    currency: string;
+    /**
+     * The checkout choices, as the purchase gave them and as you saved them since. Billing does not check
+     * `return_url`; validate it before navigating.
+     */
+    checkout: CheckoutOptions;
+    /**
+     * The promotion code saved on the session, or used to complete it; null without one.
+     * @nullable
+     */
+    promotion_code: string | null;
+    /** The discount the session gets, from its promotion code or otherwise the best applicable account discount. Null when there is none, and for an expired session. */
+    discount: CheckoutSessionDiscount | null;
+    /** Sum before discounts, excluding tax already included in the item amounts. */
+    subtotal: Money | null;
+    /** Total item discounts. */
+    discount_amount: Money | null;
+    /** Total tax on the discounted amounts. */
+    tax_amount: Money | null;
+    /** subtotal minus discount_amount plus tax_amount, before credit grants and balance. Confirm an open session with it as `expected_amount`. */
+    total: Money | null;
+    /**
+     * "`complete`: tax is calculated for the billing account's invoice contact, or for `address` in a preview
+     * without an account. `requires_location_inputs`: a preview without an account or `address`, which leaves out
+     * tax that would be added; tax already contained in a price is included."
+     */
+    tax_status: CheckoutSessionTaxStatus;
+    /**
+     * Immediate changes and items added to an existing subscription of an open session only; null otherwise.
+     * The instant they are priced from; confirm the session with it so it is priced from the same instant.
+     * @nullable
+     */
+    proration_date: string | null;
+    /** Account funds for completing an open session; null for other sessions and without an account. */
+    funds: Funds | null;
+    /**
+     * The free trial grants of the account that the session can use now, soonest to expire first. Empty for a
+     * session that is not open, without an account, and for changes and renewals.
+     */
+    trial_grants: TrialGrant[];
+    /**
+     * When an open session expires; null in a preview. The order a complete session created has its own payment deadline.
+     * @nullable
+     */
+    expires_at: string | null;
+    /**
+     * Null in a preview.
+     * @nullable
+     */
+    created_at: string | null;
+    /** @nullable */
+    completed_at: string | null;
+    /** @nullable */
+    expired_at: string | null;
+    /**
+     * The order created when the session completed. Null otherwise.
+     * @nullable
+     */
+    order_id: string | null;
+    /** The subscriptions the session buys, renews or changes, in order, each with its items. */
+    subscriptions: CheckoutSessionSubscription[];
+}
+export interface CheckoutSessionList {
+    items: CheckoutSession[];
+    pagination: OffsetPagination;
+}
+/**
+ * Settings of a subscription a previewed purchase opens, as the owning service would give them.
+ */
+export interface SubscriptionDataInput {
+    /**
+     * Give this or `trial_end`, not both.
+     * @minimum 1
+     * @maximum 730
+     */
+    trial_period_days?: number;
+    trial_end?: string;
+    trial_settings?: TrialSettings;
+}
+/**
+ * `new` previews a purchase, `modify` a change of subscription items, `renew` a renewal.
+ */
+export type CheckoutSessionPreviewRequestType = (typeof CheckoutSessionPreviewRequestType)[keyof typeof CheckoutSessionPreviewRequestType];
+export declare const CheckoutSessionPreviewRequestType: {
+    readonly new: "new";
+    readonly renew: "renew";
+    readonly modify: "modify";
+};
+/**
+ * For `modify` only; defaults to `immediate`. `immediate` prices the rest of the paid period from
+ * `proration_date`, charging an upgrade the difference and showing what a downgrade refunds. `period_end`
+ * prices the first period at the new terms, which replaces the renewal when the paid period ends.
+ */
+export type CheckoutSessionPreviewRequestChangeEffective = (typeof CheckoutSessionPreviewRequestChangeEffective)[keyof typeof CheckoutSessionPreviewRequestChangeEffective];
+export declare const CheckoutSessionPreviewRequestChangeEffective: {
+    readonly immediate: "immediate";
+    readonly period_end: "period_end";
+};
+/**
+ * For `renew` only, as in creating a renewal Checkout Session.
+ */
+export type CheckoutSessionPreviewRequestInterval = (typeof CheckoutSessionPreviewRequestInterval)[keyof typeof CheckoutSessionPreviewRequestInterval];
+export declare const CheckoutSessionPreviewRequestInterval: {
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * Where a customer is, for the tax that would be added there.
+ */
+export interface CustomerAddress {
+    /**
+     * ISO 3166-1 alpha-2, two uppercase letters.
+     * @pattern ^[A-Z]{2}$
+     */
+    country: string;
+    /**
+     * The state or province, as the tax rates name it.
+     * @minLength 1
+     * @maxLength 128
+     */
+    state?: string;
+}
+export type CheckoutSessionItemInputInterval = (typeof CheckoutSessionItemInputInterval)[keyof typeof CheckoutSessionItemInputInterval];
+export declare const CheckoutSessionItemInputInterval: {
+    readonly none: "none";
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * The dimension values of what is bought, such as region and instance type, or after a change, given in full. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused with `BILLING_PRICE_UNAVAILABLE` rather than priced at zero. Prices are set per currency, and a currency may not offer some combinations at all, for example in a region it does not sell to.
+ */
+export type CheckoutSessionItemInputDimensions = {
+    [key: string]: string;
+};
+/**
+ * Identify a price, or select one for a plan; give each resource's ID or lookup key, never both, and
+ * product_id with lookup keys. A change names its `subscription_item_id`; without a price or billing terms the
+ * plan's price with the item's price type, usage type, interval, interval count and cancellation policy is
+ * selected, and omitted dimensions keep the item's. A metered item includes only any setup charge; its usage is
+ * estimated with `estimate-usage`.
+ */
+export interface CheckoutSessionItemInput {
+    /** For `modify` only. The subscription item changed. */
+    subscription_item_id?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    price_lookup_key?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    plan_lookup_key?: string;
+    price_id?: string;
+    product_id?: ProductId;
+    plan_id?: string;
+    /** Narrows the selection when a plan offers more than one price type. */
+    price_type?: PriceType;
+    /** Narrows the selection when a plan offers more than one usage type. */
+    usage_type?: UsageType;
+    interval?: CheckoutSessionItemInputInterval;
+    /** @minimum 1 */
+    interval_count?: number;
+    /** Selects among licensed prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily. */
+    cancellation_policy?: CancellationPolicy;
+    /**
+     * The quantity bought, or after a change.
+     * @pattern ^(?:(?:[1-9][0-9]{0,27}|0(?:[1-9][0-9]{0,26}|0(?:[1-9][0-9]{0,25}|0(?:[1-9][0-9]{0,24}|0(?:[1-9][0-9]{0,23}|0(?:[1-9][0-9]{0,22}|0(?:[1-9][0-9]{0,21}|0(?:[1-9][0-9]{0,20}|0(?:[1-9][0-9]{0,19}|0(?:[1-9][0-9]{0,18}|0(?:[1-9][0-9]{0,17}|0(?:[1-9][0-9]{0,16}|0(?:[1-9][0-9]{0,15}|0(?:[1-9][0-9]{0,14}|0(?:[1-9][0-9]{0,13}|0(?:[1-9][0-9]{0,12}|0(?:[1-9][0-9]{0,11}|0(?:[1-9][0-9]{0,10}|0(?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9])))))))))))))))))))))))))))([.][0-9]{1,10})?|0{1,28}[.](?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9]))))))))))$
+     */
+    quantity: string;
+    /** The dimension values of what is bought, such as region and instance type, or after a change, given in full. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused with `BILLING_PRICE_UNAVAILABLE` rather than priced at zero. Prices are set per currency, and a currency may not offer some combinations at all, for example in a region it does not sell to. */
+    dimensions?: CheckoutSessionItemInputDimensions;
+}
+/**
+ * One subscription of the previewed session. For `new`, give its items, with `subscription_id` to add them to
+ * that existing subscription and otherwise optionally `subscription_data`; for `modify`, the subscription and the
+ * items changed; for `renew`, only the subscription.
+ */
+export interface CheckoutSessionPreviewSubscription {
+    subscription_id?: string;
+    /**
+     * @minItems 1
+     * @maxItems 100
      */
-    auto_renew?: boolean;
+    items?: CheckoutSessionItemInput[];
+    subscription_data?: SubscriptionDataInput;
 }
 /**
- * One subscription of the session.
+ * The session to preview, as it would be created. Give exactly one of `billing_account_id` and `currency`;
+ * changes, renewals, items added to an existing subscription and trial grants need the account. A request that
+ * does not fit `type` fails with `BILLING_PURCHASE_INVALID` and the field.
  */
-export interface CheckoutSessionSubscription {
+export interface CheckoutSessionPreviewRequest {
+    /** `new` previews a purchase, `modify` a change of subscription items, `renew` a renewal. */
+    type: CheckoutSessionPreviewRequestType;
     /**
-     * The existing subscription renewed or changed, or that new items are added to. Null for a subscription the purchase opens.
-     * @nullable
+     * The billing account to price for; it must be yours or currently pay for a project you are a member of, and an access token is required. Subscriptions changed or renewed must currently be paid by it.
+     * @minimum 1
      */
-    subscription_id: string | null;
+    billing_account_id?: number;
     /**
-     * The free trial a subscription the purchase opens gets; null without one.
-     * @nullable
+     * For `new` only. The ISO 4217 currency to price in without an account.
+     * @minLength 3
+     * @maxLength 3
      */
-    trial_period_days: number | null;
+    currency?: string;
     /**
-     * The end of the free trial a subscription the purchase opens gets; null without one or when given in days.
-     * @nullable
+     * Only with `currency`. Where the customer is, to include the tax that would be added there for a customer
+     * who is not tax exempt; `tax_status` is then `complete`. Refused with `billing_account_id`, whose invoice
+     * contact decides tax.
      */
-    trial_end: string | null;
-}
-/**
- * A purchase waiting for you to complete checkout. Completing it applies the discount and creates the order with its invoice issued; the order carries the session's ID.
- */
-export interface CheckoutSession {
-    id: string;
-    product_id: ProductId;
-    billing_account_id: number;
-    account: AccountIdentity;
+    address?: CustomerAddress;
     /**
-     * The project the purchase is for. Null for an account-level purchase, such as a membership.
-     * @nullable
+     * For `modify` only; defaults to `immediate`. `immediate` prices the rest of the paid period from
+     * `proration_date`, charging an upgrade the difference and showing what a downgrade refunds. `period_end`
+     * prices the first period at the new terms, which replaces the renewal when the paid period ends.
      */
-    project_id: string | null;
-    /** The project and its current name. Null for an account-level purchase or when the project cannot be read; `project_id` still identifies it. */
-    project: NamedIdentity | null;
-    /** `new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or billing terms. */
-    type: CheckoutSessionType;
-    /** When a change takes effect, as on the order it creates; `none` for anything that is not a change. */
-    change_effective: CheckoutSessionChangeEffective;
-    status: CheckoutSessionStatus;
-    currency: string;
-    /** The checkout choices as the purchase gave them. Billing does not check `return_url`; validate it before navigating. */
-    checkout: CheckoutOptions;
-    /** When an open session expires. The order a complete session created has its own payment deadline. */
-    expires_at: string;
-    created_at: string;
-    /** @nullable */
-    completed_at: string | null;
-    /** @nullable */
-    expired_at: string | null;
+    change_effective?: CheckoutSessionPreviewRequestChangeEffective;
     /**
-     * The order created when the session completed. Null otherwise.
-     * @nullable
+     * At most 100 items in all for `new` and `modify`, and each subscription at most once for `renew`.
+     * @minItems 1
+     * @maxItems 100
      */
-    order_id: string | null;
-    /** The subscriptions the session buys, renews or changes, in order; each item names its entry in `subscription_index`. */
-    subscriptions: CheckoutSessionSubscription[];
-}
-export interface CheckoutSessionList {
-    items: CheckoutSession[];
-    pagination: OffsetPagination;
-}
-/**
- * The dimension values of what is bought, such as region and instance type.
- */
-export type CheckoutSessionItemDimensions = {
-    [key: string]: string;
-};
-/**
- * One item of the session. It becomes the order item at the same position; its price is chosen when checkout completes.
- */
-export interface CheckoutSessionItem {
-    /** @minimum 0 */
-    position: number;
-    plan_id: string;
-    plan_name: string;
+    subscriptions: CheckoutSessionPreviewSubscription[];
     /**
-     * The price the item named. Null when Billing selects it by billing terms or from the subscription being changed or renewed.
-     * @nullable
+     * For `renew` only, as in creating a renewal Checkout Session.
+     * @minimum 1
      */
-    price_id: string | null;
-    quantity: string;
-    /** The dimension values of what is bought, such as region and instance type. */
-    dimensions: CheckoutSessionItemDimensions;
+    periods?: number;
     /**
-     * The item's subscription, as its index in the session's `subscriptions`.
-     * @minimum 0
+     * For `renew` only, as in creating a renewal Checkout Session.
+     * @minimum 1
      */
-    subscription_index: number;
+    interval_count?: number;
+    /** For `renew` only, as in creating a renewal Checkout Session. */
+    interval?: CheckoutSessionPreviewRequestInterval;
+    /** For `renew` only, as in creating a renewal Checkout Session. */
+    cancellation_policy?: CancellationPolicy;
     /**
-     * The subscription item changed or renewed. Null for an item the purchase adds.
+     * For `new` and `modify`. Evaluated without being applied.
+     * @minLength 1
+     * @maxLength 64
+     */
+    promotion_code?: string;
+    /** For `new` with `billing_account_id`. A free trial grant of the account to preview the purchase with. */
+    trial_grant_id?: string;
+}
+/**
+ * Give at least one choice. Saving a choice equal to the current one changes nothing.
+ */
+export interface CheckoutSessionUpdate {
+    /**
+     * The promotion code to complete the session with; null removes it, and the best applicable account discount applies instead.
+     * @minLength 1
+     * @maxLength 64
      * @nullable
      */
-    subscription_item_id: string | null;
+    promotion_code?: string | null;
     /**
-     * Renewals only; null otherwise. How many consecutive periods are renewed.
-     * @minimum 1
+     * A free trial grant of the session's billing account to use; null removes it.
      * @nullable
      */
-    periods: number | null;
-}
-export interface CheckoutSessionItemList {
-    items: CheckoutSessionItem[];
-    pagination: OffsetPagination;
+    trial_grant_id?: string | null;
+    /** Turns on or off automatic renewal of every subscription with licensed items the session opens. It must be your own choice. */
+    auto_renew?: boolean;
 }
 /**
  * As in renewing.
@@ -2197,15 +2491,13 @@ export interface CheckoutSessionCreate {
     cancellation_policy?: CancellationPolicy;
 }
 export interface CheckoutSessionConfirm {
+    /** The session's `total` as read, after discounts and tax and before credit grants or balance. */
+    expected_amount: Money & string;
     /**
-     * As quoted. Omit to apply the best applicable account discount.
-     * @minLength 1
-     * @maxLength 64
+     * Immediate changes and items added to an existing subscription only. The session's `proration_date` as
+     * read; it must be a whole second, not in the future and at most 10 minutes old, otherwise the request is
+     * refused with `BILLING_CHANGE_INVALID`. Defaults to the time of the request.
      */
-    promotion_code?: string;
-    /** The quote's `total`, after discounts and tax and before credit grants or balance. */
-    expected_amount: Money & string;
-    /** Immediate changes only. The quote's `proration_date`; it must be a whole second, not in the future and at most 10 minutes old, otherwise the request is refused with `BILLING_CHANGE_INVALID`. Defaults to the time of the request. */
     proration_date?: string;
 }
 /**
@@ -2504,6 +2796,10 @@ export interface DiscountList {
     items: Discount[];
     pagination: OffsetPagination;
 }
+export interface TrialGrantList {
+    items: TrialGrant[];
+    pagination: OffsetPagination;
+}
 export interface OrderItemList {
     items: OrderItem[];
     pagination: OffsetPagination;
@@ -2762,52 +3058,6 @@ export interface PriceList {
     items: Price[];
     pagination: OffsetPagination;
 }
-export type QuoteItemInputInterval = (typeof QuoteItemInputInterval)[keyof typeof QuoteItemInputInterval];
-export declare const QuoteItemInputInterval: {
-    readonly none: "none";
-    readonly day: "day";
-    readonly month: "month";
-    readonly year: "year";
-};
-/**
- * The dimension values of what is bought, such as region and instance type. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused with `BILLING_PRICE_UNAVAILABLE` rather than priced at zero. Prices are set per currency, and a currency may not offer some combinations at all, for example in a region it does not sell to.
- */
-export type QuoteItemInputDimensions = {
-    [key: string]: string;
-};
-/**
- * Identify a price, or select one for a plan; give each resource's ID or lookup key, never both, and product_id with lookup keys. A metered item includes only any setup charge; its usage is estimated with `estimate-usage`.
- */
-export interface QuoteItemInput {
-    /**
-     * @minLength 1
-     * @maxLength 128
-     */
-    price_lookup_key?: string;
-    /**
-     * @minLength 1
-     * @maxLength 128
-     */
-    plan_lookup_key?: string;
-    price_id?: string;
-    product_id?: ProductId;
-    plan_id?: string;
-    /** Narrows the selection when a plan offers more than one price type. */
-    price_type?: PriceType;
-    /** Narrows the selection when a plan offers more than one usage type. */
-    usage_type?: UsageType;
-    interval?: QuoteItemInputInterval;
-    /** @minimum 1 */
-    interval_count?: number;
-    /** Selects among licensed prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily. */
-    cancellation_policy?: CancellationPolicy;
-    /** @pattern ^(?:(?:[1-9][0-9]{0,27}|0(?:[1-9][0-9]{0,26}|0(?:[1-9][0-9]{0,25}|0(?:[1-9][0-9]{0,24}|0(?:[1-9][0-9]{0,23}|0(?:[1-9][0-9]{0,22}|0(?:[1-9][0-9]{0,21}|0(?:[1-9][0-9]{0,20}|0(?:[1-9][0-9]{0,19}|0(?:[1-9][0-9]{0,18}|0(?:[1-9][0-9]{0,17}|0(?:[1-9][0-9]{0,16}|0(?:[1-9][0-9]{0,15}|0(?:[1-9][0-9]{0,14}|0(?:[1-9][0-9]{0,13}|0(?:[1-9][0-9]{0,12}|0(?:[1-9][0-9]{0,11}|0(?:[1-9][0-9]{0,10}|0(?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9])))))))))))))))))))))))))))([.][0-9]{1,10})?|0{1,28}[.](?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9]))))))))))$ */
-    quantity: string;
-    /** The dimension values of what is bought, such as region and instance type. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused with `BILLING_PRICE_UNAVAILABLE` rather than priced at zero. Prices are set per currency, and a currency may not offer some combinations at all, for example in a region it does not sell to. */
-    dimensions?: QuoteItemInputDimensions;
-    /** Price the line as a new item added to this existing subscription, as the owning service adds it when buying for a resource the subscription pays for. Needs `billing_account_id`, which must currently pay for the subscription. A licensed line is priced up to the subscription's `current_term_end`, the rest of the current period in proportion to the time left from `proration_date`, and must have the subscription's interval and interval count; a metered line has no immediate charge; added to a trialing subscription, the line is free until the trial ends. */
-    subscription_id?: string;
-}
 /**
  * The values of the meter's presentation dimensions, present only when grouped by meter.
  */
@@ -2880,7 +3130,7 @@ export interface ActiveResourceList {
     pagination: OffsetPagination;
 }
 /**
- * An estimated refund to the original payment sources. Before acceptance, cancellation returns the collected amount. For delivered service, only value paid by this order is included; renewals are evaluated with their own orders under the agreed cancellation terms. Nothing is refunded by the quote; the amount is fixed when cancellation or termination is confirmed.
+ * An estimated refund to the original payment sources. Before acceptance, cancellation returns the collected amount. For delivered service, only value paid by this order is included; renewals are evaluated with their own orders under the agreed cancellation terms. Nothing is refunded by the preview; the amount is fixed when cancellation or termination is confirmed.
  */
 export interface OrderRefundPreview {
     order_id: string;
@@ -2971,118 +3221,6 @@ export interface UsageEstimate {
     /** One per request item, in request order. */
     items: UsageEstimateItem[];
 }
-/**
- * When the changes take effect; defaults to `immediate`. `immediate` prices the rest of the paid period from `proration_date`, charging an upgrade the difference and showing what a downgrade refunds. `period_end` prices the first period at the new terms, which replaces the renewal when the paid period ends.
- */
-export type QuoteRequestChangeEffective = (typeof QuoteRequestChangeEffective)[keyof typeof QuoteRequestChangeEffective];
-export declare const QuoteRequestChangeEffective: {
-    readonly immediate: "immediate";
-    readonly period_end: "period_end";
-};
-export type QuoteChangeInputInterval = (typeof QuoteChangeInputInterval)[keyof typeof QuoteChangeInputInterval];
-export declare const QuoteChangeInputInterval: {
-    readonly none: "none";
-    readonly day: "day";
-    readonly month: "month";
-    readonly year: "year";
-};
-/**
- * The dimension values after the change, given in full; omit to keep the item's.
- */
-export type QuoteChangeInputDimensions = {
-    [key: string]: string;
-};
-/**
- * The new terms of one subscription item. Identify the price, or the plan to select one from, as for a proposed item. Without a price or billing terms, the plan's price with the item's price type, usage type, interval, interval count and cancellation policy is selected. Omitted dimensions keep the item's.
- */
-export interface QuoteChangeInput {
-    subscription_item_id: string;
-    /**
-     * @minLength 1
-     * @maxLength 128
-     */
-    price_lookup_key?: string;
-    /**
-     * @minLength 1
-     * @maxLength 128
-     */
-    plan_lookup_key?: string;
-    price_id?: string;
-    product_id?: ProductId;
-    plan_id?: string;
-    /** Selects the price type instead of keeping the item's. */
-    price_type?: PriceType;
-    /** Selects the usage type instead of keeping the item's. */
-    usage_type?: UsageType;
-    interval?: QuoteChangeInputInterval;
-    /** @minimum 1 */
-    interval_count?: number;
-    /** Selects among licensed prices with otherwise identical billing terms. */
-    cancellation_policy?: CancellationPolicy;
-    /**
-     * The quantity after the change.
-     * @pattern ^(?:(?:[1-9][0-9]{0,27}|0(?:[1-9][0-9]{0,26}|0(?:[1-9][0-9]{0,25}|0(?:[1-9][0-9]{0,24}|0(?:[1-9][0-9]{0,23}|0(?:[1-9][0-9]{0,22}|0(?:[1-9][0-9]{0,21}|0(?:[1-9][0-9]{0,20}|0(?:[1-9][0-9]{0,19}|0(?:[1-9][0-9]{0,18}|0(?:[1-9][0-9]{0,17}|0(?:[1-9][0-9]{0,16}|0(?:[1-9][0-9]{0,15}|0(?:[1-9][0-9]{0,14}|0(?:[1-9][0-9]{0,13}|0(?:[1-9][0-9]{0,12}|0(?:[1-9][0-9]{0,11}|0(?:[1-9][0-9]{0,10}|0(?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9])))))))))))))))))))))))))))([.][0-9]{1,10})?|0{1,28}[.](?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9]))))))))))$
-     */
-    quantity: string;
-    /** The dimension values after the change, given in full; omit to keep the item's. */
-    dimensions?: QuoteChangeInputDimensions;
-}
-export interface QuoteAddress {
-    /**
-     * ISO 3166-1 alpha-2, two uppercase letters.
-     * @pattern ^[A-Z]{2}$
-     */
-    country: string;
-    /**
-     * The state or province, as the tax rates name it.
-     * @minLength 1
-     * @maxLength 128
-     */
-    state?: string;
-}
-/**
- * Quote proposed items, changes or renewals: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes, renewals and items added to an existing subscription need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.
- */
-export interface QuoteRequest {
-    /**
-     * The billing account to price for; it must be yours or currently pay for a project you are a member of, and an access token is required. Renewals must currently be paid by it.
-     * @minimum 1
-     */
-    billing_account_id?: number;
-    /**
-     * The ISO 4217 currency to price in without an account.
-     * @minLength 3
-     * @maxLength 3
-     */
-    currency?: string;
-    /**
-     * A proposed purchase.
-     * @minItems 1
-     * @maxItems 100
-     */
-    items?: QuoteItemInput[];
-    /**
-     * Preview renewing these subscriptions together in one renewal order, as a renewal Checkout Session does, each at most once; `total` is that order's. Each must currently be paid by `billing_account_id`, be yours to read as the owner of that account or a member of the subscription's project, and all must belong to the same project and service. To apply a promotion code, create a renewal Checkout Session and quote it.
-     * @minItems 1
-     * @maxItems 100
-     */
-    renewals?: QuoteRenewal[];
-    /**
-     * Preview changing these subscription items in one order, each at most once. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account or a member of the subscription's project; all must belong to the same project, or all to no project.
-     * @minItems 1
-     * @maxItems 100
-     */
-    changes?: QuoteChangeInput[];
-    /** When the changes take effect; defaults to `immediate`. `immediate` prices the rest of the paid period from `proration_date`, charging an upgrade the difference and showing what a downgrade refunds. `period_end` prices the first period at the new terms, which replaces the renewal when the paid period ends. */
-    change_effective?: QuoteRequestChangeEffective;
-    /** Only with `currency`. Where the customer is, to include the tax that would be added there for a customer who is not tax exempt; `tax_status` is then `complete`. Refused with `billing_account_id`, whose invoice contact decides tax. */
-    address?: QuoteAddress;
-    /**
-     * @minLength 1
-     * @maxLength 64
-     */
-    promotion_code?: string;
-}
 /**
  * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
  */
@@ -3827,6 +3965,30 @@ export type ListAccountDiscountsParams = {
      */
     status?: DiscountStatus[];
 };
+export type ListTrialGrantsParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+    /**
+     * Only this account; all of yours when omitted.
+     */
+    billing_account_id?: AccountIdQueryParameter;
+    /**
+     * Only grants in these statuses; omit for every status. Comma-separated, for example `status=available,scheduled`.
+     * @minItems 1
+     * @maxItems 5
+     */
+    status?: TrialGrantStatus[];
+};
 export type ListCreditGrantsParams = {
     /**
      * 1-based page number. Defaults to 1.
@@ -4126,27 +4288,6 @@ export type ListCheckoutSessionsParams = {
      */
     project_ids?: ProjectIdsQueryParameter;
 };
-export type ListCheckoutSessionItemsParams = {
-    /**
-     * 1-based page number. Defaults to 1.
-     * @minimum 1
-     * @maximum 2147483647
-     */
-    page?: number;
-    /**
-     * Items per page. Defaults to 50; at most 200.
-     * @minimum 1
-     * @maximum 200
-     */
-    page_size?: number;
-};
-export type GetCheckoutSessionQuoteParams = {
-    /**
-     * @minLength 1
-     * @maxLength 64
-     */
-    promotion_code?: string;
-};
 export type ListOrdersParams = {
     /**
      * 1-based page number. Defaults to 1.