@flexprice/sdk 2.1.6 → 2.1.10

package/src/sdk/models/list-subscription-line-items-response.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  PaginationResponse,
+  PaginationResponse$inboundSchema,
+} from "./pagination-response.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  SubscriptionLineItemResponse,
+  SubscriptionLineItemResponse$inboundSchema,
+} from "./subscription-line-item-response.js";
+
+export type ListSubscriptionLineItemsResponse = {
+  items?: Array<SubscriptionLineItemResponse> | undefined;
+  pagination?: PaginationResponse | undefined;
+};
+
+/** @internal */
+export const ListSubscriptionLineItemsResponse$inboundSchema: z.ZodMiniType<
+  ListSubscriptionLineItemsResponse,
+  unknown
+> = z.object({
+  items: types.optional(z.array(SubscriptionLineItemResponse$inboundSchema)),
+  pagination: types.optional(PaginationResponse$inboundSchema),
+});
+
+export function listSubscriptionLineItemsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSubscriptionLineItemsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSubscriptionLineItemsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSubscriptionLineItemsResponse' from JSON`,
+  );
+}

package/src/sdk/models/plan-filter.ts

@@ -32,6 +32,7 @@ export type PlanFilter = {
   filters?: Array<FilterCondition> | undefined;
   limit?: number | undefined;
   lookupKey?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
   offset?: number | undefined;
   order?: PlanFilterOrder | undefined;
   planIds?: Array<string> | undefined;
@@ -52,6 +53,7 @@ export type PlanFilter$Outbound = {
   filters?: Array<FilterCondition$Outbound> | undefined;
   limit?: number | undefined;
   lookup_key?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
   offset?: number | undefined;
   order?: string | undefined;
   plan_ids?: Array<string> | undefined;
@@ -71,6 +73,7 @@ export const PlanFilter$outboundSchema: z.ZodMiniType<
     filters: z.optional(z.array(FilterCondition$outboundSchema)),
     limit: z.optional(z.int()),
     lookupKey: z.optional(z.string()),
+    metadata: z.optional(z.record(z.string(), z.string())),
     offset: z.optional(z.int()),
     order: z.optional(PlanFilterOrder$outboundSchema),
     planIds: z.optional(z.array(z.string())),

package/src/sdk/models/s3-job-config.ts

@@ -7,6 +7,12 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
+import {
+  ExportMetadataField,
+  ExportMetadataField$inboundSchema,
+  ExportMetadataField$Outbound,
+  ExportMetadataField$outboundSchema,
+} from "./export-metadata-field.js";
 import {
   S3CompressionType,
   S3CompressionType$inboundSchema,
@@ -30,6 +36,10 @@ export type S3JobConfig = {
    * Custom S3 endpoint URL (e.g., "http://minio:9000" for MinIO)
    */
   endpointUrl?: string | undefined;
+  /**
+   * Optional user-selected metadata columns
+   */
+  exportMetadataFields?: Array<ExportMetadataField> | undefined;
   /**
    * Optional prefix for S3 keys (e.g., "flexprice-exports/")
    */
@@ -39,7 +49,7 @@ export type S3JobConfig = {
    */
   region?: string | undefined;
   /**
-   * Use path-style addressing instead of virtual-hosted-style (required for MinIO)
+   * Use path-style addressing (required for MinIO)
    */
   usePathStyle?: boolean | undefined;
 };
@@ -52,6 +62,9 @@ export const S3JobConfig$inboundSchema: z.ZodMiniType<S3JobConfig, unknown> = z
       compression: types.optional(S3CompressionType$inboundSchema),
       encryption: types.optional(S3EncryptionType$inboundSchema),
       endpoint_url: types.optional(types.string()),
+      export_metadata_fields: types.optional(
+        z.array(ExportMetadataField$inboundSchema),
+      ),
       key_prefix: types.optional(types.string()),
       region: types.optional(types.string()),
       use_path_style: types.optional(types.boolean()),
@@ -59,6 +72,7 @@ export const S3JobConfig$inboundSchema: z.ZodMiniType<S3JobConfig, unknown> = z
     z.transform((v) => {
       return remap$(v, {
         "endpoint_url": "endpointUrl",
+        "export_metadata_fields": "exportMetadataFields",
         "key_prefix": "keyPrefix",
         "use_path_style": "usePathStyle",
       });
@@ -70,6 +84,7 @@ export type S3JobConfig$Outbound = {
   compression?: string | undefined;
   encryption?: string | undefined;
   endpoint_url?: string | undefined;
+  export_metadata_fields?: Array<ExportMetadataField$Outbound> | undefined;
   key_prefix?: string | undefined;
   region?: string | undefined;
   use_path_style?: boolean | undefined;
@@ -85,6 +100,9 @@ export const S3JobConfig$outboundSchema: z.ZodMiniType<
     compression: z.optional(S3CompressionType$outboundSchema),
     encryption: z.optional(S3EncryptionType$outboundSchema),
     endpointUrl: z.optional(z.string()),
+    exportMetadataFields: z.optional(
+      z.array(ExportMetadataField$outboundSchema),
+    ),
     keyPrefix: z.optional(z.string()),
     region: z.optional(z.string()),
     usePathStyle: z.optional(z.boolean()),
@@ -92,6 +110,7 @@ export const S3JobConfig$outboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       endpointUrl: "endpoint_url",
+      exportMetadataFields: "export_metadata_fields",
       keyPrefix: "key_prefix",
       usePathStyle: "use_path_style",
     });

package/src/sdk/models/scheduled-task-entity-type.ts

@@ -11,6 +11,7 @@ export const ScheduledTaskEntityType = {
   Invoice: "invoice",
   CreditTopups: "credit_topups",
   CreditUsage: "credit_usage",
+  UsageAnalytics: "usage_analytics",
 } as const;
 export type ScheduledTaskEntityType = OpenEnum<typeof ScheduledTaskEntityType>;
 

package/src/sdk/models/sub-modify-grouped-invoicing-params.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  GroupedInvoicingAction,
+  GroupedInvoicingAction$outboundSchema,
+} from "./grouped-invoicing-action.js";
+
+export type SubModifyGroupedInvoicingParams = {
+  action: GroupedInvoicingAction;
+  childSubscriptionIds?: Array<string> | undefined;
+  /**
+   * ParentSubscriptionID is required for action 'add'.
+   */
+  parentSubscriptionId?: string | undefined;
+};
+
+/** @internal */
+export type SubModifyGroupedInvoicingParams$Outbound = {
+  action: string;
+  child_subscription_ids?: Array<string> | undefined;
+  parent_subscription_id?: string | undefined;
+};
+
+/** @internal */
+export const SubModifyGroupedInvoicingParams$outboundSchema: z.ZodMiniType<
+  SubModifyGroupedInvoicingParams$Outbound,
+  SubModifyGroupedInvoicingParams
+> = z.pipe(
+  z.object({
+    action: GroupedInvoicingAction$outboundSchema,
+    childSubscriptionIds: z.optional(z.array(z.string())),
+    parentSubscriptionId: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      childSubscriptionIds: "child_subscription_ids",
+      parentSubscriptionId: "parent_subscription_id",
+    });
+  }),
+);
+
+export function subModifyGroupedInvoicingParamsToJSON(
+  subModifyGroupedInvoicingParams: SubModifyGroupedInvoicingParams,
+): string {
+  return JSON.stringify(
+    SubModifyGroupedInvoicingParams$outboundSchema.parse(
+      subModifyGroupedInvoicingParams,
+    ),
+  );
+}

package/src/sdk/models/subscription-inheritance-config.ts

@@ -6,9 +6,34 @@ import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type SubscriptionInheritanceConfig = {
+  /**
+   * ExternalCustomerIDsToInheritSubscription: child customer external IDs for which
+   *
+   * @remarks
+   * inherited skeleton subscriptions will be created. Only valid for parent behavior.
+   */
   externalCustomerIdsToInheritSubscription?: Array<string> | undefined;
+  /**
+   * InvoicingCustomerExternalID sets a different billing recipient (external ID).
+   *
+   * @remarks
+   * Required for delegated; rejected for inherited; optional for others.
+   */
   invoicingCustomerExternalId?: string | undefined;
+  /**
+   * ParentSubscriptionID links this subscription to an existing parent.
+   *
+   * @remarks
+   * Required for inherited and grouped_invoicing; rejected for standalone, delegated, parent.
+   */
   parentSubscriptionId?: string | undefined;
+  /**
+   * SubscriptionsIDsForGroupedInvoicing: existing standalone subscription IDs to convert to
+   *
+   * @remarks
+   * grouped_invoicing under this parent at creation time. Only valid for parent behavior.
+   */
+  subscriptionsIdsForGroupedInvoicing?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -16,6 +41,7 @@ export type SubscriptionInheritanceConfig$Outbound = {
   external_customer_ids_to_inherit_subscription?: Array<string> | undefined;
   invoicing_customer_external_id?: string | undefined;
   parent_subscription_id?: string | undefined;
+  subscriptions_ids_for_grouped_invoicing?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -27,6 +53,7 @@ export const SubscriptionInheritanceConfig$outboundSchema: z.ZodMiniType<
     externalCustomerIdsToInheritSubscription: z.optional(z.array(z.string())),
     invoicingCustomerExternalId: z.optional(z.string()),
     parentSubscriptionId: z.optional(z.string()),
+    subscriptionsIdsForGroupedInvoicing: z.optional(z.array(z.string())),
   }),
   z.transform((v) => {
     return remap$(v, {
@@ -34,6 +61,8 @@ export const SubscriptionInheritanceConfig$outboundSchema: z.ZodMiniType<
         "external_customer_ids_to_inherit_subscription",
       invoicingCustomerExternalId: "invoicing_customer_external_id",
       parentSubscriptionId: "parent_subscription_id",
+      subscriptionsIdsForGroupedInvoicing:
+        "subscriptions_ids_for_grouped_invoicing",
     });
   }),
 );

package/src/sdk/models/subscription-line-item-entity-type.ts

@@ -20,3 +20,8 @@ export const SubscriptionLineItemEntityType$inboundSchema: z.ZodMiniType<
   SubscriptionLineItemEntityType,
   unknown
 > = openEnums.inboundSchema(SubscriptionLineItemEntityType);
+/** @internal */
+export const SubscriptionLineItemEntityType$outboundSchema: z.ZodMiniType<
+  string,
+  SubscriptionLineItemEntityType
+> = openEnums.outboundSchema(SubscriptionLineItemEntityType);

package/src/sdk/models/subscription-line-item-filter.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  FilterCondition,
+  FilterCondition$Outbound,
+  FilterCondition$outboundSchema,
+} from "./filter-condition.js";
+import {
+  SortCondition,
+  SortCondition$Outbound,
+  SortCondition$outboundSchema,
+} from "./sort-condition.js";
+import { Status, Status$outboundSchema } from "./status.js";
+import {
+  SubscriptionLineItemEntityType,
+  SubscriptionLineItemEntityType$outboundSchema,
+} from "./subscription-line-item-entity-type.js";
+
+export const SubscriptionLineItemFilterOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type SubscriptionLineItemFilterOrder = ClosedEnum<
+  typeof SubscriptionLineItemFilterOrder
+>;
+
+export type SubscriptionLineItemFilter = {
+  activeFilter?: boolean | undefined;
+  addonAssociationIds?: Array<string> | undefined;
+  billingPeriods?: Array<string> | undefined;
+  currencies?: Array<string> | undefined;
+  currentPeriodStart?: Date | undefined;
+  customerIds?: Array<string> | undefined;
+  endTime?: Date | undefined;
+  entityIds?: Array<string> | undefined;
+  entityType?: SubscriptionLineItemEntityType | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition> | undefined;
+  limit?: number | undefined;
+  meterIds?: Array<string> | undefined;
+  offset?: number | undefined;
+  order?: SubscriptionLineItemFilterOrder | undefined;
+  priceIds?: Array<string> | undefined;
+  sort?: Array<SortCondition> | undefined;
+  startTime?: Date | undefined;
+  status?: Status | undefined;
+  /**
+   * Specific filters
+   */
+  subscriptionIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SubscriptionLineItemFilterOrder$outboundSchema: z.ZodMiniEnum<
+  typeof SubscriptionLineItemFilterOrder
+> = z.enum(SubscriptionLineItemFilterOrder);
+
+/** @internal */
+export type SubscriptionLineItemFilter$Outbound = {
+  active_filter: boolean;
+  addon_association_ids?: Array<string> | undefined;
+  billing_periods?: Array<string> | undefined;
+  currencies?: Array<string> | undefined;
+  current_period_start?: string | undefined;
+  customer_ids?: Array<string> | undefined;
+  end_time?: string | undefined;
+  entity_ids?: Array<string> | undefined;
+  entity_type?: string | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition$Outbound> | undefined;
+  limit?: number | undefined;
+  meter_ids?: Array<string> | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  price_ids?: Array<string> | undefined;
+  sort?: Array<SortCondition$Outbound> | undefined;
+  start_time?: string | undefined;
+  status?: string | undefined;
+  subscription_ids?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SubscriptionLineItemFilter$outboundSchema: z.ZodMiniType<
+  SubscriptionLineItemFilter$Outbound,
+  SubscriptionLineItemFilter
+> = z.pipe(
+  z.object({
+    activeFilter: z._default(z.boolean(), true),
+    addonAssociationIds: z.optional(z.array(z.string())),
+    billingPeriods: z.optional(z.array(z.string())),
+    currencies: z.optional(z.array(z.string())),
+    currentPeriodStart: z.optional(
+      z.pipe(z.date(), z.transform(v => v.toISOString())),
+    ),
+    customerIds: z.optional(z.array(z.string())),
+    endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    entityIds: z.optional(z.array(z.string())),
+    entityType: z.optional(SubscriptionLineItemEntityType$outboundSchema),
+    expand: z.optional(z.string()),
+    filters: z.optional(z.array(FilterCondition$outboundSchema)),
+    limit: z.optional(z.int()),
+    meterIds: z.optional(z.array(z.string())),
+    offset: z.optional(z.int()),
+    order: z.optional(SubscriptionLineItemFilterOrder$outboundSchema),
+    priceIds: z.optional(z.array(z.string())),
+    sort: z.optional(z.array(SortCondition$outboundSchema)),
+    startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    status: z.optional(Status$outboundSchema),
+    subscriptionIds: z.optional(z.array(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      activeFilter: "active_filter",
+      addonAssociationIds: "addon_association_ids",
+      billingPeriods: "billing_periods",
+      currentPeriodStart: "current_period_start",
+      customerIds: "customer_ids",
+      endTime: "end_time",
+      entityIds: "entity_ids",
+      entityType: "entity_type",
+      meterIds: "meter_ids",
+      priceIds: "price_ids",
+      startTime: "start_time",
+      subscriptionIds: "subscription_ids",
+    });
+  }),
+);
+
+export function subscriptionLineItemFilterToJSON(
+  subscriptionLineItemFilter: SubscriptionLineItemFilter,
+): string {
+  return JSON.stringify(
+    SubscriptionLineItemFilter$outboundSchema.parse(subscriptionLineItemFilter),
+  );
+}

package/src/sdk/models/subscription-modify-type.ts

@@ -8,6 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 export const SubscriptionModifyType = {
   Inheritance: "inheritance",
   QuantityChange: "quantity_change",
+  GroupedInvoicing: "grouped_invoicing",
 } as const;
 export type SubscriptionModifyType = ClosedEnum<typeof SubscriptionModifyType>;
 

package/src/sdk/models/subscription-response-v2.ts

@@ -66,6 +66,14 @@ export type SubscriptionResponseV2 = {
    * This will be null if no pause is active or scheduled
    */
   activePauseId?: string | undefined;
+  /**
+   * AutoInvoiceThreshold is the usage amount (in subscription currency) that triggers
+   *
+   * @remarks
+   * an intermediate invoice. Overrides the plan-level threshold when set.
+   * Nil means: inherit from the plan's threshold (which may also be nil = disabled).
+   */
+  autoInvoiceThreshold?: string | undefined;
   /**
    * BillingAnchor is the reference point that aligns future billing cycle dates.
    *
@@ -234,6 +242,7 @@ export const SubscriptionResponseV2$inboundSchema: z.ZodMiniType<
 > = z.pipe(
   z.object({
     active_pause_id: types.optional(types.string()),
+    auto_invoice_threshold: types.optional(types.string()),
     billing_anchor: types.optional(types.date()),
     billing_cadence: types.optional(BillingCadence$inboundSchema),
     billing_cycle: types.optional(BillingCycle$inboundSchema),
@@ -294,6 +303,7 @@ export const SubscriptionResponseV2$inboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       "active_pause_id": "activePauseId",
+      "auto_invoice_threshold": "autoInvoiceThreshold",
       "billing_anchor": "billingAnchor",
       "billing_cadence": "billingCadence",
       "billing_cycle": "billingCycle",

package/src/sdk/models/subscription-response.ts

@@ -70,6 +70,14 @@ export type SubscriptionResponse = {
    * This will be null if no pause is active or scheduled
    */
   activePauseId?: string | undefined;
+  /**
+   * AutoInvoiceThreshold is the usage amount (in subscription currency) that triggers
+   *
+   * @remarks
+   * an intermediate invoice. Overrides the plan-level threshold when set.
+   * Nil means: inherit from the plan's threshold (which may also be nil = disabled).
+   */
+  autoInvoiceThreshold?: string | undefined;
   /**
    * BillingAnchor is the reference point that aligns future billing cycle dates.
    *
@@ -230,6 +238,7 @@ export const SubscriptionResponse$inboundSchema: z.ZodMiniType<
 > = z.pipe(
   z.object({
     active_pause_id: types.optional(types.string()),
+    auto_invoice_threshold: types.optional(types.string()),
     billing_anchor: types.optional(types.date()),
     billing_cadence: types.optional(BillingCadence$inboundSchema),
     billing_cycle: types.optional(BillingCycle$inboundSchema),
@@ -291,6 +300,7 @@ export const SubscriptionResponse$inboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       "active_pause_id": "activePauseId",
+      "auto_invoice_threshold": "autoInvoiceThreshold",
       "billing_anchor": "billingAnchor",
       "billing_cadence": "billingCadence",
       "billing_cycle": "billingCycle",

package/src/sdk/models/subscription-type.ts

@@ -8,8 +8,10 @@ import { OpenEnum } from "../../types/enums.js";
 
 export const SubscriptionType = {
   Standalone: "standalone",
+  DelegatedInvoicing: "delegated_invoicing",
   Parent: "parent",
   Inherited: "inherited",
+  GroupedInvoicing: "grouped_invoicing",
 } as const;
 export type SubscriptionType = OpenEnum<typeof SubscriptionType>;
 

package/src/sdk/subscriptions.ts

@@ -22,6 +22,7 @@ import { subscriptionsListAllSubscriptionSchedules } from "../funcs/subscription
 import { subscriptionsListSubscriptionSchedules } from "../funcs/subscriptions-list-subscription-schedules.js";
 import { subscriptionsPreviewSubscriptionChange } from "../funcs/subscriptions-preview-subscription-change.js";
 import { subscriptionsPreviewSubscriptionModify } from "../funcs/subscriptions-preview-subscription-modify.js";
+import { subscriptionsQuerySubscriptionLineItems } from "../funcs/subscriptions-query-subscription-line-items.js";
 import { subscriptionsQuerySubscription } from "../funcs/subscriptions-query-subscription.js";
 import { subscriptionsRemoveSubscriptionAddon } from "../funcs/subscriptions-remove-subscription-addon.js";
 import { subscriptionsUpdateSubscriptionLineItem } from "../funcs/subscriptions-update-subscription-line-item.js";
@@ -82,6 +83,23 @@ export class Subscriptions extends ClientSDK {
     ));
   }
 
+  /**
+   * Search subscription line items
+   *
+   * @remarks
+   * List subscription line items with a JSON filter (subscription, customer, price, pagination, expand=prices, etc.).
+   */
+  async querySubscriptionLineItems(
+    request: models.SubscriptionLineItemFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListSubscriptionLineItemsResponse> {
+    return unwrapAsync(subscriptionsQuerySubscriptionLineItems(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update subscription line item
    *

package/src/types/primitives.ts

@@ -131,13 +131,11 @@ export function literalBigInt<T extends bigint>(value: T): z.ZodMiniType<T> {
 }
 
 export function optional<T extends z.ZodMiniType>(t: T) {
-  return z.union([
-    z.undefined(),
-
+  return z.optional(z.union([
     // Null -> undefined
     z.pipe(z.null(), z.transform(() => unrecognized(undefined))),
     t,
-  ]);
+  ]));
 }
 
 export function nullable<T extends z.ZodMiniType>(t: T) {