@schematichq/schematic-typescript-node 1.6.3 → 1.6.5

package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts

@@ -7,22 +7,32 @@ import type * as Schematic from "../../../../index";
  *     }
  */
 export interface PublishPlanVersionRequestBody {
+    /** When the company gets the plan. On a custom-plan republish, on_payment is only accepted when the amendment is invoiced today (migration_strategy immediate, proration_behavior always_invoice, collection_method send_invoice): the company stays on its current version until that invoice is paid. */
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     address?: Schematic.CustomerBillingAddress;
     /** The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription. */
     billingCycleAnchor?: Date;
+    /** The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. Only honored on a first publish that starts a subscription. */
+    billingStartDate?: Date;
+    /** How the invoice a custom-plan republish raises today is collected. send_invoice (the default) issues it for the company to pay; charge_automatically charges the default payment method straight away. Only accepted on a custom-plan republish with migration_strategy immediate and proration_behavior always_invoice. */
+    collectionMethod?: Schematic.BillingCollectionMethod;
+    /** A Stripe coupon to apply. On a custom-plan republish it discounts the amendment invoice and is only used when that invoice is raised today; it must exist in Stripe. It is attached to the subscription, so a repeating or forever coupon also discounts the renewals that follow. */
     couponExternalId?: string;
     customFieldValues?: Schematic.CheckoutFieldValue[];
     customerEmail?: string;
+    /** Payment terms in days. On a custom-plan republish they apply to the amendment invoice only, leave the subscription's renewal terms unchanged, and are only used when that invoice is raised today and sent rather than charged. Defaults to the subscription's terms. */
     daysUntilDue?: number;
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
     phone?: string;
     /** When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true. */
     prorateFirstPeriod?: boolean;
+    /** How Stripe handles the price difference when companies are migrated. With migration_strategy immediate, omitted means create_prorations. With end_of_billing_period only none is accepted and means the same as omitting it: the change lands on the renewal boundary, so there is nothing to prorate. With scheduled any value is accepted and omitted means none. Not accepted with leave. */
     prorationBehavior?: Schematic.MigrationProrationBehavior;
     /** Refuse the publish if any company would be migrated onto the new version */
     requireNoMigration?: boolean;
+    /** When every company moves, for migration_strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies. */
+    scheduledAt?: Date;
     /** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
     sendInvoice?: boolean;
     taxId?: Schematic.TaxIdInput;

package/dist/api/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts

@@ -9,6 +9,8 @@ export interface RetryCustomPlanBillingRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     /** The date the subscription's billing period renews on. Only honored when the retry creates a subscription. */
     billingCycleAnchor?: Date;
+    /** The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. When both are omitted, the term pinned at finalize is reissued. Only honored when the retry creates a subscription. */
+    billingStartDate?: Date;
     customerEmail: string;
     daysUntilDue?: number;
     /** When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true. */

package/dist/api/resources/plans/client/requests/index.d.ts

@@ -4,6 +4,7 @@ export type { CreateBillingLinkedPlanRequestBody } from "./CreateBillingLinkedPl
 export type { CreateCustomPlanRequestBody } from "./CreateCustomPlanRequestBody";
 export type { DeletePlanVersionRequest } from "./DeletePlanVersionRequest";
 export type { GetPlanRequest } from "./GetPlanRequest";
+export type { GetPlanVersionDiffRequest } from "./GetPlanVersionDiffRequest";
 export type { ListBillingProductMatchCompaniesRequest } from "./ListBillingProductMatchCompaniesRequest";
 export type { ListCustomPlanBillingsRequest } from "./ListCustomPlanBillingsRequest";
 export type { ListPlanIssuesRequest } from "./ListPlanIssuesRequest";

package/dist/api/resources/plans/types/GetPlanVersionDiffParams.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Input parameters
+ */
+export interface GetPlanVersionDiffParams {
+    /** The version to compare against. Defaults to the plan's published version. */
+    against?: string;
+}

package/dist/api/resources/plans/types/GetPlanVersionDiffResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetPlanVersionDiffResponse {
+    data: Schematic.PlanVersionDiffResponseData;
+    /** Input parameters */
+    params: Schematic.GetPlanVersionDiffParams;
+}

package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts

@@ -9,7 +9,7 @@ export interface ListCustomPlanBillingsParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
-    /** Filter by the flow that created the billing record. Defaults to custom_plan. */
+    /** Filter by the flow that created the billing record: custom_plan for a first publish, amendment for a republish, manage_plan for a standard plan assigned by invoice. Defaults to custom_plan. */
     planBillingSource?: Schematic.PlanBillingSource;
     /** Filter by plan ID */
     planId?: string;

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

@@ -9,6 +9,8 @@ export * from "./DeletePlanVersionParams";
 export * from "./DeletePlanVersionResponse";
 export * from "./GetPlanParams";
 export * from "./GetPlanResponse";
+export * from "./GetPlanVersionDiffParams";
+export * from "./GetPlanVersionDiffResponse";
 export * from "./ListBillingProductMatchCompaniesParams";
 export * from "./ListBillingProductMatchCompaniesResponse";
 export * from "./ListCustomPlanBillingsParams";

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface BillingCouponResponseData {
     accountId: string;
     amountOff?: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     duration?: string;
     durationInMonths?: number;
     environmentId: string;

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

@@ -10,7 +10,7 @@ export interface BillingCreditGrantResponseData {
     creditIcon?: string;
     creditId: string;
     creditName: string;
-    currency?: string;
+    currency?: Schematic.Currency;
     expiresAt?: Date;
     grantReason: Schematic.BillingCreditGrantReason;
     id: string;
@@ -20,7 +20,7 @@ export interface BillingCreditGrantResponseData {
     planName?: string;
     /** What the postpaid charges costs, in the currency's minor unit. */
     postpaidChargeAmount?: number;
-    postpaidChargeCurrency?: string;
+    postpaidChargeCurrency?: Schematic.Currency;
     /** Credits consumed past a zero balance in the window still open. */
     postpaidChargedCredits?: number;
     price?: Schematic.BillingPriceResponseData;

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

@@ -1,5 +1,6 @@
+import type * as Schematic from "../index";
 export interface BillingCustomerSubscription {
-    currency: string;
+    currency: Schematic.Currency;
     expiredAt?: Date;
     interval: string;
     meteredUsage: boolean;

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

@@ -1,6 +1,6 @@
 import type * as Schematic from "../index";
 export interface BillingPriceResponseData {
-    currency: string;
+    currency: Schematic.Currency;
     externalPriceId: string;
     id: string;
     interval: Schematic.BillingProductPriceInterval;

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface BillingPriceView {
     billingScheme: Schematic.BillingPriceScheme;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     id: string;
     interval: Schematic.BillingProductPriceInterval;
     intervalCount: number;

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

@@ -3,7 +3,7 @@ export interface BillingProductForSubscriptionResponseData {
     billingScheme: Schematic.BillingPriceScheme;
     billingThreshold?: number;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     environmentId: string;
     externalId: string;
     id: string;

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface BillingProductPriceResponseData {
     billingScheme: Schematic.BillingPriceScheme;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     id: string;
     interval: Schematic.BillingProductPriceInterval;
     intervalCount: number;

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

@@ -1,7 +1,7 @@
 import type * as Schematic from "../index";
 export interface BillingProductPricing {
     billingThreshold?: number;
-    currency: string;
+    currency: Schematic.Currency;
     interval: string;
     meterId?: string;
     packageSize?: number;

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

@@ -0,0 +1,4 @@
+import type * as Schematic from "../index";
+export interface BillingSettingsResponseData {
+    defaultProviderType?: Schematic.BillingProviderType;
+}

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

@@ -1,8 +1,9 @@
+import type * as Schematic from "../index";
 export interface BillingSubscriptionDiscountView {
     amountOff?: number;
     couponId: string;
     couponName: string;
-    currency?: string;
+    currency?: Schematic.Currency;
     customerFacingCode?: string;
     discountExternalId: string;
     duration: string;

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

@@ -5,7 +5,7 @@ export interface BillingSubscriptionResponseData {
     cancelAtPeriodEnd: boolean;
     companyId?: string;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     defaultPaymentMethodId?: string;
     expiredAt?: Date;

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

@@ -5,7 +5,7 @@ export interface BillingSubscriptionView {
     cancelAtPeriodEnd: boolean;
     companyId?: string;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     defaultPaymentMethodId?: string;
     discounts: Schematic.BillingSubscriptionDiscountView[];

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

@@ -1,5 +1,7 @@
 export interface CaptureRawEvent {
     capturedAt: Date;
+    contextSignature?: string;
+    contextSignatureChecked?: boolean;
     eventId?: string;
     rawBytes: string;
     remoteIp: string;

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

@@ -1,5 +1,6 @@
 import type * as Schematic from "../index";
 export interface CatalogConfigOrderedPlan {
+    credits?: Schematic.CatalogConfigPlanCredit[];
     entitlements?: Schematic.CatalogConfigOrderedEntitlement[];
     planId: string;
 }

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

@@ -1,5 +1,6 @@
 import type * as Schematic from "../index";
 export interface CatalogConfigOrderedPlanResponseData {
+    credits: Schematic.CatalogConfigPlanCreditResponseData[];
     entitlements: Schematic.CatalogConfigOrderedEntitlementResponseData[];
     planId: string;
 }

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

@@ -0,0 +1,4 @@
+export interface CatalogConfigPlanCredit {
+    creditId: string;
+    visible?: boolean;
+}

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

@@ -0,0 +1,4 @@
+export interface CatalogConfigPlanCreditResponseData {
+    creditId: string;
+    visible: boolean;
+}

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

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

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

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

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

@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
 export interface CheckFlagsResponseData {
     /** Lease-aware credit balances keyed by credit ID, covering every credit type the company holds a balance in */
     creditBalances?: Record<string, Schematic.CompanyCreditBalance>;
+    /** Credit spend policies binding the evaluated company and user; empty when none bind. Each response carries the whole set, so replace any previously received set with it. Advisory: the flag values do not reflect them, since a check names no draw amount */
+    creditSpendPolicies: Schematic.CreditSpendPolicy[];
     flags: Schematic.CheckFlagResponseData[];
     plan?: Schematic.DatastreamCompanyPlan;
 }

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

@@ -0,0 +1,47 @@
+export declare const CheckoutProblemCode: {
+    readonly AddOnConflictsWithPlan: "add_on_conflicts_with_plan";
+    readonly AddOnIntervalMismatch: "add_on_interval_mismatch";
+    readonly AddOnRequiresBilledPlan: "add_on_requires_billed_plan";
+    readonly AddOnUnavailable: "add_on_unavailable";
+    readonly BillingCycleAnchorConflictsWithTrial: "billing_cycle_anchor_conflicts_with_trial";
+    readonly BillingCycleAnchorMustBeFuture: "billing_cycle_anchor_must_be_future";
+    readonly BillingCycleAnchorNeedsNewSubscription: "billing_cycle_anchor_needs_new_subscription";
+    readonly BillingCycleAnchorWithoutPlan: "billing_cycle_anchor_without_plan";
+    readonly BillingStartDateMustBePast: "billing_start_date_must_be_past";
+    readonly BillingStartDateNeedsNewSubscription: "billing_start_date_needs_new_subscription";
+    readonly BillingStartDateNeedsRenewalDate: "billing_start_date_needs_renewal_date";
+    readonly BillingStartDateNotBeforeRenewalDate: "billing_start_date_not_before_renewal_date";
+    readonly BillingStartDateTooFarInPast: "billing_start_date_too_far_in_past";
+    readonly CreditBundleIncompatible: "credit_bundle_incompatible";
+    readonly CreditBundleUnavailable: "credit_bundle_unavailable";
+    readonly CreditBundlesActivateOnPayment: "credit_bundles_activate_on_payment";
+    readonly CurrencyMismatch: "currency_mismatch";
+    readonly CustomFieldRequired: "custom_field_required";
+    readonly DiscountIneligible: "discount_ineligible";
+    readonly DowngradeNotPermitted: "downgrade_not_permitted";
+    readonly FreeFirstPeriodActivatesOnPayment: "free_first_period_activates_on_payment";
+    readonly InvoiceEmailRequired: "invoice_email_required";
+    readonly InvoicedSubscriptionConflictsWithTrial: "invoiced_subscription_conflicts_with_trial";
+    readonly InvoicedSubscriptionNeedsNewSubscription: "invoiced_subscription_needs_new_subscription";
+    readonly InvoicedSubscriptionRequiresPlan: "invoiced_subscription_requires_plan";
+    readonly OptInRequired: "opt_in_required";
+    readonly PayInAdvancePriceInvalid: "pay_in_advance_price_invalid";
+    readonly PayInAdvanceRequired: "pay_in_advance_required";
+    readonly PaymentMethodRequired: "payment_method_required";
+    readonly PlanNotTrialable: "plan_not_trialable";
+    readonly PlanUnavailable: "plan_unavailable";
+    readonly PriceUnavailable: "price_unavailable";
+    readonly ProrateFirstPeriodWithoutAnchor: "prorate_first_period_without_anchor";
+    readonly ProviderRejected: "provider_rejected";
+    readonly ScheduledChangeBlocksPurchase: "scheduled_change_blocks_purchase";
+    readonly ScheduledChangePending: "scheduled_change_pending";
+    readonly SelectionInvalid: "selection_invalid";
+    readonly SubscriptionCurrencyChange: "subscription_currency_change";
+    readonly TrialEndMustBeFuture: "trial_end_must_be_future";
+    readonly TrialEndTooFar: "trial_end_too_far";
+    readonly TrialExcludesAddOns: "trial_excludes_add_ons";
+    readonly TrialExcludesUsageBased: "trial_excludes_usage_based";
+    readonly UsagePriceMissingForInterval: "usage_price_missing_for_interval";
+    readonly UsageOverLimit: "usage_over_limit";
+};
+export type CheckoutProblemCode = (typeof CheckoutProblemCode)[keyof typeof CheckoutProblemCode];

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

@@ -0,0 +1,19 @@
+import type * as Schematic from "../index";
+export interface CheckoutProblemResponseData {
+    /** Whether completing the checkout would be refused while this stands. */
+    blocking: boolean;
+    bundleId?: string;
+    code: Schematic.CheckoutProblemCode;
+    /** The currency this problem is about, when it is about one. */
+    currency?: Schematic.Currency;
+    /** Diagnostic detail for operators, including what the billing provider said. Never shown to a customer. */
+    detail?: string;
+    featureId?: string;
+    fieldId?: string;
+    /** What is wrong, in words safe for anyone allowed to read the checkout. */
+    message: string;
+    paymentMethodId?: string;
+    planId?: string;
+    priceId?: string;
+    source: Schematic.CheckoutProblemSource;
+}

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

@@ -0,0 +1,6 @@
+export declare const CheckoutProblemSource: {
+    readonly Provider: "provider";
+    readonly Requirement: "requirement";
+    readonly Validation: "validation";
+};
+export type CheckoutProblemSource = (typeof CheckoutProblemSource)[keyof typeof CheckoutProblemSource];

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

@@ -7,7 +7,7 @@ export interface CheckoutSubscription {
     confirmPaymentIntentClientSecret?: string;
     confirmPaymentIntentId?: string;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     defaultPaymentMethodId?: string;
     expiredAt?: Date;

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

@@ -3,7 +3,7 @@ export interface CompanyBillingEntitySubscriptionResponseData {
     cancelAt?: Date;
     cancelAtPeriodEnd: boolean;
     company?: Schematic.CompanyResponseData;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     discounts: Schematic.BillingSubscriptionDiscountView[];
     expiredAt?: Date;

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

@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
 export interface CompanyDetailResponseData {
     addOns: Schematic.CompanyPlanWithBillingSubView[];
     billingCreditBalances?: Record<string, number>;
+    billingEmail?: string;
     billingProfile?: Schematic.CompanyBillingProfileResponseData;
     billingProfiles?: Schematic.CompanyBillingProfileResponseData[];
     billingSubscription?: Schematic.BillingSubscriptionView;

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

@@ -12,6 +12,8 @@ export interface CompanyOverrideResponseData {
     metricPeriod?: Schematic.MetricPeriod;
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     notes: Schematic.CompanyOverrideNoteResponseData[];
+    /** Credits per unit of the quantity (per token for inference features), keyed by quantity key. Absent when the entitlement prices requests only. */
+    quantityRates?: Record<string, number>;
     ruleId?: string;
     ruleIdUsageExceeded?: string;
     updatedAt: Date;

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

@@ -17,6 +17,7 @@ export interface CompanyPlanDetailResponseData {
     controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
+    creditVisibility?: Schematic.PlanCreditVisibility[];
     credits: Schematic.BillingCreditResponseData[];
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     current: boolean;
@@ -25,6 +26,7 @@ export interface CompanyPlanDetailResponseData {
     description: string;
     draftVersion?: Schematic.PlanVersionResponseData;
     entitlements?: Schematic.PlanEntitlementResponseData[];
+    estimatedTotals?: Schematic.EstimatedPlanTotal[];
     features: Schematic.FeatureInPlanResponseData[];
     icon: Schematic.PlanIcon;
     id: string;

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface CompanySubscriptionResponseData {
     cancelAt?: Date;
     cancelAtPeriodEnd: boolean;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     discounts: Schematic.BillingSubscriptionDiscountView[];
     expiredAt?: Date;

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

@@ -0,0 +1,11 @@
+import type * as Schematic from "../index";
+export interface CompanyUserUsageMetricsResponseData {
+    /** End of the usage window (exclusive) */
+    endTime: Date;
+    /** Event-based features the company has user-attributed usage for in the window; a feature with usage but no entitlement is still listed */
+    features: Schematic.FeatureResponseData[];
+    /** Whether the company consumed any credits in the window */
+    hasCredits: boolean;
+    /** Start of the usage window */
+    startTime: Date;
+}

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

@@ -0,0 +1,15 @@
+import type * as Schematic from "../index";
+export interface CompanyUserUsageResponseData {
+    /** End of the usage window (exclusive) */
+    endTime: Date;
+    /** This page of per-user consumption within the window, heaviest first */
+    rows: Schematic.CompanyUserUsageRowResponseData[];
+    /** Start of the usage window */
+    startTime: Date;
+    /** The heaviest user's fraction (0-1) of consumption, measured across every user in the window and not just this page */
+    topUserShare: number;
+    /** Consumption across every user in the window including unattributed, not just this page */
+    total: number;
+    /** Consumption from events sent without a user; not a user, so it is excluded from rows and from the count, and returned on every page. Null when the window has none */
+    unattributed?: Schematic.CompanyUserUsageRowResponseData;
+}

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

@@ -0,0 +1,13 @@
+import type * as Schematic from "../index";
+export interface CompanyUserUsageRowResponseData {
+    /** When the user last used the feature within the window; null for the credits metric, which aggregates balances rather than timestamped events */
+    lastSeen?: Date;
+    /** This row's fraction (0-1) of consumption within the window, including unattributed consumption */
+    share: number;
+    /** The user the consumption is attributed to; null for consumption from events sent without a user */
+    user?: Schematic.UserResponseData;
+    /** The user the consumption is attributed to; null for unattributed consumption */
+    userId?: string;
+    /** The user's consumption of the metric within the window */
+    value: number;
+}

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

@@ -1,6 +1,7 @@
 export interface ComponentDisplaySettings {
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

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

@@ -1,6 +1,7 @@
 export interface ComponentSettingsResponseData {
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

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

@@ -12,6 +12,7 @@ export interface Condition {
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     metricValue?: number;
     operator: Schematic.ComparableOperator;
+    quantityRates?: Record<string, number>;
     resourceIds: string[];
     traitDefinition?: Schematic.TraitDefinition;
     traitValue: string;

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

@@ -15,6 +15,7 @@ export interface ConditionResponseData {
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     metricValue?: number;
     operator: Schematic.ComparableOperator;
+    quantityRates?: Record<string, number>;
     resourceUnspecifiedIds: string[];
     ruleId: string;
     traitEntityType?: Schematic.EntityType;

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

@@ -20,6 +20,7 @@ export interface ConditionView {
     operator: Schematic.ComparableOperator;
     planVersions: Schematic.GenericPreviewObject[];
     plans: Schematic.GenericPreviewObject[];
+    quantityRates?: Record<string, number>;
     resourceUnspecifiedIds: string[];
     ruleId: string;
     trait?: Schematic.EntityTraitDefinitionResponseData;

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

@@ -1,6 +1,7 @@
+import type * as Schematic from "../index";
 export interface CouponRequestBody {
     amountOff: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     duration: string;
     durationInMonths: number;
     maxRedemptions: number;

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

@@ -3,7 +3,7 @@ export interface CreateEntitlementInBundleRequestBody {
     billingProductId?: string;
     billingThreshold?: number;
     creditConsumptionRate?: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.CurrencyPriceRequestBody[];
     featureId: string;
     metricPeriod?: Schematic.MetricPeriod;
@@ -22,6 +22,8 @@ export interface CreateEntitlementInBundleRequestBody {
     priceBehavior?: Schematic.EntitlementPriceBehavior;
     /** Use MonthlyPriceTiers or YearlyPriceTiers instead */
     priceTiers?: Schematic.CreatePriceTierRequestBody[];
+    /** Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it. */
+    quantityRates?: Record<string, number>;
     quarterlyMeteredPriceId?: string;
     quarterlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     quarterlyUnitPrice?: number;

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

@@ -4,6 +4,8 @@ export interface CreateEntitlementReqCommon {
     featureId: string;
     metricPeriod?: Schematic.MetricPeriod;
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
+    /** Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it. */
+    quantityRates?: Record<string, number>;
     valueBool?: boolean;
     valueCreditId?: string;
     valueNumeric?: number;

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

@@ -0,0 +1,10 @@
+import type * as Schematic from "../index";
+export interface CreditBalanceEventResponseData {
+    amount: number;
+    eventType: Schematic.CreditEventType;
+    grantId?: string;
+    grantReason?: Schematic.BillingCreditGrantReason;
+    planId?: string;
+    timestamp: Date;
+    zeroedOutReason?: Schematic.BillingCreditGrantZeroedOutReason;
+}

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

@@ -0,0 +1,5 @@
+export interface CreditBalanceFeatureConsumptionResponseData {
+    amount: number;
+    featureId: string;
+    featureName: string;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface CreditBalancePointResponseData {
+    balance: number;
+    /** Credits drawn during this day, as a positive number */
+    consumed: number;
+    consumedByFeature: Schematic.CreditBalanceFeatureConsumptionResponseData[];
+    /** Start of the UTC day this point covers */
+    timestamp: Date;
+}

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

@@ -0,0 +1,8 @@
+import type * as Schematic from "../index";
+export interface CreditBalanceTimeSeriesResponseData {
+    balancePoints: Schematic.CreditBalancePointResponseData[];
+    billingCreditId: string;
+    events: Schematic.CreditBalanceEventResponseData[];
+    /** True when an external provider owns this credit's ledger, in which case Schematic has no history to report and the series is empty */
+    external: boolean;
+}

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

@@ -1,5 +1,5 @@
 import type * as Schematic from "../index";
 export interface CreditBundleCurrencyPrice {
-    currency: string;
+    currency: Schematic.Currency;
     price?: Schematic.BillingPriceView;
 }

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

@@ -1,5 +1,6 @@
+import type * as Schematic from "../index";
 export interface CreditBundleCurrencyPriceRequestBody {
-    currency: string;
+    currency: Schematic.Currency;
     pricePerUnit?: number;
     pricePerUnitDecimal?: string;
 }

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

@@ -1,5 +1,5 @@
 import type * as Schematic from "../index";
 export interface CreditBundleCurrencyPriceResponseData {
-    currency: string;
+    currency: Schematic.Currency;
     price?: Schematic.BillingPriceResponseData;
 }