@schematichq/schematic-typescript-node 1.6.4 → 1.6.5

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

@@ -0,0 +1,137 @@
+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";
+};
+export type Currency = (typeof Currency)[keyof typeof Currency];

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

@@ -1,6 +1,6 @@
 import type * as Schematic from "../index";
 export interface CurrencyPriceRequestBody {
-    currency: string;
+    currency: Schematic.Currency;
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;

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

@@ -5,15 +5,21 @@ export interface CustomPlanBillingResponseData {
     billingCycleAnchor?: Date;
     /** The date the contract term starts, when the operator pinned one. A past date was backdated onto the subscription so the first period runs from the contract date rather than from finalization. */
     billingStartDate?: Date;
+    /** The checkout this billing record was created from, when it was created from one. */
+    checkoutId?: string;
     companyId: string;
     createdAt: Date;
     daysUntilDue: number;
     externalInvoiceId?: string;
     id: string;
+    /** The plan version migration this amendment invoice belongs to. Null for a first publish or a plan assigned through Manage Plan. */
+    migrationId?: string;
     paidAt?: Date;
-    /** The flow that created this billing record: a custom plan, or a standard plan assigned by invoice through Manage Plan. */
+    /** The flow that created this billing record: a custom plan's first publish, an amendment of a live custom plan, or a standard plan assigned by invoice through Manage Plan. */
     planBillingSource: Schematic.PlanBillingSource;
     planId: string;
+    /** What the linked checkout still reports wrong, in the order found. Empty when there is no linked checkout or it completed cleanly. */
+    problems: Schematic.CheckoutProblemResponseData[];
     /** Whether the shortened period the renewal date created was billed pro rata when the subscription started. False means that period is free and the first invoice is the one raised on the renewal date. */
     prorateFirstPeriod?: boolean;
     publishedAt?: Date;

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

@@ -1,6 +1,6 @@
 import type * as Schematic from "../index";
 export interface EntitlementCurrencyPricesResponseData {
-    currency: string;
+    currency: Schematic.Currency;
     monthlyPrice?: Schematic.BillingPriceView;
     quarterlyPrice?: Schematic.BillingPriceView;
     yearlyPrice?: Schematic.BillingPriceView;

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

@@ -1,6 +1,6 @@
 import type * as Schematic from "../index";
 export interface EstimatedPlanTotal {
     amount: number;
-    currency: string;
+    currency: Schematic.Currency;
     period: Schematic.PlanPriceCadence;
 }

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

@@ -5,6 +5,8 @@ export interface FeatureDetailResponseData {
     billingProduct?: Schematic.BillingProductResponseData;
     createdAt: Date;
     description: string;
+    /** Which event stream meters this feature. Track features are metered by track events; inference features are metered by inference events whose event label matches event_subtype, and meter through credits only. */
+    eventSource: Schematic.FeatureEventSource;
     eventSubtype?: string;
     eventSummary?: Schematic.EventSummaryResponseData;
     featureType: Schematic.FeatureType;

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

@@ -30,6 +30,8 @@ export interface FeatureEntitlement {
     metricResetAt?: Date;
     /** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
     monthReset?: Schematic.MetricPeriodMonthReset;
+    /** 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 */
+    quantityRates?: Record<string, number>;
     /** For usage-based pricing, the soft limit for overage charges or the next tier boundary */
     softLimit?: number;
     /** If the company has a numeric entitlement for this feature, the current usage amount */

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

@@ -0,0 +1,5 @@
+export declare const FeatureEventSource: {
+    readonly Inference: "inference";
+    readonly Track: "track";
+};
+export type FeatureEventSource = (typeof FeatureEventSource)[keyof typeof FeatureEventSource];

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

@@ -3,6 +3,8 @@ export interface FeatureInPlanResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     createdAt: Date;
     description: string;
+    /** Which event stream meters this feature. Track features are metered by track events; inference features are metered by inference events whose event label matches event_subtype, and meter through credits only. */
+    eventSource: Schematic.FeatureEventSource;
     eventSubtype?: string;
     eventSummary?: Schematic.EventSummaryResponseData;
     featureType: Schematic.FeatureType;

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

@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
 export interface FeatureResponseData {
     createdAt: Date;
     description: string;
+    /** Which event stream meters this feature. Track features are metered by track events; inference features are metered by inference events whose event label matches event_subtype, and meter through credits only. */
+    eventSource: Schematic.FeatureEventSource;
     eventSubtype?: string;
     featureType: Schematic.FeatureType;
     icon: string;

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

@@ -5,6 +5,7 @@ export interface FeatureView {
     billingProduct?: Schematic.BillingProductRecordResponseData;
     createdAt: Date;
     description: string;
+    eventSource: Schematic.FeatureEventSource;
     eventSubtype?: string;
     eventSummary?: Schematic.EventSummaryResponseData;
     featureType: Schematic.FeatureType;

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

@@ -4,7 +4,7 @@ export interface InvoiceRequestBody {
     amountPaid: number;
     amountRemaining: number;
     collectionMethod: string;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     dueDate?: Date;
     endingBalance?: number;

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

@@ -6,7 +6,7 @@ export interface InvoiceResponseData {
     collectionMethod: string;
     companyId?: string;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     dueDate?: Date;
     endingBalance: number;

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

@@ -1,4 +1,5 @@
 import type * as Schematic from "../index";
 export interface ManagePlanPreviewResponseResponseData {
+    problems: Schematic.CheckoutProblemResponseData[];
     subscriptionChangePreview?: Schematic.PreviewSubscriptionChangeResponseData;
 }

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

@@ -20,10 +20,12 @@ export interface ManagePlanRequest {
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
     /** ISO 4217 currency this change is being built in. Prices are still selected by id; this records the intent. */
-    currency?: string;
+    currency?: Schematic.Currency;
     customFieldValues: Schematic.CheckoutFieldValue[];
     /** Payment terms in days for an invoiced subscription. Defaults to 30. */
     daysUntilDue?: number;
+    /** If true, the first invoice is recorded in Stripe as paid outside Stripe and the company gets the plan straight away. Requires collection_method to be send_invoice, and the invoice is not emailed. Defaults to false. */
+    paidOutsideStripe?: boolean;
     payInAdvanceEntitlements: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodExternalId?: string;
     promoCode?: string;

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

@@ -1,5 +1,7 @@
 import type * as Schematic from "../index";
 export interface ManagePlanResponseResponseData {
+    checkoutId?: string;
     company?: Schematic.CompanyDetailResponseData;
+    problems: Schematic.CheckoutProblemResponseData[];
     success: boolean;
 }

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

@@ -1,4 +1,5 @@
+import type * as Schematic from "../index";
 export interface MrrResponseData {
     amount: number;
-    currency: string;
+    currency: Schematic.Currency;
 }

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

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

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

@@ -7,7 +7,7 @@ export interface PendingMigrationResponseData {
     prorationBehavior?: Schematic.MigrationProrationBehavior;
     /** Deprecated; use effective_at, which carries the same value. */
     scheduledFor?: Date;
-    /** Whether the company moves at the end of its billing period (end_of_billing_period) or on a specific date (scheduled). The type is shared with plan version migrations, but only those two values appear here: an immediate migration never pends. */
+    /** Whether the company moves at the end of its billing period (end_of_billing_period) or on a specific date (scheduled). The type is shared with plan version migrations, but only those two values appear here: this view lists deferred migrations only, so an immediate migration is never shown, even while it is pending. */
     strategy: Schematic.PlanVersionMigrationStrategy;
     toPlanId: string;
     toPlanName: string;

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

@@ -1,4 +1,5 @@
 export declare const PlanBillingSource: {
+    readonly Amendment: "amendment";
     readonly CustomPlan: "custom_plan";
     readonly ManagePlan: "manage_plan";
 };

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

@@ -1,4 +1,5 @@
 export declare const PlanChangeAction: {
+    readonly Amendment: "amendment";
     readonly Checkout: "checkout";
     readonly CompanyUpsert: "company_upsert";
     readonly FallbackPlan: "fallback_plan";

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

@@ -0,0 +1,8 @@
+export declare const PlanChangeAmendmentStatus: {
+    readonly Applied: "applied";
+    readonly Cancelled: "cancelled";
+    readonly Failed: "failed";
+    readonly Scheduled: "scheduled";
+    readonly Skipped: "skipped";
+};
+export type PlanChangeAmendmentStatus = (typeof PlanChangeAmendmentStatus)[keyof typeof PlanChangeAmendmentStatus];

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

@@ -4,6 +4,8 @@ export interface PlanChangeResponseData {
     actorType: Schematic.ActorType;
     addOnsAdded: Schematic.PlanSnapshotView[];
     addOnsRemoved: Schematic.PlanSnapshotView[];
+    /** Set when the action is amendment. A custom plan amendment records one plan change per status: scheduled when it is finalized for a later date, then applied when the company moves to the new version, cancelled when the scheduled change is called off, or failed or skipped when its migration ends without moving the company (an error, or the company was no longer on the version the amendment started from). Only an applied amendment changed the company's plan version. */
+    amendmentStatus?: Schematic.PlanChangeAmendmentStatus;
     apiKey?: Schematic.ApiKeyResponseData;
     auditLog?: Schematic.AuditLogListResponseData;
     basePlan?: Schematic.PlanSnapshotView;
@@ -20,6 +22,8 @@ export interface PlanChangeResponseData {
     integration?: Schematic.IntegrationResponseData;
     /** True when this change moved the company to a different version of the same plan (e.g. a plan version migration) rather than to a different plan. */
     isVersionUpgrade: boolean;
+    /** The plan version migration that carries this change. Set on amendment plan changes, where it ties the scheduled, applied and cancelled records of one amendment together. */
+    migrationId?: string;
     previousBasePlan?: Schematic.PlanSnapshotView;
     /** The plan version of the previous base plan before this change. */
     previousBasePlanVersion?: Schematic.PlanVersionSnapshotView;

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

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

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

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

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

@@ -1,5 +1,6 @@
+import type * as Schematic from "../index";
 export interface PlanCurrencyPriceRequestBody {
-    currency: string;
+    currency: Schematic.Currency;
     monthlyPrice?: number;
     oneTimePrice?: number;
     quarterlyPrice?: number;

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

@@ -1,6 +1,6 @@
 import type * as Schematic from "../index";
 export interface PlanCurrencyPricesResponseData {
-    currency: string;
+    currency: Schematic.Currency;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     oneTimePrice?: Schematic.BillingPriceResponseData;
     quarterlyPrice?: Schematic.BillingPriceResponseData;

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

@@ -21,6 +21,8 @@ export interface PlanEntitlementResponseData {
     plan?: Schematic.PlanResponseData;
     planId: string;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
+    /** 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;
     softLimit?: number;

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

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

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

@@ -0,0 +1,5 @@
+import type * as Schematic from "../index";
+export interface PlanVersionBillingProductChangeResponseData {
+    "new"?: Schematic.BillingProductDetailResponseData;
+    old?: Schematic.BillingProductDetailResponseData;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface PlanVersionCreditGrantChangeResponseData {
+    changeType: Schematic.PlanVersionDiffChangeType;
+    /** For a changed grant, the fields that differ. */
+    changedFields: string[];
+    creditId: string;
+    "new"?: Schematic.BillingPlanCreditGrantResponseData;
+    old?: Schematic.BillingPlanCreditGrantResponseData;
+}

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

@@ -0,0 +1,6 @@
+export declare const PlanVersionDiffChangeType: {
+    readonly Added: "added";
+    readonly Changed: "changed";
+    readonly Removed: "removed";
+};
+export type PlanVersionDiffChangeType = (typeof PlanVersionDiffChangeType)[keyof typeof PlanVersionDiffChangeType];

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

@@ -0,0 +1,7 @@
+export declare const PlanVersionDiffPriceCadence: {
+    readonly Monthly: "monthly";
+    readonly OneTime: "one_time";
+    readonly Quarterly: "quarterly";
+    readonly Yearly: "yearly";
+};
+export type PlanVersionDiffPriceCadence = (typeof PlanVersionDiffPriceCadence)[keyof typeof PlanVersionDiffPriceCadence];

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

@@ -0,0 +1,19 @@
+import type * as Schematic from "../index";
+export interface PlanVersionDiffResponseData {
+    /** Set when the version's billing product changed; null when it is the same on both versions. */
+    billingProduct?: Schematic.PlanVersionBillingProductChangeResponseData;
+    /** Credit grants added, removed, or changed, keyed by credit. */
+    creditGrants: Schematic.PlanVersionCreditGrantChangeResponseData[];
+    /** Entitlements added, removed, or changed, keyed by feature. */
+    entitlements: Schematic.PlanVersionEntitlementChangeResponseData[];
+    /** The version compared against, or null when the plan has no published version. */
+    from?: Schematic.PlanVersionResponseData;
+    /** Whether moving a subscription from the compared version to this one changes its billing. */
+    hasBillingChanges: boolean;
+    /** Plan-level fields that changed: name, description, icon, and charge_type. */
+    planFields: Schematic.PlanVersionFieldChangeResponseData[];
+    /** Base prices that changed, one entry per currency and cadence. */
+    prices: Schematic.PlanVersionPriceChangeResponseData[];
+    /** The version being compared. */
+    to?: Schematic.PlanVersionResponseData;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface PlanVersionEntitlementChangeResponseData {
+    changeType: Schematic.PlanVersionDiffChangeType;
+    /** For a changed entitlement, the fields that differ. usage_quantity is the committed quantity of a pay-in-advance entitlement. */
+    changedFields: string[];
+    featureId: string;
+    "new"?: Schematic.PlanEntitlementResponseData;
+    old?: Schematic.PlanEntitlementResponseData;
+}

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

@@ -0,0 +1,5 @@
+export interface PlanVersionFieldChangeResponseData {
+    field: string;
+    "new": string;
+    old: string;
+}

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

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface PlanVersionPriceChangeResponseData {
+    cadence: Schematic.PlanVersionDiffPriceCadence;
+    currency: Schematic.Currency;
+    "new"?: Schematic.BillingPriceResponseData;
+    old?: Schematic.BillingPriceResponseData;
+}

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

@@ -16,6 +16,7 @@ export interface PlanViewPublicResponseData {
     controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
+    creditVisibility?: Schematic.PlanCreditVisibility[];
     credits: Schematic.BillingCreditResponseData[];
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     custom: boolean;

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

@@ -11,6 +11,7 @@ export interface PreviewSubscriptionChangeResponseData {
     paymentMethodRequired: boolean;
     percentOff: number;
     periodStart: Date;
+    problems: Schematic.CheckoutProblemResponseData[];
     promoCodeApplied: boolean;
     proration: number;
     scheduledChangeTime?: Date;

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

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

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface PreviewSubscriptionFinanceResponseData {
     amountOff: number;
     /** ISO 4217 currency every amount in this block is denominated in. */
-    currency: string;
+    currency: Schematic.Currency;
     discountAmount: number;
     discounts: Schematic.PreviewSubscriptionDiscountResponseData[];
     dueNow: number;

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

@@ -12,6 +12,7 @@ export interface RulesengineCondition {
     metricPeriodMonthReset?: Schematic.RulesengineMetricPeriodMonthReset;
     metricValue?: number;
     operator: Schematic.RulesengineComparableOperator;
+    quantityRates?: Record<string, number>;
     resourceIds: string[];
     traitDefinition?: Schematic.RulesengineTraitDefinition;
     traitValue: string;

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

@@ -30,6 +30,8 @@ export interface RulesengineFeatureEntitlement {
     metricResetAt?: Date;
     /** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
     monthReset?: Schematic.RulesengineMetricPeriodMonthReset;
+    /** 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 */
+    quantityRates?: Record<string, number>;
     /** For usage-based pricing, the soft limit for overage charges or the next tier boundary */
     softLimit?: number;
     /** If the company has a numeric entitlement for this feature, the current usage amount */

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

@@ -1,5 +1,6 @@
+import type * as Schematic from "../index";
 export interface ScheduledDowngradeResponseData {
-    currency: string;
+    currency: Schematic.Currency;
     effectiveAfter: Date;
     fromPlanId: string;
     fromPlanName: string;

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

@@ -6,7 +6,7 @@ export interface UpcomingInvoiceResponseData {
     collectionMethod: string;
     companyId?: string;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     dueDate?: Date;
     endingBalance: number;

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

@@ -3,6 +3,8 @@ export interface UpdateEntitlementReqCommon {
     creditConsumptionRate?: number;
     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/UpsertBillingProductRequestBody.d.ts

@@ -3,7 +3,7 @@ export interface UpsertBillingProductRequestBody {
     billingProductId?: string;
     billingStrategy?: Schematic.BillingStrategy;
     chargeType: Schematic.ChargeType;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.PlanCurrencyPriceRequestBody[];
     isTrialable: boolean;
     monthlyPrice?: number;

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface UsageBasedEntitlementRequestBody {
     billingProductId?: string;
     billingThreshold?: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.CurrencyPriceRequestBody[];
     monthlyMeteredPriceId?: string;
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];