@flexprice/mcp-server 2.0.10 → 2.0.12

package/src/models/dtousagebreakdownitem.ts

@@ -14,9 +14,19 @@ export type DtoUsageBreakdownItem = {
 
 export const DtoUsageBreakdownItem$zodSchema: z.ZodType<DtoUsageBreakdownItem> =
   z.object({
-    cost: z.string().optional(),
-    event_count: z.int().optional(),
-    grouped_by: z.record(z.string(), z.string()).optional(),
-    percentage: z.string().optional(),
-    usage: z.string().optional(),
+    cost: z.string().optional().describe(
+      "cost is the cost attributed to this group for the line item",
+    ),
+    event_count: z.int().optional().describe(
+      "event_count is the number of events from this group (optional)",
+    ),
+    grouped_by: z.record(z.string(), z.string()).optional().describe(
+      "grouped_by contains the grouping field values (e.g., {\"source\": \"api\", \"org_id\": \"org123\"})",
+    ),
+    percentage: z.string().optional().describe(
+      "percentage is the percentage of total line item cost from this group (optional)",
+    ),
+    usage: z.string().optional().describe(
+      "usage is the total usage amount from this group (optional, for additional context)",
+    ),
   });

package/src/models/executesubscriptionchangeop.ts

@@ -24,7 +24,9 @@ export type ExecuteSubscriptionChangeRequest = {
 export const ExecuteSubscriptionChangeRequest$zodSchema: z.ZodType<
   ExecuteSubscriptionChangeRequest
 > = z.object({
-  body: DtoSubscriptionChangeRequest$zodSchema,
+  body: DtoSubscriptionChangeRequest$zodSchema.describe(
+    "Subscription change request",
+  ),
   id: z.string().describe("Subscription ID"),
 });
 

package/src/models/githubcomflexpriceflexpriceinternaldomaincustomercustomer.ts

@@ -30,21 +30,45 @@ export type GithubComFlexpriceFlexpriceInternalDomainCustomerCustomer = {
 export const GithubComFlexpriceFlexpriceInternalDomainCustomerCustomer$zodSchema:
   z.ZodType<GithubComFlexpriceFlexpriceInternalDomainCustomerCustomer> = z
     .object({
-      address_city: z.string().optional(),
-      address_country: z.string().optional(),
-      address_line1: z.string().optional(),
-      address_line2: z.string().optional(),
-      address_postal_code: z.string().optional(),
-      address_state: z.string().optional(),
+      address_city: z.string().optional().describe(
+        "AddressCity is the city of the customer's address",
+      ),
+      address_country: z.string().optional().describe(
+        "AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)",
+      ),
+      address_line1: z.string().optional().describe(
+        "AddressLine1 is the first line of the customer's address",
+      ),
+      address_line2: z.string().optional().describe(
+        "AddressLine2 is the second line of the customer's address",
+      ),
+      address_postal_code: z.string().optional().describe(
+        "AddressPostalCode is the postal code of the customer's address",
+      ),
+      address_state: z.string().optional().describe(
+        "AddressState is the state of the customer's address",
+      ),
       created_at: z.string().optional(),
       created_by: z.string().optional(),
-      email: z.string().optional(),
-      environment_id: z.string().optional(),
-      external_id: z.string().optional(),
-      id: z.string().optional(),
-      metadata: z.record(z.string(), z.string()).optional(),
-      name: z.string().optional(),
-      parent_customer_id: z.string().optional(),
+      email: z.string().optional().describe(
+        "Email is the email of the customer",
+      ),
+      environment_id: z.string().optional().describe(
+        "EnvironmentID is the environment identifier for the customer",
+      ),
+      external_id: z.string().optional().describe(
+        "ExternalID is the external identifier for the customer",
+      ),
+      id: z.string().optional().describe(
+        "ID is the unique identifier for the customer",
+      ),
+      metadata: z.record(z.string(), z.string()).optional().describe(
+        "Metadata",
+      ),
+      name: z.string().optional().describe("Name is the name of the customer"),
+      parent_customer_id: z.string().optional().describe(
+        "Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.\nRetained for backward compatibility; no hierarchy rules are enforced at the service layer.\nParentCustomerID is the parent customer identifier for the customer.",
+      ),
       status: Status$zodSchema.optional(),
       tenant_id: z.string().optional(),
       updated_at: z.string().optional(),

package/src/models/invoicefilter.ts

@@ -52,27 +52,53 @@ export type InvoiceFilter = {
 };
 
 export const InvoiceFilter$zodSchema: z.ZodType<InvoiceFilter> = z.object({
-  amount_due_gt: z.number().optional(),
-  amount_remaining_gt: z.number().optional(),
-  customer_id: z.string().optional(),
+  amount_due_gt: z.number().optional().describe(
+    "amount_due_gt filters invoices with a total amount due greater than the specified value\nUseful for finding invoices above a certain threshold or identifying high-value invoices",
+  ),
+  amount_remaining_gt: z.number().optional().describe(
+    "amount_remaining_gt filters invoices with an outstanding balance greater than the specified value\nUseful for finding invoices that still have significant unpaid amounts",
+  ),
+  customer_id: z.string().optional().describe(
+    "customer_id filters invoices for a specific customer using FlexPrice's internal customer ID\nThis is the ID returned by FlexPrice when creating or retrieving customers",
+  ),
   end_time: z.string().optional(),
   expand: z.string().optional(),
-  external_customer_id: z.string().optional(),
+  external_customer_id: z.string().optional().describe(
+    "external_customer_id filters invoices for a customer using your system's customer identifier\nThis is the ID you provided when creating the customer in FlexPrice",
+  ),
   filters: z.array(FilterCondition$zodSchema).optional(),
-  invoice_ids: z.array(z.string()).optional(),
-  invoice_status: z.array(InvoiceStatus$zodSchema).optional(),
+  invoice_ids: z.array(z.string()).optional().describe(
+    "invoice_ids restricts results to invoices with the specified IDs\nUse this to retrieve specific invoices when you know their exact identifiers",
+  ),
+  invoice_status: z.array(InvoiceStatus$zodSchema).optional().describe(
+    "invoice_status filters by the current state of invoices in their lifecycle\nMultiple statuses can be specified to include invoices in any of the listed states",
+  ),
   invoice_type: InvoiceType$zodSchema.optional(),
   limit: z.int().optional(),
   offset: z.int().optional(),
   order: InvoiceFilterOrder$zodSchema.optional(),
-  payment_status: z.array(PaymentStatus$zodSchema).optional(),
-  period_end_gte: z.string().optional(),
-  period_end_lte: z.string().optional(),
-  period_start_gte: z.string().optional(),
-  period_start_lte: z.string().optional(),
-  skip_line_items: z.boolean().optional(),
+  payment_status: z.array(PaymentStatus$zodSchema).optional().describe(
+    "payment_status filters by the payment state of invoices\nMultiple statuses can be specified to include invoices with any of the listed payment states",
+  ),
+  period_end_gte: z.string().optional().describe(
+    "period_end_gte filters invoices with period_end >= value",
+  ),
+  period_end_lte: z.string().optional().describe(
+    "period_end_lte filters invoices with period_end <= value",
+  ),
+  period_start_gte: z.string().optional().describe(
+    "period_start_gte filters invoices with period_start >= value",
+  ),
+  period_start_lte: z.string().optional().describe(
+    "period_start_lte filters invoices with period_start <= value",
+  ),
+  skip_line_items: z.boolean().optional().describe(
+    "SkipLineItems if true, will not include line items in the response",
+  ),
   sort: z.array(SortCondition$zodSchema).optional(),
   start_time: z.string().optional(),
   status: Status$zodSchema.optional(),
-  subscription_id: z.string().optional(),
+  subscription_id: z.string().optional().describe(
+    "subscription_id filters invoices generated for a specific subscription\nOnly returns invoices that were created as part of the specified subscription's billing",
+  ),
 });

package/src/models/meteraggregation.ts

@@ -21,10 +21,18 @@ export type MeterAggregation = {
 export const MeterAggregation$zodSchema: z.ZodType<MeterAggregation> = z.object(
   {
     bucket_size: WindowSize$zodSchema.optional(),
-    expression: z.string().optional(),
-    field: z.string().optional(),
-    group_by: z.string().optional(),
-    multiplier: z.string().optional(),
+    expression: z.string().optional().describe(
+      "Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).",
+    ),
+    field: z.string().optional().describe(
+      "Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set.",
+    ),
+    group_by: z.string().optional().describe(
+      "GroupBy is the property name in event.properties to group by before aggregating.\nCurrently only supported for MAX aggregation with bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total.",
+    ),
+    multiplier: z.string().optional().describe(
+      "Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null.",
+    ),
     type: AggregationType$zodSchema.optional(),
   },
 );

package/src/models/meterfilter.ts

@@ -10,6 +10,10 @@ export type MeterFilter = {
 };
 
 export const MeterFilter$zodSchema: z.ZodType<MeterFilter> = z.object({
-  key: z.string().optional(),
-  values: z.array(z.string()).optional(),
+  key: z.string().optional().describe(
+    "Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys",
+  ),
+  values: z.array(z.string()).optional().describe(
+    "Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc",
+  ),
 });

package/src/models/metermeter.ts

@@ -31,11 +31,19 @@ export const MeterMeter$zodSchema: z.ZodType<MeterMeter> = z.object({
   aggregation: MeterAggregation$zodSchema.optional(),
   created_at: z.string().optional(),
   created_by: z.string().optional(),
-  environment_id: z.string().optional(),
-  event_name: z.string().optional(),
-  filters: z.array(MeterFilter$zodSchema).optional(),
-  id: z.string().optional(),
-  name: z.string().optional(),
+  environment_id: z.string().optional().describe(
+    "EnvironmentID is the environment identifier for the meter",
+  ),
+  event_name: z.string().optional().describe(
+    "EventName is the unique identifier for the event that this meter is tracking\nIt is a mandatory field in the events table and hence being used as the primary matching field\nWe can have multiple meters tracking the same event but with different filters and aggregation",
+  ),
+  filters: z.array(MeterFilter$zodSchema).optional().describe(
+    "Filters define the criteria for the meter to be applied on the events before aggregation\nIt also defines the possible values on which later the charges will be applied",
+  ),
+  id: z.string().optional().describe(
+    "ID is the unique identifier for the meter",
+  ),
+  name: z.string().optional().describe("Name is the display name of the meter"),
   reset_usage: ResetUsage$zodSchema.optional(),
   status: Status$zodSchema.optional(),
   tenant_id: z.string().optional(),

package/src/models/pausesubscriptionop.ts

@@ -24,7 +24,9 @@ export type PauseSubscriptionRequest = {
 export const PauseSubscriptionRequest$zodSchema: z.ZodType<
   PauseSubscriptionRequest
 > = z.object({
-  body: DtoPauseSubscriptionRequest$zodSchema,
+  body: DtoPauseSubscriptionRequest$zodSchema.describe(
+    "Pause subscription request",
+  ),
   id: z.string().describe("Subscription ID"),
 });
 

package/src/models/planfilter.ts

@@ -39,7 +39,9 @@ export type PlanFilter = {
 export const PlanFilter$zodSchema: z.ZodType<PlanFilter> = z.object({
   end_time: z.string().optional(),
   expand: z.string().optional(),
-  filters: z.array(FilterCondition$zodSchema).optional(),
+  filters: z.array(FilterCondition$zodSchema).optional().describe(
+    "filters allows complex filtering based on multiple fields",
+  ),
   limit: z.int().optional(),
   lookup_key: z.string().optional(),
   offset: z.int().optional(),

package/src/models/postplansidcloneop.ts

@@ -21,7 +21,7 @@ export type PostPlansIdCloneRequest = { id: string; body: DtoClonePlanRequest };
 export const PostPlansIdCloneRequest$zodSchema: z.ZodType<
   PostPlansIdCloneRequest
 > = z.object({
-  body: DtoClonePlanRequest$zodSchema,
+  body: DtoClonePlanRequest$zodSchema.describe("Clone configuration"),
   id: z.string().describe("Source Plan ID"),
 });
 

package/src/models/previewsubscriptionchangeop.ts

@@ -24,7 +24,9 @@ export type PreviewSubscriptionChangeRequest = {
 export const PreviewSubscriptionChangeRequest$zodSchema: z.ZodType<
   PreviewSubscriptionChangeRequest
 > = z.object({
-  body: DtoSubscriptionChangeRequest$zodSchema,
+  body: DtoSubscriptionChangeRequest$zodSchema.describe(
+    "Subscription change preview request",
+  ),
   id: z.string().describe("Subscription ID"),
 });
 

package/src/models/pricefilter.ts

@@ -52,13 +52,17 @@ export const PriceFilter$zodSchema: z.ZodType<PriceFilter> = z.object({
   entity_ids: z.array(z.string()).optional(),
   entity_type: PriceEntityType$zodSchema.optional(),
   expand: z.string().optional(),
-  filters: z.array(FilterCondition$zodSchema).optional(),
+  filters: z.array(FilterCondition$zodSchema).optional().describe(
+    "DSL filters",
+  ),
   limit: z.int().optional(),
   meter_ids: z.array(z.string()).optional(),
   offset: z.int().optional(),
   order: PriceFilterOrder$zodSchema.optional(),
   parent_price_id: z.string().optional(),
-  plan_ids: z.array(z.string()).optional(),
+  plan_ids: z.array(z.string()).optional().describe(
+    "Price override filtering fields",
+  ),
   price_ids: z.array(z.string()).optional(),
   sort: z.string().optional(),
   start_date_lt: z.string().optional(),

package/src/models/pricejsonbtransformquantity.ts

@@ -13,6 +13,6 @@ export type PriceJSONBTransformQuantity = {
 export const PriceJSONBTransformQuantity$zodSchema: z.ZodType<
   PriceJSONBTransformQuantity
 > = z.object({
-  divide_by: z.int().optional(),
+  divide_by: z.int().optional().describe("Divide quantity by this number"),
   round: RoundType$zodSchema.optional(),
 });

package/src/models/priceprice.ts

@@ -65,43 +65,85 @@ export type PricePrice = {
 };
 
 export const PricePrice$zodSchema: z.ZodType<PricePrice> = z.object({
-  amount: z.string().optional(),
+  amount: z.string().optional().describe(
+    "Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50",
+  ),
   billing_cadence: BillingCadence$zodSchema.optional(),
   billing_model: BillingModel$zodSchema.optional(),
   billing_period: BillingPeriod$zodSchema.optional(),
-  billing_period_count: z.int().optional(),
-  conversion_rate: z.string().optional(),
+  billing_period_count: z.int().optional().describe(
+    "BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12",
+  ),
+  conversion_rate: z.string().optional().describe(
+    "ConversionRate is the conversion rate of the price unit to the fiat currency",
+  ),
   created_at: z.string().optional(),
   created_by: z.string().optional(),
-  currency: z.string().optional(),
-  description: z.string().optional(),
-  display_amount: z.string().optional(),
-  display_name: z.string().optional(),
-  display_price_unit_amount: z.string().optional(),
-  end_date: z.string().optional(),
-  entity_id: z.string().optional(),
+  currency: z.string().optional().describe(
+    "Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp",
+  ),
+  description: z.string().optional().describe("Description of the price"),
+  display_amount: z.string().optional().describe(
+    "DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50",
+  ),
+  display_name: z.string().optional().describe(
+    "DisplayName is the name of the price",
+  ),
+  display_price_unit_amount: z.string().optional().describe(
+    "DisplayPriceUnitAmount is the formatted amount of the price unit",
+  ),
+  end_date: z.string().optional().describe(
+    "EndDate is the end date of the price",
+  ),
+  entity_id: z.string().optional().describe(
+    "EntityID holds the value of the \"entity_id\" field.",
+  ),
   entity_type: PriceEntityType$zodSchema.optional(),
-  environment_id: z.string().optional(),
-  group_id: z.string().optional(),
-  id: z.string().optional(),
+  environment_id: z.string().optional().describe(
+    "EnvironmentID is the environment identifier for the price",
+  ),
+  group_id: z.string().optional().describe(
+    "GroupID references the group this price belongs to",
+  ),
+  id: z.string().optional().describe("ID uuid identifier for the price"),
   invoice_cadence: InvoiceCadence$zodSchema.optional(),
-  lookup_key: z.string().optional(),
+  lookup_key: z.string().optional().describe(
+    "LookupKey used for looking up the price in the database",
+  ),
   metadata: z.record(z.string(), z.string()).optional(),
-  meter_id: z.string().optional(),
-  min_quantity: z.string().nullable().optional(),
-  parent_price_id: z.string().optional(),
-  price_unit: z.string().optional(),
-  price_unit_amount: z.string().optional(),
-  price_unit_id: z.string().optional(),
-  price_unit_tiers: z.array(PricePriceTier$zodSchema).optional(),
+  meter_id: z.string().optional().describe(
+    "MeterID is the id of the meter for usage based pricing",
+  ),
+  min_quantity: z.string().nullable().optional().describe(
+    "MinQuantity is the minimum quantity of the price",
+  ),
+  parent_price_id: z.string().optional().describe(
+    "ParentPriceID references the root price (always set for price lineage tracking)",
+  ),
+  price_unit: z.string().optional().describe(
+    "PriceUnit is the code of the price unit (e.g., 'btc', 'eth')",
+  ),
+  price_unit_amount: z.string().optional().describe(
+    "PriceUnitAmount is the amount of the price unit",
+  ),
+  price_unit_id: z.string().optional().describe(
+    "PriceUnitID is the id of the price unit (for CUSTOM type)",
+  ),
+  price_unit_tiers: z.array(PricePriceTier$zodSchema).optional().describe(
+    "PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED",
+  ),
   price_unit_type: PriceUnitType$zodSchema.optional(),
-  start_date: z.string().optional(),
+  start_date: z.string().optional().describe(
+    "StartDate is the start date of the price",
+  ),
   status: Status$zodSchema.optional(),
   tenant_id: z.string().optional(),
   tier_mode: BillingTier$zodSchema.optional(),
   tiers: z.array(PricePriceTier$zodSchema).optional(),
   transform_quantity: PriceJSONBTransformQuantity$zodSchema.optional(),
-  trial_period: z.int().optional(),
+  trial_period: z.int().optional().describe(
+    "TrialPeriod is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)",
+  ),
   type: PriceType$zodSchema.optional(),
   updated_at: z.string().optional(),
   updated_by: z.string().optional(),

package/src/models/pricepricetier.ts

@@ -11,7 +11,13 @@ export type PricePriceTier = {
 };
 
 export const PricePriceTier$zodSchema: z.ZodType<PricePriceTier> = z.object({
-  flat_amount: z.string().optional(),
-  unit_amount: z.string().optional(),
-  up_to: z.int().optional(),
+  flat_amount: z.string().optional().describe(
+    "flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\"",
+  ),
+  unit_amount: z.string().optional().describe(
+    "unit_amount is the amount per unit for the given tier",
+  ),
+  up_to: z.int().optional().describe(
+    "up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes",
+  ),
 });

package/src/models/pricetransformquantity.ts

@@ -13,6 +13,6 @@ export type PriceTransformQuantity = {
 export const PriceTransformQuantity$zodSchema: z.ZodType<
   PriceTransformQuantity
 > = z.object({
-  divide_by: z.int().optional(),
+  divide_by: z.int().optional().describe("Divide quantity by this number"),
   round: RoundType$zodSchema.optional(),
 });

package/src/models/reportingunit.ts

@@ -11,7 +11,13 @@ export type ReportingUnit = {
 };
 
 export const ReportingUnit$zodSchema: z.ZodType<ReportingUnit> = z.object({
-  conversion_rate: z.number().optional(),
-  unit_plural: z.string().optional(),
-  unit_singular: z.string().optional(),
+  conversion_rate: z.number().optional().describe(
+    "Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0",
+  ),
+  unit_plural: z.string().optional().describe(
+    "Display unit label, plural (e.g. \"seconds\")",
+  ),
+  unit_singular: z.string().optional().describe(
+    "Display unit label, singular (e.g. \"second\")",
+  ),
 });

package/src/models/resumesubscriptionop.ts

@@ -24,7 +24,9 @@ export type ResumeSubscriptionRequest = {
 export const ResumeSubscriptionRequest$zodSchema: z.ZodType<
   ResumeSubscriptionRequest
 > = z.object({
-  body: DtoResumeSubscriptionRequest$zodSchema,
+  body: DtoResumeSubscriptionRequest$zodSchema.describe(
+    "Resume subscription request",
+  ),
   id: z.string().describe("Subscription ID"),
 });
 

package/src/models/subscriptionfilter.ts

@@ -55,24 +55,41 @@ export type SubscriptionFilter = {
 
 export const SubscriptionFilter$zodSchema: z.ZodType<SubscriptionFilter> = z
   .object({
-    active_at: z.string().optional(),
-    billing_cadence: z.array(BillingCadence$zodSchema).optional(),
-    billing_period: z.array(BillingPeriod$zodSchema).optional(),
-    customer_id: z.string().optional(),
+    active_at: z.string().optional().describe(
+      "ActiveAt filters subscriptions that are active at the given time",
+    ),
+    billing_cadence: z.array(BillingCadence$zodSchema).optional().describe(
+      "BillingCadence filters by billing cadence",
+    ),
+    billing_period: z.array(BillingPeriod$zodSchema).optional().describe(
+      "BillingPeriod filters by billing period",
+    ),
+    customer_id: z.string().optional().describe(
+      "CustomerID filters by customer ID",
+    ),
     end_time: z.string().optional(),
     expand: z.string().optional(),
-    external_customer_id: z.string().optional(),
+    external_customer_id: z.string().optional().describe(
+      "ExternalCustomerID filters by external customer ID",
+    ),
     filters: z.array(FilterCondition$zodSchema).optional(),
-    invoicing_customer_ids: z.array(z.string()).optional(),
+    invoicing_customer_ids: z.array(z.string()).optional().describe(
+      "InvoicingCustomerIDs filters by invoicing customer ID",
+    ),
     limit: z.int().optional(),
     offset: z.int().optional(),
     order: SubscriptionFilterOrder$zodSchema.optional(),
-    parent_subscription_ids: z.array(z.string()).optional(),
-    plan_id: z.string().optional(),
+    parent_subscription_ids: z.array(z.string()).optional().describe(
+      "ParentSubscriptionIDs filters by parent subscription IDs",
+    ),
+    plan_id: z.string().optional().describe("PlanID filters by plan ID"),
     sort: z.array(SortCondition$zodSchema).optional(),
     start_time: z.string().optional(),
     status: Status$zodSchema.optional(),
     subscription_ids: z.array(z.string()).optional(),
-    subscription_status: z.array(SubscriptionStatus$zodSchema).optional(),
-    with_line_items: z.boolean().optional(),
+    subscription_status: z.array(SubscriptionStatus$zodSchema).optional()
+      .describe("SubscriptionStatus filters by subscription status"),
+    with_line_items: z.boolean().optional().describe(
+      "WithLineItems includes line items in the response",
+    ),
   });

package/src/models/subscriptionsubscriptionlineitem.ts

@@ -59,8 +59,10 @@ export const SubscriptionSubscriptionLineItem$zodSchema: z.ZodType<
   SubscriptionSubscriptionLineItem
 > = z.object({
   billing_period: BillingPeriod$zodSchema.optional(),
-  billing_period_count: z.int().optional(),
-  commitment_amount: z.string().optional(),
+  billing_period_count: z.int().optional().describe(
+    "from price at create; default 1",
+  ),
+  commitment_amount: z.string().optional().describe("Commitment fields"),
   commitment_duration: BillingPeriod$zodSchema.optional(),
   commitment_overage_factor: z.string().optional(),
   commitment_quantity: z.string().optional(),

package/src/models/subscriptionsubscriptionpause.ts

@@ -35,20 +35,36 @@ export const SubscriptionSubscriptionPause$zodSchema: z.ZodType<
 > = z.object({
   created_at: z.string().optional(),
   created_by: z.string().optional(),
-  environment_id: z.string().optional(),
-  id: z.string().optional(),
+  environment_id: z.string().optional().describe(
+    "EnvironmentID is the environment identifier for the pause",
+  ),
+  id: z.string().optional().describe(
+    "ID is the unique identifier for the subscription pause",
+  ),
   metadata: z.record(z.string(), z.string()).optional(),
-  original_period_end: z.string().optional(),
-  original_period_start: z.string().optional(),
-  pause_end: z.string().optional(),
+  original_period_end: z.string().optional().describe(
+    "OriginalPeriodEnd is the end of the billing period when the pause was created",
+  ),
+  original_period_start: z.string().optional().describe(
+    "OriginalPeriodStart is the start of the billing period when the pause was created",
+  ),
+  pause_end: z.string().optional().describe(
+    "PauseEnd is when the pause will end (null for indefinite)",
+  ),
   pause_mode: PauseMode$zodSchema.optional(),
-  pause_start: z.string().optional(),
+  pause_start: z.string().optional().describe(
+    "PauseStart is when the pause actually started",
+  ),
   pause_status: PauseStatus$zodSchema.optional(),
-  reason: z.string().optional(),
+  reason: z.string().optional().describe("Reason is the reason for pausing"),
   resume_mode: ResumeMode$zodSchema.optional(),
-  resumed_at: z.string().optional(),
+  resumed_at: z.string().optional().describe(
+    "ResumedAt is when the pause was actually ended (if manually resumed)",
+  ),
   status: Status$zodSchema.optional(),
-  subscription_id: z.string().optional(),
+  subscription_id: z.string().optional().describe(
+    "SubscriptionID is the identifier for the subscription",
+  ),
   tenant_id: z.string().optional(),
   updated_at: z.string().optional(),
   updated_by: z.string().optional(),

package/src/models/updatecustomerop.ts

@@ -24,7 +24,7 @@ export type UpdateCustomerRequest = {
 
 export const UpdateCustomerRequest$zodSchema: z.ZodType<UpdateCustomerRequest> =
   z.object({
-    body: DtoUpdateCustomerRequest$zodSchema,
+    body: DtoUpdateCustomerRequest$zodSchema.describe("Customer"),
     external_customer_id: z.string().describe("Customer External ID")
       .optional(),
     id: z.string().describe("Customer ID").optional(),

package/src/models/updateinvoiceop.ts

@@ -23,7 +23,7 @@ export type UpdateInvoiceRequest = {
 
 export const UpdateInvoiceRequest$zodSchema: z.ZodType<UpdateInvoiceRequest> = z
   .object({
-    body: DtoUpdateInvoiceRequest$zodSchema,
+    body: DtoUpdateInvoiceRequest$zodSchema.describe("Invoice Update Request"),
     id: z.string().describe("Invoice ID"),
   });
 

package/src/models/updateinvoicepaymentstatusop.ts

@@ -24,7 +24,9 @@ export type UpdateInvoicePaymentStatusRequest = {
 export const UpdateInvoicePaymentStatusRequest$zodSchema: z.ZodType<
   UpdateInvoicePaymentStatusRequest
 > = z.object({
-  body: DtoUpdatePaymentStatusRequest$zodSchema,
+  body: DtoUpdatePaymentStatusRequest$zodSchema.describe(
+    "Payment Status Update Request",
+  ),
   id: z.string().describe("Invoice ID"),
 });
 

package/src/models/updateplanop.ts

@@ -20,7 +20,7 @@ export type UpdatePlanRequest = { id: string; body: DtoUpdatePlanRequest };
 
 export const UpdatePlanRequest$zodSchema: z.ZodType<UpdatePlanRequest> = z
   .object({
-    body: DtoUpdatePlanRequest$zodSchema,
+    body: DtoUpdatePlanRequest$zodSchema.describe("Plan update"),
     id: z.string().describe("Plan ID"),
   });
 

package/src/models/updatepriceop.ts

@@ -20,7 +20,7 @@ export type UpdatePriceRequest = { id: string; body: DtoUpdatePriceRequest };
 
 export const UpdatePriceRequest$zodSchema: z.ZodType<UpdatePriceRequest> = z
   .object({
-    body: DtoUpdatePriceRequest$zodSchema,
+    body: DtoUpdatePriceRequest$zodSchema.describe("Price configuration"),
     id: z.string().describe("Price ID"),
   });