@schematichq/schematic-typescript-node 1.4.6 → 1.4.8

package/dist/api/resources/integrationsapi/types/ListIntegrationsParams.d.ts

@@ -0,0 +1,15 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListIntegrationsParams {
+    billingOnly?: boolean;
+    excludeIds?: string[];
+    id?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    state?: Schematic.IntegrationState;
+    type?: Schematic.IntegrationType;
+}

package/dist/api/resources/integrationsapi/types/ListIntegrationsResponse.d.ts

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

package/dist/api/resources/integrationsapi/types/LoadSampleDataSetResponse.d.ts

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

package/dist/api/resources/{companies/types/CreatePlanTraitResponse.d.ts → integrationsapi/types/RunIntegrationResponse.d.ts}

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

package/dist/api/resources/integrationsapi/types/StartDataImportResponse.d.ts

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

package/dist/api/resources/{companies/types/DeletePlanTraitResponse.d.ts → integrationsapi/types/UninstallIntegrationResponse.d.ts}

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

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

@@ -1 +1,10 @@
+export * from "./AssumeStripeInstalledResponse";
 export * from "./GetIntegrationWebhookUrlResponse";
+export * from "./InstallIntegrationResponse";
+export * from "./InstallStripeResponse";
+export * from "./ListIntegrationsParams";
+export * from "./ListIntegrationsResponse";
+export * from "./LoadSampleDataSetResponse";
+export * from "./RunIntegrationResponse";
+export * from "./StartDataImportResponse";
+export * from "./UninstallIntegrationResponse";

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

@@ -10,6 +10,25 @@ export declare namespace PlanbundleClient {
 export declare class PlanbundleClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PlanbundleClient.Options>;
     constructor(options: PlanbundleClient.Options);
+    /**
+     * @param {Schematic.CreateCustomPlanBundleRequestBody} request
+     * @param {PlanbundleClient.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.planbundle.createCustomPlanBundle({
+     *         entitlements: [{
+     *                 action: "create"
+     *             }]
+     *     })
+     */
+    createCustomPlanBundle(request: Schematic.CreateCustomPlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCustomPlanBundleResponse>;
+    private __createCustomPlanBundle;
     /**
      * @param {Schematic.CreatePlanBundleRequestBody} request
      * @param {PlanbundleClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts

@@ -0,0 +1,14 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         entitlements: [{
+ *                 action: "create"
+ *             }]
+ *     }
+ */
+export interface CreateCustomPlanBundleRequestBody {
+    billingProduct?: Schematic.UpsertBillingProductRequestBody;
+    entitlements: Schematic.PlanBundleEntitlementRequestBody[];
+    plan?: Schematic.CreateCustomPlanBundlePlanRequestBody;
+}

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

@@ -1,2 +1,3 @@
+export type { CreateCustomPlanBundleRequestBody } from "./CreateCustomPlanBundleRequestBody";
 export type { CreatePlanBundleRequestBody } from "./CreatePlanBundleRequestBody";
 export type { UpdatePlanBundleRequestBody } from "./UpdatePlanBundleRequestBody";

package/dist/api/resources/planbundle/types/CreateCustomPlanBundleResponse.d.ts

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

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

@@ -1,2 +1,3 @@
+export * from "./CreateCustomPlanBundleResponse";
 export * from "./CreatePlanBundleResponse";
 export * from "./UpdatePlanBundleResponse";

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

@@ -35,6 +35,7 @@ export interface CreatePlanGroupRequestBody {
     checkoutCollectAddress: boolean;
     checkoutCollectEmail: boolean;
     checkoutCollectPhone: boolean;
+    customCheckoutFields?: Schematic.CheckoutFieldInput[];
     customPlanConfig?: Schematic.CustomPlanConfig;
     customPlanId?: string;
     enableTaxCollection: boolean;

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

@@ -35,6 +35,7 @@ export interface UpdatePlanGroupRequestBody {
     checkoutCollectAddress: boolean;
     checkoutCollectEmail: boolean;
     checkoutCollectPhone: boolean;
+    customCheckoutFields?: Schematic.CheckoutFieldInput[];
     customPlanConfig?: Schematic.CustomPlanConfig;
     customPlanId?: string;
     enableTaxCollection: boolean;

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

@@ -31,6 +31,21 @@ export declare class PlanmigrationsClient {
      */
     listCompanyMigrations(request?: Schematic.ListCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMigrationsResponse>;
     private __listCompanyMigrations;
+    /**
+     * @param {string} plan_version_company_migration_id - plan_version_company_migration_id
+     * @param {PlanmigrationsClient.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.planmigrations.retryCompanyMigration("plan_version_company_migration_id")
+     */
+    retryCompanyMigration(plan_version_company_migration_id: string, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.RetryCompanyMigrationResponse>;
+    private __retryCompanyMigration;
     /**
      * @param {Schematic.CountCompanyMigrationsRequest} request
      * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -72,6 +87,29 @@ export declare class PlanmigrationsClient {
      */
     listMigrations(request?: Schematic.ListMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListMigrationsResponse>;
     private __listMigrations;
+    /**
+     * @param {Schematic.CreateMigrationInput} request
+     * @param {PlanmigrationsClient.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.planmigrations.createMigration({
+     *         companyIds: ["company_ids"],
+     *         excludedCompanyIds: ["excluded_company_ids"],
+     *         planId: "plan_id",
+     *         planVersionIdTo: "plan_version_id_to",
+     *         planVersionIdsFrom: ["plan_version_ids_from"],
+     *         strategy: "immediate",
+     *         targetPlanType: "plan"
+     *     })
+     */
+    createMigration(request: Schematic.CreateMigrationInput, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateMigrationResponse>;
+    private __createMigration;
     /**
      * @param {string} plan_version_migration_id - plan_version_migration_id
      * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -86,6 +124,24 @@ export declare class PlanmigrationsClient {
      */
     getMigration(plan_version_migration_id: string, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetMigrationResponse>;
     private __getMigration;
+    /**
+     * @param {string} plan_version_migration_id - plan_version_migration_id
+     * @param {Schematic.RetryMigrationRequestBody} request
+     * @param {PlanmigrationsClient.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.planmigrations.retryMigration("plan_version_migration_id", {
+     *         errorCodes: ["ambiguous_subscription_item"]
+     *     })
+     */
+    retryMigration(plan_version_migration_id: string, request: Schematic.RetryMigrationRequestBody, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.RetryMigrationResponse>;
+    private __retryMigration;
     /**
      * @param {Schematic.CountMigrationsRequest} request
      * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -0,0 +1,22 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyIds: ["company_ids"],
+ *         excludedCompanyIds: ["excluded_company_ids"],
+ *         planId: "plan_id",
+ *         planVersionIdTo: "plan_version_id_to",
+ *         planVersionIdsFrom: ["plan_version_ids_from"],
+ *         strategy: "immediate",
+ *         targetPlanType: "plan"
+ *     }
+ */
+export interface CreateMigrationInput {
+    companyIds: string[];
+    excludedCompanyIds: string[];
+    planId: string;
+    planVersionIdTo: string;
+    planVersionIdsFrom: string[];
+    strategy: Schematic.PlanVersionMigrationStrategy;
+    targetPlanType: Schematic.PlanType;
+}

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

@@ -0,0 +1,10 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         errorCodes: ["ambiguous_subscription_item"]
+ *     }
+ */
+export interface RetryMigrationRequestBody {
+    errorCodes: Schematic.MigrationErrorCode[];
+}

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

@@ -1,4 +1,6 @@
 export type { CountCompanyMigrationsRequest } from "./CountCompanyMigrationsRequest";
 export type { CountMigrationsRequest } from "./CountMigrationsRequest";
+export type { CreateMigrationInput } from "./CreateMigrationInput";
 export type { ListCompanyMigrationsRequest } from "./ListCompanyMigrationsRequest";
 export type { ListMigrationsRequest } from "./ListMigrationsRequest";
+export type { RetryMigrationRequestBody } from "./RetryMigrationRequestBody";

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

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

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

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

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

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

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

@@ -2,8 +2,11 @@ export * from "./CountCompanyMigrationsParams";
 export * from "./CountCompanyMigrationsResponse";
 export * from "./CountMigrationsParams";
 export * from "./CountMigrationsResponse";
+export * from "./CreateMigrationResponse";
 export * from "./GetMigrationResponse";
 export * from "./ListCompanyMigrationsParams";
 export * from "./ListCompanyMigrationsResponse";
 export * from "./ListMigrationsParams";
 export * from "./ListMigrationsResponse";
+export * from "./RetryCompanyMigrationResponse";
+export * from "./RetryMigrationResponse";

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

@@ -28,6 +28,68 @@ export declare class PlansClient {
      */
     updateCompanyPlans(company_plan_id: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyPlansResponse>;
     private __updateCompanyPlans;
+    /**
+     * @param {Schematic.ListCustomPlanBillingsRequest} request
+     * @param {PlansClient.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.plans.listCustomPlanBillings({
+     *         companyId: "company_id",
+     *         planId: "plan_id",
+     *         status: "active",
+     *         statuses: ["active"],
+     *         limit: 1000000,
+     *         offset: 1000000
+     *     })
+     */
+    listCustomPlanBillings(request?: Schematic.ListCustomPlanBillingsRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCustomPlanBillingsResponse>;
+    private __listCustomPlanBillings;
+    /**
+     * @param {string} custom_plan_billing_id - custom_plan_billing_id
+     * @param {Schematic.MarkCustomPlanBillingPaidRequestBody} request
+     * @param {PlansClient.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.plans.markCustomPlanBillingPaid("custom_plan_billing_id", {
+     *         "key": "value"
+     *     })
+     */
+    markCustomPlanBillingPaid(custom_plan_billing_id: string, request: Schematic.MarkCustomPlanBillingPaidRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.MarkCustomPlanBillingPaidResponse>;
+    private __markCustomPlanBillingPaid;
+    /**
+     * @param {string} custom_plan_billing_id - custom_plan_billing_id
+     * @param {Schematic.RetryCustomPlanBillingRequestBody} request
+     * @param {PlansClient.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.plans.retryCustomPlanBilling("custom_plan_billing_id", {
+     *         customerEmail: "customer_email",
+     *         payInAdvance: [{
+     *                 priceId: "price_id",
+     *                 quantity: 1000000
+     *             }]
+     *     })
+     */
+    retryCustomPlanBilling(custom_plan_billing_id: string, request: Schematic.RetryCustomPlanBillingRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.RetryCustomPlanBillingResponse>;
+    private __retryCustomPlanBilling;
     /**
      * @param {Schematic.CreateCustomPlanRequestBody} request
      * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,14 +122,18 @@ export declare class PlansClient {
      * @example
      *     await client.plans.listPlans({
      *         companyId: "company_id",
+     *         companyScopedOnly: true,
+     *         excludeCompanyScoped: true,
      *         forFallbackPlan: true,
      *         forInitialPlan: true,
      *         forTrialExpiryPlan: true,
      *         hasProductId: true,
+     *         ids: ["ids"],
      *         includeDraftVersions: true,
      *         planType: "plan",
      *         q: "q",
      *         scopedToCompanyId: "scoped_to_company_id",
+     *         withEntitlements: true,
      *         withoutEntitlementFor: "without_entitlement_for",
      *         withoutPaidProductId: true,
      *         limit: 1000000,
@@ -176,7 +242,7 @@ export declare class PlansClient {
      *
      * @example
      *     await client.plans.upsertPlanForBillingProduct({
-     *         billingProvider: "orb",
+     *         billingProvider: "metronome",
      *         description: "description",
      *         externalResourceId: "external_resource_id",
      *         name: "name",
@@ -238,14 +304,18 @@ export declare class PlansClient {
      * @example
      *     await client.plans.countPlans({
      *         companyId: "company_id",
+     *         companyScopedOnly: true,
+     *         excludeCompanyScoped: true,
      *         forFallbackPlan: true,
      *         forInitialPlan: true,
      *         forTrialExpiryPlan: true,
      *         hasProductId: true,
+     *         ids: ["ids"],
      *         includeDraftVersions: true,
      *         planType: "plan",
      *         q: "q",
      *         scopedToCompanyId: "scoped_to_company_id",
+     *         withEntitlements: true,
      *         withoutEntitlementFor: "without_entitlement_for",
      *         withoutPaidProductId: true,
      *         limit: 1000000,

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

@@ -3,14 +3,18 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         companyId: "company_id",
+ *         companyScopedOnly: true,
+ *         excludeCompanyScoped: true,
  *         forFallbackPlan: true,
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
  *         hasProductId: true,
+ *         ids: ["ids"],
  *         includeDraftVersions: true,
  *         planType: "plan",
  *         q: "q",
  *         scopedToCompanyId: "scoped_to_company_id",
+ *         withEntitlements: true,
  *         withoutEntitlementFor: "without_entitlement_for",
  *         withoutPaidProductId: true,
  *         limit: 1000000,
@@ -19,6 +23,10 @@ import type * as Schematic from "../../../../index";
  */
 export interface CountPlansRequest {
     companyId?: string;
+    /** Only return plans that are scoped to a company (custom plans assigned to a company) */
+    companyScopedOnly?: boolean;
+    /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
+    excludeCompanyScoped?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
@@ -35,6 +43,8 @@ export interface CountPlansRequest {
     q?: string;
     /** Filter plans scoped to a specific company (custom plans) */
     scopedToCompanyId?: string;
+    /** Include each plan's entitlements in the response */
+    withEntitlements?: boolean;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
- *         billingProvider: "orb",
+ *         billingProvider: "metronome",
  *         description: "description",
  *         externalResourceId: "external_resource_id",
  *         name: "name",
@@ -13,6 +13,7 @@ export interface CreateBillingLinkedPlanRequestBody {
     billingProvider: Schematic.BillingProviderType;
     description: string;
     externalResourceId: string;
+    externalResourceVersion?: string;
     icon?: Schematic.PlanIcon;
     name: string;
     planType: Schematic.PlanType;

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

@@ -0,0 +1,26 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         planId: "plan_id",
+ *         status: "active",
+ *         statuses: ["active"],
+ *         limit: 1000000,
+ *         offset: 1000000
+ *     }
+ */
+export interface ListCustomPlanBillingsRequest {
+    /** Filter by company ID */
+    companyId?: string;
+    /** Filter by plan ID */
+    planId?: string;
+    /** Filter by billing status */
+    status?: Schematic.CustomPlanBillingStatus;
+    /** Filter by multiple billing statuses */
+    statuses?: Schematic.CustomPlanBillingStatus | Schematic.CustomPlanBillingStatus[];
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

@@ -3,14 +3,18 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         companyId: "company_id",
+ *         companyScopedOnly: true,
+ *         excludeCompanyScoped: true,
  *         forFallbackPlan: true,
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
  *         hasProductId: true,
+ *         ids: ["ids"],
  *         includeDraftVersions: true,
  *         planType: "plan",
  *         q: "q",
  *         scopedToCompanyId: "scoped_to_company_id",
+ *         withEntitlements: true,
  *         withoutEntitlementFor: "without_entitlement_for",
  *         withoutPaidProductId: true,
  *         limit: 1000000,
@@ -19,6 +23,10 @@ import type * as Schematic from "../../../../index";
  */
 export interface ListPlansRequest {
     companyId?: string;
+    /** Only return plans that are scoped to a company (custom plans assigned to a company) */
+    companyScopedOnly?: boolean;
+    /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
+    excludeCompanyScoped?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
@@ -35,6 +43,8 @@ export interface ListPlansRequest {
     q?: string;
     /** Filter plans scoped to a specific company (custom plans) */
     scopedToCompanyId?: string;
+    /** Include each plan's entitlements in the response */
+    withEntitlements?: boolean;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

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

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

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

@@ -5,7 +5,9 @@ export type { CreateCustomPlanRequestBody } from "./CreateCustomPlanRequestBody"
 export type { DeletePlanVersionRequest } from "./DeletePlanVersionRequest";
 export type { GetPlanRequest } from "./GetPlanRequest";
 export type { ListBillingProductMatchCompaniesRequest } from "./ListBillingProductMatchCompaniesRequest";
+export type { ListCustomPlanBillingsRequest } from "./ListCustomPlanBillingsRequest";
 export type { ListPlanIssuesRequest } from "./ListPlanIssuesRequest";
 export type { ListPlansRequest } from "./ListPlansRequest";
 export type { PublishPlanVersionRequestBody } from "./PublishPlanVersionRequestBody";
+export type { RetryCustomPlanBillingRequestBody } from "./RetryCustomPlanBillingRequestBody";
 export type { UpdateCompanyPlansRequestBody } from "./UpdateCompanyPlansRequestBody";

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

@@ -4,6 +4,10 @@ import type * as Schematic from "../../../index";
  */
 export interface CountPlansParams {
     companyId?: string;
+    /** Only return plans that are scoped to a company (custom plans assigned to a company) */
+    companyScopedOnly?: boolean;
+    /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
+    excludeCompanyScoped?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
@@ -24,6 +28,8 @@ export interface CountPlansParams {
     q?: string;
     /** Filter plans scoped to a specific company (custom plans) */
     scopedToCompanyId?: string;
+    /** Include each plan's entitlements in the response */
+    withEntitlements?: boolean;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

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

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListCustomPlanBillingsParams {
+    /** Filter by company ID */
+    companyId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Filter by plan ID */
+    planId?: string;
+    /** Filter by billing status */
+    status?: Schematic.CustomPlanBillingStatus;
+    /** Filter by multiple billing statuses */
+    statuses?: Schematic.CustomPlanBillingStatus[];
+}

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

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

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

@@ -4,6 +4,10 @@ import type * as Schematic from "../../../index";
  */
 export interface ListPlansParams {
     companyId?: string;
+    /** Only return plans that are scoped to a company (custom plans assigned to a company) */
+    companyScopedOnly?: boolean;
+    /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
+    excludeCompanyScoped?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
@@ -24,6 +28,8 @@ export interface ListPlansParams {
     q?: string;
     /** Filter plans scoped to a specific company (custom plans) */
     scopedToCompanyId?: string;
+    /** Include each plan's entitlements in the response */
+    withEntitlements?: boolean;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */