@schematichq/schematic-react 1.11.0 → 1.12.0

package/dist/schematic-react.d.ts

@@ -67,6 +67,12 @@ declare namespace billingApi {
         ApiErrorToJSON,
         ApiErrorToJSONTyped,
         ApiError,
+        instanceOfBillingCreditGrantReason,
+        BillingCreditGrantReasonFromJSON,
+        BillingCreditGrantReasonFromJSONTyped,
+        BillingCreditGrantReasonToJSON,
+        BillingCreditGrantReasonToJSONTyped,
+        BillingCreditGrantReason,
         instanceOfBillingPlanCreditGrantResetCadence,
         BillingPlanCreditGrantResetCadenceFromJSON,
         BillingPlanCreditGrantResetCadenceFromJSONTyped,
@@ -115,6 +121,42 @@ declare namespace billingApi {
         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,
@@ -217,6 +259,24 @@ declare namespace billingApi {
         FeatureTypeToJSON,
         FeatureTypeToJSONTyped,
         FeatureType,
+        instanceOfGetCompanyCreditBalancesResponse,
+        GetCompanyCreditBalancesResponseFromJSON,
+        GetCompanyCreditBalancesResponseFromJSONTyped,
+        GetCompanyCreditBalancesResponseToJSON,
+        GetCompanyCreditBalancesResponseToJSONTyped,
+        GetCompanyCreditBalancesResponse,
+        instanceOfGetCompanyCreditUserUsageParams,
+        GetCompanyCreditUserUsageParamsFromJSON,
+        GetCompanyCreditUserUsageParamsFromJSONTyped,
+        GetCompanyCreditUserUsageParamsToJSON,
+        GetCompanyCreditUserUsageParamsToJSONTyped,
+        GetCompanyCreditUserUsageParams,
+        instanceOfGetCompanyCreditUserUsageResponse,
+        GetCompanyCreditUserUsageResponseFromJSON,
+        GetCompanyCreditUserUsageResponseFromJSONTyped,
+        GetCompanyCreditUserUsageResponseToJSON,
+        GetCompanyCreditUserUsageResponseToJSONTyped,
+        GetCompanyCreditUserUsageResponse,
         instanceOfGetCompanyFeatureUsageResponse,
         GetCompanyFeatureUsageResponseFromJSON,
         GetCompanyFeatureUsageResponseFromJSONTyped,
@@ -332,6 +392,10 @@ declare interface BillingClient {
     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;
@@ -340,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
@@ -357,13 +439,15 @@ export declare type BillingData = {
     sessionKey?: string;
 };
 
-export declare function BillingDataProvider({ actions, children, data, featureUserUsage, 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;
@@ -403,6 +487,9 @@ export declare interface BillingDataSource {
      */
     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;
@@ -483,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" | "fetchFeatureUsage" | "fetchFeatureUserUsage">;
+export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage" | "fetchCreditBalances" | "fetchCreditUserUsage">;
 
 declare interface BillingProviderDataProps {
     /**
@@ -523,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" | "featureUsage";
+export declare type BillingResourceName = "invoices" | "upcomingInvoice" | "paymentMethods" | "featureUsage" | "creditBalances";
 
 declare type BillingResourceName_2 = keyof BillingResources_2;
 
@@ -535,6 +622,7 @@ declare interface BillingResourceParams_2 {
     upcomingInvoice: Record<string, never>;
     paymentMethods: Record<string, never>;
     featureUsage: Record<string, never>;
+    creditBalances: Record<string, never>;
 }
 
 export declare type BillingResources = Pick<BillingResources_2, BillingResourceName>;
@@ -565,6 +653,12 @@ declare interface BillingResources_2 {
      * 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[];
 }
 
 /**
@@ -1061,6 +1155,356 @@ export declare interface 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
@@ -1664,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 */
@@ -1673,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[];
 
@@ -1820,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
@@ -2142,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}
@@ -2763,6 +3250,8 @@ declare class SchematicBillingClient implements BillingClient {
     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>;
 }
 
@@ -2856,6 +3345,11 @@ declare namespace SchematicJS {
         CheckPlanReturnFromJSON,
         CheckPlanReturnListenerFn,
         CompanyCreditBalance,
+        CompanyCreditBalanceResponseData,
+        CompanyCreditCompositionResponseData,
+        CompanyCreditGrantResponseData,
+        CompanyCreditUserUsageResponseData,
+        CompanyCreditUserUsageRowResponseData,
         CompanyDiscountResponseData,
         CompanyFeatureUsageResponseData,
         CompanyFeatureUserUsageResponseData,
@@ -2865,10 +3359,13 @@ declare namespace SchematicJS {
         CompanyUserUsageResponseData,
         ContextSignatureProvider,
         CreditBalance,
+        CreditBalanceEntry,
         CreditBalanceListenerFn,
         CreditBalances,
         CreditBalancesFromJSON,
         CreditBalancesListenerFn,
+        CreditComposition,
+        CreditGrant,
         CreditSpendPolicies,
         creditSpendPoliciesEqual,
         CreditSpendPoliciesFromJSON,
@@ -2878,6 +3375,8 @@ declare namespace SchematicJS {
         CreditSpendPolicyListenerFn,
         CreditSpendPolicyScope,
         CreditSpendWindow,
+        CreditUserUsage,
+        CreditUserUsageRow,
         DEFAULT_INVOICE_QUERY,
         Discount,
         EmptyListenerFn,
@@ -3234,6 +3733,19 @@ 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.