@schematichq/schematic-react 1.10.0 → 1.12.0

package/dist/schematic-react.d.ts

@@ -67,18 +67,120 @@ declare namespace billingApi {
         ApiErrorToJSON,
         ApiErrorToJSONTyped,
         ApiError,
+        instanceOfBillingCreditGrantReason,
+        BillingCreditGrantReasonFromJSON,
+        BillingCreditGrantReasonFromJSONTyped,
+        BillingCreditGrantReasonToJSON,
+        BillingCreditGrantReasonToJSONTyped,
+        BillingCreditGrantReason,
+        instanceOfBillingPlanCreditGrantResetCadence,
+        BillingPlanCreditGrantResetCadenceFromJSON,
+        BillingPlanCreditGrantResetCadenceFromJSONTyped,
+        BillingPlanCreditGrantResetCadenceToJSON,
+        BillingPlanCreditGrantResetCadenceToJSONTyped,
+        BillingPlanCreditGrantResetCadence,
+        instanceOfBillingPriceScheme,
+        BillingPriceSchemeFromJSON,
+        BillingPriceSchemeFromJSONTyped,
+        BillingPriceSchemeToJSON,
+        BillingPriceSchemeToJSONTyped,
+        BillingPriceScheme,
+        instanceOfBillingProductPriceInterval,
+        BillingProductPriceIntervalFromJSON,
+        BillingProductPriceIntervalFromJSONTyped,
+        BillingProductPriceIntervalToJSON,
+        BillingProductPriceIntervalToJSONTyped,
+        BillingProductPriceInterval,
         instanceOfBillingProviderType,
         BillingProviderTypeFromJSON,
         BillingProviderTypeFromJSONTyped,
         BillingProviderTypeToJSON,
         BillingProviderTypeToJSONTyped,
         BillingProviderType,
+        instanceOfBillingTiersMode,
+        BillingTiersModeFromJSON,
+        BillingTiersModeFromJSONTyped,
+        BillingTiersModeToJSON,
+        BillingTiersModeToJSONTyped,
+        BillingTiersMode,
+        instanceOfCatalogCreditGrantResponseData,
+        CatalogCreditGrantResponseDataFromJSON,
+        CatalogCreditGrantResponseDataFromJSONTyped,
+        CatalogCreditGrantResponseDataToJSON,
+        CatalogCreditGrantResponseDataToJSONTyped,
+        CatalogCreditGrantResponseData,
+        instanceOfCatalogPriceResponseData,
+        CatalogPriceResponseDataFromJSON,
+        CatalogPriceResponseDataFromJSONTyped,
+        CatalogPriceResponseDataToJSON,
+        CatalogPriceResponseDataToJSONTyped,
+        CatalogPriceResponseData,
+        instanceOfCatalogPriceTierResponseData,
+        CatalogPriceTierResponseDataFromJSON,
+        CatalogPriceTierResponseDataFromJSONTyped,
+        CatalogPriceTierResponseDataToJSON,
+        CatalogPriceTierResponseDataToJSONTyped,
+        CatalogPriceTierResponseData,
+        instanceOfCompanyCreditBalanceResponseData,
+        CompanyCreditBalanceResponseDataFromJSON,
+        CompanyCreditBalanceResponseDataFromJSONTyped,
+        CompanyCreditBalanceResponseDataToJSON,
+        CompanyCreditBalanceResponseDataToJSONTyped,
+        CompanyCreditBalanceResponseData,
+        instanceOfCompanyCreditBalancesResponseData,
+        CompanyCreditBalancesResponseDataFromJSON,
+        CompanyCreditBalancesResponseDataFromJSONTyped,
+        CompanyCreditBalancesResponseDataToJSON,
+        CompanyCreditBalancesResponseDataToJSONTyped,
+        CompanyCreditBalancesResponseData,
+        instanceOfCompanyCreditCompositionResponseData,
+        CompanyCreditCompositionResponseDataFromJSON,
+        CompanyCreditCompositionResponseDataFromJSONTyped,
+        CompanyCreditCompositionResponseDataToJSON,
+        CompanyCreditCompositionResponseDataToJSONTyped,
+        CompanyCreditCompositionResponseData,
+        instanceOfCompanyCreditGrantResponseData,
+        CompanyCreditGrantResponseDataFromJSON,
+        CompanyCreditGrantResponseDataFromJSONTyped,
+        CompanyCreditGrantResponseDataToJSON,
+        CompanyCreditGrantResponseDataToJSONTyped,
+        CompanyCreditGrantResponseData,
+        instanceOfCompanyCreditUserUsageResponseData,
+        CompanyCreditUserUsageResponseDataFromJSON,
+        CompanyCreditUserUsageResponseDataFromJSONTyped,
+        CompanyCreditUserUsageResponseDataToJSON,
+        CompanyCreditUserUsageResponseDataToJSONTyped,
+        CompanyCreditUserUsageResponseData,
+        instanceOfCompanyCreditUserUsageRowResponseData,
+        CompanyCreditUserUsageRowResponseDataFromJSON,
+        CompanyCreditUserUsageRowResponseDataFromJSONTyped,
+        CompanyCreditUserUsageRowResponseDataToJSON,
+        CompanyCreditUserUsageRowResponseDataToJSONTyped,
+        CompanyCreditUserUsageRowResponseData,
         instanceOfCompanyDiscountResponseData,
         CompanyDiscountResponseDataFromJSON,
         CompanyDiscountResponseDataFromJSONTyped,
         CompanyDiscountResponseDataToJSON,
         CompanyDiscountResponseDataToJSONTyped,
         CompanyDiscountResponseData,
+        instanceOfCompanyFeatureUsageListResponseData,
+        CompanyFeatureUsageListResponseDataFromJSON,
+        CompanyFeatureUsageListResponseDataFromJSONTyped,
+        CompanyFeatureUsageListResponseDataToJSON,
+        CompanyFeatureUsageListResponseDataToJSONTyped,
+        CompanyFeatureUsageListResponseData,
+        instanceOfCompanyFeatureUsageResponseData,
+        CompanyFeatureUsageResponseDataFromJSON,
+        CompanyFeatureUsageResponseDataFromJSONTyped,
+        CompanyFeatureUsageResponseDataToJSON,
+        CompanyFeatureUsageResponseDataToJSONTyped,
+        CompanyFeatureUsageResponseData,
+        instanceOfCompanyFeatureUserUsageResponseData,
+        CompanyFeatureUserUsageResponseDataFromJSON,
+        CompanyFeatureUserUsageResponseDataFromJSONTyped,
+        CompanyFeatureUserUsageResponseDataToJSON,
+        CompanyFeatureUserUsageResponseDataToJSONTyped,
+        CompanyFeatureUserUsageResponseData,
         instanceOfCompanyInvoiceResponseData,
         CompanyInvoiceResponseDataFromJSON,
         CompanyInvoiceResponseDataFromJSONTyped,
@@ -109,6 +211,12 @@ declare namespace billingApi {
         CompanyUpcomingInvoiceResponseDataToJSON,
         CompanyUpcomingInvoiceResponseDataToJSONTyped,
         CompanyUpcomingInvoiceResponseData,
+        instanceOfCompanyUserUsageResponseData,
+        CompanyUserUsageResponseDataFromJSON,
+        CompanyUserUsageResponseDataFromJSONTyped,
+        CompanyUserUsageResponseDataToJSON,
+        CompanyUserUsageResponseDataToJSONTyped,
+        CompanyUserUsageResponseData,
         instanceOfCreateSetupIntentResponse,
         CreateSetupIntentResponseFromJSON,
         CreateSetupIntentResponseFromJSONTyped,
@@ -127,6 +235,66 @@ declare namespace billingApi {
         DeleteResponseToJSON,
         DeleteResponseToJSONTyped,
         DeleteResponse,
+        instanceOfEntitlementPriceBehavior,
+        EntitlementPriceBehaviorFromJSON,
+        EntitlementPriceBehaviorFromJSONTyped,
+        EntitlementPriceBehaviorToJSON,
+        EntitlementPriceBehaviorToJSONTyped,
+        EntitlementPriceBehavior,
+        instanceOfEntitlementType,
+        EntitlementTypeFromJSON,
+        EntitlementTypeFromJSONTyped,
+        EntitlementTypeToJSON,
+        EntitlementTypeToJSONTyped,
+        EntitlementType,
+        instanceOfEntitlementValueType,
+        EntitlementValueTypeFromJSON,
+        EntitlementValueTypeFromJSONTyped,
+        EntitlementValueTypeToJSON,
+        EntitlementValueTypeToJSONTyped,
+        EntitlementValueType_2 as EntitlementValueType,
+        instanceOfFeatureType,
+        FeatureTypeFromJSON,
+        FeatureTypeFromJSONTyped,
+        FeatureTypeToJSON,
+        FeatureTypeToJSONTyped,
+        FeatureType,
+        instanceOfGetCompanyCreditBalancesResponse,
+        GetCompanyCreditBalancesResponseFromJSON,
+        GetCompanyCreditBalancesResponseFromJSONTyped,
+        GetCompanyCreditBalancesResponseToJSON,
+        GetCompanyCreditBalancesResponseToJSONTyped,
+        GetCompanyCreditBalancesResponse,
+        instanceOfGetCompanyCreditUserUsageParams,
+        GetCompanyCreditUserUsageParamsFromJSON,
+        GetCompanyCreditUserUsageParamsFromJSONTyped,
+        GetCompanyCreditUserUsageParamsToJSON,
+        GetCompanyCreditUserUsageParamsToJSONTyped,
+        GetCompanyCreditUserUsageParams,
+        instanceOfGetCompanyCreditUserUsageResponse,
+        GetCompanyCreditUserUsageResponseFromJSON,
+        GetCompanyCreditUserUsageResponseFromJSONTyped,
+        GetCompanyCreditUserUsageResponseToJSON,
+        GetCompanyCreditUserUsageResponseToJSONTyped,
+        GetCompanyCreditUserUsageResponse,
+        instanceOfGetCompanyFeatureUsageResponse,
+        GetCompanyFeatureUsageResponseFromJSON,
+        GetCompanyFeatureUsageResponseFromJSONTyped,
+        GetCompanyFeatureUsageResponseToJSON,
+        GetCompanyFeatureUsageResponseToJSONTyped,
+        GetCompanyFeatureUsageResponse,
+        instanceOfGetCompanyFeatureUserUsageParams,
+        GetCompanyFeatureUserUsageParamsFromJSON,
+        GetCompanyFeatureUserUsageParamsFromJSONTyped,
+        GetCompanyFeatureUserUsageParamsToJSON,
+        GetCompanyFeatureUserUsageParamsToJSONTyped,
+        GetCompanyFeatureUserUsageParams,
+        instanceOfGetCompanyFeatureUserUsageResponse,
+        GetCompanyFeatureUserUsageResponseFromJSON,
+        GetCompanyFeatureUserUsageResponseFromJSONTyped,
+        GetCompanyFeatureUserUsageResponseToJSON,
+        GetCompanyFeatureUserUsageResponseToJSONTyped,
+        GetCompanyFeatureUserUsageResponse,
         instanceOfGetCompanyInvoicesParams,
         GetCompanyInvoicesParamsFromJSON,
         GetCompanyInvoicesParamsFromJSONTyped,
@@ -157,12 +325,30 @@ declare namespace billingApi {
         InvoiceStatusToJSON,
         InvoiceStatusToJSONTyped,
         InvoiceStatus,
+        instanceOfMetricPeriod,
+        MetricPeriodFromJSON,
+        MetricPeriodFromJSONTyped,
+        MetricPeriodToJSON,
+        MetricPeriodToJSONTyped,
+        MetricPeriod_2 as MetricPeriod,
+        instanceOfMetricPeriodMonthReset,
+        MetricPeriodMonthResetFromJSON,
+        MetricPeriodMonthResetFromJSONTyped,
+        MetricPeriodMonthResetToJSON,
+        MetricPeriodMonthResetToJSONTyped,
+        MetricPeriodMonthReset_2 as MetricPeriodMonthReset,
         instanceOfPaymentMethodResponseData,
         PaymentMethodResponseDataFromJSON,
         PaymentMethodResponseDataFromJSONTyped,
         PaymentMethodResponseDataToJSON,
         PaymentMethodResponseDataToJSONTyped,
         PaymentMethodResponseData,
+        instanceOfPlanCreditGrantScaling,
+        PlanCreditGrantScalingFromJSON,
+        PlanCreditGrantScalingFromJSONTyped,
+        PlanCreditGrantScalingToJSON,
+        PlanCreditGrantScalingToJSONTyped,
+        PlanCreditGrantScaling,
         instanceOfSetupIntentResponseData,
         SetupIntentResponseDataFromJSON,
         SetupIntentResponseDataFromJSONTyped,
@@ -202,6 +388,14 @@ declare interface BillingClient {
     updatePaymentMethod(externalId: string): Promise<void>;
     /** Removes the method, by Schematic's id (`id`). */
     deletePaymentMethod(id: string): Promise<void>;
+    /** Empty when the company is entitled to nothing. */
+    fetchFeatureUsage(): Promise<FeatureUsage[]>;
+    /** One event-based feature's usage by user over its metric period. */
+    fetchFeatureUserUsage(params: FeatureUserUsageRequest): Promise<FeatureUserUsage>;
+    /** Empty when the company holds no credits and its plan draws on none. */
+    fetchCreditBalances(): Promise<CreditBalanceEntry[]>;
+    /** One credit's consumption by user over the span of its live grants. */
+    fetchCreditUserUsage(params: CreditUserUsageRequest): Promise<CreditUserUsage>;
     readonly sessionStatus: SessionStatus;
     readonly sessionKey: string | undefined;
     setSession(session: SessionInput): void;
@@ -210,6 +404,24 @@ declare interface BillingClient {
 
 declare type BillingClientOptions = SessionOptions;
 
+/**
+ *
+ * @export
+ */
+declare const BillingCreditGrantReason: {
+    readonly Adjustment: "adjustment";
+    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";
+};
+
+declare type BillingCreditGrantReason = (typeof BillingCreditGrantReason)[keyof typeof BillingCreditGrantReason];
+
 /**
  * A prefetch or fixture. An omitted key reports as pending; a keyed resource
  * seeds under `params`, or its defaults when absent, so a prefetch for a
@@ -227,11 +439,15 @@ export declare type BillingData = {
     sessionKey?: string;
 };
 
-export declare function BillingDataProvider({ actions, children, data, locale, onLoadMoreInvoices, onMissingString, onRefetch, status, strings, translate, }: BillingDataProviderProps): React_2.JSX.Element;
+export declare function BillingDataProvider({ actions, children, creditUserUsage, data, featureUserUsage, locale, onLoadMoreInvoices, onMissingString, onRefetch, status, strings, translate, }: BillingDataProviderProps): React_2.JSX.Element;
 
 declare interface BillingDataProviderDataProps {
     /** A missing key reports as pending. */
     data: BillingData;
+    /** Usage by user, by feature id; a feature left out reports as pending. */
+    featureUserUsage?: Record<string, FeatureUserUsage>;
+    /** Consumption by user, by credit id; a credit left out reports as pending. */
+    creditUserUsage?: Record<string, CreditUserUsage>;
     /** Simulated loading / failure per resource; wins over `data`. */
     status?: BillingDataStatus;
     onRefetch?: (name: BillingResourceName) => void;
@@ -264,6 +480,16 @@ export declare interface BillingDataSource {
      */
     subscribe<K extends BillingResourceName>(name: K, params: BillingResourceParams[K], listener: () => void): () => void;
     handle<K extends BillingResourceName>(name: K, params: BillingResourceParams[K]): ResourceHandle<BillingResources[K]>;
+    /**
+     * One feature's usage by user. Keyed by feature, so it sits beside the
+     * named resources rather than among them: a source that holds one value
+     * per name has no slot for it.
+     */
+    subscribeFeatureUserUsage(featureId: string, listener: () => void): () => void;
+    featureUserUsage(featureId: string): ResourceHandle<FeatureUserUsage>;
+    /** One credit's consumption by user, keyed like `featureUserUsage`. */
+    subscribeCreditUserUsage(creditId: string, listener: () => void): () => void;
+    creditUserUsage(creditId: string): ResourceHandle<CreditUserUsage>;
     /** Never rejects: a failure lands on the resource's `error`. */
     loadMoreInvoices: (query: InvoiceQuery) => Promise<void>;
     invalidateAll: () => void;
@@ -279,6 +505,21 @@ export declare type BillingDataStatus = {
     };
 };
 
+/**
+ *
+ * @export
+ */
+declare const BillingPlanCreditGrantResetCadence: {
+    readonly Daily: "daily";
+    readonly Every6Months: "every_6_months";
+    readonly Monthly: "monthly";
+    readonly Quarterly: "quarterly";
+    readonly Weekly: "weekly";
+    readonly Yearly: "yearly";
+};
+
+declare type BillingPlanCreditGrantResetCadence = (typeof BillingPlanCreditGrantResetCadence)[keyof typeof BillingPlanCreditGrantResetCadence];
+
 declare interface BillingPrefetchOptions {
     /**
      * The resources the page renders, and no default: each one is a request
@@ -291,6 +532,30 @@ declare interface BillingPrefetchOptions {
     invoices?: InvoiceQuery;
 }
 
+/**
+ *
+ * @export
+ */
+declare const BillingPriceScheme: {
+    readonly PerUnit: "per_unit";
+    readonly Tiered: "tiered";
+};
+
+declare type BillingPriceScheme = (typeof BillingPriceScheme)[keyof typeof BillingPriceScheme];
+
+/**
+ *
+ * @export
+ */
+declare const BillingProductPriceInterval: {
+    readonly Day: "day";
+    readonly Month: "month";
+    readonly OneTime: "one-time";
+    readonly Year: "year";
+};
+
+declare type BillingProductPriceInterval = (typeof BillingProductPriceInterval)[keyof typeof BillingProductPriceInterval];
+
 /**
  * Provides the billing hooks from a `BillingStore` over a `BillingProviderClient`.
  * Rendered by `SchematicProvider`; usable on its own with a client.
@@ -305,7 +570,7 @@ export declare function BillingProvider({ billingClient, children, initialData,
  * much. Named apart from schematic-js's `BillingClient`, which is the whole
  * interface; this is the part the hooks here call.
  */
-export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod">;
+export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage" | "fetchCreditBalances" | "fetchCreditUserUsage">;
 
 declare interface BillingProviderDataProps {
     /**
@@ -345,7 +610,7 @@ declare interface BillingProviderDataProps {
 export declare type BillingProviderProps = BillingProviderDataProps & SchematicI18nConfig;
 
 /** The resources this package serves; a key of schematic-js's contract. */
-export declare type BillingResourceName = "invoices" | "upcomingInvoice" | "paymentMethods";
+export declare type BillingResourceName = "invoices" | "upcomingInvoice" | "paymentMethods" | "featureUsage" | "creditBalances";
 
 declare type BillingResourceName_2 = keyof BillingResources_2;
 
@@ -356,6 +621,8 @@ declare interface BillingResourceParams_2 {
     invoices: InvoiceQuery;
     upcomingInvoice: Record<string, never>;
     paymentMethods: Record<string, never>;
+    featureUsage: Record<string, never>;
+    creditBalances: Record<string, never>;
 }
 
 export declare type BillingResources = Pick<BillingResources_2, BillingResourceName>;
@@ -381,10 +648,229 @@ declare interface BillingResources_2 {
      * has no method on file — so only `undefined` means not loaded.
      */
     paymentMethods: PaymentMethod[];
+    /**
+     * `GET /company/usage`. Empty is a loaded value — the company is entitled
+     * to nothing — so only `undefined` means not loaded.
+     */
+    featureUsage: FeatureUsage[];
+    /**
+     * `GET /company/credits`. Empty is a loaded value — the company holds no
+     * credits and its plan draws on none — so only `undefined` means not
+     * loaded.
+     */
+    creditBalances: CreditBalanceEntry[];
 }
 
+/**
+ *
+ * @export
+ */
+declare const BillingTiersMode: {
+    readonly Graduated: "graduated";
+    readonly Volume: "volume";
+};
+
+declare type BillingTiersMode = (typeof BillingTiersMode)[keyof typeof BillingTiersMode];
+
 declare type BooleanListenerFn = (value: boolean) => void;
 
+/**
+ *
+ * @export
+ * @interface CatalogCreditGrantResponseData
+ */
+declare interface CatalogCreditGrantResponseData {
+    /**
+     * Flat credit amount granted to the company regardless of scaling.
+     * @type {number}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    companyCreditAmount: number;
+    /**
+     * Credits granted; for per_license scaling this is the amount per license unit.
+     * @type {number}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditAmount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditIcon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditPluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditSingularName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    licenseId?: string | null;
+    /**
+     *
+     * @type {BillingPlanCreditGrantResetCadence}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    resetCadence?: BillingPlanCreditGrantResetCadence | null;
+    /**
+     *
+     * @type {PlanCreditGrantScaling}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    scaling: PlanCreditGrantScaling;
+}
+
+/**
+ *
+ * @export
+ * @interface CatalogPriceResponseData
+ */
+declare interface CatalogPriceResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    currency: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {BillingProductPriceInterval}
+     * @memberof CatalogPriceResponseData
+     */
+    interval: BillingProductPriceInterval;
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceResponseData
+     */
+    intervalCount: number;
+    /**
+     * Per-unit price of the final tier, precomputed for overage display.
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    overageUnitPriceDecimal?: string | null;
+    /**
+     * Units covered per priced package; a price of $10 with package_size 1000 charges $10 per 1000 units.
+     * @type {number}
+     * @memberof CatalogPriceResponseData
+     */
+    packageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceResponseData
+     */
+    price: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    priceDecimal?: string | null;
+    /**
+     *
+     * @type {Array<CatalogPriceTierResponseData>}
+     * @memberof CatalogPriceResponseData
+     */
+    priceTiers: Array<CatalogPriceTierResponseData>;
+    /**
+     *
+     * @type {BillingPriceScheme}
+     * @memberof CatalogPriceResponseData
+     */
+    scheme: BillingPriceScheme;
+    /**
+     *
+     * @type {BillingTiersMode}
+     * @memberof CatalogPriceResponseData
+     */
+    tiersMode?: BillingTiersMode | null;
+}
+
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CatalogPriceTierResponseData
+ */
+declare interface CatalogPriceTierResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    flatPrice?: number | null;
+    /**
+     * Lower bound of the tier (inclusive).
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    from: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    perUnitPrice?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceTierResponseData
+     */
+    perUnitPriceDecimal?: string | null;
+    /**
+     * Upper bound of the tier (inclusive); null means unbounded.
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    to?: number | null;
+}
+
 /**
  *
  * @export
@@ -650,84 +1136,684 @@ declare type CheckPlanReturnListenerFn = (value: CheckPlanReturn) => void;
  */
 export declare interface CompanyCreditBalance {
     /**
-     * Remaining credit, excluding any open lease hold (the value SDKs gate on)
+     * Remaining credit, excluding any open lease hold (the value SDKs gate on)
+     * @type {number}
+     * @memberof CompanyCreditBalance
+     */
+    remaining: number;
+    /**
+     * Amount held by the company's open credit lease, 0 when none is open
+     * @type {number}
+     * @memberof CompanyCreditBalance
+     */
+    reserved: number;
+    /**
+     * Spendable balance including the open lease hold (remaining + reserved)
+     * @type {number}
+     * @memberof CompanyCreditBalance
+     */
+    settled: number;
+}
+
+/**
+ *
+ * @export
+ * @interface CompanyCreditBalanceResponseData
+ */
+declare interface CompanyCreditBalanceResponseData {
+    /**
+     * How the plan's grants of this credit add up per period; null unless the plan grants it per license and the license count is known.
+     * @type {CompanyCreditCompositionResponseData}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    composition?: CompanyCreditCompositionResponseData;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    creditDescription: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    creditIcon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    creditId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    creditName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    creditPluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    creditSingularName?: string | null;
+    /**
+     * The earliest expiry among grants that will not be replaced.
+     * @type {Date}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    expiresAt?: Date | null;
+    /**
+     * The live grants behind the balance, newest first. Empty for a credit the plan draws on that the company holds none of.
+     * @type {Array<CompanyCreditGrantResponseData>}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    grants: Array<CompanyCreditGrantResponseData>;
+    /**
+     * Whether a bundle of this credit is on offer to the company's plan.
+     * @type {boolean}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    purchasable: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    remaining: number;
+    /**
+     * The earliest refresh among grants that renew.
+     * @type {Date}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    resetsAt?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    used: number;
+}
+
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CompanyCreditCompositionResponseData
+ */
+declare interface CompanyCreditCompositionResponseData {
+    /**
+     * Credits granted to the company once per period, on top of the per-license amount.
+     * @type {number}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    fixedQuantity: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    licenseId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    licenseName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    licensePluralName?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    licenseQuantity: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    licenseSingularName?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    perLicenseAmount: number;
+    /**
+     * day, week, month or year.
+     * @type {string}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    period: string;
+    /**
+     * When the company's next bill renews the plan: the subscription's period end, else the stored next bill's due date. Null when the subscription cancels at period end, its trial cancels, or neither is known.
+     * @type {Date}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    renewsAt?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditCompositionResponseData
+     */
+    total: number;
+}
+
+/**
+ *
+ * @export
+ * @interface CompanyCreditGrantResponseData
+ */
+declare interface CompanyCreditGrantResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    bundleId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    bundleName?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    createdAt: Date;
+    /**
+     * When these credits go away unreplaced; null if the grant renews or never expires.
+     * @type {Date}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    expiresAt?: Date | null;
+    /**
+     *
+     * @type {BillingCreditGrantReason}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    grantReason: BillingCreditGrantReason;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    planId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    planName?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    quantity: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    quantityRemaining: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    quantityUsed: number;
+    /**
+     * The cadence a renewing grant refreshes on, when it is known.
+     * @type {BillingPlanCreditGrantResetCadence}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    renewalPeriod?: BillingPlanCreditGrantResetCadence | null;
+    /**
+     * When this grant refreshes; null if it does not renew.
+     * @type {Date}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    resetsAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyCreditGrantResponseData
+     */
+    validFrom?: Date | null;
+}
+
+/**
+ *
+ * @export
+ * @interface CompanyCreditUserUsageResponseData
+ */
+declare interface CompanyCreditUserUsageResponseData {
+    /**
+     * How many of the company's users the breakdown lists across every page, including those who consumed none of the credit in the span; 0 for a credit with no live grant. Unattributed consumption is not a user and is not counted.
+     * @type {number}
+     * @memberof CompanyCreditUserUsageResponseData
+     */
+    count: number;
+    /**
+     * End of the span; the time of the request for a credit the company holds no live grant of.
+     * @type {Date}
+     * @memberof CompanyCreditUserUsageResponseData
+     */
+    endTime?: Date | null;
+    /**
+     * Start of the span; equal to end_time for a credit the company holds no live grant of.
+     * @type {Date}
+     * @memberof CompanyCreditUserUsageResponseData
+     */
+    startTime?: Date | null;
+    /**
+     * Consumption across every user in the span, not just this page.
+     * @type {number}
+     * @memberof CompanyCreditUserUsageResponseData
+     */
+    total: number;
+    /**
+     * Consumption from events sent without a user; null when there is none.
+     * @type {number}
+     * @memberof CompanyCreditUserUsageResponseData
+     */
+    unattributed?: number | null;
+    /**
+     * This page of users, heaviest first.
+     * @type {Array<CompanyCreditUserUsageRowResponseData>}
+     * @memberof CompanyCreditUserUsageResponseData
+     */
+    users: Array<CompanyCreditUserUsageRowResponseData>;
+}
+
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CompanyCreditUserUsageRowResponseData
+ */
+declare interface CompanyCreditUserUsageRowResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditUserUsageRowResponseData
+     */
+    name?: string | null;
+    /**
+     * This user's fraction (0-1) of all consumption in the span, unattributed included.
+     * @type {number}
+     * @memberof CompanyCreditUserUsageRowResponseData
+     */
+    share: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyCreditUserUsageRowResponseData
+     */
+    used: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyCreditUserUsageRowResponseData
+     */
+    userId: string;
+}
+
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CompanyDiscountResponseData
+ */
+declare interface CompanyDiscountResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyDiscountResponseData
+     */
+    amountOff?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    couponName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    currency?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    customerFacingCode?: string | null;
+    /**
+     * Provider vocabulary: once, repeating, or forever.
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    duration: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyDiscountResponseData
+     */
+    durationInMonths?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyDiscountResponseData
+     */
+    percentOff?: number | null;
+}
+
+/**
+ *
+ * @export
+ * @interface CompanyFeatureUsageResponseData
+ */
+declare interface CompanyFeatureUsageResponseData {
+    /**
+     * Whether the company may use the feature right now.
+     * @type {boolean}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    access: boolean;
+    /**
+     * The entitlement's own limit before any price behavior applies: the numeric value, or the trait's value for a trait-based entitlement. For a credit entitlement, the credits granted in the current billing period (all time without a subscription). Null for unlimited and boolean entitlements.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    allocation?: number | null;
+    /**
+     * Set when entitlement_type is company_override.
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    companyOverrideId?: string | null;
+    /**
+     * Credits consumed per unit of usage, for entitlements that burn credits.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    consumptionRate?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditIcon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditPluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditSingularName?: string | null;
+    /**
+     * What the feature costs at price, in its minor units: the allocation for pay_in_advance, usage for tier and pay_as_you_go, and usage above soft_limit for overage. Null when there is no price, the price behavior bills nothing, or there is nothing yet to bill it on (no allocation for pay_in_advance, unknown usage for tier, no usage for pay_as_you_go and overage); tier at zero usage, and overage within soft_limit, cost 0.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    currentCost?: number | null;
+    /**
+     *
+     * @type {EntitlementType}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    entitlementType: EntitlementType;
+    /**
+     * When a company override ends; plan entitlements do not expire.
+     * @type {Date}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    expiresAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureDescription: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureIcon: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featurePluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureSingularName?: string | null;
+    /**
+     *
+     * @type {FeatureType}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureType: FeatureType;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    licenseId?: string | null;
+    /**
+     *
+     * @type {MetricPeriod}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    metricPeriod?: MetricPeriod_2 | null;
+    /**
+     *
+     * @type {MetricPeriodMonthReset}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    metricPeriodMonthReset?: MetricPeriodMonthReset_2 | null;
+    /**
+     * The plan's credit grants that scale with the license this feature counts.
+     * @type {Array<CatalogCreditGrantResponseData>}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    perLicenseCreditGrants: Array<CatalogCreditGrantResponseData>;
+    /**
+     * Set when entitlement_type is plan_entitlement.
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    planEntitlementId?: string | null;
+    /**
+     * The metered price the company is billed at: the slot for its billing period, in the subscription's currency, or in none when the price predates multi-currency (any currency without a subscription). Null when the feature has no such price for that period.
+     * @type {CatalogPriceResponseData}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    price?: CatalogPriceResponseData;
+    /**
+     *
+     * @type {EntitlementPriceBehavior}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    priceBehavior?: EntitlementPriceBehavior | null;
+    /**
+     * When the usage metric next resets.
+     * @type {Date}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    resetsAt?: Date | null;
+    /**
+     *
      * @type {number}
-     * @memberof CompanyCreditBalance
+     * @memberof CompanyFeatureUsageResponseData
      */
-    remaining: number;
+    softLimit?: number | null;
     /**
-     * Amount held by the company's open credit lease, 0 when none is open
+     * Usage in the current metric period; null for features that are not metered.
      * @type {number}
-     * @memberof CompanyCreditBalance
+     * @memberof CompanyFeatureUsageResponseData
      */
-    reserved: number;
+    usage?: number | null;
     /**
-     * Spendable balance including the open lease hold (remaining + reserved)
+     *
+     * @type {boolean}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    valueBool?: boolean | null;
+    /**
+     *
      * @type {number}
-     * @memberof CompanyCreditBalance
+     * @memberof CompanyFeatureUsageResponseData
      */
-    settled: number;
+    valueNumeric?: number | null;
+    /**
+     *
+     * @type {EntitlementValueType}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    valueType: EntitlementValueType_2;
+    /**
+     * The default warning-tier value, when configured.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    warningThreshold?: number | null;
 }
 
-/**
- * Schematic API
- * Schematic API
- *
- * The version of the OpenAPI document: 0.1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
 /**
  *
  * @export
- * @interface CompanyDiscountResponseData
+ * @interface CompanyFeatureUserUsageResponseData
  */
-declare interface CompanyDiscountResponseData {
+declare interface CompanyFeatureUserUsageResponseData {
     /**
-     *
+     * How many of the company's users the breakdown lists across every page, including those without usage in the period; unattributed usage is not a user and is not counted.
      * @type {number}
-     * @memberof CompanyDiscountResponseData
-     */
-    amountOff?: number | null;
-    /**
-     *
-     * @type {string}
-     * @memberof CompanyDiscountResponseData
+     * @memberof CompanyFeatureUserUsageResponseData
      */
-    couponName: string;
+    count: number;
     /**
-     *
-     * @type {string}
-     * @memberof CompanyDiscountResponseData
+     * End of the feature's current metric period (exclusive).
+     * @type {Date}
+     * @memberof CompanyFeatureUserUsageResponseData
      */
-    currency?: string | null;
+    endTime: Date;
     /**
-     *
-     * @type {string}
-     * @memberof CompanyDiscountResponseData
+     * Start of the feature's current metric period.
+     * @type {Date}
+     * @memberof CompanyFeatureUserUsageResponseData
      */
-    customerFacingCode?: string | null;
+    startTime: Date;
     /**
-     * Provider vocabulary: once, repeating, or forever.
-     * @type {string}
-     * @memberof CompanyDiscountResponseData
+     * Usage across every user in the period, not just this page.
+     * @type {number}
+     * @memberof CompanyFeatureUserUsageResponseData
      */
-    duration: string;
+    total: number;
     /**
-     *
+     * Usage from events sent without a user; null when the period has none.
      * @type {number}
-     * @memberof CompanyDiscountResponseData
+     * @memberof CompanyFeatureUserUsageResponseData
      */
-    durationInMonths?: number | null;
+    unattributed?: number | null;
     /**
-     *
-     * @type {number}
-     * @memberof CompanyDiscountResponseData
+     * This page of users, highest usage first.
+     * @type {Array<CompanyUserUsageResponseData>}
+     * @memberof CompanyFeatureUserUsageResponseData
      */
-    percentOff?: number | null;
+    users: Array<CompanyUserUsageResponseData>;
 }
 
 /**
@@ -933,6 +2019,85 @@ declare interface CompanyUpcomingInvoiceResponseData {
     subtotal: number;
 }
 
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CompanyUserUsageResponseData
+ */
+declare interface CompanyUserUsageResponseData {
+    /**
+     * When the user last used the feature in the period.
+     * @type {Date}
+     * @memberof CompanyUserUsageResponseData
+     */
+    lastSeen: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyUserUsageResponseData
+     */
+    name?: string | null;
+    /**
+     * This user's fraction (0-1) of all usage in the period, unattributed usage included.
+     * @type {number}
+     * @memberof CompanyUserUsageResponseData
+     */
+    share: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyUserUsageResponseData
+     */
+    usage: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyUserUsageResponseData
+     */
+    userId: string;
+}
+
+/**
+ * Function supplied by the integrating application that returns an HMAC context
+ * signature (`iat.exp.sig`) for the given context.
+ *
+ * Because a publishable key is public, the signature must be produced by the
+ * customer's backend, which holds the matching secret API key. A typical
+ * implementation forwards the context to that backend and returns the
+ * `X-Schematic-Context-Sig` value it computes:
+ *
+ * ```ts
+ * const schematic = new Schematic(pubKey, {
+ *   getContextSignature: async (context) => {
+ *     const res = await fetch("/api/schematic/sign", {
+ *       method: "POST",
+ *       credentials: "include",
+ *       headers: { "Content-Type": "application/json" },
+ *       body: JSON.stringify(context),
+ *     });
+ *     const { signature } = await res.json();
+ *     return signature; // "iat.exp.sig"
+ *   },
+ * });
+ * ```
+ *
+ * The SDK derives the expiry from the returned string (its middle segment) and
+ * caches it per context, so the function is only invoked when no fresh
+ * signature is available.
+ */
+declare type ContextSignatureProvider = (context: SchematicContext) => string | Promise<string>;
+
 /** A company's lease-aware balance for a single credit type */
 export declare type CreditBalance = {
     /** Spendable balance including any open lease hold (remaining + reserved); the number to display to end users */
@@ -943,6 +2108,20 @@ export declare type CreditBalance = {
     reserved: number;
 };
 
+/**
+ * One credit's balance. What the server has already decided, so a consumer
+ * never re-derives it:
+ *
+ * * `grants` are the live ones only, newest first; expired and zeroed-out
+ *   grants are gone, so `total` is `used` plus `remaining`.
+ * * A credit the plan draws on that the company holds none of is a zero
+ *   balance with no grants.
+ * * Each grant carries `resetsAt` or `expiresAt`, never both.
+ * * `purchasable` — a bundle of it is on offer to the company's plan.
+ * * `composition` — how a per-license plan grant adds up per period.
+ */
+export declare type CreditBalanceEntry = CompanyCreditBalanceResponseData;
+
 declare type CreditBalanceListenerFn = CreditBalancesListenerFn | EmptyListenerFn;
 
 /** A company's lease-aware credit balances keyed by credit ID */
@@ -952,6 +2131,10 @@ declare const CreditBalancesFromJSON: (json: any) => CreditBalances;
 
 declare type CreditBalancesListenerFn = (value: CreditBalances) => void;
 
+export declare type CreditComposition = CompanyCreditCompositionResponseData;
+
+export declare type CreditGrant = CompanyCreditGrantResponseData;
+
 /** Every spend policy binding the current context, company-scope first */
 export declare type CreditSpendPolicies = CreditSpendPolicy[];
 
@@ -1099,6 +2282,23 @@ declare interface CreditSpendWindow_2 {
     unit: string;
 }
 
+/**
+ * One credit's consumption by user over the span of its live grants: a page
+ * of `users`, heaviest first; `count` users in all; the span's `total`; and
+ * `unattributed` consumption from events sent without a user. Empty for a
+ * credit the company holds no live grant of.
+ */
+export declare type CreditUserUsage = CompanyCreditUserUsageResponseData;
+
+declare interface CreditUserUsageRequest {
+    creditId: string;
+    /** Users per page; the server's default when omitted. */
+    limit?: number;
+    offset?: number;
+}
+
+export declare type CreditUserUsageRow = CompanyCreditUserUsageRowResponseData;
+
 /**
  *
  * @export
@@ -1139,6 +2339,32 @@ export declare type Discount = CompanyDiscountResponseData;
 
 declare type EmptyListenerFn = () => void;
 
+/**
+ *
+ * @export
+ */
+declare const EntitlementPriceBehavior: {
+    readonly CreditBurndown: "credit_burndown";
+    readonly Overage: "overage";
+    readonly PayAsYouGo: "pay_as_you_go";
+    readonly PayInAdvance: "pay_in_advance";
+    readonly Tier: "tier";
+};
+
+declare type EntitlementPriceBehavior = (typeof EntitlementPriceBehavior)[keyof typeof EntitlementPriceBehavior];
+
+/**
+ *
+ * @export
+ */
+declare const EntitlementType: {
+    readonly CompanyOverride: "company_override";
+    readonly PlanEntitlement: "plan_entitlement";
+    readonly Unknown: "unknown";
+};
+
+declare type EntitlementType = (typeof EntitlementType)[keyof typeof EntitlementType];
+
 /**
  *
  * @export
@@ -1154,6 +2380,21 @@ declare const EntitlementValueType: {
 
 declare type EntitlementValueType = (typeof EntitlementValueType)[keyof typeof EntitlementValueType];
 
+/**
+ *
+ * @export
+ */
+declare const EntitlementValueType_2: {
+    readonly Boolean: "boolean";
+    readonly Credit: "credit";
+    readonly Numeric: "numeric";
+    readonly Trait: "trait";
+    readonly Unknown: "unknown";
+    readonly Unlimited: "unlimited";
+};
+
+declare type EntitlementValueType_2 = (typeof EntitlementValueType_2)[keyof typeof EntitlementValueType_2];
+
 declare type Event_2 = {
     api_key: string;
     body: EventBody;
@@ -1278,6 +2519,12 @@ export declare type EventBodyTrack = SchematicContext & {
 
 export declare type EventType = "identify" | "track" | "flag_check";
 
+/**
+ * Users fetched for one feature's breakdown. The breakdown is read once, not
+ * paged: it lists the heaviest users and says how many more there are.
+ */
+export declare const FEATURE_USER_USAGE_LIMIT = 20;
+
 /**
  *
  * @export
@@ -1374,6 +2621,14 @@ declare interface FeatureEntitlement {
      * @memberof FeatureEntitlement
      */
     monthReset?: MetricPeriodMonthReset | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the credit cost per unit of each quantity an event carries, keyed by quantity key (per token for inference features). Absent when the entitlement prices requests only
+     * @type {{ [key: string]: number; }}
+     * @memberof FeatureEntitlement
+     */
+    quantityRates?: {
+        [key: string]: number;
+    };
     /**
      * For usage-based pricing, the soft limit for overage charges or the next tier boundary
      * @type {number}
@@ -1400,6 +2655,48 @@ declare interface FeatureEntitlement {
     warningTiers?: Array<WarningTier>;
 }
 
+/**
+ *
+ * @export
+ */
+declare const FeatureType: {
+    readonly Boolean: "boolean";
+    readonly Event: "event";
+    readonly License: "license";
+    readonly Trait: "trait";
+};
+
+declare type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
+
+/**
+ * One feature the company is entitled to, and its usage. What the server has
+ * already decided, so a consumer never re-derives it:
+ *
+ * * `price` — the one metered price the company is billed at: its billing
+ *   period's slot, in the subscription's currency when the feature is priced
+ *   in it. Absent when the period has none; another cadence's price is never
+ *   substituted.
+ * * `currentCost` — what the feature costs at `price`, in its minor units.
+ * * `perLicenseCreditGrants` — the plan's credit grants that scale with the
+ *   license this feature counts.
+ */
+export declare type FeatureUsage = CompanyFeatureUsageResponseData;
+
+/**
+ * One event-based feature's usage by user over its current metric period:
+ * a page of `users`, highest usage first; `count` users in all; the period's
+ * `total`; and `unattributed` usage from events sent without a user, which is
+ * not a user and never on the page.
+ */
+export declare type FeatureUserUsage = CompanyFeatureUserUsageResponseData;
+
+declare interface FeatureUserUsageRequest {
+    featureId: string;
+    /** Users per page; the server's default when omitted. */
+    limit?: number;
+    offset?: number;
+}
+
 /**
  * Server prefetch for a provider's `initialData`. A resource that fails is
  * left out rather than thrown, so one of them cannot block a page.
@@ -1468,6 +2765,9 @@ export declare type InvoiceStatus = (typeof InvoiceStatus)[keyof typeof InvoiceS
 /** A record of unique key-value pairs used for identifying a company or user */
 export declare type Keys = Record<string, string>;
 
+/** A metered price, tiers included. */
+export declare type MeteredPrice = CatalogPriceResponseData;
+
 /**
  *
  * @export
@@ -1481,6 +2781,19 @@ declare const MetricPeriod: {
 
 declare type MetricPeriod = (typeof MetricPeriod)[keyof typeof MetricPeriod];
 
+/**
+ *
+ * @export
+ */
+declare const MetricPeriod_2: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};
+
+declare type MetricPeriod_2 = (typeof MetricPeriod_2)[keyof typeof MetricPeriod_2];
+
 /**
  *
  * @export
@@ -1492,6 +2805,17 @@ declare const MetricPeriodMonthReset: {
 
 declare type MetricPeriodMonthReset = (typeof MetricPeriodMonthReset)[keyof typeof MetricPeriodMonthReset];
 
+/**
+ *
+ * @export
+ */
+declare const MetricPeriodMonthReset_2: {
+    readonly BillingCycle: "billing_cycle";
+    readonly FirstOfMonth: "first_of_month";
+};
+
+declare type MetricPeriodMonthReset_2 = (typeof MetricPeriodMonthReset_2)[keyof typeof MetricPeriodMonthReset_2];
+
 /**
  * Keeps only the fields the request reads. The store keys a row set by the
  * query's shape, so a field the API never sees would key a row set of its
@@ -1538,6 +2862,20 @@ export declare interface PaymentMethodsHandle extends ResourceHandle<PaymentMeth
 
 declare type PendingListenerFn = BooleanListenerFn | EmptyListenerFn;
 
+/** A plan credit grant that scales per license. */
+export declare type PerLicenseCreditGrant = CatalogCreditGrantResponseData;
+
+/**
+ *
+ * @export
+ */
+declare const PlanCreditGrantScaling: {
+    readonly Fixed: "fixed";
+    readonly PerLicense: "per_license";
+};
+
+declare type PlanCreditGrantScaling = (typeof PlanCreditGrantScaling)[keyof typeof PlanCreditGrantScaling];
+
 declare type PlanListenerFn = CheckPlanReturnListenerFn | EmptyListenerFn;
 
 declare interface RequestOptions {
@@ -1602,6 +2940,7 @@ declare type RuleType_2 = (typeof RuleType_2)[keyof typeof RuleType_2];
 export declare class Schematic {
     private _additionalHeaders;
     private apiKey;
+    private contextSignatureManager?;
     private _apiUrl;
     private conn;
     private context;
@@ -1680,6 +3019,22 @@ export declare class Schematic {
      * Only logs if debug mode is enabled
      */
     debug(message: string, ...args: unknown[]): void;
+    /**
+     * Resolve the HMAC context-signature value for a context, if a signature
+     * provider is configured. Returns undefined when no provider is set, when
+     * offline, or when the signature could not be obtained.
+     */
+    private contextSignature;
+    /**
+     * Build the `X-Schematic-Context-Sig` header for a context, or an empty
+     * object when no signature is available. Spread into request headers.
+     *
+     * Returns synchronously (not a Promise) when no signature provider is
+     * configured, so callers that dispatch on the same tick (e.g. fire-and-forget
+     * event sends) keep their existing timing; only a configured provider, which
+     * must fetch a signature, yields a Promise.
+     */
+    private contextSignatureHeaders;
     /**
      * Create a persistent message handler for websocket flag updates
      */
@@ -1894,6 +3249,10 @@ declare class SchematicBillingClient implements BillingClient {
     createSetupIntent(): Promise<SetupIntent>;
     updatePaymentMethod(externalId: string): Promise<void>;
     deletePaymentMethod(id: string): Promise<void>;
+    fetchFeatureUsage(): Promise<FeatureUsage[]>;
+    fetchCreditBalances(): Promise<CreditBalanceEntry[]>;
+    fetchCreditUserUsage(params: CreditUserUsageRequest): Promise<CreditUserUsage>;
+    fetchFeatureUserUsage(params: FeatureUserUsageRequest): Promise<FeatureUserUsage>;
 }
 
 /** Context for checking flags and sending events */
@@ -1974,6 +3333,9 @@ declare namespace SchematicJS {
         BillingResourceParams_2 as BillingResourceParams,
         BillingResources_2 as BillingResources,
         BooleanListenerFn,
+        CatalogCreditGrantResponseData,
+        CatalogPriceResponseData,
+        CatalogPriceTierResponseData,
         CheckFlagResponseData,
         CheckFlagReturn,
         CheckFlagReturnFromJSON,
@@ -1983,15 +3345,27 @@ declare namespace SchematicJS {
         CheckPlanReturnFromJSON,
         CheckPlanReturnListenerFn,
         CompanyCreditBalance,
+        CompanyCreditBalanceResponseData,
+        CompanyCreditCompositionResponseData,
+        CompanyCreditGrantResponseData,
+        CompanyCreditUserUsageResponseData,
+        CompanyCreditUserUsageRowResponseData,
         CompanyDiscountResponseData,
+        CompanyFeatureUsageResponseData,
+        CompanyFeatureUserUsageResponseData,
         CompanyInvoiceResponseData,
         CompanyPaymentMethodResponseData,
         CompanyUpcomingInvoiceResponseData,
+        CompanyUserUsageResponseData,
+        ContextSignatureProvider,
         CreditBalance,
+        CreditBalanceEntry,
         CreditBalanceListenerFn,
         CreditBalances,
         CreditBalancesFromJSON,
         CreditBalancesListenerFn,
+        CreditComposition,
+        CreditGrant,
         CreditSpendPolicies,
         creditSpendPoliciesEqual,
         CreditSpendPoliciesFromJSON,
@@ -2001,6 +3375,8 @@ declare namespace SchematicJS {
         CreditSpendPolicyListenerFn,
         CreditSpendPolicyScope,
         CreditSpendWindow,
+        CreditUserUsage,
+        CreditUserUsageRow,
         DEFAULT_INVOICE_QUERY,
         Discount,
         EmptyListenerFn,
@@ -2010,6 +3386,8 @@ declare namespace SchematicJS {
         EventBodyIdentify,
         EventBodyTrack,
         EventType,
+        FeatureUsage,
+        FeatureUserUsage,
         FlagCheckListenerFn,
         FlagValueListenerFn,
         Invoice,
@@ -2021,8 +3399,10 @@ declare namespace SchematicJS {
         InvoicesResult,
         InvoiceStatus,
         Keys,
+        MeteredPrice,
         PaymentMethod,
         PendingListenerFn,
+        PerLicenseCreditGrant,
         PlanListenerFn,
         RequestOptions,
         ResourceState,
@@ -2047,6 +3427,7 @@ declare namespace SchematicJS {
         TrialStatus,
         UpcomingInvoice,
         UsagePeriod,
+        UserUsage,
         WarningTier
     }
 }
@@ -2061,6 +3442,16 @@ export declare type SchematicOptions = {
     debug?: boolean;
     /** Optionally provide a custom event URL */
     eventUrl?: string;
+    /** Optionally provide a function that returns an HMAC context signature
+     * (`iat.exp.sig`) for a given context. Required only when the Schematic
+     * environment has context-signature verification enabled. Because a
+     * publishable key is public, the signature must be produced by your backend
+     * (which holds the matching secret API key); this function typically forwards
+     * the context to that backend and returns the value it computes. The SDK
+     * caches the signature per context, derives its expiry from the returned
+     * string, and attaches it as the `X-Schematic-Context-Sig` header on flag
+     * checks, the WebSocket bootstrap, and events. */
+    getContextSignature?: ContextSignatureProvider;
     /** Enable offline mode to prevent all network requests.
      * When enabled, events are only logged not sent, and flag checks return fallback values.
      * Can also be enabled at runtime via URL query parameter "schematic_offline=true" */
@@ -2342,6 +3733,32 @@ export declare enum UsagePeriod {
 
 export declare function useBillingDataSource(): BillingDataSource;
 
+/**
+ * The company's credit balances, one per credit. `data` is empty when it
+ * holds no credits and its plan draws on none; `undefined` means not loaded.
+ */
+export declare function useCreditBalances(): ResourceHandle<CreditBalanceEntry[]>;
+
+/**
+ * One credit's consumption by user over the span of its live grants: the
+ * heaviest users, how many there are in all, and consumption from events
+ * sent without a user. Empty for a credit the company holds no live grant of.
+ */
+export declare function useCreditUserUsage(creditId: string): ResourceHandle<CreditUserUsage>;
+
+/**
+ * Every feature the company is entitled to, with its usage. `data` is empty
+ * when it is entitled to nothing; `undefined` is what means not loaded yet.
+ */
+export declare function useFeatureUsage(): ResourceHandle<FeatureUsage[]>;
+
+/**
+ * One event-based feature's usage by user over its metric period: the
+ * heaviest users, how many there are in all, and usage sent without a user.
+ * A feature the company has no event-based entitlement to fails with a 404.
+ */
+export declare function useFeatureUserUsage(featureId: string): ResourceHandle<FeatureUserUsage>;
+
 /** Reloads every loaded billing resource (after a plan change, for instance). */
 export declare function useInvalidateBillingData(): () => void;
 
@@ -2364,6 +3781,8 @@ export declare function useInvoices(query?: InvoiceQuery): InvoicesHandle;
  */
 export declare function usePaymentMethods(): PaymentMethodsHandle;
 
+export declare type UserUsage = CompanyUserUsageResponseData;
+
 export declare const useSchematic: () => SchematicContextProps;
 
 export declare const useSchematicContext: (opts?: SchematicHookOpts) => {