@schematichq/schematic-typescript-node 1.5.0 → 1.5.2

package/dist/Client.d.ts

@@ -69,6 +69,14 @@ export declare class SchematicClient {
     get scheduledcheckout(): ScheduledcheckoutClient;
     get accesstokens(): AccesstokensClient;
     get webhooks(): WebhooksClient;
+    /**
+     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.getCreditLedger()
+     */
+    getCreditLedger(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __getCreditLedger;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.

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

@@ -54,6 +54,36 @@ export declare class BillingClient {
      */
     upsertBillingCoupon(request: Schematic.CreateCouponRequestBody, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingCouponResponse>;
     private __upsertBillingCoupon;
+    /**
+     * @param {string} billing_id - billing_id
+     * @param {BillingClient.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}
+     *
+     * @example
+     *     await client.billing.deleteBillingCoupon("billing_id")
+     */
+    deleteBillingCoupon(billing_id: string, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingCouponResponse>;
+    private __deleteBillingCoupon;
+    /**
+     * @param {string} billing_id - billing_id
+     * @param {BillingClient.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}
+     *
+     * @example
+     *     await client.billing.deleteBillingCustomer("billing_id")
+     */
+    deleteBillingCustomer(billing_id: string, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingCustomerResponse>;
+    private __deleteBillingCustomer;
     /**
      * @param {Schematic.CreateBillingCustomerRequestBody} request
      * @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -164,6 +194,21 @@ export declare class BillingClient {
      */
     upsertInvoice(request: Schematic.CreateInvoiceRequestBody, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertInvoiceResponse>;
     private __upsertInvoice;
+    /**
+     * @param {string} billing_id - billing_id
+     * @param {BillingClient.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}
+     *
+     * @example
+     *     await client.billing.deleteBillingInvoice("billing_id")
+     */
+    deleteBillingInvoice(billing_id: string, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingInvoiceResponse>;
+    private __deleteBillingInvoice;
     /**
      * @param {Schematic.ListMetersRequest} request
      * @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -275,6 +320,7 @@ export declare class BillingClient {
      *         ids: ["ids"],
      *         interval: "interval",
      *         isActive: true,
+     *         planVersionId: "plan_version_id",
      *         price: 1000000,
      *         productId: "product_id",
      *         productIds: ["product_ids"],
@@ -350,6 +396,7 @@ export declare class BillingClient {
      *         ids: ["ids"],
      *         interval: "interval",
      *         isActive: true,
+     *         planVersionId: "plan_version_id",
      *         price: 1000000,
      *         productId: "product_id",
      *         productIds: ["product_ids"],

package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts

@@ -8,6 +8,7 @@ import type * as Schematic from "../../../../index";
  *         ids: ["ids"],
  *         interval: "interval",
  *         isActive: true,
+ *         planVersionId: "plan_version_id",
  *         price: 1000000,
  *         productId: "product_id",
  *         productIds: ["product_ids"],
@@ -31,6 +32,8 @@ export interface ListBillingPricesRequest {
     interval?: string;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string | string[];

package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts

@@ -8,6 +8,7 @@ import type * as Schematic from "../../../../index";
  *         ids: ["ids"],
  *         interval: "interval",
  *         isActive: true,
+ *         planVersionId: "plan_version_id",
  *         price: 1000000,
  *         productId: "product_id",
  *         productIds: ["product_ids"],
@@ -31,6 +32,8 @@ export interface ListBillingProductPricesRequest {
     interval?: string;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string | string[];

package/dist/api/resources/billing/types/DeleteBillingCouponResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface DeleteBillingCouponResponse {
+    data: Schematic.DeleteResponse;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/billing/types/DeleteBillingCustomerResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface DeleteBillingCustomerResponse {
+    data: Schematic.DeleteResponse;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/billing/types/DeleteBillingInvoiceResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface DeleteBillingInvoiceResponse {
+    data: Schematic.DeleteResponse;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/billing/types/ListBillingPricesParams.d.ts

@@ -17,6 +17,8 @@ export interface ListBillingPricesParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string[];

package/dist/api/resources/billing/types/ListBillingProductPricesParams.d.ts

@@ -17,6 +17,8 @@ export interface ListBillingProductPricesParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string[];

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

@@ -2,6 +2,9 @@ export * from "./CountBillingProductsParams";
 export * from "./CountBillingProductsResponse";
 export * from "./CountCustomersParams";
 export * from "./CountCustomersResponse";
+export * from "./DeleteBillingCouponResponse";
+export * from "./DeleteBillingCustomerResponse";
+export * from "./DeleteBillingInvoiceResponse";
 export * from "./DeleteBillingProductResponse";
 export * from "./DeletePaymentMethodByExternalIdResponse";
 export * from "./DeleteProductPriceResponse";

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

@@ -419,54 +419,6 @@ export declare class CreditsClient {
      */
     releaseCreditLease(lease_id: string, request: Schematic.ReleaseCreditLeaseRequestBody, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ReleaseCreditLeaseResponse>;
     private __releaseCreditLease;
-    /**
-     * @param {Schematic.GetEnrichedCreditLedgerRequest} request
-     * @param {CreditsClient.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}
-     *
-     * @example
-     *     await client.credits.getEnrichedCreditLedger({
-     *         companyId: "company_id",
-     *         billingCreditId: "billing_credit_id",
-     *         featureId: "feature_id",
-     *         period: "daily",
-     *         startTime: "start_time",
-     *         endTime: "end_time",
-     *         limit: 1000000,
-     *         offset: 1000000
-     *     })
-     */
-    getEnrichedCreditLedger(request: Schematic.GetEnrichedCreditLedgerRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetEnrichedCreditLedgerResponse>;
-    private __getEnrichedCreditLedger;
-    /**
-     * @param {Schematic.CountCreditLedgerRequest} request
-     * @param {CreditsClient.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}
-     *
-     * @example
-     *     await client.credits.countCreditLedger({
-     *         companyId: "company_id",
-     *         billingCreditId: "billing_credit_id",
-     *         featureId: "feature_id",
-     *         period: "daily",
-     *         startTime: "start_time",
-     *         endTime: "end_time",
-     *         limit: 1000000,
-     *         offset: 1000000
-     *     })
-     */
-    countCreditLedger(request: Schematic.CountCreditLedgerRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditLedgerResponse>;
-    private __countCreditLedger;
     /**
      * @param {Schematic.ListBillingPlanCreditGrantsRequest} request
      * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -5,13 +5,11 @@ export type { CountBillingPlanCreditGrantsRequest } from "./CountBillingPlanCred
 export type { CountCompanyGrantsRequest } from "./CountCompanyGrantsRequest";
 export type { CountCreditBundlesRequest } from "./CountCreditBundlesRequest";
 export type { CountCreditEventLedgerRequest } from "./CountCreditEventLedgerRequest";
-export type { CountCreditLedgerRequest } from "./CountCreditLedgerRequest";
 export type { CreateBillingCreditRequestBody } from "./CreateBillingCreditRequestBody";
 export type { CreateCompanyCreditGrant } from "./CreateCompanyCreditGrant";
 export type { CreateCreditBundleRequestBody } from "./CreateCreditBundleRequestBody";
 export type { DeleteBillingPlanCreditGrantRequest } from "./DeleteBillingPlanCreditGrantRequest";
 export type { ExtendCreditLeaseRequestBody } from "./ExtendCreditLeaseRequestBody";
-export type { GetEnrichedCreditLedgerRequest } from "./GetEnrichedCreditLedgerRequest";
 export type { ListBillingCreditsRequest } from "./ListBillingCreditsRequest";
 export type { ListBillingPlanCreditGrantsRequest } from "./ListBillingPlanCreditGrantsRequest";
 export type { ListCompanyCreditBalancesRequest } from "./ListCompanyCreditBalancesRequest";

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

@@ -11,8 +11,6 @@ export * from "./CountCreditBundlesParams";
 export * from "./CountCreditBundlesResponse";
 export * from "./CountCreditEventLedgerParams";
 export * from "./CountCreditEventLedgerResponse";
-export * from "./CountCreditLedgerParams";
-export * from "./CountCreditLedgerResponse";
 export * from "./CreateBillingCreditResponse";
 export * from "./CreateBillingPlanCreditGrantResponse";
 export * from "./CreateCreditBundleResponse";
@@ -21,8 +19,6 @@ export * from "./DeleteBillingPlanCreditGrantResponse";
 export * from "./DeleteCreditBundleResponse";
 export * from "./ExtendCreditLeaseResponse";
 export * from "./GetCreditBundleResponse";
-export * from "./GetEnrichedCreditLedgerParams";
-export * from "./GetEnrichedCreditLedgerResponse";
 export * from "./GetSingleBillingCreditResponse";
 export * from "./GetSingleBillingPlanCreditGrantResponse";
 export * from "./GrantBillingCreditsToCompanyResponse";

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

@@ -43,6 +43,7 @@ export declare class PlangroupsClient {
      *         checkoutCollectEmail: true,
      *         checkoutCollectPhone: true,
      *         enableTaxCollection: true,
+     *         optInEnabled: true,
      *         orderedAddOns: [{
      *                 planId: "plan_id"
      *             }],
@@ -84,6 +85,7 @@ export declare class PlangroupsClient {
      *         checkoutCollectEmail: true,
      *         checkoutCollectPhone: true,
      *         enableTaxCollection: true,
+     *         optInEnabled: true,
      *         orderedAddOns: [{
      *                 planId: "plan_id"
      *             }],

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

@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
  *         checkoutCollectEmail: true,
  *         checkoutCollectPhone: true,
  *         enableTaxCollection: true,
+ *         optInEnabled: true,
  *         orderedAddOns: [{
  *                 planId: "plan_id"
  *             }],
@@ -42,6 +43,9 @@ export interface CreatePlanGroupRequestBody {
     fallbackPlanId?: string;
     initialPlanId?: string;
     initialPlanPriceId?: string;
+    optInEnabled: boolean;
+    optInText?: string;
+    optInTitle?: string;
     orderedAddOns: Schematic.OrderedPlansInGroup[];
     orderedBundleList: Schematic.PlanGroupBundleOrder[];
     orderedPlans: Schematic.OrderedPlansInGroup[];

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

@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
  *         checkoutCollectEmail: true,
  *         checkoutCollectPhone: true,
  *         enableTaxCollection: true,
+ *         optInEnabled: true,
  *         orderedAddOns: [{
  *                 planId: "plan_id"
  *             }],
@@ -42,6 +43,9 @@ export interface UpdatePlanGroupRequestBody {
     fallbackPlanId?: string;
     initialPlanId?: string;
     initialPlanPriceId?: string;
+    optInEnabled: boolean;
+    optInText?: string;
+    optInTitle?: string;
     orderedAddOns: Schematic.OrderedPlansInGroup[];
     orderedBundleList: Schematic.PlanGroupBundleOrder[];
     orderedPlans: Schematic.OrderedPlansInGroup[];

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

@@ -81,11 +81,7 @@ export declare class PlansClient {
      *
      * @example
      *     await client.plans.retryCustomPlanBilling("custom_plan_billing_id", {
-     *         customerEmail: "customer_email",
-     *         payInAdvance: [{
-     *                 priceId: "price_id",
-     *                 quantity: 1000000
-     *             }]
+     *         customerEmail: "customer_email"
      *     })
      */
     retryCustomPlanBilling(custom_plan_billing_id: string, request: Schematic.RetryCustomPlanBillingRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.RetryCustomPlanBillingResponse>;
@@ -374,11 +370,7 @@ export declare class PlansClient {
      * @example
      *     await client.plans.publishPlanVersion("plan_id", {
      *         excludedCompanyIds: ["excluded_company_ids"],
-     *         migrationStrategy: "immediate",
-     *         payInAdvance: [{
-     *                 priceId: "price_id",
-     *                 quantity: 1000000
-     *             }]
+     *         migrationStrategy: "immediate"
      *     })
      */
     publishPlanVersion(plan_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;

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

@@ -3,11 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         excludedCompanyIds: ["excluded_company_ids"],
- *         migrationStrategy: "immediate",
- *         payInAdvance: [{
- *                 priceId: "price_id",
- *                 quantity: 1000000
- *             }]
+ *         migrationStrategy: "immediate"
  *     }
  */
 export interface PublishPlanVersionRequestBody {
@@ -16,5 +12,4 @@ export interface PublishPlanVersionRequestBody {
     daysUntilDue?: number;
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
-    payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
 }

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

@@ -2,16 +2,11 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
- *         customerEmail: "customer_email",
- *         payInAdvance: [{
- *                 priceId: "price_id",
- *                 quantity: 1000000
- *             }]
+ *         customerEmail: "customer_email"
  *     }
  */
 export interface RetryCustomPlanBillingRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     customerEmail: string;
     daysUntilDue?: number;
-    payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
 }

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

@@ -149,6 +149,24 @@ export declare class WebhooksClient {
      */
     deleteWebhook(webhook_id: string, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteWebhookResponse>;
     private __deleteWebhook;
+    /**
+     * @param {string} webhook_id - webhook_id
+     * @param {Schematic.TestWebhookRequestBody} request
+     * @param {WebhooksClient.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}
+     *
+     * @example
+     *     await client.webhooks.sendTestWebhookAction("webhook_id", {
+     *         requestType: "subscription.trial.ended"
+     *     })
+     */
+    sendTestWebhookAction(webhook_id: string, request: Schematic.TestWebhookRequestBody, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<Schematic.SendTestWebhookActionResponse>;
+    private __sendTestWebhookAction;
     /**
      * @param {Schematic.CountWebhooksRequest} request
      * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/webhooks/client/requests/TestWebhookRequestBody.d.ts

@@ -0,0 +1,10 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         requestType: "subscription.trial.ended"
+ *     }
+ */
+export interface TestWebhookRequestBody {
+    requestType: Schematic.WebhookRequestType;
+}

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

@@ -3,4 +3,5 @@ export type { CountWebhooksRequest } from "./CountWebhooksRequest";
 export type { CreateWebhookRequestBody } from "./CreateWebhookRequestBody";
 export type { ListWebhookEventsRequest } from "./ListWebhookEventsRequest";
 export type { ListWebhooksRequest } from "./ListWebhooksRequest";
+export type { TestWebhookRequestBody } from "./TestWebhookRequestBody";
 export type { UpdateWebhookRequestBody } from "./UpdateWebhookRequestBody";

package/dist/api/resources/webhooks/types/SendTestWebhookActionResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface SendTestWebhookActionResponse {
+    data: Schematic.TestWebhookResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

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

@@ -10,4 +10,5 @@ export * from "./ListWebhookEventsParams";
 export * from "./ListWebhookEventsResponse";
 export * from "./ListWebhooksParams";
 export * from "./ListWebhooksResponse";
+export * from "./SendTestWebhookActionResponse";
 export * from "./UpdateWebhookResponse";

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

@@ -1,5 +1,4 @@
 export declare const AccountMemberPermission: {
-    readonly BillingCreditsEdit: "billing_credits_edit";
     readonly CompaniesEdit: "companies_edit";
     readonly CompanyUsersEdit: "company_users_edit";
     readonly ComponentsEdit: "components_edit";

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

@@ -3,5 +3,6 @@ export declare const BillingCreditGrantZeroedOutReason: {
     readonly Manual: "manual";
     readonly PlanChange: "plan_change";
     readonly PlanPeriodReset: "plan_period_reset";
+    readonly Reconciled: "reconciled";
 };
 export type BillingCreditGrantZeroedOutReason = (typeof BillingCreditGrantZeroedOutReason)[keyof typeof BillingCreditGrantZeroedOutReason];

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

@@ -8,6 +8,7 @@ export interface ChangeSubscriptionInternalRequestBody {
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;
+    optInAccepted?: boolean;
     payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodId?: string;
     promoCode?: string;

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

@@ -7,6 +7,7 @@ export interface ChangeSubscriptionRequestBody {
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;
+    optInAccepted?: boolean;
     payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodId?: string;
     promoCode?: string;

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

@@ -1,5 +1,7 @@
 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>;
     flags: Schematic.CheckFlagResponseData[];
     plan?: Schematic.DatastreamCompanyPlan;
 }

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

@@ -2,4 +2,7 @@ export interface CheckoutSettingsResponseData {
     collectAddress: boolean;
     collectEmail: boolean;
     collectPhone: boolean;
+    optInEnabled: boolean;
+    optInText?: string;
+    optInTitle?: string;
 }

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

@@ -0,0 +1,8 @@
+export interface CompanyCreditBalance {
+    /** Remaining credit, excluding any open lease hold (the value SDKs gate on) */
+    remaining: number;
+    /** Amount held by the company's open credit lease, 0 when none is open */
+    reserved: number;
+    /** Spendable balance including the open lease hold (remaining + reserved) */
+    settled: number;
+}

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

@@ -7,6 +7,7 @@ export interface CompanySubscriptionResponseData {
     discounts: Schematic.BillingSubscriptionDiscountView[];
     expiredAt?: Date;
     interval: string;
+    isInitial: boolean;
     latestInvoice?: Schematic.InvoiceResponseData;
     paymentMethod?: Schematic.PaymentMethodResponseData;
     products: Schematic.BillingProductForSubscriptionResponseData[];

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

@@ -2,16 +2,24 @@ import type * as Schematic from "../index";
 export interface FeatureEntitlement {
     /** If the company has a numeric entitlement for this feature, the allocated amount */
     allocation?: number;
+    /** If the company has a credit-based entitlement for this feature, the credit cost per unit of usage */
+    consumptionRate?: number;
     /** If the company has a credit-based entitlement for this feature, the ID of the credit */
     creditId?: string;
-    /** If the company has a credit-based entitlement for this feature, the remaining credit amount */
+    /** If the company has a credit-based entitlement for this feature, the credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead */
     creditRemaining?: number;
+    /** If the company has a credit-based entitlement for this feature, the unspent amount held by an open credit lease. Returns to credit_remaining when the lease is released */
+    creditReserved?: number;
+    /** If the company has a credit-based entitlement for this feature, the balance net of actual consumption, unaffected by open lease holds (credit_remaining plus credit_reserved). The number to display to end users */
+    creditSettled?: number;
     /** If the company has a credit-based entitlement for this feature, the total credit amount */
     creditTotal?: number;
     /** If the company has a credit-based entitlement for this feature, the amount of credit used */
     creditUsed?: number;
     /** If the feature is event-based, the name of the event tracked for usage */
     eventName?: string;
+    /** For event-based or credit-metered feature entitlements, the event subtype whose usage is tracked */
+    eventSubtype?: string;
     /** The ID of the feature */
     featureId: string;
     /** The key of the flag associated with the feature */

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

@@ -16,6 +16,8 @@ export interface PlanChangeResponseData {
     createdAt: Date;
     environmentId: string;
     id: string;
+    /** 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;
     previousBasePlan?: Schematic.PlanSnapshotView;
     /** The plan version of the previous base plan before this change. */
     previousBasePlanVersion?: Schematic.PlanVersionSnapshotView;

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

@@ -5,6 +5,9 @@ export interface PreviewSubscriptionChangeResponseData {
     finance?: Schematic.PreviewSubscriptionFinanceResponseData;
     isScheduledDowngrade: boolean;
     newCharges: number;
+    optInRequired: boolean;
+    optInText?: string;
+    optInTitle?: string;
     paymentMethodRequired: boolean;
     percentOff: number;
     periodStart: Date;

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

@@ -2,16 +2,24 @@ import type * as Schematic from "../index";
 export interface RulesengineFeatureEntitlement {
     /** If the company has a numeric entitlement for this feature, the allocated amount */
     allocation?: number;
+    /** If the company has a credit-based entitlement for this feature, the credit cost per unit of usage */
+    consumptionRate?: number;
     /** If the company has a credit-based entitlement for this feature, the ID of the credit */
     creditId?: string;
-    /** If the company has a credit-based entitlement for this feature, the remaining credit amount */
+    /** If the company has a credit-based entitlement for this feature, the credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead */
     creditRemaining?: number;
+    /** If the company has a credit-based entitlement for this feature, the unspent amount held by an open credit lease. Returns to credit_remaining when the lease is released */
+    creditReserved?: number;
+    /** If the company has a credit-based entitlement for this feature, the balance net of actual consumption, unaffected by open lease holds (credit_remaining plus credit_reserved). The number to display to end users */
+    creditSettled?: number;
     /** If the company has a credit-based entitlement for this feature, the total credit amount */
     creditTotal?: number;
     /** If the company has a credit-based entitlement for this feature, the amount of credit used */
     creditUsed?: number;
     /** If the feature is event-based, the name of the event tracked for usage */
     eventName?: string;
+    /** For event-based or credit-metered feature entitlements, the event subtype whose usage is tracked */
+    eventSubtype?: string;
     /** The ID of the feature */
     featureId: string;
     /** The key of the flag associated with the feature */

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

@@ -0,0 +1,4 @@
+export interface TestWebhookResponseData {
+    responseCode: number;
+    success: boolean;
+}

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

@@ -73,6 +73,7 @@ export * from "./CheckoutFieldWithValue";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
 export * from "./ClerkIntegrationConfig";
+export * from "./CompanyCreditBalance";
 export * from "./CompanyCreditBalanceResponseData";
 export * from "./CompanyDetailResponseData";
 export * from "./CompanyEventPeriodMetricsResponseData";
@@ -137,8 +138,6 @@ export * from "./CreditGrantDetail";
 export * from "./CreditGrantExpiryRequestBody";
 export * from "./CreditGrantSortOrder";
 export * from "./CreditLeaseResponseData";
-export * from "./CreditLedgerEnrichedEntryResponseData";
-export * from "./CreditLedgerPeriod";
 export * from "./CreditsAutoTopupCompanySummary";
 export * from "./CreditsAutoTopupCreditSummary";
 export * from "./CreditsAutoTopupHardFailure";
@@ -341,6 +340,7 @@ export * from "./SubscriptionTraitUpdate";
 export * from "./SubscriptionType";
 export * from "./TemporaryAccessTokenResourceType";
 export * from "./TemporaryAccessTokenResponseData";
+export * from "./TestWebhookResponseData";
 export * from "./TimeSeriesGranularity";
 export * from "./TopFeatureByUsageResponseData";
 export * from "./TopFeaturesByUsageResponseData";