@leaflow/sdk 0.121.0 → 0.122.0

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

@@ -20,7 +20,7 @@ export const QuotedDiscountType = {
     promotion_code: "promotion_code",
     account_discount: "account_discount",
 };
-export const CancellationRefundPreviewItemBillingType = {
+export const CancellationRefundPreviewItemChargeType = {
     postpaid: "postpaid",
     prepaid: "prepaid",
     one_time: "one_time",
@@ -38,7 +38,7 @@ export const CancellationOrigin = {
     operator: "operator",
     project_deletion: "project_deletion",
 };
-export const CancellationItemBillingType = {
+export const CancellationItemChargeType = {
     postpaid: "postpaid",
     prepaid: "prepaid",
     one_time: "one_time",
@@ -51,7 +51,7 @@ export const CancellationItemStatus = {
     canceled: "canceled",
     failed: "failed",
 };
-export const CancellationRequestStatus = {
+export const SubscriptionCancellationStatus = {
     requested: "requested",
     scheduled: "scheduled",
     releasing: "releasing",
@@ -59,7 +59,7 @@ export const CancellationRequestStatus = {
     completed: "completed",
     canceled: "canceled",
 };
-export const CancellationRequestMode = {
+export const SubscriptionCancellationMode = {
     immediate: "immediate",
     period_end: "period_end",
 };
@@ -87,7 +87,7 @@ export const PriceOptionInterval = {
 export const PurchaseOperation = {
     new: "new",
     renew: "renew",
-    change: "change",
+    modify: "modify",
 };
 export const TopUpStatus = {
     pending: "pending",
@@ -130,17 +130,20 @@ export const TransactionType = {
     topup: "topup",
     payment: "payment",
     refund: "refund",
-    payout: "payout",
     adjustment: "adjustment",
 };
 export const InvoiceStatus = {
     draft: "draft",
     open: "open",
     paid: "paid",
-    refunded: "refunded",
     void: "void",
     uncollectible: "uncollectible",
 };
+export const InvoiceCustomerTaxExempt = {
+    none: "none",
+    exempt: "exempt",
+    reverse: "reverse",
+};
 export const InvoiceItemType = {
     usage: "usage",
     subscription: "subscription",
@@ -158,6 +161,16 @@ export const CreditNoteStatus = {
     issued: "issued",
     void: "void",
 };
+export const CreditNoteReason = {
+    provisioning_failed: "provisioning_failed",
+    order_expired: "order_expired",
+    order_canceled: "order_canceled",
+    change_canceled: "change_canceled",
+    change_expired: "change_expired",
+    subscription_canceled: "subscription_canceled",
+    usage_true_up: "usage_true_up",
+    operator: "operator",
+};
 export const RefundDestination = {
     balance: "balance",
     gateway: "gateway",
@@ -181,7 +194,7 @@ export const RefundReason = {
     payment_not_applied: "payment_not_applied",
     operator: "operator",
 };
-export const SubscriptionBillingType = {
+export const SubscriptionChargeType = {
     postpaid: "postpaid",
     prepaid: "prepaid",
     one_time: "one_time",
@@ -216,7 +229,6 @@ export const RenewalOrderRequestInterval = {
     year: "year",
 };
 export const OrderStatus = {
-    pending_checkout: "pending_checkout",
     pending: "pending",
     accepted: "accepted",
     completed: "completed",
@@ -231,10 +243,9 @@ export const OrderItemStatus = {
     canceled: "canceled",
 };
 export const OrderType = {
-    purchase: "purchase",
+    new: "new",
     renew: "renew",
-    change: "change",
-    adopt: "adopt",
+    modify: "modify",
 };
 export const OrderChangeEffective = {
     none: "none",
@@ -247,14 +258,16 @@ export const OrderItemInterval = {
     month: "month",
     year: "year",
 };
-export const OrderItemBillingType = {
+export const OrderItemChargeType = {
     postpaid: "postpaid",
     prepaid: "prepaid",
     one_time: "one_time",
 };
 export const DiscountStatus = {
+    scheduled: "scheduled",
     active: "active",
-    revoked: "revoked",
+    expired: "expired",
+    voided: "voided",
 };
 export const DiscountType = {
     percentage: "percentage",
@@ -277,6 +290,12 @@ export const AllowanceStatus = {
     expired: "expired",
     voided: "voided",
 };
+export const FeatureGrantStatus = {
+    scheduled: "scheduled",
+    active: "active",
+    expired: "expired",
+    voided: "voided",
+};
 export const PriceType = {
     postpaid: "postpaid",
     prepaid: "prepaid",
@@ -298,8 +317,12 @@ export const PriceInterval = {
     month: "month",
     year: "year",
 };
-export const RatePricingModel = {
+export const RateBillingScheme = {
     per_unit: "per_unit",
+    tiered: "tiered",
+};
+export const RateTiersMode = {
+    none: "none",
     graduated: "graduated",
     volume: "volume",
 };
@@ -320,6 +343,11 @@ export const ActiveResourceStatus = {
     closing: "closing",
     closed: "closed",
 };
+export const ContactTaxExempt = {
+    none: "none",
+    exempt: "exempt",
+    reverse: "reverse",
+};
 export const StatementStatus = {
     open: "open",
     closed: "closed",

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

@@ -320,15 +320,26 @@ export declare const DeletePaymentMethodParams: zod.ZodObject<{
  * 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
- * operation. Promotion codes are confirmed by checkout, before collecting payment.
+ * operation.
+ *
+ * The draft invoice of a deferred order is priced when it is first paid: Billing applies
+ * promotion_code, or the best applicable account discount when it is omitted, compares the total
+ * with expected_amount, records the discount on the order and issues the invoice before collecting.
+ * An invalid or inapplicable code fails rather than collecting full price, and a different total
+ * fails with `BILLING_AMOUNT_CHANGED`; in both cases nothing changes. The terms are fixed before
+ * any funds are collected and stay fixed when collection does not complete, for example with
+ * insufficient funds or a declined card: later attempts reuse them, and a different promotion_code
+ * is then refused with `BILLING_ORDER_CHECKOUT_CONFLICT`. A deferred period-end change can be paid
+ * once its first period is due to be invoiced; earlier attempts are refused with
+ * `BILLING_CHANGE_NOT_INVOICED`.
  *
  * Returns a payment action when customer interaction is required. requires_action and processing
  * do not mean paid; the invoice is marked paid after payment is confirmed. An unresolved payment
  * attempt is reused, and retries do not apply credit grants or balance twice.
  *
  * Calling this on an invoice that is already paid returns the existing payment result without
- * another charge. A draft order invoice must first be confirmed through checkout. It and a void
- * invoice are refused with `BILLING_INVOICE_NOT_PAYABLE`; the invoice of an order that has failed or was
+ * another charge. A void invoice is refused with `BILLING_INVOICE_NOT_PAYABLE`; the invoice of an
+ * order that has failed or was
  * canceled, with `BILLING_ORDER_FAILED` or `BILLING_ORDER_CANCELED`; and that of an order whose
  * payment deadline has passed, with `BILLING_ORDER_EXPIRED`.
  * @summary Pay an invoice
@@ -343,6 +354,8 @@ export declare const PayInvoiceBody: zod.ZodObject<{
     use_balance: zod.ZodDefault<zod.ZodBoolean>;
     use_credits: zod.ZodDefault<zod.ZodBoolean>;
     return_url: zod.ZodOptional<zod.ZodString>;
+    promotion_code: zod.ZodOptional<zod.ZodString>;
+    expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
 }, zod.z.core.$strict>;
 /**
  * What paying this invoice now would take from credit grants, from the balance and, for the rest,
@@ -350,6 +363,8 @@ export declare const PayInvoiceBody: zod.ZodObject<{
  * straight afterwards takes exactly these amounts unless the account's funds change in between.
  * Nothing is charged, reserved or created.
  *
+ * A draft order invoice is priced as paying it with the same promotion_code would price it.
+ *
  * Refused with the same errors as paying, except that insufficient funds are not an error here:
  * they show as a `gateway_amount` above zero.
  * @summary Preview invoice payment
@@ -357,22 +372,28 @@ export declare const PayInvoiceBody: zod.ZodObject<{
 export declare const PreviewInvoicePaymentParams: zod.ZodObject<{
     invoiceId: zod.ZodUUID;
 }, zod.z.core.$strict>;
+export declare const previewInvoicePaymentQueryPromotionCodeMax = 64;
 export declare const previewInvoicePaymentQueryUseBalanceDefault = true;
 export declare const previewInvoicePaymentQueryUseCreditsDefault = true;
 export declare const PreviewInvoicePaymentQueryParams: zod.ZodObject<{
+    promotion_code: zod.ZodOptional<zod.ZodString>;
     use_balance: zod.ZodDefault<zod.ZodBoolean>;
     use_credits: zod.ZodDefault<zod.ZodBoolean>;
 }, zod.z.core.$strict>;
 /**
  * Pays outstanding invoices, including the invoices of the listed orders, from the account's
  * eligible credit grants and then its balance. No payment gateway is used; an invoice to be
- * paid online is paid on its own.
+ * paid online is paid on its own. The draft invoice of a deferred order takes the best applicable
+ * account discount and is issued first, and stays issued if the payment fails; pay it on its own to
+ * apply a promotion code.
  *
  * Either every invoice is paid or none is. When the credit grants and balance cannot cover
  * them all, the request fails with `BILLING_INSUFFICIENT_FUNDS` and nothing is charged.
+ * A total different from expected_amount fails with `BILLING_AMOUNT_CHANGED` and nothing is charged.
  * Invoices that are already paid are not charged again. An invoice with an online payment
- * still in progress is refused with `BILLING_PAYMENT_PENDING`, a draft order invoice or void invoice with
- * `BILLING_INVOICE_NOT_PAYABLE`, an order that has failed or was canceled with
+ * still in progress is refused with `BILLING_PAYMENT_PENDING`, a void invoice with
+ * `BILLING_INVOICE_NOT_PAYABLE`, a deferred period-end change not yet due to be invoiced with
+ * `BILLING_CHANGE_NOT_INVOICED`, an order that has failed or was canceled with
  * `BILLING_ORDER_FAILED` or `BILLING_ORDER_CANCELED`, and an order whose payment deadline has
  * passed with `BILLING_ORDER_EXPIRED`.
  * @summary Pay together
@@ -380,6 +401,7 @@ export declare const PreviewInvoicePaymentQueryParams: zod.ZodObject<{
 export declare const PayTogetherBody: zod.ZodObject<{
     invoice_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
     order_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
+    expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
 }, zod.z.core.$strict>;
 /**
  * What paying these invoices together now would take from credit grants and from the balance,
@@ -394,9 +416,10 @@ export declare const PayTogetherBody: zod.ZodObject<{
 export declare const PreviewPayTogetherBody: zod.ZodObject<{
     invoice_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
     order_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
+    expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
 }, zod.z.core.$strict>;
 /**
- * Paginated issued invoices belonging to owned billing accounts, filtered by billing_account_id, status and creation interval. Drafts are excluded; top-ups do not create invoices.
+ * Paginated issued invoices belonging to owned billing accounts, filtered by billing_account_id, status and creation interval. Drafts are excluded, including the draft invoice of an order awaiting payment, which is reached through its order; top-ups do not create invoices.
  * @summary List invoices
  */
 export declare const listInvoicesQueryPageDefault = 1;
@@ -412,21 +435,20 @@ export declare const ListInvoicesQueryParams: zod.ZodObject<{
         open: "open";
         draft: "draft";
         paid: "paid";
-        refunded: "refunded";
         uncollectible: "uncollectible";
     }>>;
     from: zod.ZodOptional<zod.z.ZodISODateTime>;
     to: zod.ZodOptional<zod.z.ZodISODateTime>;
 }, zod.z.core.$strict>;
 /**
- * Returns an issued invoice for an owned billing account with its amounts, tax lines and payment state. Returns 404 for a missing or unissued invoice and 403 when its account belongs to another user.
+ * Returns an invoice for an owned billing account with its amounts, tax lines and payment state, whether issued or the draft invoice of an order. Returns 404 for a missing invoice or another draft and 403 when its account belongs to another user.
  * @summary Get invoice
  */
 export declare const GetInvoiceParams: zod.ZodObject<{
     invoiceId: zod.ZodUUID;
 }, zod.z.core.$strict>;
 /**
- * Paginated lines of an issued invoice belonging to an owned billing account, including their service periods and project references. A missing or unissued invoice returns 404; another user account returns 403.
+ * Paginated lines of an invoice belonging to an owned billing account, issued or the draft invoice of an order, including their service periods and project references. A missing invoice or another draft returns 404; another user account returns 403.
  * @summary List invoice items
  */
 export declare const ListInvoiceItemsParams: zod.ZodObject<{
@@ -631,11 +653,11 @@ export declare const CancelSubscriptionBody: zod.ZodObject<{
     reason: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
 /**
- * Calculates exactly one target for a billing account you own: proposed items, existing order checkout, renewals, cancellation or order refund. Returns all requested calculations or a structured error. No quote is saved and no resource, payment, reservation or redemption is created.
+ * Calculates exactly one target for a billing account you own: proposed items, an existing order, renewals, cancellation or order refund. Returns all requested calculations or a structured error. No quote is saved and no resource, payment, reservation or redemption is created.
  *
  * Existing orders use their recorded purchase account and terms. Renewals and cancellations use the account currently paying for each subscription. Every target must belong to the requested account. A project association or project token does not authorize a quote.
  *
- * Use an existing order quote's total as expected_amount at checkout. A confirmed order returns its recorded amounts; a different promotion code is refused. Requested future usage estimates are not collectible checkout amounts. An unknown delivery outcome is not proof of refund eligibility.
+ * Use an existing order quote's total as expected_amount when paying the order's invoice. An order whose terms are fixed returns its recorded amounts; a different promotion code is refused. Requested future usage estimates are not collectible checkout amounts. An unknown delivery outcome is not proof of refund eligibility.
  * @summary Create a quote
  */
 export declare const CreateQuoteBody: zod.ZodObject<{
@@ -775,7 +797,7 @@ export declare const CreateCancellationBody: zod.ZodObject<{
     reason: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
 /**
- * Returns a cancellation request for an authorized billing account with its schedule, expected refundable amount and individual subscription outcomes. Read individual item states for per-subscription outcomes, including partial success.
+ * Returns a cancellation for an authorized billing account with its schedule, expected refundable amount and individual subscription outcomes. Read individual item states for per-subscription outcomes, including partial success.
  * @summary Get a cancellation
  */
 export declare const GetCancellationParams: zod.ZodObject<{
@@ -808,7 +830,7 @@ export declare const ListRenewalPricesQueryParams: zod.ZodObject<{
     page_size: zod.ZodDefault<zod.ZodInt>;
 }, zod.z.core.$strict>;
 /**
- * Purchases prepaid periods from paid_until using the agreed recurring amount, and pays for them at
+ * Purchases prepaid periods from current_term_end using the agreed recurring amount, and pays for them at
  * once. A changed interval selects a current price and freezes new terms on the order, applied
  * only after fulfillment. Existing paid periods keep their value.
  *
@@ -844,12 +866,12 @@ export declare const RenewSubscriptionBody: zod.ZodObject<{
 }, zod.z.core.$strict>;
 /**
  * Places a renewal order with a draft invoice, without applying a new discount or charging anything.
- * Quote and confirm its checkout before collecting payment to renew. Existing subscription
+ * Pay its invoice to renew; a promotion code can be applied when paying. Existing subscription
  * discount commitments are retained. The periods and price are chosen as for renewing. The order
  * can be paid until the current paid period ends, and never after the end of the first period it renews; unpaid by
  * then, it is canceled. While auto-renew is on, the renewal due at the end of the period pays
- * this order instead of placing another, confirming checkout with an applicable account discount
- * first if it has not already been confirmed.
+ * this order instead of placing another, applying an applicable account discount first if the
+ * order's terms are not fixed yet.
  *
  * Save `order_id` before submitting and read the order after an unknown outcome; creating it a
  * second time conflicts.
@@ -869,8 +891,9 @@ export declare const CreateRenewalOrderBody: zod.ZodObject<{
     }>>;
 }, zod.z.core.$strict>;
 /**
- * Controls automatic prepaid renewal. Disabling it does not shorten paid_until and still permits
- * manual renewal. Postpaid subscriptions do not renew and keep this false.
+ * Controls automatic prepaid renewal. Disabling it does not shorten current_term_end and still permits
+ * manual renewal. A postpaid subscription always continues until it is canceled; setting it is refused with 409
+ * `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED`.
  *
  * While the subscription has an open cancellation, turning it on or off is refused with 409
  * `BILLING_SUBSCRIPTION_OPERATION_PENDING` and `meta.cancellation_id`: creating the cancellation
@@ -915,9 +938,9 @@ export declare const ListAllowancesQueryParams: zod.ZodObject<{
     project_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
 }, zod.z.core.$strict>;
 /**
- * Lists acceptance status and associated invoice amounts. pending_checkout awaits confirmation;
- * pending has confirmed checkout and may be unpaid or paid. active means accepted, not delivered.
- * pending_checkout and pending orders can expire at expires_at.
+ * Lists acceptance status and associated invoice amounts. A pending order is not yet accepted;
+ * its invoice shows whether it still needs payment. accepted means accepted, not delivered.
+ * Pending orders can expire at expires_at.
  * @summary List orders
  */
 export declare const listOrdersQueryPageDefault = 1;
@@ -934,7 +957,6 @@ export declare const ListOrdersQueryParams: zod.ZodObject<{
         completed: "completed";
         failed: "failed";
         canceled: "canceled";
-        pending_checkout: "pending_checkout";
         accepted: "accepted";
         partially_completed: "partially_completed";
     }>>;
@@ -949,44 +971,6 @@ export declare const ListOrdersQueryParams: zod.ZodObject<{
 export declare const GetOrderParams: zod.ZodObject<{
     orderId: zod.ZodUUID;
 }, zod.z.core.$strict>;
-/**
- * Confirms the purchase's final amount and discount. Supply the same promotion_code used for the
- * preview, or omit it to select an applicable account discount. At most one new coupon is applied
- * to an order; existing subscription discount commitments are not stacked with a new coupon on
- * the same line. Promotion codes are evaluated against the order, not client-supplied line amounts.
- *
- * Rechecks eligibility and redemption availability. A different total fails with
- * BILLING_AMOUNT_CHANGED. An invalid or inapplicable code fails rather than collecting full price.
- * A failed confirmation leaves the invoice draft and reserves no discount redemption.
- *
- * 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 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. 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
- * that code is refused with BILLING_ORDER_CHECKOUT_CONFLICT. Payment retries reuse the confirmed
- * terms. Cancellation, expiry or complete fulfillment failure releases the reservation or returns
- * the consumed redemption; a refund alone does not.
- *
- * The order must belong to one of your billing accounts. A canceled, failed or expired order
- * cannot be checked out. A period-end change cannot be checked out before its renewal invoice is
- * available. Orders retain their billing account and currency after a project is linked elsewhere;
- * discounts from another account cannot be used for them.
- * @summary Confirm order checkout
- */
-export declare const CheckoutOrderParams: zod.ZodObject<{
-    orderId: zod.ZodUUID;
-}, zod.z.core.$strict>;
-export declare const CheckoutOrderBody: zod.ZodObject<{
-    promotion_code: zod.ZodOptional<zod.ZodString>;
-    expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
-}, zod.z.core.$strict>;
 /**
  * Cancels the selected, still-undelivered items of an unaccepted order without recording a
  * delivery failure. Omit order_item_ids to select every still-pending item, or name one or
@@ -995,10 +979,10 @@ export declare const CheckoutOrderBody: zod.ZodObject<{
  * its existing pending phase while any item is still pending; its final outcome follows all
  * item outcomes. Previously failed items keep their failure outcome.
  *
- * Payment may be absent, partial or complete. Confirmed checkout keeps the selected items'
- * agreed amounts and discounts; credit notes reduce issued invoices, and collected amounts
- * are returned to their original payment sources. When checkout has not been confirmed, the
- * remaining items are quoted again. External payment-method refunds can finish asynchronously.
+ * Payment may be absent, partial or complete. Once the order's terms are fixed, the selected items
+ * keep their agreed amounts and discounts; credit notes reduce issued invoices, and collected amounts
+ * are returned to their original payment sources. While the terms of a deferred order are not fixed,
+ * the remaining items are priced again. External payment-method refunds can finish asynchronously.
  * The order and financial history are retained; the same cancellation does not refund twice.
  *
  * Once the order is accepted, its owning service coordinates cancellation and confirms
@@ -1034,8 +1018,9 @@ export declare const ListOrderItemsQueryParams: zod.ZodObject<{
  * does not appear, so that "this does not exist" and "this has not been bought" cannot be
  * confused.
  *
- * Derived from live subscriptions rather than stored, so this always agrees with what is
- * being paid for. It stops being listed as soon as the subscription providing it ends.
+ * Derived from live subscriptions and active feature grants rather than stored, so this always
+ * agrees with what is being paid for and granted. It stops being listed as soon as the
+ * subscription or grant providing it ends.
  * @summary List entitlements
  */
 export declare const listEntitlementsQueryPageDefault = 1;
@@ -1052,6 +1037,30 @@ export declare const ListEntitlementsQueryParams: zod.ZodObject<{
     project_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
     product_id: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
+/**
+ * Access to features held by a billing account for a period, for example through a membership. While a grant
+ * is active, every project whose current billing account holds it has the feature, in addition to the
+ * features of its own subscriptions.
+ * @summary List feature grants
+ */
+export declare const listFeatureGrantsQueryPageDefault = 1;
+export declare const listFeatureGrantsQueryPageMax = 2147483647;
+export declare const listFeatureGrantsQueryPageSizeDefault = 50;
+export declare const listFeatureGrantsQueryPageSizeMax = 200;
+export declare const listFeatureGrantsQueryProductIdMax = 64;
+export declare const listFeatureGrantsQueryProductIdRegExp: RegExp;
+export declare const ListFeatureGrantsQueryParams: zod.ZodObject<{
+    page: zod.ZodDefault<zod.ZodInt>;
+    page_size: zod.ZodDefault<zod.ZodInt>;
+    billing_account_id: zod.ZodOptional<zod.ZodInt>;
+    product_id: zod.ZodOptional<zod.ZodString>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        expired: "expired";
+        active: "active";
+        scheduled: "scheduled";
+        voided: "voided";
+    }>>;
+}, zod.z.core.$strict>;
 /**
  * Every sellable thing and what it costs, in one request. A plan appears once per price.
  *