@schematichq/schematic-react 1.11.0 → 1.13.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,78 @@ declare namespace billingApi {
         CatalogPriceTierResponseDataToJSON,
         CatalogPriceTierResponseDataToJSONTyped,
         CatalogPriceTierResponseData,
+        instanceOfCompanyContextCustomPlanBillingResponseData,
+        CompanyContextCustomPlanBillingResponseDataFromJSON,
+        CompanyContextCustomPlanBillingResponseDataFromJSONTyped,
+        CompanyContextCustomPlanBillingResponseDataToJSON,
+        CompanyContextCustomPlanBillingResponseDataToJSONTyped,
+        CompanyContextCustomPlanBillingResponseData,
+        instanceOfCompanyContextPlanResponseData,
+        CompanyContextPlanResponseDataFromJSON,
+        CompanyContextPlanResponseDataFromJSONTyped,
+        CompanyContextPlanResponseDataToJSON,
+        CompanyContextPlanResponseDataToJSONTyped,
+        CompanyContextPlanResponseData,
+        instanceOfCompanyContextResponseData,
+        CompanyContextResponseDataFromJSON,
+        CompanyContextResponseDataFromJSONTyped,
+        CompanyContextResponseDataToJSON,
+        CompanyContextResponseDataToJSONTyped,
+        CompanyContextResponseData,
+        instanceOfCompanyContextScheduledDowngradeResponseData,
+        CompanyContextScheduledDowngradeResponseDataFromJSON,
+        CompanyContextScheduledDowngradeResponseDataFromJSONTyped,
+        CompanyContextScheduledDowngradeResponseDataToJSON,
+        CompanyContextScheduledDowngradeResponseDataToJSONTyped,
+        CompanyContextScheduledDowngradeResponseData,
+        instanceOfCompanyContextSubscriptionResponseData,
+        CompanyContextSubscriptionResponseDataFromJSON,
+        CompanyContextSubscriptionResponseDataFromJSONTyped,
+        CompanyContextSubscriptionResponseDataToJSON,
+        CompanyContextSubscriptionResponseDataToJSONTyped,
+        CompanyContextSubscriptionResponseData,
+        instanceOfCompanyCreditAutoTopupResponseData,
+        CompanyCreditAutoTopupResponseDataFromJSON,
+        CompanyCreditAutoTopupResponseDataFromJSONTyped,
+        CompanyCreditAutoTopupResponseDataToJSON,
+        CompanyCreditAutoTopupResponseDataToJSONTyped,
+        CompanyCreditAutoTopupResponseData,
+        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,
@@ -181,6 +259,18 @@ declare namespace billingApi {
         CreateSetupIntentResponseToJSON,
         CreateSetupIntentResponseToJSONTyped,
         CreateSetupIntentResponse,
+        instanceOfCurrency,
+        CurrencyFromJSON,
+        CurrencyFromJSONTyped,
+        CurrencyToJSON,
+        CurrencyToJSONTyped,
+        Currency,
+        instanceOfCustomPlanActivationStrategy,
+        CustomPlanActivationStrategyFromJSON,
+        CustomPlanActivationStrategyFromJSONTyped,
+        CustomPlanActivationStrategyToJSON,
+        CustomPlanActivationStrategyToJSONTyped,
+        CustomPlanActivationStrategy,
         instanceOfDeletePaymentMethodResponse,
         DeletePaymentMethodResponseFromJSON,
         DeletePaymentMethodResponseFromJSONTyped,
@@ -217,6 +307,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,
@@ -253,6 +361,12 @@ declare namespace billingApi {
         GetCompanyPaymentMethodsResponseToJSON,
         GetCompanyPaymentMethodsResponseToJSONTyped,
         GetCompanyPaymentMethodsResponse,
+        instanceOfGetCompanyResponse,
+        GetCompanyResponseFromJSON,
+        GetCompanyResponseFromJSONTyped,
+        GetCompanyResponseToJSON,
+        GetCompanyResponseToJSONTyped,
+        GetCompanyResponse,
         instanceOfGetCompanyUpcomingInvoiceResponse,
         GetCompanyUpcomingInvoiceResponseFromJSON,
         GetCompanyUpcomingInvoiceResponseFromJSONTyped,
@@ -332,6 +446,12 @@ 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>;
+    /** The company's plan, add-ons, and subscription state. */
+    fetchCompany(): Promise<Company>;
     readonly sessionStatus: SessionStatus;
     readonly sessionKey: string | undefined;
     setSession(session: SessionInput): void;
@@ -340,6 +460,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 +495,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 +543,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 +626,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" | "fetchCompany">;
 
 declare interface BillingProviderDataProps {
     /**
@@ -523,7 +666,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" | "company";
 
 declare type BillingResourceName_2 = keyof BillingResources_2;
 
@@ -535,6 +678,8 @@ declare interface BillingResourceParams_2 {
     upcomingInvoice: Record<string, never>;
     paymentMethods: Record<string, never>;
     featureUsage: Record<string, never>;
+    creditBalances: Record<string, never>;
+    company: Record<string, never>;
 }
 
 export declare type BillingResources = Pick<BillingResources_2, BillingResourceName>;
@@ -565,6 +710,14 @@ 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[];
+    /** `GET /company`. */
+    company: Company;
 }
 
 /**
@@ -662,10 +815,10 @@ declare interface CatalogCreditGrantResponseData {
 declare interface CatalogPriceResponseData {
     /**
      *
-     * @type {string}
+     * @type {Currency}
      * @memberof CatalogPriceResponseData
      */
-    currency: string;
+    currency: Currency;
     /**
      *
      * @type {string}
@@ -1024,6 +1177,302 @@ declare const CheckPlanReturnFromJSON: (json: any) => CheckPlanReturn;
 
 declare type CheckPlanReturnListenerFn = (value: CheckPlanReturn) => void;
 
+/**
+ * The company. The server has already made the embed's derivations from its
+ * hydrated `company`:
+ *
+ * * `subscription` is absent when the company has none, or several.
+ * * `subscription.period` comes from its first recurring product, else its
+ *   interval; `subscription.nextBillAt` is the embed's next bill date.
+ * * `customPlanBilling` is the newest pending one, with its `dueAt`.
+ */
+export declare type Company = CompanyContextResponseData;
+
+/**
+ *
+ * @export
+ * @interface CompanyContextCustomPlanBillingResponseData
+ */
+declare interface CompanyContextCustomPlanBillingResponseData {
+    /**
+     * on_payment: the plan activates once the invoice is paid. on_publish: the plan is active and ends unless the invoice is paid.
+     * @type {CustomPlanActivationStrategy}
+     * @memberof CompanyContextCustomPlanBillingResponseData
+     */
+    activationStrategy: CustomPlanActivationStrategy;
+    /**
+     * When payment is due: days_until_due after the billing was published, else created.
+     * @type {Date}
+     * @memberof CompanyContextCustomPlanBillingResponseData
+     */
+    dueAt: Date;
+    /**
+     * Where the company pays the invoice.
+     * @type {string}
+     * @memberof CompanyContextCustomPlanBillingResponseData
+     */
+    invoiceUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextCustomPlanBillingResponseData
+     */
+    planId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextCustomPlanBillingResponseData
+     */
+    planName?: string | 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 CompanyContextPlanResponseData
+ */
+declare interface CompanyContextPlanResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextPlanResponseData
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextPlanResponseData
+     */
+    id: string;
+    /**
+     * The credits the plan grants, in the plan's order.
+     * @type {Array<string>}
+     * @memberof CompanyContextPlanResponseData
+     */
+    includedCreditIds: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextPlanResponseData
+     */
+    name: string;
+    /**
+     * The period the plan is billed in: day, week, month, quarter, year, or one-time. Null when it is not billed.
+     * @type {string}
+     * @memberof CompanyContextPlanResponseData
+     */
+    period?: string | null;
+    /**
+     * What the company is billed per period, in minor units of the subscription's currency. Null when it is not billed.
+     * @type {number}
+     * @memberof CompanyContextPlanResponseData
+     */
+    price?: number | null;
+}
+
+/**
+ *
+ * @export
+ * @interface CompanyContextResponseData
+ */
+declare interface CompanyContextResponseData {
+    /**
+     * The add-ons the company holds.
+     * @type {Array<CompanyContextPlanResponseData>}
+     * @memberof CompanyContextResponseData
+     */
+    addOns: Array<CompanyContextPlanResponseData>;
+    /**
+     * The newest custom plan billing awaiting payment or activation; null when none is pending.
+     * @type {CompanyContextCustomPlanBillingResponseData}
+     * @memberof CompanyContextResponseData
+     */
+    customPlanBilling?: CompanyContextCustomPlanBillingResponseData;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextResponseData
+     */
+    name: string;
+    /**
+     * The company's base plan; null when it has none.
+     * @type {CompanyContextPlanResponseData}
+     * @memberof CompanyContextResponseData
+     */
+    plan?: CompanyContextPlanResponseData;
+    /**
+     * A plan change scheduled for the end of the billing period; null when none is.
+     * @type {CompanyContextScheduledDowngradeResponseData}
+     * @memberof CompanyContextResponseData
+     */
+    scheduledDowngrade?: CompanyContextScheduledDowngradeResponseData;
+    /**
+     * The company's subscription; null when it has none, or several.
+     * @type {CompanyContextSubscriptionResponseData}
+     * @memberof CompanyContextResponseData
+     */
+    subscription?: CompanyContextSubscriptionResponseData;
+}
+
+/**
+ * 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 CompanyContextScheduledDowngradeResponseData
+ */
+declare interface CompanyContextScheduledDowngradeResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextScheduledDowngradeResponseData
+     */
+    fromPlanId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextScheduledDowngradeResponseData
+     */
+    fromPlanName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextScheduledDowngradeResponseData
+     */
+    toPlanId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyContextScheduledDowngradeResponseData
+     */
+    toPlanName: string;
+}
+
+/**
+ *
+ * @export
+ * @interface CompanyContextSubscriptionResponseData
+ */
+declare interface CompanyContextSubscriptionResponseData {
+    /**
+     * When the subscription is set to end.
+     * @type {Date}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    cancelAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    cancelAtPeriodEnd: boolean;
+    /**
+     *
+     * @type {Currency}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    currency: Currency;
+    /**
+     * When the current period ends, and the company is next billed unless its trial is set to cancel: the period end, else the stored next bill's due date. Null when the subscription cancels at period end or neither is known.
+     * @type {Date}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    nextBillAt?: Date | null;
+    /**
+     * The period the subscription bills in: day, week, month, quarter, or year.
+     * @type {string}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    period?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    periodEnd?: Date | null;
+    /**
+     * Provider vocabulary: trialing, active, past_due, and so on.
+     * @type {string}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    status: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyContextSubscriptionResponseData
+     */
+    trialEnd?: Date | 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 CompanyCreditAutoTopupResponseData
+ */
+declare interface CompanyCreditAutoTopupResponseData {
+    /**
+     * Credits each top-up adds.
+     * @type {number}
+     * @memberof CompanyCreditAutoTopupResponseData
+     */
+    amount?: number | null;
+    /**
+     * Whether top-ups run: the company's choice when self_service, else the plan's; false when the plan turns top-ups off.
+     * @type {boolean}
+     * @memberof CompanyCreditAutoTopupResponseData
+     */
+    enabled: boolean;
+    /**
+     * Whether the company may change these settings itself.
+     * @type {boolean}
+     * @memberof CompanyCreditAutoTopupResponseData
+     */
+    selfService: boolean;
+    /**
+     * The remaining balance that triggers a top-up.
+     * @type {number}
+     * @memberof CompanyCreditAutoTopupResponseData
+     */
+    thresholdCredits?: number | null;
+}
+
 /**
  * Schematic API
  * Schematic API
@@ -1061,6 +1510,319 @@ export declare interface CompanyCreditBalance {
     settled: number;
 }
 
+/**
+ *
+ * @export
+ * @interface CompanyCreditBalanceResponseData
+ */
+declare interface CompanyCreditBalanceResponseData {
+    /**
+     * How the credit tops itself up; null unless the company's base plan grants it.
+     * @type {CompanyCreditAutoTopupResponseData}
+     * @memberof CompanyCreditBalanceResponseData
+     */
+    autoTopup?: CompanyCreditAutoTopupResponseData;
+    /**
+     * 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
@@ -1072,6 +1834,38 @@ export declare interface CompanyCreditBalance {
  * 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;
+}
+
 /**
  *
  * @export
@@ -1092,10 +1886,10 @@ declare interface CompanyDiscountResponseData {
     couponName: string;
     /**
      *
-     * @type {string}
+     * @type {Currency}
      * @memberof CompanyDiscountResponseData
      */
-    currency?: string | null;
+    currency?: Currency | null;
     /**
      *
      * @type {string}
@@ -1392,10 +2186,10 @@ declare interface CompanyInvoiceResponseData {
     createdAt: Date;
     /**
      *
-     * @type {string}
+     * @type {Currency}
      * @memberof CompanyInvoiceResponseData
      */
-    currency: string;
+    currency: Currency;
     /**
      *
      * @type {Date}
@@ -1525,6 +2319,11 @@ declare interface CompanyPaymentMethodResponseData {
     type: string;
 }
 
+/** A plan or add-on the company holds, at the price it is billed. */
+export declare type CompanyPlan = CompanyContextPlanResponseData;
+
+export declare type CompanySubscription = CompanyContextSubscriptionResponseData;
+
 /**
  *
  * @export
@@ -1539,10 +2338,10 @@ declare interface CompanyUpcomingInvoiceResponseData {
     amountDue: number;
     /**
      *
-     * @type {string}
+     * @type {Currency}
      * @memberof CompanyUpcomingInvoiceResponseData
      */
-    currency: string;
+    currency: Currency;
     /**
      * How much of the company's existing balance this invoice consumes.
      * @type {number}
@@ -1654,6 +2453,8 @@ declare interface CompanyUserUsageResponseData {
  */
 declare type ContextSignatureProvider = (context: SchematicContext) => string | Promise<string>;
 
+export declare type CreditAutoTopup = CompanyCreditAutoTopupResponseData;
+
 /** 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 */
@@ -1664,6 +2465,22 @@ 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.
+ * * `autoTopup` — auto top-up for a credit the base plan grants, with the
+ *   company's own settings applied.
+ */
+export declare type CreditBalanceEntry = CompanyCreditBalanceResponseData;
+
 declare type CreditBalanceListenerFn = CreditBalancesListenerFn | EmptyListenerFn;
 
 /** A company's lease-aware credit balances keyed by credit ID */
@@ -1673,6 +2490,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 +2641,179 @@ 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
+ */
+declare const Currency: {
+    readonly Aed: "aed";
+    readonly Afn: "afn";
+    readonly All: "all";
+    readonly Amd: "amd";
+    readonly Ang: "ang";
+    readonly Aoa: "aoa";
+    readonly Ars: "ars";
+    readonly Aud: "aud";
+    readonly Awg: "awg";
+    readonly Azn: "azn";
+    readonly Bam: "bam";
+    readonly Bbd: "bbd";
+    readonly Bdt: "bdt";
+    readonly Bif: "bif";
+    readonly Bmd: "bmd";
+    readonly Bnd: "bnd";
+    readonly Bob: "bob";
+    readonly Brl: "brl";
+    readonly Bsd: "bsd";
+    readonly Bwp: "bwp";
+    readonly Byn: "byn";
+    readonly Bzd: "bzd";
+    readonly Cad: "cad";
+    readonly Cdf: "cdf";
+    readonly Chf: "chf";
+    readonly Clp: "clp";
+    readonly Cny: "cny";
+    readonly Cop: "cop";
+    readonly Crc: "crc";
+    readonly Cve: "cve";
+    readonly Czk: "czk";
+    readonly Djf: "djf";
+    readonly Dkk: "dkk";
+    readonly Dop: "dop";
+    readonly Dzd: "dzd";
+    readonly Egp: "egp";
+    readonly Etb: "etb";
+    readonly Eur: "eur";
+    readonly Fjd: "fjd";
+    readonly Fkp: "fkp";
+    readonly Gbp: "gbp";
+    readonly Gel: "gel";
+    readonly Gip: "gip";
+    readonly Gmd: "gmd";
+    readonly Gnf: "gnf";
+    readonly Gtq: "gtq";
+    readonly Gyd: "gyd";
+    readonly Hkd: "hkd";
+    readonly Hnl: "hnl";
+    readonly Htg: "htg";
+    readonly Huf: "huf";
+    readonly Idr: "idr";
+    readonly Ils: "ils";
+    readonly Inr: "inr";
+    readonly Isk: "isk";
+    readonly Jmd: "jmd";
+    readonly Jpy: "jpy";
+    readonly Kes: "kes";
+    readonly Kgs: "kgs";
+    readonly Khr: "khr";
+    readonly Kmf: "kmf";
+    readonly Krw: "krw";
+    readonly Kyd: "kyd";
+    readonly Kzt: "kzt";
+    readonly Lak: "lak";
+    readonly Lbp: "lbp";
+    readonly Lkr: "lkr";
+    readonly Lrd: "lrd";
+    readonly Lsl: "lsl";
+    readonly Mad: "mad";
+    readonly Mdl: "mdl";
+    readonly Mga: "mga";
+    readonly Mkd: "mkd";
+    readonly Mmk: "mmk";
+    readonly Mnt: "mnt";
+    readonly Mop: "mop";
+    readonly Mur: "mur";
+    readonly Mvr: "mvr";
+    readonly Mwk: "mwk";
+    readonly Mxn: "mxn";
+    readonly Myr: "myr";
+    readonly Mzn: "mzn";
+    readonly Nad: "nad";
+    readonly Ngn: "ngn";
+    readonly Nio: "nio";
+    readonly Nok: "nok";
+    readonly Npr: "npr";
+    readonly Nzd: "nzd";
+    readonly Pab: "pab";
+    readonly Pen: "pen";
+    readonly Pgk: "pgk";
+    readonly Php: "php";
+    readonly Pkr: "pkr";
+    readonly Pln: "pln";
+    readonly Pyg: "pyg";
+    readonly Qar: "qar";
+    readonly Ron: "ron";
+    readonly Rsd: "rsd";
+    readonly Rub: "rub";
+    readonly Rwf: "rwf";
+    readonly Sar: "sar";
+    readonly Sbd: "sbd";
+    readonly Scr: "scr";
+    readonly Sek: "sek";
+    readonly Sgd: "sgd";
+    readonly Shp: "shp";
+    readonly Sle: "sle";
+    readonly Sos: "sos";
+    readonly Srd: "srd";
+    readonly Std: "std";
+    readonly Szl: "szl";
+    readonly Thb: "thb";
+    readonly Tjs: "tjs";
+    readonly Top: "top";
+    readonly Try: "try";
+    readonly Ttd: "ttd";
+    readonly Twd: "twd";
+    readonly Tzs: "tzs";
+    readonly Uah: "uah";
+    readonly Ugx: "ugx";
+    readonly Usd: "usd";
+    readonly Uyu: "uyu";
+    readonly Uzs: "uzs";
+    readonly Vnd: "vnd";
+    readonly Vuv: "vuv";
+    readonly Wst: "wst";
+    readonly Xaf: "xaf";
+    readonly Xcd: "xcd";
+    readonly Xcg: "xcg";
+    readonly Xof: "xof";
+    readonly Xpf: "xpf";
+    readonly Yer: "yer";
+    readonly Zar: "zar";
+    readonly Zmw: "zmw";
+};
+
+declare type Currency = (typeof Currency)[keyof typeof Currency];
+
+/**
+ *
+ * @export
+ */
+declare const CustomPlanActivationStrategy: {
+    readonly Payment: "on_payment";
+    readonly Publish: "on_publish";
+};
+
+declare type CustomPlanActivationStrategy = (typeof CustomPlanActivationStrategy)[keyof typeof CustomPlanActivationStrategy];
+
+export declare type CustomPlanBilling = CompanyContextCustomPlanBillingResponseData;
+
 /**
  *
  * @export
@@ -2142,6 +3136,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}
@@ -2450,6 +3452,8 @@ declare const RuleType_2: {
 
 declare type RuleType_2 = (typeof RuleType_2)[keyof typeof RuleType_2];
 
+export declare type ScheduledDowngrade = CompanyContextScheduledDowngradeResponseData;
+
 export declare class Schematic {
     private _additionalHeaders;
     private apiKey;
@@ -2763,6 +3767,9 @@ declare class SchematicBillingClient implements BillingClient {
     updatePaymentMethod(externalId: string): Promise<void>;
     deletePaymentMethod(id: string): Promise<void>;
     fetchFeatureUsage(): Promise<FeatureUsage[]>;
+    fetchCompany(): Promise<Company>;
+    fetchCreditBalances(): Promise<CreditBalanceEntry[]>;
+    fetchCreditUserUsage(params: CreditUserUsageRequest): Promise<CreditUserUsage>;
     fetchFeatureUserUsage(params: FeatureUserUsageRequest): Promise<FeatureUserUsage>;
 }
 
@@ -2855,20 +3862,38 @@ declare namespace SchematicJS {
         CheckPlanReturn,
         CheckPlanReturnFromJSON,
         CheckPlanReturnListenerFn,
+        Company,
+        CompanyContextCustomPlanBillingResponseData,
+        CompanyContextPlanResponseData,
+        CompanyContextResponseData,
+        CompanyContextScheduledDowngradeResponseData,
+        CompanyContextSubscriptionResponseData,
+        CompanyCreditAutoTopupResponseData,
         CompanyCreditBalance,
+        CompanyCreditBalanceResponseData,
+        CompanyCreditCompositionResponseData,
+        CompanyCreditGrantResponseData,
+        CompanyCreditUserUsageResponseData,
+        CompanyCreditUserUsageRowResponseData,
         CompanyDiscountResponseData,
         CompanyFeatureUsageResponseData,
         CompanyFeatureUserUsageResponseData,
         CompanyInvoiceResponseData,
         CompanyPaymentMethodResponseData,
+        CompanyPlan,
+        CompanySubscription,
         CompanyUpcomingInvoiceResponseData,
         CompanyUserUsageResponseData,
         ContextSignatureProvider,
+        CreditAutoTopup,
         CreditBalance,
+        CreditBalanceEntry,
         CreditBalanceListenerFn,
         CreditBalances,
         CreditBalancesFromJSON,
         CreditBalancesListenerFn,
+        CreditComposition,
+        CreditGrant,
         CreditSpendPolicies,
         creditSpendPoliciesEqual,
         CreditSpendPoliciesFromJSON,
@@ -2878,6 +3903,9 @@ declare namespace SchematicJS {
         CreditSpendPolicyListenerFn,
         CreditSpendPolicyScope,
         CreditSpendWindow,
+        CreditUserUsage,
+        CreditUserUsageRow,
+        CustomPlanBilling,
         DEFAULT_INVOICE_QUERY,
         Discount,
         EmptyListenerFn,
@@ -2908,6 +3936,7 @@ declare namespace SchematicJS {
         RequestOptions,
         ResourceState,
         RuleType,
+        ScheduledDowngrade,
         Schematic,
         SchematicApiError,
         SchematicBillingClient,
@@ -3234,6 +4263,26 @@ export declare enum UsagePeriod {
 
 export declare function useBillingDataSource(): BillingDataSource;
 
+/**
+ * The company's plan and add-ons at their billed prices, its subscription,
+ * any scheduled downgrade and any pending custom plan billing. `undefined`
+ * means not loaded.
+ */
+export declare function useCompany(): ResourceHandle<Company>;
+
+/**
+ * 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.