@schematichq/schematic-typescript-node 1.6.1 → 1.6.3

package/README.md

@@ -895,6 +895,8 @@ await client.identify(
 
 Or call `client.prewarm(evalCtx, creditTypeIds)` directly. Both are no-ops in server mode.
 
+Pre-warming resolves the company the way the server does: it looks the keys up first, whatever they are named, and only when nothing matches does it read a value carrying Schematic's `comp_` prefix as the company id.
+
 ### Failure behavior
 
 A check that cannot be gated (API unreachable, Redis down, lease exhausted) fails closed by default. Override per check:

package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts

@@ -26,5 +26,6 @@ export interface CreateInvoiceRequestBody {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    total?: number;
     url?: string;
 }

package/dist/api/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts

@@ -9,6 +9,7 @@
 export interface AcquireCreditLeaseRequestBody {
     companyId: string;
     creditTypeId: string;
+    /** When the hold lapses if the lease is never released; defaults to five minutes from now and may be at most one hour out. The unspent hold is refunded on expiry */
     expiresAt?: Date;
     requestedAmount: number;
 }

package/dist/api/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts

@@ -6,5 +6,8 @@
  */
 export interface ExtendCreditLeaseRequestBody {
     additionalAmount: number;
+    /** Pushes the lease's expiry out; may be at most one hour from now. Leave unset to keep the expiry the lease already has */
     expiresAt?: Date;
+    /** A caller-chosen key for safe retries: a second request with the same key returns the lease as it stands instead of growing it again. Keys are unique per environment across every extend */
+    idempotencyKey?: string;
 }

package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts

@@ -24,7 +24,11 @@ export interface CreateBillingLinkedPlanEntitlementRequestBody {
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;
+    /** How often overage charges are assessed and invoiced. Defaults to end_of_billing_period, where the billing provider aggregates usage over the subscription's own period and bills it at period end. Set to monthly or quarterly to have overage assessed each month or quarter and billed on its own invoice, which is the point of the setting on annual plans. A quarter charges each month's usage against that month's allowance. Only applies to overage price behavior. */
+    overageBillingCadence?: Schematic.BillingArrearsCadence;
     overageBillingProductId?: string;
+    /** Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Quarterly windows run in three-month blocks from the billing period start, held to the subscription's own period, or in calendar quarters at month_end. Only applies when overage_billing_cadence is monthly or quarterly, and must match metric_period_month_reset so each window closes when the allowance resets: billing_period_start for billing_cycle, month_end for first_of_month. Defaults to the anchor that matches the reset. */
+    overageInvoiceAnchor?: Schematic.BillingArrearsAnchor;
     planId: string;
     planVersionId?: string;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
@@ -36,7 +40,7 @@ export interface CreateBillingLinkedPlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts

@@ -20,7 +20,11 @@ export interface CreatePlanEntitlementRequestBody {
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;
+    /** How often overage charges are assessed and invoiced. Defaults to end_of_billing_period, where the billing provider aggregates usage over the subscription's own period and bills it at period end. Set to monthly or quarterly to have overage assessed each month or quarter and billed on its own invoice, which is the point of the setting on annual plans. A quarter charges each month's usage against that month's allowance. Only applies to overage price behavior. */
+    overageBillingCadence?: Schematic.BillingArrearsCadence;
     overageBillingProductId?: string;
+    /** Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Quarterly windows run in three-month blocks from the billing period start, held to the subscription's own period, or in calendar quarters at month_end. Only applies when overage_billing_cadence is monthly or quarterly, and must match metric_period_month_reset so each window closes when the allowance resets: billing_period_start for billing_cycle, month_end for first_of_month. Defaults to the anchor that matches the reset. */
+    overageInvoiceAnchor?: Schematic.BillingArrearsAnchor;
     planId: string;
     planVersionId?: string;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
@@ -32,7 +36,7 @@ export interface CreatePlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts

@@ -17,7 +17,11 @@ export interface UpdatePlanEntitlementRequestBody {
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;
+    /** How often overage charges are assessed and invoiced. Defaults to end_of_billing_period, where the billing provider aggregates usage over the subscription's own period and bills it at period end. Set to monthly or quarterly to have overage assessed each month or quarter and billed on its own invoice, which is the point of the setting on annual plans. A quarter charges each month's usage against that month's allowance. Only applies to overage price behavior. */
+    overageBillingCadence?: Schematic.BillingArrearsCadence;
     overageBillingProductId?: string;
+    /** Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Quarterly windows run in three-month blocks from the billing period start, held to the subscription's own period, or in calendar quarters at month_end. Only applies when overage_billing_cadence is monthly or quarterly, and must match metric_period_month_reset so each window closes when the allowance resets: billing_period_start for billing_cycle, month_end for first_of_month. Defaults to the anchor that matches the reset. */
+    overageInvoiceAnchor?: Schematic.BillingArrearsAnchor;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
     /** Use MonthlyPriceTiers or YearlyPriceTiers instead */
     priceTiers?: Schematic.CreatePriceTierRequestBody[];
@@ -27,7 +31,7 @@ export interface UpdatePlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/features/client/requests/CheckAndReserveFlagRequestBody.d.ts

@@ -7,9 +7,11 @@ export interface CheckAndReserveFlagRequestBody {
     company?: Record<string, string>;
     /** When the hold lapses if no track event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry */
     expiresAt?: Date;
-    /** Hypothetical usage to evaluate the flag against. When credit_cost names the entitlement's credit, that cost is what gets held; otherwise the hold is quantity times the entitlement's consumption rate */
+    /** A caller-chosen key for safe retries: a second request with the same key returns the original reservation instead of taking another hold */
+    idempotencyKey?: string;
+    /** Hypothetical usage to evaluate the flag against. When credit_cost names the entitlement's credit, that cost is what gets held; otherwise the hold is the entitlement's consumption rate times quantity, or, when quantity is omitted, times the usage stated here */
     preflight?: Schematic.PreflightRequestBody;
-    /** Units of the feature the operation will consume; defaults to 1. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event */
+    /** Units of the feature the operation will consume. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event. When it is omitted the units come from preflight.event_usage.quantity, if that event subtype is the entitlement's, else from preflight.usage, else 1 */
     quantity?: number;
     user?: Record<string, string>;
 }

package/dist/api/types/BillingArrearsCadence.d.ts

@@ -1,5 +1,6 @@
 export declare const BillingArrearsCadence: {
     readonly EndOfBillingPeriod: "end_of_billing_period";
     readonly Monthly: "monthly";
+    readonly Quarterly: "quarterly";
 };
 export type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof BillingArrearsCadence];

package/dist/api/types/BillingCreditGrantReason.d.ts

@@ -3,6 +3,9 @@ export declare const BillingCreditGrantReason: {
     readonly BillingCreditAutoTopup: "billing_credit_auto_topup";
     readonly Free: "free";
     readonly Plan: "plan";
+    readonly PostpaidForgiven: "postpaid_forgiven";
+    readonly PostpaidOverdraft: "postpaid_overdraft";
+    readonly PostpaidSettlement: "postpaid_settlement";
     readonly Purchased: "purchased";
     readonly Rollover: "rollover";
 };

package/dist/api/types/BillingCreditResponseData.d.ts

@@ -10,6 +10,7 @@ export interface BillingCreditResponseData {
     description: string;
     icon?: string;
     id: string;
+    ledgerAuthority: Schematic.BillingCreditLedgerAuthority;
     name: string;
     pluralName?: string;
     price?: Schematic.BillingPriceResponseData;

package/dist/api/types/BillingPlanCreditGrantBillingMode.d.ts

@@ -0,0 +1,5 @@
+export declare const BillingPlanCreditGrantBillingMode: {
+    readonly Granted: "granted";
+    readonly Billed: "billed";
+};
+export type BillingPlanCreditGrantBillingMode = (typeof BillingPlanCreditGrantBillingMode)[keyof typeof BillingPlanCreditGrantBillingMode];

package/dist/api/types/BillingPlanCreditGrantPriceTierResponseData.d.ts

@@ -0,0 +1,10 @@
+export interface BillingPlanCreditGrantPriceTierResponseData {
+    /** Lower bound of the tier, in credits per invoice (inclusive). */
+    from: number;
+    /** Price per credit in this tier, in the plan currency's smallest unit. */
+    perUnitPrice?: number;
+    /** Price per credit in this tier as a decimal, for rates below one cent. */
+    perUnitPriceDecimal?: string;
+    /** Upper bound of the tier, in credits per invoice (inclusive). Null marks the final, unbounded tier. */
+    to?: number;
+}

package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts

@@ -16,6 +16,8 @@ export interface BillingPlanCreditGrantResponseData {
     autoTopupSelfService: boolean;
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
+    /** Whether the credits are included in the plan price (granted) or billed as their own subscription line at a price per credit (billed). */
+    billingMode: Schematic.BillingPlanCreditGrantBillingMode;
     /** Deprecated: bundle availability is a per-bundle plan compatibility set now; use compatible_plan_ids on credit bundles instead. */
     canBuyBundles: boolean;
     /** Credits granted once per company on top of the per-license amount. Always 0 when scaling is fixed. */
@@ -49,6 +51,10 @@ export interface BillingPlanCreditGrantResponseData {
     postpaidRatePerUnit?: number;
     /** Decimal form of postpaid_rate_per_unit, for rates finer than one minor unit. */
     postpaidRatePerUnitDecimal?: string;
+    /** The Stripe price a billed grant bills through. Minted when the plan version is published. */
+    price?: Schematic.BillingPriceResponseData;
+    /** Tier table pricing the credits, cheapest bound first. Empty unless billing_mode is billed and the credits are priced on tiers. */
+    priceTiers: Schematic.BillingPlanCreditGrantPriceTierResponseData[];
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;
@@ -56,5 +62,11 @@ export interface BillingPlanCreditGrantResponseData {
     rolloverPercentage: number;
     /** Whether the grant is a fixed amount per company, or issued once per license the company holds. */
     scaling: Schematic.PlanCreditGrantScaling;
+    /** How price_tiers apply: volume prices every credit at the rate of the tier the total lands in, graduated prices each tier's own credits at its own rate. Set only when price_tiers is non-empty. */
+    tierMode?: Schematic.BillingTiersMode;
+    /** Price per credit in the plan currency's smallest unit. Set only when billing_mode is billed and the credits are priced at one rate. */
+    unitPrice?: number;
+    /** Price per credit as a decimal in the plan currency's smallest unit. Set only when billing_mode is billed and the rate is below one cent. */
+    unitPriceDecimal?: string;
     updatedAt: Date;
 }

package/dist/api/types/ChangeSubscriptionInternalRequestBody.d.ts

@@ -6,6 +6,8 @@ export interface ChangeSubscriptionInternalRequestBody {
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    /** ISO 4217 currency this cart is being built in. Prices are still selected by id; this records the intent, and a cart that prices in another currency is reported as a problem. */
+    currency?: string;
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;

package/dist/api/types/ChangeSubscriptionRequestBody.d.ts

@@ -5,6 +5,8 @@ export interface ChangeSubscriptionRequestBody {
     billingEntityId?: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    /** ISO 4217 currency this cart is being built in. Prices are still selected by id; this records the intent, and a cart that prices in another currency is reported as a problem. */
+    currency?: string;
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;

package/dist/api/types/CompanyFeatureUsageExportMetadataVisibleColumnsItem.d.ts

@@ -3,5 +3,6 @@ export declare const CompanyFeatureUsageExportMetadataVisibleColumnsItem: {
     readonly Subscription: "subscription";
     readonly Users: "users";
     readonly LastSeenAt: "last_seen_at";
+    readonly CreatedAt: "created_at";
 };
 export type CompanyFeatureUsageExportMetadataVisibleColumnsItem = (typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem)[keyof typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem];

package/dist/api/types/CompanyPlanCreditGrantView.d.ts

@@ -17,6 +17,8 @@ export interface CompanyPlanCreditGrantView {
     billingCreditPostpaidEnabled: boolean;
     billingCreditPostpaidRatePerUnit?: number;
     billingCreditPostpaidRatePerUnitDecimal?: string;
+    billingMode: Schematic.BillingPlanCreditGrantBillingMode;
+    billingProductPriceId?: string;
     companyAutoTopupAmount?: number;
     companyAutoTopupEnabled?: boolean;
     companyAutoTopupThresholdCredits?: number;
@@ -41,6 +43,7 @@ export interface CompanyPlanCreditGrantView {
     planVersionId?: string;
     /** Deprecated field, will be removed in the future. Use Credit.PluralName instead. */
     pluralName?: string;
+    price?: Schematic.BillingPriceView;
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType: Schematic.BillingPlanCreditGrantResetType;

package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts

@@ -3,7 +3,7 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     applyToExisting?: boolean;
     /** Which boundary closes a monthly arrears window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Only applies when arrears_cadence is monthly; defaults to billing_period_start. */
     arrearsAnchor?: Schematic.BillingArrearsAnchor;
-    /** How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. */
+    /** How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. Quarterly is not available for postpaid charges. */
     arrearsCadence?: Schematic.BillingArrearsCadence;
     autoTopupAmount?: number;
     autoTopupAmountType?: Schematic.CreditAutoTopupAmountType;
@@ -15,6 +15,8 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     autoTopupSelfService?: boolean;
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
+    /** Whether the credits are included in the plan price (granted) or billed as their own subscription line at a price per credit (billed). Billed is only available on custom plans. Defaults to granted. */
+    billingMode?: Schematic.BillingPlanCreditGrantBillingMode;
     /** Deprecated: use compatible_plan_ids on credit bundles instead. Still accepted; writes through to the credit's bundle compatibility. */
     canBuyBundles?: boolean;
     /** Credits granted once per company on top of the per-license amount. Only valid when scaling is per_license. Defaults to 0. */
@@ -36,6 +38,8 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     postpaidRatePerUnit?: number;
     /** Decimal string form of postpaid_rate_per_unit, for rates finer than one minor unit (for example 0.0002). Takes precedence over postpaid_rate_per_unit when both are set, matching how the credit's own price_per_unit_decimal behaves. */
     postpaidRatePerUnitDecimal?: string;
+    /** Tier table pricing the credits on this grant, cheapest bound first, the last tier unbounded. Give this instead of unit_price to charge a rate that changes with the number of credits on the invoice. Requires tier_mode. */
+    priceTiers?: Schematic.CreditGrantPriceTierRequestBody[];
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;
@@ -43,4 +47,10 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     rolloverPercentage?: number;
     /** Whether the grant is a fixed amount per company, or issued once per license the company holds. Defaults to fixed. */
     scaling?: Schematic.PlanCreditGrantScaling;
+    /** How price_tiers apply: volume prices every credit at the rate of the tier the total lands in, graduated prices each tier's own credits at its own rate. Required with price_tiers. */
+    tierMode?: Schematic.BillingTiersMode;
+    /** Price per credit in the plan currency's smallest unit. Required when billing_mode is billed, unless unit_price_decimal or price_tiers is set. */
+    unitPrice?: number;
+    /** Price per credit as a decimal in the plan currency's smallest unit, for prices below one cent. */
+    unitPriceDecimal?: string;
 }

package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts

@@ -12,7 +12,11 @@ export interface CreateEntitlementInBundleRequestBody {
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;
+    /** How often overage charges are assessed and invoiced. Defaults to end_of_billing_period, where the billing provider aggregates usage over the subscription's own period and bills it at period end. Set to monthly or quarterly to have overage assessed each month or quarter and billed on its own invoice, which is the point of the setting on annual plans. A quarter charges each month's usage against that month's allowance. Only applies to overage price behavior. */
+    overageBillingCadence?: Schematic.BillingArrearsCadence;
     overageBillingProductId?: string;
+    /** Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Quarterly windows run in three-month blocks from the billing period start, held to the subscription's own period, or in calendar quarters at month_end. Only applies when overage_billing_cadence is monthly or quarterly, and must match metric_period_month_reset so each window closes when the allowance resets: billing_period_start for billing_cycle, month_end for first_of_month. Defaults to the anchor that matches the reset. */
+    overageInvoiceAnchor?: Schematic.BillingArrearsAnchor;
     planId: string;
     planVersionId?: string;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
@@ -24,7 +28,7 @@ export interface CreateEntitlementInBundleRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/types/CreditEventLedgerResponseData.d.ts

@@ -29,7 +29,9 @@ export interface CreditEventLedgerResponseData {
     quantityRemainingAtZeroOut?: number;
     sourceId: number;
     toGrantId?: string;
+    transferReason?: Schematic.CreditTransferReason;
     usageEventId?: string;
     usageReason?: Schematic.CreditUsageReason;
+    userId?: string;
     zeroedOutReason?: Schematic.BillingCreditGrantZeroedOutReason;
 }

package/dist/api/types/CreditGrantPriceTierRequestBody.d.ts

@@ -0,0 +1,8 @@
+export interface CreditGrantPriceTierRequestBody {
+    /** Price per credit in this tier, in the plan currency's smallest unit. */
+    perUnitPrice?: number;
+    /** Price per credit in this tier as a decimal in the plan currency's smallest unit, for prices below one cent. */
+    perUnitPriceDecimal?: string;
+    /** Inclusive upper bound of this tier, counted in credits per invoice. Null marks the final, unbounded tier. */
+    upTo?: number;
+}

package/dist/api/types/CreditTransferReason.d.ts

@@ -0,0 +1,7 @@
+export declare const CreditTransferReason: {
+    readonly OverdraftRecovery: "overdraft_recovery";
+    readonly PostpaidDebtMoved: "postpaid_debt_moved";
+    readonly PostpaidForgiven: "postpaid_forgiven";
+    readonly PostpaidPaid: "postpaid_paid";
+};
+export type CreditTransferReason = (typeof CreditTransferReason)[keyof typeof CreditTransferReason];

package/dist/api/types/InvoiceRequestBody.d.ts

@@ -13,5 +13,6 @@ export interface InvoiceRequestBody {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    total?: number;
     url?: string;
 }

package/dist/api/types/InvoiceResponseData.d.ts

@@ -19,6 +19,8 @@ export interface InvoiceResponseData {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    /** Amount after discounts and tax, before applying the customer balance. Null when the provider has not reported it: rows synced before the column existed, or pushed without one. */
+    total?: number;
     updatedAt: Date;
     url?: string;
 }

package/dist/api/types/ManagePlanRequest.d.ts

@@ -19,6 +19,8 @@ export interface ManagePlanRequest {
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    /** ISO 4217 currency this change is being built in. Prices are still selected by id; this records the intent. */
+    currency?: string;
     customFieldValues: Schematic.CheckoutFieldValue[];
     /** Payment terms in days for an invoiced subscription. Defaults to 30. */
     daysUntilDue?: number;

package/dist/api/types/PlanCreditGrantView.d.ts

@@ -17,6 +17,8 @@ export interface PlanCreditGrantView {
     billingCreditPostpaidEnabled: boolean;
     billingCreditPostpaidRatePerUnit?: number;
     billingCreditPostpaidRatePerUnitDecimal?: string;
+    billingMode: Schematic.BillingPlanCreditGrantBillingMode;
+    billingProductPriceId?: string;
     companyCreditAmount: number;
     createdAt: Date;
     credit?: Schematic.BillingCreditView;
@@ -38,6 +40,7 @@ export interface PlanCreditGrantView {
     planVersionId?: string;
     /** Deprecated field, will be removed in the future. Use Credit.PluralName instead. */
     pluralName?: string;
+    price?: Schematic.BillingPriceView;
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType: Schematic.BillingPlanCreditGrantResetType;

package/dist/api/types/PlanEntitlementResponseData.d.ts

@@ -14,6 +14,10 @@ export interface PlanEntitlementResponseData {
     meteredYearlyPrice?: Schematic.BillingPriceView;
     metricPeriod?: Schematic.MetricPeriod;
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
+    /** How often overage charges are assessed and invoiced. Null or end_of_billing_period means the billing provider aggregates usage over the subscription's own period and bills it at period end. Monthly and quarterly mean Schematic assesses the overage each month or quarter and bills it on its own invoice. Only applies to overage price behavior. */
+    overageBillingCadence?: Schematic.BillingArrearsCadence;
+    /** Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end), which for a quarterly window means calendar quarters. Only meaningful when overage_billing_cadence is monthly or quarterly. */
+    overageInvoiceAnchor?: Schematic.BillingArrearsAnchor;
     plan?: Schematic.PlanResponseData;
     planId: string;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
@@ -22,7 +26,7 @@ export interface PlanEntitlementResponseData {
     softLimit?: number;
     updatedAt: Date;
     usageBasedProduct?: Schematic.BillingProductResponseData;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCredit?: Schematic.BillingCreditResponseData;

package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts

@@ -1,6 +1,8 @@
 import type * as Schematic from "../index";
 export interface PreviewSubscriptionFinanceResponseData {
     amountOff: number;
+    /** ISO 4217 currency every amount in this block is denominated in. */
+    currency: string;
     discountAmount: number;
     discounts: Schematic.PreviewSubscriptionDiscountResponseData[];
     dueNow: number;

package/dist/api/types/RulesengineComparableOperator.d.ts

@@ -0,0 +1,11 @@
+export declare const RulesengineComparableOperator: {
+    readonly Eq: "eq";
+    readonly Gt: "gt";
+    readonly Gte: "gte";
+    readonly IsEmpty: "is_empty";
+    readonly Lt: "lt";
+    readonly Lte: "lte";
+    readonly NotEmpty: "not_empty";
+    readonly Ne: "ne";
+};
+export type RulesengineComparableOperator = (typeof RulesengineComparableOperator)[keyof typeof RulesengineComparableOperator];

package/dist/api/types/RulesengineCondition.d.ts

@@ -11,7 +11,7 @@ export interface RulesengineCondition {
     metricPeriod?: Schematic.RulesengineMetricPeriod;
     metricPeriodMonthReset?: Schematic.RulesengineMetricPeriodMonthReset;
     metricValue?: number;
-    operator: Schematic.ComparableOperator;
+    operator: Schematic.RulesengineComparableOperator;
     resourceIds: string[];
     traitDefinition?: Schematic.RulesengineTraitDefinition;
     traitValue: string;

package/dist/api/types/UpcomingInvoiceResponseData.d.ts

@@ -18,6 +18,8 @@ export interface UpcomingInvoiceResponseData {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    /** Amount after discounts and tax, before applying the customer balance. Null when the provider has not reported it. */
+    total?: number;
     updatedAt: Date;
     url?: string;
 }

package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts

@@ -3,7 +3,7 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     applyToExisting?: boolean;
     /** Which boundary closes a monthly arrears window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Only applies when arrears_cadence is monthly; defaults to billing_period_start. Send null to fall back to the default. */
     arrearsAnchor?: Schematic.BillingArrearsAnchor;
-    /** How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. Send null to fall back to the default. */
+    /** How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. Quarterly is not available for postpaid charges. Send null to fall back to the default. */
     arrearsCadence?: Schematic.BillingArrearsCadence;
     autoTopupAmount?: number;
     autoTopupAmountType?: Schematic.CreditAutoTopupAmountType;
@@ -15,6 +15,8 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     autoTopupSelfService?: boolean;
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
+    /** Whether the credits are included in the plan price (granted) or billed as their own subscription line at a price per credit (billed). Billed is only available on custom plans. */
+    billingMode?: Schematic.BillingPlanCreditGrantBillingMode;
     /** Deprecated: use compatible_plan_ids on credit bundles instead. Still accepted; writes through to the credit's bundle compatibility. */
     canBuyBundles?: boolean;
     /** Credits granted once per company on top of the per-license amount. Only valid when the grant scales per license. */
@@ -33,6 +35,8 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     postpaidRatePerUnit?: number;
     /** Decimal string form of postpaid_rate_per_unit, for rates finer than one minor unit (for example 0.0002). Takes precedence over postpaid_rate_per_unit when both are set, matching how the credit's own price_per_unit_decimal behaves. Send null to clear it. */
     postpaidRatePerUnitDecimal?: string;
+    /** Tier table pricing the credits on this grant, cheapest bound first, the last tier unbounded. Sending it moves the grant off one rate per credit. Requires tier_mode. */
+    priceTiers?: Schematic.CreditGrantPriceTierRequestBody[];
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;
@@ -40,4 +44,10 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     rolloverPercentage?: number;
     /** Whether the grant is a fixed amount per company, or issued once per license the company holds. Changing this re-issues the credits companies already hold for this grant. */
     scaling?: Schematic.PlanCreditGrantScaling;
+    /** How price_tiers apply: volume prices every credit at the rate of the tier the total lands in, graduated prices each tier's own credits at its own rate. Required with price_tiers. */
+    tierMode?: Schematic.BillingTiersMode;
+    /** Price per credit in the plan currency's smallest unit. Required when billing_mode is billed, unless unit_price_decimal or price_tiers is set. Sending it moves a tiered grant back to one rate per credit. */
+    unitPrice?: number;
+    /** Price per credit as a decimal in the plan currency's smallest unit, for prices below one cent. */
+    unitPriceDecimal?: string;
 }

package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts

@@ -8,7 +8,11 @@ export interface UsageBasedEntitlementRequestBody {
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;
+    /** How often overage charges are assessed and invoiced. Defaults to end_of_billing_period, where the billing provider aggregates usage over the subscription's own period and bills it at period end. Set to monthly or quarterly to have overage assessed each month or quarter and billed on its own invoice, which is the point of the setting on annual plans. A quarter charges each month's usage against that month's allowance. Only applies to overage price behavior. */
+    overageBillingCadence?: Schematic.BillingArrearsCadence;
     overageBillingProductId?: string;
+    /** Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Quarterly windows run in three-month blocks from the billing period start, held to the subscription's own period, or in calendar quarters at month_end. Only applies when overage_billing_cadence is monthly or quarterly, and must match metric_period_month_reset so each window closes when the allowance resets: billing_period_start for billing_cycle, month_end for first_of_month. Defaults to the anchor that matches the reset. */
+    overageInvoiceAnchor?: Schematic.BillingArrearsAnchor;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
     /** Use MonthlyPriceTiers or YearlyPriceTiers instead */
     priceTiers?: Schematic.CreatePriceTierRequestBody[];
@@ -18,7 +22,7 @@ export interface UsageBasedEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     yearlyMeteredPriceId?: string;
     yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];

package/dist/api/types/UsageBasedEntitlementResponseData.d.ts

@@ -9,7 +9,7 @@ export interface UsageBasedEntitlementResponseData {
     monthlyUsageBasedPrice?: Schematic.BillingPriceView;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
     quarterlyUsageBasedPrice?: Schematic.BillingPriceView;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueNumeric?: number;

package/dist/api/types/index.d.ts

@@ -37,6 +37,8 @@ export * from "./BillingCustomerSubscription";
 export * from "./BillingCustomerWithSubscriptionsResponseData";
 export * from "./BillingLinkedResourceResponseData";
 export * from "./BillingMeterResponseData";
+export * from "./BillingPlanCreditGrantBillingMode";
+export * from "./BillingPlanCreditGrantPriceTierResponseData";
 export * from "./BillingPlanCreditGrantResetCadence";
 export * from "./BillingPlanCreditGrantResetStart";
 export * from "./BillingPlanCreditGrantResetType";
@@ -168,6 +170,7 @@ export * from "./CreditEventLedgerResponseData";
 export * from "./CreditEventType";
 export * from "./CreditGrantDetail";
 export * from "./CreditGrantExpiryRequestBody";
+export * from "./CreditGrantPriceTierRequestBody";
 export * from "./CreditGrantSortOrder";
 export * from "./CreditLeaseResponseData";
 export * from "./CreditReservationResponseData";
@@ -181,6 +184,7 @@ export * from "./CreditsAutoTopupSuccess";
 export * from "./CreditsCreditPurchaseSuccess";
 export * from "./CreditsWebhookCompanySummary";
 export * from "./CreditsWebhookCreditSummary";
+export * from "./CreditTransferReason";
 export * from "./CreditTransferResponseData";
 export * from "./CreditTransferView";
 export * from "./CreditTriggerConfig";
@@ -376,6 +380,7 @@ export * from "./RulesEngineSchemaVersion";
 export * from "./RulesengineCheckFlagResult";
 export * from "./RulesengineCompany";
 export * from "./RulesengineCompanyMetric";
+export * from "./RulesengineComparableOperator";
 export * from "./RulesengineCondition";
 export * from "./RulesengineConditionGroup";
 export * from "./RulesengineConditionType";

package/dist/cache/redis.d.ts

@@ -39,6 +39,17 @@ export interface RedisClient {
         arguments: string[];
     }): Promise<unknown>;
     pExpireAt(key: string, timestamp: number): Promise<unknown>;
+    multi?(): RedisMulti;
+}
+/**
+ * The queued-command half of MULTI/EXEC, as node-redis v4 returns it from
+ * `multi()`. Only the commands the SDK queues are declared; every one of them
+ * is single-key, so the transaction is safe under Redis Cluster too.
+ */
+export interface RedisMulti {
+    hSet(key: string, field: string | Record<string, string | number>, value?: string | number): RedisMulti;
+    pExpireAt(key: string, timestamp: number): RedisMulti;
+    exec(): Promise<unknown>;
 }
 export interface RedisOptions extends CacheOptions {
     /** Pre-created, connected redis client */