@schematichq/schematic-typescript-node 1.6.3 → 1.6.5

package/dist/api/resources/credits/types/GetCreditSpendPolicyUsageParams.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Input parameters
+ */
+export interface GetCreditSpendPolicyUsageParams {
+    billingCreditId?: string;
+    companyId?: string;
+    userIds?: string[];
+}

package/dist/api/resources/credits/types/GetCreditSpendPolicyUsageResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetCreditSpendPolicyUsageResponse {
+    data: Schematic.CreditSpendPolicyResponseData[];
+    /** Input parameters */
+    params: Schematic.GetCreditSpendPolicyUsageParams;
+}

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

@@ -22,8 +22,12 @@ export * from "./DeleteBillingPlanCreditGrantResponse";
 export * from "./DeleteCreditBundleResponse";
 export * from "./DeleteCreditSpendPolicyResponse";
 export * from "./ExtendCreditLeaseResponse";
+export * from "./GetCreditBalanceTimeSeriesParams";
+export * from "./GetCreditBalanceTimeSeriesResponse";
 export * from "./GetCreditBundleResponse";
 export * from "./GetCreditSpendPolicyResponse";
+export * from "./GetCreditSpendPolicyUsageParams";
+export * from "./GetCreditSpendPolicyUsageResponse";
 export * from "./GetSingleBillingCreditResponse";
 export * from "./GetSingleBillingPlanCreditGrantResponse";
 export * from "./GrantBillingCreditsToCompanyResponse";

package/dist/api/resources/entitlements/client/Client.d.ts

@@ -541,6 +541,75 @@ export declare class EntitlementsClient {
      */
     getUserUsageByCompany(request: Schematic.GetUserUsageByCompanyRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetUserUsageByCompanyResponse>;
     private __getUserUsageByCompany;
+    /**
+     * @param {Schematic.GetCompanyUserUsageMetricsRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.entitlements.getCompanyUserUsageMetrics({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         startTime: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    getCompanyUserUsageMetrics(request: Schematic.GetCompanyUserUsageMetricsRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCompanyUserUsageMetricsResponse>;
+    private __getCompanyUserUsageMetrics;
+    /**
+     * @param {Schematic.ListCompanyUserUsageRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.entitlements.listCompanyUserUsage({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         featureId: "feature_id",
+     *         metric: "credits",
+     *         limit: 1000000,
+     *         offset: 1000000,
+     *         startTime: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    listCompanyUserUsage(request: Schematic.ListCompanyUserUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyUserUsageResponse>;
+    private __listCompanyUserUsage;
+    /**
+     * @param {Schematic.CountCompanyUserUsageRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.entitlements.countCompanyUserUsage({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         featureId: "feature_id",
+     *         metric: "credits",
+     *         limit: 1000000,
+     *         offset: 1000000,
+     *         startTime: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    countCompanyUserUsage(request: Schematic.CountCompanyUserUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyUserUsageResponse>;
+    private __countCompanyUserUsage;
     /**
      * @param {Schematic.GetUserUsageDetailRequest} request
      * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/entitlements/client/requests/CountCompanyUserUsageRequest.d.ts

@@ -0,0 +1,29 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         featureId: "feature_id",
+ *         metric: "credits",
+ *         limit: 1000000,
+ *         offset: 1000000,
+ *         startTime: new Date("2024-01-15T09:30:00.000Z")
+ *     }
+ */
+export interface CountCompanyUserUsageRequest {
+    /** Company to break usage down for */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Which metric to break usage down by */
+    metric: Schematic.UserUsageMetric;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts

@@ -14,7 +14,7 @@ export interface CreateBillingLinkedPlanEntitlementRequestBody {
     billingProvider: Schematic.BillingProviderType;
     billingThreshold?: number;
     creditConsumptionRate?: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.CurrencyPriceRequestBody[];
     externalResourceId: string;
     featureId: string;
@@ -34,6 +34,8 @@ export interface CreateBillingLinkedPlanEntitlementRequestBody {
     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/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts

@@ -15,6 +15,8 @@ export interface CreateCompanyOverrideRequestBody {
     metricPeriod?: Schematic.MetricPeriod;
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     note?: string;
+    /** 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/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts

@@ -11,7 +11,7 @@ export interface CreatePlanEntitlementRequestBody {
     billingProductId?: string;
     billingThreshold?: number;
     creditConsumptionRate?: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.CurrencyPriceRequestBody[];
     featureId: string;
     metricPeriod?: Schematic.MetricPeriod;
@@ -30,6 +30,8 @@ export interface CreatePlanEntitlementRequestBody {
     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/resources/entitlements/client/requests/GetCompanyUserUsageMetricsRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         startTime: new Date("2024-01-15T09:30:00.000Z")
+ *     }
+ */
+export interface GetCompanyUserUsageMetricsRequest {
+    /** Company to list available metrics for */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/client/requests/ListCompanyUserUsageRequest.d.ts

@@ -0,0 +1,29 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         featureId: "feature_id",
+ *         metric: "credits",
+ *         limit: 1000000,
+ *         offset: 1000000,
+ *         startTime: new Date("2024-01-15T09:30:00.000Z")
+ *     }
+ */
+export interface ListCompanyUserUsageRequest {
+    /** Company to break usage down for */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Which metric to break usage down by */
+    metric: Schematic.UserUsageMetric;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts

@@ -11,6 +11,8 @@ export interface UpdateCompanyOverrideRequestBody {
     metricPeriod?: Schematic.MetricPeriod;
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     note?: string;
+    /** 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/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts

@@ -9,7 +9,7 @@ export interface UpdatePlanEntitlementRequestBody {
     billingProductId?: string;
     billingThreshold?: number;
     creditConsumptionRate?: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.CurrencyPriceRequestBody[];
     metricPeriod?: Schematic.MetricPeriod;
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
@@ -25,6 +25,8 @@ export interface UpdatePlanEntitlementRequestBody {
     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/resources/entitlements/client/requests/index.d.ts

@@ -1,4 +1,5 @@
 export type { CountCompanyOverridesRequest } from "./CountCompanyOverridesRequest";
+export type { CountCompanyUserUsageRequest } from "./CountCompanyUserUsageRequest";
 export type { CountFeatureCompaniesRequest } from "./CountFeatureCompaniesRequest";
 export type { CountFeatureUsageRequest } from "./CountFeatureUsageRequest";
 export type { CountFeatureUsersRequest } from "./CountFeatureUsersRequest";
@@ -7,11 +8,13 @@ export type { CreateBillingLinkedPlanEntitlementRequestBody } from "./CreateBill
 export type { CreateCompanyOverrideRequestBody } from "./CreateCompanyOverrideRequestBody";
 export type { CreatePlanEntitlementRequestBody } from "./CreatePlanEntitlementRequestBody";
 export type { DuplicatePlanEntitlementsRequestBody } from "./DuplicatePlanEntitlementsRequestBody";
+export type { GetCompanyUserUsageMetricsRequest } from "./GetCompanyUserUsageMetricsRequest";
 export type { GetFeatureUsageByCompanyRequest } from "./GetFeatureUsageByCompanyRequest";
 export type { GetFeatureUsageTimeSeriesRequest } from "./GetFeatureUsageTimeSeriesRequest";
 export type { GetUserUsageByCompanyRequest } from "./GetUserUsageByCompanyRequest";
 export type { GetUserUsageDetailRequest } from "./GetUserUsageDetailRequest";
 export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
+export type { ListCompanyUserUsageRequest } from "./ListCompanyUserUsageRequest";
 export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
 export type { ListFeatureUsageHistoryRequest } from "./ListFeatureUsageHistoryRequest";
 export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";

package/dist/api/resources/entitlements/types/CountCompanyUserUsageParams.d.ts

@@ -0,0 +1,20 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface CountCompanyUserUsageParams {
+    /** Company to break usage down for */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Which metric to break usage down by */
+    metric?: Schematic.UserUsageMetric;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/types/CountCompanyUserUsageResponse.d.ts

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

package/dist/api/resources/entitlements/types/GetCompanyUserUsageMetricsParams.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Input parameters
+ */
+export interface GetCompanyUserUsageMetricsParams {
+    /** Company to list available metrics for */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/types/GetCompanyUserUsageMetricsResponse.d.ts

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

package/dist/api/resources/entitlements/types/ListCompanyUserUsageParams.d.ts

@@ -0,0 +1,20 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListCompanyUserUsageParams {
+    /** Company to break usage down for */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Which metric to break usage down by */
+    metric?: Schematic.UserUsageMetric;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/types/ListCompanyUserUsageResponse.d.ts

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

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

@@ -1,5 +1,7 @@
 export * from "./CountCompanyOverridesParams";
 export * from "./CountCompanyOverridesResponse";
+export * from "./CountCompanyUserUsageParams";
+export * from "./CountCompanyUserUsageResponse";
 export * from "./CountFeatureCompaniesParams";
 export * from "./CountFeatureCompaniesResponse";
 export * from "./CountFeatureUsageParams";
@@ -14,6 +16,8 @@ export * from "./DeleteCompanyOverrideResponse";
 export * from "./DeletePlanEntitlementResponse";
 export * from "./DuplicatePlanEntitlementsResponse";
 export * from "./GetCompanyOverrideResponse";
+export * from "./GetCompanyUserUsageMetricsParams";
+export * from "./GetCompanyUserUsageMetricsResponse";
 export * from "./GetFeatureUsageByCompanyParams";
 export * from "./GetFeatureUsageByCompanyResponse";
 export * from "./GetFeatureUsageTimeSeriesParams";
@@ -25,6 +29,8 @@ export * from "./GetUserUsageDetailParams";
 export * from "./GetUserUsageDetailResponse";
 export * from "./ListCompanyOverridesParams";
 export * from "./ListCompanyOverridesResponse";
+export * from "./ListCompanyUserUsageParams";
+export * from "./ListCompanyUserUsageResponse";
 export * from "./ListFeatureCompaniesParams";
 export * from "./ListFeatureCompaniesResponse";
 export * from "./ListFeatureUsageHistoryParams";

package/dist/api/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts

@@ -12,6 +12,8 @@ import type * as Schematic from "../../../../index";
 export interface CreateBillingLinkedFeatureRequestBody {
     billingProvider: Schematic.BillingProviderType;
     description: string;
+    /** Which event stream meters this feature; defaults to track, and cannot change after creation. Inference is only valid on event features: their event_subtype matches the event label on inference events, and they meter through credits only. */
+    eventSource?: Schematic.FeatureEventSource;
     eventSubtype?: string;
     externalResourceId: string;
     featureType: Schematic.FeatureType;

package/dist/api/resources/features/client/requests/CreateFeatureRequestBody.d.ts

@@ -9,6 +9,8 @@ import type * as Schematic from "../../../../index";
  */
 export interface CreateFeatureRequestBody {
     description: string;
+    /** Which event stream meters this feature; defaults to track, and cannot change after creation. Inference is only valid on event features: their event_subtype matches the event label on inference events, and they meter through credits only. */
+    eventSource?: Schematic.FeatureEventSource;
     eventSubtype?: string;
     featureType: Schematic.FeatureType;
     flag?: Schematic.CreateOrUpdateFlagRequestBody;

package/dist/api/resources/features/client/requests/UpdateFeatureRequestBody.d.ts

@@ -5,6 +5,8 @@ import type * as Schematic from "../../../../index";
  */
 export interface UpdateFeatureRequestBody {
     description?: string;
+    /** Which event stream meters this feature. It is fixed at creation: an update that changes it is rejected. */
+    eventSource?: Schematic.FeatureEventSource;
     eventSubtype?: string;
     featureType?: Schematic.FeatureType;
     flag?: Schematic.CreateOrUpdateFlagRequestBody;

package/dist/api/resources/plangroups/client/Client.d.ts

@@ -63,6 +63,7 @@ export declare class PlangroupsClient {
      *         prorationBehavior: "create_prorations",
      *         showAsMonthlyPrices: true,
      *         showCredits: true,
+     *         showEstimatedTotal: true,
      *         showFeatureDescription: true,
      *         showHardLimit: true,
      *         showPeriodToggle: true,
@@ -108,6 +109,7 @@ export declare class PlangroupsClient {
      *         prorationBehavior: "create_prorations",
      *         showAsMonthlyPrices: true,
      *         showCredits: true,
+     *         showEstimatedTotal: true,
      *         showFeatureDescription: true,
      *         showHardLimit: true,
      *         showPeriodToggle: true,

package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts

@@ -23,6 +23,7 @@ import type * as Schematic from "../../../../index";
  *         prorationBehavior: "create_prorations",
  *         showAsMonthlyPrices: true,
  *         showCredits: true,
+ *         showEstimatedTotal: true,
  *         showFeatureDescription: true,
  *         showHardLimit: true,
  *         showPeriodToggle: true,
@@ -61,6 +62,7 @@ export interface CreatePlanGroupRequestBody {
     scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts

@@ -23,6 +23,7 @@ import type * as Schematic from "../../../../index";
  *         prorationBehavior: "create_prorations",
  *         showAsMonthlyPrices: true,
  *         showCredits: true,
+ *         showEstimatedTotal: true,
  *         showFeatureDescription: true,
  *         showHardLimit: true,
  *         showPeriodToggle: true,
@@ -61,6 +62,7 @@ export interface UpdatePlanGroupRequestBody {
     scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

package/dist/api/resources/planmigrations/client/Client.d.ts

@@ -88,6 +88,7 @@ export declare class PlanmigrationsClient {
      * @example
      *     await client.planmigrations.listMigrations({
      *         featureId: "feature_id",
+     *         featurePlanRolloutId: "feature_plan_rollout_id",
      *         planVersionId: "plan_version_id",
      *         status: "cancelled",
      *         limit: 1000000,
@@ -204,6 +205,7 @@ export declare class PlanmigrationsClient {
      * @example
      *     await client.planmigrations.countMigrations({
      *         featureId: "feature_id",
+     *         featurePlanRolloutId: "feature_plan_rollout_id",
      *         planVersionId: "plan_version_id",
      *         status: "cancelled",
      *         limit: 1000000,

package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts

@@ -3,6 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         featureId: "feature_id",
+ *         featurePlanRolloutId: "feature_plan_rollout_id",
  *         planVersionId: "plan_version_id",
  *         status: "cancelled",
  *         limit: 1000000,
@@ -11,6 +12,7 @@ import type * as Schematic from "../../../../index";
  */
 export interface CountMigrationsRequest {
     featureId?: string;
+    featurePlanRolloutId?: string;
     planVersionId?: string;
     status?: Schematic.PlanVersionMigrationStatus;
     /** Page limit (default 100) */

package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts

@@ -14,7 +14,10 @@ export interface CreateMigrationInput {
     planId: string;
     planVersionIdTo: string;
     planVersionIdsFrom?: string[];
+    /** How Stripe handles the price difference when companies are migrated. With 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. */
     prorationBehavior?: Schematic.MigrationProrationBehavior;
+    /** When every company moves, for strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies. */
+    scheduledAt?: Date;
     strategy: Schematic.PlanVersionMigrationStrategy;
     targetPlanType: Schematic.PlanType;
 }

package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts

@@ -3,6 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         featureId: "feature_id",
+ *         featurePlanRolloutId: "feature_plan_rollout_id",
  *         planVersionId: "plan_version_id",
  *         status: "cancelled",
  *         limit: 1000000,
@@ -11,6 +12,7 @@ import type * as Schematic from "../../../../index";
  */
 export interface ListMigrationsRequest {
     featureId?: string;
+    featurePlanRolloutId?: string;
     planVersionId?: string;
     status?: Schematic.PlanVersionMigrationStatus;
     /** Page limit (default 100) */

package/dist/api/resources/planmigrations/types/CountMigrationsParams.d.ts

@@ -4,6 +4,7 @@ import type * as Schematic from "../../../index";
  */
 export interface CountMigrationsParams {
     featureId?: string;
+    featurePlanRolloutId?: string;
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */

package/dist/api/resources/planmigrations/types/ListMigrationsParams.d.ts

@@ -4,6 +4,7 @@ import type * as Schematic from "../../../index";
  */
 export interface ListMigrationsParams {
     featureId?: string;
+    featurePlanRolloutId?: string;
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */

package/dist/api/resources/plans/client/Client.d.ts

@@ -46,7 +46,7 @@ export declare class PlansClient {
      *     await client.plans.listCustomPlanBillings({
      *         companyId: "company_id",
      *         planId: "plan_id",
-     *         planBillingSource: "custom_plan",
+     *         planBillingSource: "amendment",
      *         status: "active",
      *         statuses: ["active"],
      *         limit: 1000000,
@@ -394,6 +394,25 @@ export declare class PlansClient {
      */
     deletePlanVersion(plan_version_id: string, request?: Schematic.DeletePlanVersionRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
     private __deletePlanVersion;
+    /**
+     * @param {string} plan_version_id - plan_version_id
+     * @param {Schematic.GetPlanVersionDiffRequest} request
+     * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.plans.getPlanVersionDiff("plan_version_id", {
+     *         against: "against"
+     *     })
+     */
+    getPlanVersionDiff(plan_version_id: string, request?: Schematic.GetPlanVersionDiffRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanVersionDiffResponse>;
+    private __getPlanVersionDiff;
     /**
      * @param {string} plan_version_id - plan_version_id
      * @param {Schematic.PublishPlanVersionRequestBody} request

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         against: "against"
+ *     }
+ */
+export interface GetPlanVersionDiffRequest {
+    /** The version to compare against. Defaults to the plan's published version. */
+    against?: string;
+}

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

@@ -4,7 +4,7 @@ import type * as Schematic from "../../../../index";
  *     {
  *         companyId: "company_id",
  *         planId: "plan_id",
- *         planBillingSource: "custom_plan",
+ *         planBillingSource: "amendment",
  *         status: "active",
  *         statuses: ["active"],
  *         limit: 1000000,
@@ -16,7 +16,7 @@ export interface ListCustomPlanBillingsRequest {
     companyId?: string;
     /** Filter by plan ID */
     planId?: string;
-    /** 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 billing status */
     status?: Schematic.CustomPlanBillingStatus;