@schematichq/schematic-react 1.12.0 → 1.14.0

package/dist/schematic-react.d.ts

@@ -57,6 +57,8 @@ export declare interface BillingActions {
     removePaymentMethod(id: string): Promise<void>;
     /** Mints a new setup intent every call; nothing is cached. */
     createSetupIntent(): Promise<SetupIntent>;
+    /** Cancels the subscription at period end and reloads what that changes. */
+    unsubscribe(): Promise<void>;
 }
 
 declare namespace billingApi {
@@ -121,6 +123,48 @@ declare namespace billingApi {
         CatalogPriceTierResponseDataToJSON,
         CatalogPriceTierResponseDataToJSONTyped,
         CatalogPriceTierResponseData,
+        instanceOfCheckoutUnsubscribeResponse,
+        CheckoutUnsubscribeResponseFromJSON,
+        CheckoutUnsubscribeResponseFromJSONTyped,
+        CheckoutUnsubscribeResponseToJSON,
+        CheckoutUnsubscribeResponseToJSONTyped,
+        CheckoutUnsubscribeResponse,
+        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,
@@ -223,6 +267,18 @@ declare namespace billingApi {
         CreateSetupIntentResponseToJSON,
         CreateSetupIntentResponseToJSONTyped,
         CreateSetupIntentResponse,
+        instanceOfCurrency,
+        CurrencyFromJSON,
+        CurrencyFromJSONTyped,
+        CurrencyToJSON,
+        CurrencyToJSONTyped,
+        Currency,
+        instanceOfCustomPlanActivationStrategy,
+        CustomPlanActivationStrategyFromJSON,
+        CustomPlanActivationStrategyFromJSONTyped,
+        CustomPlanActivationStrategyToJSON,
+        CustomPlanActivationStrategyToJSONTyped,
+        CustomPlanActivationStrategy,
         instanceOfDeletePaymentMethodResponse,
         DeletePaymentMethodResponseFromJSON,
         DeletePaymentMethodResponseFromJSONTyped,
@@ -313,6 +369,12 @@ declare namespace billingApi {
         GetCompanyPaymentMethodsResponseToJSON,
         GetCompanyPaymentMethodsResponseToJSONTyped,
         GetCompanyPaymentMethodsResponse,
+        instanceOfGetCompanyResponse,
+        GetCompanyResponseFromJSON,
+        GetCompanyResponseFromJSONTyped,
+        GetCompanyResponseToJSON,
+        GetCompanyResponseToJSONTyped,
+        GetCompanyResponse,
         instanceOfGetCompanyUpcomingInvoiceResponse,
         GetCompanyUpcomingInvoiceResponseFromJSON,
         GetCompanyUpcomingInvoiceResponseFromJSONTyped,
@@ -388,6 +450,12 @@ declare interface BillingClient {
     updatePaymentMethod(externalId: string): Promise<void>;
     /** Removes the method, by Schematic's id (`id`). */
     deletePaymentMethod(id: string): Promise<void>;
+    /**
+     * Cancels the company's subscription at the end of its billing period.
+     * Rejects when it has no single active subscription, or that one is
+     * already set to cancel.
+     */
+    cancelSubscription(): 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. */
@@ -396,6 +464,8 @@ declare interface BillingClient {
     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;
@@ -570,7 +640,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" | "fetchCreditBalances" | "fetchCreditUserUsage">;
+export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage" | "fetchCreditBalances" | "fetchCreditUserUsage" | "fetchCompany" | "cancelSubscription">;
 
 declare interface BillingProviderDataProps {
     /**
@@ -610,7 +680,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" | "creditBalances";
+export declare type BillingResourceName = "invoices" | "upcomingInvoice" | "paymentMethods" | "featureUsage" | "creditBalances" | "company";
 
 declare type BillingResourceName_2 = keyof BillingResources_2;
 
@@ -623,6 +693,7 @@ declare interface BillingResourceParams_2 {
     paymentMethods: Record<string, never>;
     featureUsage: Record<string, never>;
     creditBalances: Record<string, never>;
+    company: Record<string, never>;
 }
 
 export declare type BillingResources = Pick<BillingResources_2, BillingResourceName>;
@@ -659,6 +730,8 @@ declare interface BillingResources_2 {
      * loaded.
      */
     creditBalances: CreditBalanceEntry[];
+    /** `GET /company`. */
+    company: Company;
 }
 
 /**
@@ -756,10 +829,10 @@ declare interface CatalogCreditGrantResponseData {
 declare interface CatalogPriceResponseData {
     /**
      *
-     * @type {string}
+     * @type {Currency}
      * @memberof CatalogPriceResponseData
      */
-    currency: string;
+    currency: Currency;
     /**
      *
      * @type {string}
@@ -1118,6 +1191,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
@@ -1161,6 +1530,12 @@ export declare interface CompanyCreditBalance {
  * @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}
@@ -1505,17 +1880,6 @@ declare interface 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
@@ -1536,10 +1900,10 @@ declare interface CompanyDiscountResponseData {
     couponName: string;
     /**
      *
-     * @type {string}
+     * @type {Currency}
      * @memberof CompanyDiscountResponseData
      */
-    currency?: string | null;
+    currency?: Currency | null;
     /**
      *
      * @type {string}
@@ -1836,10 +2200,10 @@ declare interface CompanyInvoiceResponseData {
     createdAt: Date;
     /**
      *
-     * @type {string}
+     * @type {Currency}
      * @memberof CompanyInvoiceResponseData
      */
-    currency: string;
+    currency: Currency;
     /**
      *
      * @type {Date}
@@ -1969,6 +2333,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
@@ -1983,10 +2352,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}
@@ -2098,6 +2467,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 */
@@ -2119,6 +2490,8 @@ export declare type CreditBalance = {
  * * 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;
 
@@ -2299,6 +2672,162 @@ declare interface CreditUserUsageRequest {
 
 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
@@ -2937,6 +3466,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;
@@ -3249,7 +3780,9 @@ declare class SchematicBillingClient implements BillingClient {
     createSetupIntent(): Promise<SetupIntent>;
     updatePaymentMethod(externalId: string): Promise<void>;
     deletePaymentMethod(id: string): Promise<void>;
+    cancelSubscription(): Promise<void>;
     fetchFeatureUsage(): Promise<FeatureUsage[]>;
+    fetchCompany(): Promise<Company>;
     fetchCreditBalances(): Promise<CreditBalanceEntry[]>;
     fetchCreditUserUsage(params: CreditUserUsageRequest): Promise<CreditUserUsage>;
     fetchFeatureUserUsage(params: FeatureUserUsageRequest): Promise<FeatureUserUsage>;
@@ -3344,6 +3877,13 @@ declare namespace SchematicJS {
         CheckPlanReturn,
         CheckPlanReturnFromJSON,
         CheckPlanReturnListenerFn,
+        Company,
+        CompanyContextCustomPlanBillingResponseData,
+        CompanyContextPlanResponseData,
+        CompanyContextResponseData,
+        CompanyContextScheduledDowngradeResponseData,
+        CompanyContextSubscriptionResponseData,
+        CompanyCreditAutoTopupResponseData,
         CompanyCreditBalance,
         CompanyCreditBalanceResponseData,
         CompanyCreditCompositionResponseData,
@@ -3355,9 +3895,12 @@ declare namespace SchematicJS {
         CompanyFeatureUserUsageResponseData,
         CompanyInvoiceResponseData,
         CompanyPaymentMethodResponseData,
+        CompanyPlan,
+        CompanySubscription,
         CompanyUpcomingInvoiceResponseData,
         CompanyUserUsageResponseData,
         ContextSignatureProvider,
+        CreditAutoTopup,
         CreditBalance,
         CreditBalanceEntry,
         CreditBalanceListenerFn,
@@ -3377,6 +3920,7 @@ declare namespace SchematicJS {
         CreditSpendWindow,
         CreditUserUsage,
         CreditUserUsageRow,
+        CustomPlanBilling,
         DEFAULT_INVOICE_QUERY,
         Discount,
         EmptyListenerFn,
@@ -3407,6 +3951,7 @@ declare namespace SchematicJS {
         RequestOptions,
         ResourceState,
         RuleType,
+        ScheduledDowngrade,
         Schematic,
         SchematicApiError,
         SchematicBillingClient,
@@ -3722,6 +4267,19 @@ export declare const TrialStatus: {
 
 export declare type TrialStatus = (typeof TrialStatus)[keyof typeof TrialStatus];
 
+export declare interface UnsubscribeHandle {
+    /**
+     * Cancels the subscription at period end; the company, its next bill and
+     * its credits reload once it lands. Rejects with the failure and records
+     * it on `mutationError`.
+     */
+    unsubscribe: () => Promise<void>;
+    /** The cancellation is in flight. */
+    isMutating: boolean;
+    /** The last attempt's failure; cleared when the next one starts. */
+    mutationError: Error | undefined;
+}
+
 export declare type UpcomingInvoice = CompanyUpcomingInvoiceResponseData;
 
 export declare enum UsagePeriod {
@@ -3733,6 +4291,13 @@ 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.
@@ -3848,6 +4413,12 @@ export declare function useSchematicTranslate(): Translate | undefined;
  */
 export declare function useSetupIntent(): SetupIntentHandle;
 
+/**
+ * Cancels the company's subscription. Subscribes to no resource: read the
+ * subscription's state from `useCompany`, which reloads once this lands.
+ */
+export declare function useUnsubscribe(): UnsubscribeHandle;
+
 /**
  * The company's next bill. `data` is `null` when there is nothing to bill —
  * no subscription, which the endpoint reports as a 204 — so an element can