@flexprice/mcp-server 2.0.10 → 2.0.11

package/src/models/dtolineitemcommitmentconfig.ts

@@ -19,11 +19,21 @@ export type DtoLineItemCommitmentConfig = {
 export const DtoLineItemCommitmentConfig$zodSchema: z.ZodType<
   DtoLineItemCommitmentConfig
 > = z.object({
-  commitment_amount: z.number().optional(),
+  commitment_amount: z.number().optional().describe(
+    "CommitmentAmount is the minimum amount committed for this line item",
+  ),
   commitment_duration: BillingPeriod$zodSchema.optional(),
-  commitment_quantity: z.number().optional(),
+  commitment_quantity: z.number().optional().describe(
+    "CommitmentQuantity is the minimum quantity committed for this line item",
+  ),
   commitment_type: CommitmentType$zodSchema.optional(),
-  enable_true_up: z.boolean().optional(),
-  is_window_commitment: z.boolean().optional(),
-  overage_factor: z.number().optional(),
+  enable_true_up: z.boolean().optional().describe(
+    "EnableTrueUp determines if true-up fee should be applied when usage is below commitment",
+  ),
+  is_window_commitment: z.boolean().optional().describe(
+    "IsWindowCommitment determines if commitment is applied per window (e.g., per day) rather than per billing period",
+  ),
+  overage_factor: z.number().optional().describe(
+    "OverageFactor is a multiplier applied to usage beyond the commitment",
+  ),
 });

package/src/models/dtolistsubscriptionpausesresponse.ts

@@ -19,6 +19,10 @@ export type DtoListSubscriptionPausesResponse = {
 export const DtoListSubscriptionPausesResponse$zodSchema: z.ZodType<
   DtoListSubscriptionPausesResponse
 > = z.object({
-  items: z.array(DtoSubscriptionPauseResponse$zodSchema).optional(),
-  total: z.int().optional(),
+  items: z.array(DtoSubscriptionPauseResponse$zodSchema).optional().describe(
+    "List of subscription pause objects\n@Description Array of subscription pauses",
+  ),
+  total: z.int().optional().describe(
+    "Total number of pauses\n@Description Total count of subscription pauses in the response",
+  ),
 }).describe("Response object for listing subscription pauses with total count");

package/src/models/dtooverrideentitlementrequest.ts

@@ -14,8 +14,16 @@ export type DtoOverrideEntitlementRequest = {
 export const DtoOverrideEntitlementRequest$zodSchema: z.ZodType<
   DtoOverrideEntitlementRequest
 > = z.object({
-  entitlement_id: z.string(),
-  is_enabled: z.boolean().optional(),
-  static_value: z.string().optional(),
-  usage_limit: z.int().optional(),
+  entitlement_id: z.string().describe(
+    "EntitlementID references the plan/addon entitlement to override",
+  ),
+  is_enabled: z.boolean().optional().describe(
+    "IsEnabled determines if the entitlement is enabled or disabled",
+  ),
+  static_value: z.string().optional().describe(
+    "StaticValue is the static value for static features",
+  ),
+  usage_limit: z.int().optional().describe(
+    "UsageLimit is the new usage limit (only these 3 fields can be overridden)\nFor metered features, nil means unlimited usage",
+  ),
 });

package/src/models/dtooverridelineitemrequest.ts

@@ -29,13 +29,25 @@ export type DtoOverrideLineItemRequest = {
 export const DtoOverrideLineItemRequest$zodSchema: z.ZodType<
   DtoOverrideLineItemRequest
 > = z.object({
-  amount: z.string().optional(),
+  amount: z.string().optional().describe(
+    "Amount is the new price amount that overrides the original price (optional)",
+  ),
   billing_model: BillingModel$zodSchema.optional(),
-  price_id: z.string(),
-  price_unit_amount: z.string().optional(),
-  price_unit_tiers: z.array(DtoCreatePriceTier$zodSchema).optional(),
-  quantity: z.string().optional(),
+  price_id: z.string().describe(
+    "PriceID references the plan price to override",
+  ),
+  price_unit_amount: z.string().optional().describe(
+    "PriceUnitAmount is the amount of the price unit (for CUSTOM type, FLAT_FEE/PACKAGE billing models)",
+  ),
+  price_unit_tiers: z.array(DtoCreatePriceTier$zodSchema).optional().describe(
+    "PriceUnitTiers are the tiers for the price unit (for CUSTOM type, TIERED billing model)",
+  ),
+  quantity: z.string().optional().describe(
+    "Quantity for this line item (optional)",
+  ),
   tier_mode: BillingTier$zodSchema.optional(),
-  tiers: z.array(DtoCreatePriceTier$zodSchema).optional(),
+  tiers: z.array(DtoCreatePriceTier$zodSchema).optional().describe(
+    "Tiers determines the pricing tiers for this line item",
+  ),
   transform_quantity: PriceTransformQuantity$zodSchema.optional(),
 });

package/src/models/dtopausesubscriptionrequest.ts

@@ -21,13 +21,25 @@ export type DtoPauseSubscriptionRequest = {
 export const DtoPauseSubscriptionRequest$zodSchema: z.ZodType<
   DtoPauseSubscriptionRequest
 > = z.object({
-  dry_run: z.boolean().optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
-  pause_days: z.int().optional(),
-  pause_end: z.string().optional(),
+  dry_run: z.boolean().optional().describe(
+    "Whether to perform a dry run\n@Description If true, validates the request and shows impact without actually pausing the subscription\n@Example false",
+  ),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "Additional metadata as key-value pairs\n@Description Optional metadata for storing additional information about the pause\n@Example {\"requested_by\": \"customer\", \"channel\": \"support_ticket\"}",
+  ),
+  pause_days: z.int().optional().describe(
+    "Duration of the pause in days\n@Description Number of days to pause the subscription. Cannot be used together with pause_end. Must be greater than 0\n@Example 30",
+  ),
+  pause_end: z.string().optional().describe(
+    "End date for the subscription pause\n@Description ISO 8601 timestamp when the pause should end. Cannot be used together with pause_days. Must be after pause_start\n@Example \"2024-02-15T00:00:00Z\"",
+  ),
   pause_mode: PauseMode$zodSchema,
-  pause_start: z.string().optional(),
-  reason: z.string().optional(),
+  pause_start: z.string().optional().describe(
+    "Start date for the subscription pause\n@Description ISO 8601 timestamp when the pause should begin. Required when pause_mode is \"scheduled\"\n@Example \"2024-01-15T00:00:00Z\"",
+  ),
+  reason: z.string().optional().describe(
+    "Reason for pausing the subscription\n@Description Optional reason for the pause. Maximum 255 characters\n@Example \"Customer requested temporary suspension\"",
+  ),
 }).describe(
   "Request object for pausing an active subscription with various pause modes and options",
 );

package/src/models/dtoplanresponse.ts

@@ -49,7 +49,9 @@ export const DtoPlanResponse$zodSchema: z.ZodType<DtoPlanResponse> = z.object({
   lookup_key: z.string().optional(),
   metadata: z.record(z.string(), z.string()).optional(),
   name: z.string().optional(),
-  prices: z.array(z.lazy(() => DtoPriceResponse$zodSchema)).optional(),
+  prices: z.array(z.lazy(() => DtoPriceResponse$zodSchema)).optional().describe(
+    "TODO: Add inline addons",
+  ),
   status: Status$zodSchema.optional(),
   tenant_id: z.string().optional(),
   updated_at: z.string().optional(),

package/src/models/dtoplansummary.ts

@@ -12,8 +12,8 @@ export type DtoPlanSummary = {
 };
 
 export const DtoPlanSummary$zodSchema: z.ZodType<DtoPlanSummary> = z.object({
-  description: z.string().optional(),
-  id: z.string().optional(),
-  lookup_key: z.string().optional(),
-  name: z.string().optional(),
+  description: z.string().optional().describe("description of the plan"),
+  id: z.string().optional().describe("id of the plan"),
+  lookup_key: z.string().optional().describe("lookup_key of the plan"),
+  name: z.string().optional().describe("name of the plan"),
 });

package/src/models/dtopriceresponse.ts

@@ -92,47 +92,89 @@ export type DtoPriceResponse = {
 export const DtoPriceResponse$zodSchema: z.ZodType<DtoPriceResponse> = z.object(
   {
     addon: z.lazy(() => DtoAddonResponse$zodSchema).optional(),
-    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(),
+    environment_id: z.string().optional().describe(
+      "EnvironmentID is the environment identifier for the price",
+    ),
     group: DtoGroupResponse$zodSchema.optional(),
-    group_id: z.string().optional(),
-    id: z.string().optional(),
+    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: DtoMeterResponse$zodSchema.optional(),
-    meter_id: z.string().optional(),
-    min_quantity: z.string().nullable().optional(),
-    parent_price_id: z.string().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)",
+    ),
     plan: z.lazy(() => DtoPlanResponse$zodSchema).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(),
+    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(),
     pricing_unit: DtoPriceUnitResponse$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/dtoprorationdetails.ts

@@ -20,15 +20,37 @@ export type DtoProrationDetails = {
 
 export const DtoProrationDetails$zodSchema: z.ZodType<DtoProrationDetails> = z
   .object({
-    charge_amount: z.string().optional(),
-    charge_description: z.string().optional(),
-    credit_amount: z.string().optional(),
-    credit_description: z.string().optional(),
-    currency: z.string().optional(),
-    current_period_end: z.string().optional(),
-    current_period_start: z.string().optional(),
-    days_remaining: z.int().optional(),
-    days_used: z.int().optional(),
-    net_amount: z.string().optional(),
-    proration_date: z.string().optional(),
+    charge_amount: z.string().optional().describe(
+      "charge_amount is the charge amount for the new subscription",
+    ),
+    charge_description: z.string().optional().describe(
+      "charge_description describes what the charge is for",
+    ),
+    credit_amount: z.string().optional().describe(
+      "credit_amount is the credit amount from the old subscription",
+    ),
+    credit_description: z.string().optional().describe(
+      "credit_description describes what the credit is for",
+    ),
+    currency: z.string().optional().describe(
+      "currency is the currency for all amounts",
+    ),
+    current_period_end: z.string().optional().describe(
+      "current_period_end is the end of the current billing period",
+    ),
+    current_period_start: z.string().optional().describe(
+      "current_period_start is the start of the current billing period",
+    ),
+    days_remaining: z.int().optional().describe(
+      "days_remaining is the number of days remaining in the current period",
+    ),
+    days_used: z.int().optional().describe(
+      "days_used is the number of days used in the current period",
+    ),
+    net_amount: z.string().optional().describe(
+      "net_amount is the net amount (charge - credit)",
+    ),
+    proration_date: z.string().optional().describe(
+      "proration_date is the date used for proration calculations",
+    ),
   });

package/src/models/dtoresumesubscriptionrequest.ts

@@ -17,7 +17,11 @@ export type DtoResumeSubscriptionRequest = {
 export const DtoResumeSubscriptionRequest$zodSchema: z.ZodType<
   DtoResumeSubscriptionRequest
 > = z.object({
-  dry_run: z.boolean().optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
+  dry_run: z.boolean().optional().describe(
+    "Whether to perform a dry run\n@Description If true, validates the request and shows impact without actually resuming the subscription\n@Example false",
+  ),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "Additional metadata as key-value pairs\n@Description Optional metadata for storing additional information about the resume operation\n@Example {\"resumed_by\": \"admin\", \"reason\": \"issue_resolved\"}",
+  ),
   resume_mode: ResumeMode$zodSchema,
 }).describe("Request object for resuming a paused subscription");

package/src/models/dtosourceusageitem.ts

@@ -14,9 +14,19 @@ export type DtoSourceUsageItem = {
 
 export const DtoSourceUsageItem$zodSchema: z.ZodType<DtoSourceUsageItem> = z
   .object({
-    cost: z.string().optional(),
-    event_count: z.int().optional(),
-    percentage: z.string().optional(),
-    source: z.string().optional(),
-    usage: z.string().optional(),
+    cost: z.string().optional().describe(
+      "cost is the cost attributed to this source for the line item",
+    ),
+    event_count: z.int().optional().describe(
+      "event_count is the number of events from this source (optional)",
+    ),
+    percentage: z.string().optional().describe(
+      "percentage is the percentage of total line item cost from this source (optional)",
+    ),
+    source: z.string().optional().describe(
+      "source is the name of the event source",
+    ),
+    usage: z.string().optional().describe(
+      "usage is the total usage amount from this source (optional, for additional context)",
+    ),
   });

package/src/models/dtosubscriptionchangeexecuteresponse.ts

@@ -45,14 +45,26 @@ export const DtoSubscriptionChangeExecuteResponse$zodSchema: z.ZodType<
   DtoSubscriptionChangeExecuteResponse
 > = z.object({
   change_type: SubscriptionChangeType$zodSchema.optional(),
-  credit_grants: z.array(DtoCreditGrantResponse$zodSchema).optional(),
-  effective_date: z.string().optional(),
+  credit_grants: z.array(DtoCreditGrantResponse$zodSchema).optional().describe(
+    "credit_grants contains any credit grants created for proration credits",
+  ),
+  effective_date: z.string().optional().describe(
+    "effective_date is when the change took effect",
+  ),
   invoice: DtoInvoiceResponse$zodSchema.optional(),
-  is_scheduled: z.boolean().optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
+  is_scheduled: z.boolean().optional().describe(
+    "is_scheduled indicates if the change was scheduled or executed immediately",
+  ),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "metadata from the request",
+  ),
   new_subscription: DtoSubscriptionSummary$zodSchema.optional(),
   old_subscription: DtoSubscriptionSummary$zodSchema.optional(),
   proration_applied: DtoProrationDetails$zodSchema.optional(),
-  schedule_id: z.string().optional(),
-  scheduled_at: z.string().optional(),
+  schedule_id: z.string().optional().describe(
+    "schedule_id is the ID of the created schedule (only if is_scheduled=true)",
+  ),
+  scheduled_at: z.string().optional().describe(
+    "scheduled_at is when the change will execute (only if is_scheduled=true)",
+  ),
 }).describe("Response after successfully executing a subscription plan change");

package/src/models/dtosubscriptionchangepreviewresponse.ts

@@ -42,14 +42,22 @@ export const DtoSubscriptionChangePreviewResponse$zodSchema: z.ZodType<
 > = z.object({
   change_type: SubscriptionChangeType$zodSchema.optional(),
   current_plan: DtoPlanSummary$zodSchema.optional(),
-  effective_date: z.string().optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
+  effective_date: z.string().optional().describe(
+    "effective_date is when the change would take effect",
+  ),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "metadata from the request",
+  ),
   new_billing_cycle: DtoBillingCycleInfo$zodSchema.optional(),
   next_invoice_preview: DtoInvoicePreview$zodSchema.optional(),
   proration_details: DtoProrationDetails$zodSchema.optional(),
-  subscription_id: z.string().optional(),
+  subscription_id: z.string().optional().describe(
+    "subscription_id is the ID of the subscription being changed",
+  ),
   target_plan: DtoPlanSummary$zodSchema.optional(),
-  warnings: z.array(z.string()).optional(),
+  warnings: z.array(z.string()).optional().describe(
+    "warnings contains any warnings about the change",
+  ),
 }).describe(
   "Response showing the financial impact of a subscription plan change",
 );

package/src/models/dtosubscriptionchangerequest.ts

@@ -32,11 +32,17 @@ export const DtoSubscriptionChangeRequest$zodSchema: z.ZodType<
   billing_cadence: BillingCadence$zodSchema,
   billing_cycle: BillingCycle$zodSchema,
   billing_period: BillingPeriod$zodSchema,
-  billing_period_count: z.int().optional(),
+  billing_period_count: z.int().optional().describe(
+    "billing_period_count is the billing period count for the new subscription",
+  ),
   change_at: ScheduleType$zodSchema.optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "metadata contains additional key-value pairs for storing extra information",
+  ),
   proration_behavior: ProrationBehavior$zodSchema,
-  target_plan_id: z.string(),
+  target_plan_id: z.string().describe(
+    "target_plan_id is the ID of the new plan to change to (required)",
+  ),
 }).describe(
   "Request object for changing a subscription plan (upgrade/downgrade)",
 );

package/src/models/dtosubscriptionlineitemresponse.ts

@@ -62,8 +62,10 @@ export const DtoSubscriptionLineItemResponse$zodSchema: z.ZodType<
   DtoSubscriptionLineItemResponse
 > = 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/dtosubscriptionpauseresponse.ts

@@ -38,20 +38,36 @@ export const DtoSubscriptionPauseResponse$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/dtosubscriptionphasecreaterequest.ts

@@ -20,10 +20,18 @@ export type DtoSubscriptionPhaseCreateRequest = {
 export const DtoSubscriptionPhaseCreateRequest$zodSchema: z.ZodType<
   DtoSubscriptionPhaseCreateRequest
 > = z.object({
-  coupons: z.array(z.string()).optional(),
+  coupons: z.array(z.string()).optional().describe(
+    "Coupons represents subscription-level coupons to be applied to this phase",
+  ),
   end_date: z.string().optional(),
-  line_item_coupons: z.record(z.string(), z.array(z.string())).optional(),
+  line_item_coupons: z.record(z.string(), z.array(z.string())).optional()
+    .describe(
+      "LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)",
+    ),
   metadata: z.record(z.string(), z.string()).optional(),
-  override_line_items: z.array(DtoOverrideLineItemRequest$zodSchema).optional(),
+  override_line_items: z.array(DtoOverrideLineItemRequest$zodSchema).optional()
+    .describe(
+      "OverrideLineItems allows customizing specific prices for this phase\nIf not provided, phase will use the same line items as the subscription (plan prices)",
+    ),
   start_date: z.string(),
 });

package/src/models/dtosubscriptionphaseresponse.ts

@@ -25,13 +25,23 @@ export const DtoSubscriptionPhaseResponse$zodSchema: z.ZodType<
 > = z.object({
   created_at: z.string().optional(),
   created_by: z.string().optional(),
-  end_date: z.string().optional(),
-  environment_id: z.string().optional(),
-  id: z.string().optional(),
+  end_date: z.string().optional().describe(
+    "EndDate is when the phase ends (nil if phase is still active or indefinite)",
+  ),
+  environment_id: z.string().optional().describe(
+    "EnvironmentID is the environment identifier for the phase",
+  ),
+  id: z.string().optional().describe(
+    "ID is the unique identifier for the subscription phase",
+  ),
   metadata: z.record(z.string(), z.string()).optional(),
-  start_date: z.string().optional(),
+  start_date: z.string().optional().describe(
+    "StartDate is when the phase starts",
+  ),
   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(),