@flexprice/mcp-server 2.0.10 → 2.0.11

package/src/models/dtosubscriptionresponse.ts

@@ -107,56 +107,116 @@ export type DtoSubscriptionResponse = {
 export const DtoSubscriptionResponse$zodSchema: z.ZodType<
   DtoSubscriptionResponse
 > = z.object({
-  active_pause_id: z.string().optional(),
-  billing_anchor: z.string().optional(),
+  active_pause_id: z.string().optional().describe(
+    "ActivePauseID references the current active pause configuration\nThis will be null if no pause is active or scheduled",
+  ),
+  billing_anchor: z.string().optional().describe(
+    "BillingAnchor is the reference point that aligns future billing cycle dates.\nIt sets the day of week for week intervals, the day of month for month and year intervals,\nand the month of year for year intervals. The timestamp is in UTC format.",
+  ),
   billing_cadence: BillingCadence$zodSchema.optional(),
   billing_cycle: BillingCycle$zodSchema.optional(),
   billing_period: BillingPeriod$zodSchema.optional(),
-  billing_period_count: z.int().optional(),
-  cancel_at: z.string().optional(),
-  cancel_at_period_end: z.boolean().optional(),
-  cancelled_at: z.string().optional(),
-  collection_method: z.string().optional(),
-  commitment_amount: z.string().optional(),
+  billing_period_count: z.int().optional().describe(
+    "BillingPeriodCount is the total number units of the billing period.",
+  ),
+  cancel_at: z.string().optional().describe(
+    "CancelAt is the date the subscription will be canceled",
+  ),
+  cancel_at_period_end: z.boolean().optional().describe(
+    "CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period",
+  ),
+  cancelled_at: z.string().optional().describe(
+    "CanceledAt is the date the subscription was canceled",
+  ),
+  collection_method: z.string().optional().describe(
+    "CollectionMethod determines how invoices are collected",
+  ),
+  commitment_amount: z.string().optional().describe(
+    "CommitmentAmount is the minimum amount a customer commits to paying for a billing period",
+  ),
   commitment_duration: BillingPeriod$zodSchema.optional(),
   coupon_associations: z.array(DtoCouponAssociationResponse$zodSchema)
-    .optional(),
+    .optional().describe(
+      "CouponAssociations are the coupon associations for this subscription",
+    ),
   created_at: z.string().optional(),
   created_by: z.string().optional(),
-  credit_grants: z.array(DtoCreditGrantResponse$zodSchema).optional(),
-  currency: z.string().optional(),
-  current_period_end: z.string().optional(),
-  current_period_start: z.string().optional(),
-  customer: DtoCustomerResponse$zodSchema.optional(),
-  customer_id: z.string().optional(),
+  credit_grants: z.array(DtoCreditGrantResponse$zodSchema).optional().describe(
+    "Credit grants are the credit grants for this subscription",
+  ),
+  currency: z.string().optional().describe(
+    "Currency is the currency of the subscription in lowercase 3 digit ISO codes",
+  ),
+  current_period_end: z.string().optional().describe(
+    "CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for.\nAt the end of this period, a new invoice will be created.",
+  ),
+  current_period_start: z.string().optional().describe(
+    "CurrentPeriodStart is the end of the current period that the subscription has been invoiced for.\nAt the end of this period, a new invoice will be created.",
+  ),
+  customer: DtoCustomerResponse$zodSchema.optional().describe(
+    "Customer response object containing all customer information",
+  ),
+  customer_id: z.string().optional().describe(
+    "CustomerID is the identifier for the customer in our system",
+  ),
   customer_timezone: z.string().optional(),
   enable_true_up: z.boolean().optional(),
-  end_date: z.string().optional(),
-  environment_id: z.string().optional(),
-  gateway_payment_method_id: z.string().optional(),
-  id: z.string().optional(),
-  invoicing_customer_id: z.string().optional(),
+  end_date: z.string().optional().describe(
+    "EndDate is the end date of the subscription",
+  ),
+  environment_id: z.string().optional().describe(
+    "EnvironmentID is the environment identifier for the subscription",
+  ),
+  gateway_payment_method_id: z.string().optional().describe(
+    "GatewayPaymentMethodID is the gateway payment method ID for this subscription",
+  ),
+  id: z.string().optional().describe(
+    "ID is the unique identifier for the subscription",
+  ),
+  invoicing_customer_id: z.string().optional().describe(
+    "InvoicingCustomerID is the customer ID to use for invoicing\nThis can differ from the subscription customer (e.g., parent company invoicing for child company)",
+  ),
   latest_invoice: z.lazy(() => DtoInvoiceResponse$zodSchema).optional(),
   line_items: z.array(SubscriptionSubscriptionLineItem$zodSchema).optional(),
-  lookup_key: z.string().optional(),
+  lookup_key: z.string().optional().describe(
+    "LookupKey is the key used to lookup the subscription in our system",
+  ),
   metadata: z.record(z.string(), z.string()).optional(),
-  overage_factor: z.string().optional(),
-  parent_subscription_id: z.string().optional(),
+  overage_factor: z.string().optional().describe(
+    "OverageFactor is a multiplier applied to usage beyond the commitment amount",
+  ),
+  parent_subscription_id: z.string().optional().describe(
+    "ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)",
+  ),
   pause_status: PauseStatus$zodSchema.optional(),
   pauses: z.array(SubscriptionSubscriptionPause$zodSchema).optional(),
-  payment_behavior: z.string().optional(),
+  payment_behavior: z.string().optional().describe(
+    "PaymentBehavior determines how subscription payments are handled",
+  ),
   payment_terms: PaymentTerms$zodSchema.optional(),
-  phases: z.array(DtoSubscriptionPhaseResponse$zodSchema).optional(),
+  phases: z.array(DtoSubscriptionPhaseResponse$zodSchema).optional().describe(
+    "Phases are the subscription phases for this subscription",
+  ),
   plan: DtoPlanResponse$zodSchema.optional(),
-  plan_id: z.string().optional(),
+  plan_id: z.string().optional().describe(
+    "PlanID is the identifier for the plan in our system",
+  ),
   proration_behavior: ProrationBehavior$zodSchema.optional(),
-  start_date: z.string().optional(),
+  start_date: z.string().optional().describe(
+    "StartDate is the start date of the subscription",
+  ),
   status: Status$zodSchema.optional(),
   subscription_status: SubscriptionStatus$zodSchema.optional(),
   tenant_id: z.string().optional(),
-  trial_end: z.string().optional(),
-  trial_start: z.string().optional(),
+  trial_end: z.string().optional().describe(
+    "TrialEnd is the end date of the trial period",
+  ),
+  trial_start: z.string().optional().describe(
+    "TrialStart is the start date of the trial period",
+  ),
   updated_at: z.string().optional(),
   updated_by: z.string().optional(),
-  version: z.int().optional(),
+  version: z.int().optional().describe(
+    "Version is used for optimistic locking",
+  ),
 });

package/src/models/dtosubscriptionresponsev2.ts

@@ -102,55 +102,120 @@ export type DtoSubscriptionResponseV2 = {
 export const DtoSubscriptionResponseV2$zodSchema: z.ZodType<
   DtoSubscriptionResponseV2
 > = z.object({
-  active_pause_id: z.string().optional(),
-  billing_anchor: z.string().optional(),
+  active_pause_id: z.string().optional().describe(
+    "ActivePauseID references the current active pause configuration\nThis will be null if no pause is active or scheduled",
+  ),
+  billing_anchor: z.string().optional().describe(
+    "BillingAnchor is the reference point that aligns future billing cycle dates.\nIt sets the day of week for week intervals, the day of month for month and year intervals,\nand the month of year for year intervals. The timestamp is in UTC format.",
+  ),
   billing_cadence: BillingCadence$zodSchema.optional(),
   billing_cycle: BillingCycle$zodSchema.optional(),
   billing_period: BillingPeriod$zodSchema.optional(),
-  billing_period_count: z.int().optional(),
-  cancel_at: z.string().optional(),
-  cancel_at_period_end: z.boolean().optional(),
-  cancelled_at: z.string().optional(),
-  collection_method: z.string().optional(),
-  commitment_amount: z.string().optional(),
+  billing_period_count: z.int().optional().describe(
+    "BillingPeriodCount is the total number units of the billing period.",
+  ),
+  cancel_at: z.string().optional().describe(
+    "CancelAt is the date the subscription will be canceled",
+  ),
+  cancel_at_period_end: z.boolean().optional().describe(
+    "CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period",
+  ),
+  cancelled_at: z.string().optional().describe(
+    "CanceledAt is the date the subscription was canceled",
+  ),
+  collection_method: z.string().optional().describe(
+    "CollectionMethod determines how invoices are collected",
+  ),
+  commitment_amount: z.string().optional().describe(
+    "CommitmentAmount is the minimum amount a customer commits to paying for a billing period",
+  ),
   commitment_duration: BillingPeriod$zodSchema.optional(),
   coupon_associations: z.array(DtoCouponAssociationResponse$zodSchema)
-    .optional(),
+    .optional().describe(
+      "CouponAssociations are included when \"coupon_associations\" is in expand parameter",
+    ),
   created_at: z.string().optional(),
   created_by: z.string().optional(),
-  credit_grants: z.array(DtoCreditGrantResponse$zodSchema).optional(),
-  currency: z.string().optional(),
-  current_period_end: z.string().optional(),
-  current_period_start: z.string().optional(),
-  customer: DtoCustomerResponse$zodSchema.optional(),
-  customer_id: z.string().optional(),
+  credit_grants: z.array(DtoCreditGrantResponse$zodSchema).optional().describe(
+    "CreditGrants are included when \"credit_grants\" is in expand parameter",
+  ),
+  currency: z.string().optional().describe(
+    "Currency is the currency of the subscription in lowercase 3 digit ISO codes",
+  ),
+  current_period_end: z.string().optional().describe(
+    "CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for.\nAt the end of this period, a new invoice will be created.",
+  ),
+  current_period_start: z.string().optional().describe(
+    "CurrentPeriodStart is the end of the current period that the subscription has been invoiced for.\nAt the end of this period, a new invoice will be created.",
+  ),
+  customer: DtoCustomerResponse$zodSchema.optional().describe(
+    "Customer response object containing all customer information",
+  ),
+  customer_id: z.string().optional().describe(
+    "CustomerID is the identifier for the customer in our system",
+  ),
   customer_timezone: z.string().optional(),
   enable_true_up: z.boolean().optional(),
-  end_date: z.string().optional(),
-  environment_id: z.string().optional(),
-  gateway_payment_method_id: z.string().optional(),
-  id: z.string().optional(),
-  invoicing_customer_id: z.string().optional(),
-  line_items: z.array(DtoSubscriptionLineItemResponse$zodSchema).optional(),
-  lookup_key: z.string().optional(),
+  end_date: z.string().optional().describe(
+    "EndDate is the end date of the subscription",
+  ),
+  environment_id: z.string().optional().describe(
+    "EnvironmentID is the environment identifier for the subscription",
+  ),
+  gateway_payment_method_id: z.string().optional().describe(
+    "GatewayPaymentMethodID is the gateway payment method ID for this subscription",
+  ),
+  id: z.string().optional().describe(
+    "ID is the unique identifier for the subscription",
+  ),
+  invoicing_customer_id: z.string().optional().describe(
+    "InvoicingCustomerID is the customer ID to use for invoicing\nThis can differ from the subscription customer (e.g., parent company invoicing for child company)",
+  ),
+  line_items: z.array(DtoSubscriptionLineItemResponse$zodSchema).optional()
+    .describe(
+      "LineItems is expanded only if \"subscription_line_items\" is in expand parameter\nEach line item can optionally include expanded price data",
+    ),
+  lookup_key: z.string().optional().describe(
+    "LookupKey is the key used to lookup the subscription in our system",
+  ),
   metadata: z.record(z.string(), z.string()).optional(),
-  overage_factor: z.string().optional(),
-  parent_subscription_id: z.string().optional(),
+  overage_factor: z.string().optional().describe(
+    "OverageFactor is a multiplier applied to usage beyond the commitment amount",
+  ),
+  parent_subscription_id: z.string().optional().describe(
+    "ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)",
+  ),
   pause_status: PauseStatus$zodSchema.optional(),
-  pauses: z.array(SubscriptionSubscriptionPause$zodSchema).optional(),
-  payment_behavior: z.string().optional(),
+  pauses: z.array(SubscriptionSubscriptionPause$zodSchema).optional().describe(
+    "Pauses are included when subscription has pause status",
+  ),
+  payment_behavior: z.string().optional().describe(
+    "PaymentBehavior determines how subscription payments are handled",
+  ),
   payment_terms: PaymentTerms$zodSchema.optional(),
-  phases: z.array(DtoSubscriptionPhaseResponse$zodSchema).optional(),
+  phases: z.array(DtoSubscriptionPhaseResponse$zodSchema).optional().describe(
+    "Phases are included when \"phases\" is in expand parameter",
+  ),
   plan: DtoPlanResponse$zodSchema.optional(),
-  plan_id: z.string().optional(),
+  plan_id: z.string().optional().describe(
+    "PlanID is the identifier for the plan in our system",
+  ),
   proration_behavior: ProrationBehavior$zodSchema.optional(),
-  start_date: z.string().optional(),
+  start_date: z.string().optional().describe(
+    "StartDate is the start date of the subscription",
+  ),
   status: Status$zodSchema.optional(),
   subscription_status: SubscriptionStatus$zodSchema.optional(),
   tenant_id: z.string().optional(),
-  trial_end: z.string().optional(),
-  trial_start: z.string().optional(),
+  trial_end: z.string().optional().describe(
+    "TrialEnd is the end date of the trial period",
+  ),
+  trial_start: z.string().optional().describe(
+    "TrialStart is the start date of the trial period",
+  ),
   updated_at: z.string().optional(),
   updated_by: z.string().optional(),
-  version: z.int().optional(),
+  version: z.int().optional().describe(
+    "Version is used for optimistic locking",
+  ),
 });

package/src/models/dtosubscriptionscheduleresponse.ts

@@ -52,19 +52,39 @@ export type DtoSubscriptionScheduleResponse = {
 export const DtoSubscriptionScheduleResponse$zodSchema: z.ZodType<
   DtoSubscriptionScheduleResponse
 > = z.object({
-  can_be_cancelled: z.boolean().optional(),
-  cancelled_at: z.string().optional(),
-  configuration: z.lazy(() => Configuration$zodSchema).optional(),
-  created_at: z.string().optional(),
-  days_until_execution: z.int().optional(),
-  error_message: z.string().optional(),
-  executed_at: z.string().optional(),
-  execution_result: z.lazy(() => ExecutionResult$zodSchema).optional(),
-  id: z.string().optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
+  can_be_cancelled: z.boolean().optional().describe(
+    "can_be_cancelled indicates if the schedule can be cancelled",
+  ),
+  cancelled_at: z.string().optional().describe(
+    "cancelled_at is when the schedule was cancelled",
+  ),
+  configuration: z.lazy(() => Configuration$zodSchema).optional().describe(
+    "configuration contains type-specific configuration (e.g., target_plan_id for plan changes)",
+  ),
+  created_at: z.string().optional().describe("created_at timestamp"),
+  days_until_execution: z.int().optional().describe(
+    "days_until_execution is the number of days until execution",
+  ),
+  error_message: z.string().optional().describe(
+    "error_message contains the error if execution failed",
+  ),
+  executed_at: z.string().optional().describe(
+    "executed_at is when the schedule was executed",
+  ),
+  execution_result: z.lazy(() => ExecutionResult$zodSchema).optional().describe(
+    "execution_result contains type-specific execution result",
+  ),
+  id: z.string().optional().describe("id of the schedule"),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "metadata from the schedule",
+  ),
   schedule_type: SubscriptionScheduleChangeType$zodSchema.optional(),
-  scheduled_at: z.string().optional(),
+  scheduled_at: z.string().optional().describe(
+    "scheduled_at is when the schedule will execute",
+  ),
   status: ScheduleStatus$zodSchema.optional(),
-  subscription_id: z.string().optional(),
-  updated_at: z.string().optional(),
+  subscription_id: z.string().optional().describe(
+    "subscription_id is the ID of the subscription",
+  ),
+  updated_at: z.string().optional().describe("updated_at timestamp"),
 }).describe("Full details of a subscription schedule");

package/src/models/dtosubscriptionsummary.ts

@@ -22,12 +22,20 @@ export type DtoSubscriptionSummary = {
 export const DtoSubscriptionSummary$zodSchema: z.ZodType<
   DtoSubscriptionSummary
 > = z.object({
-  archived_at: z.string().optional(),
-  billing_anchor: z.string().optional(),
-  created_at: z.string().optional(),
-  current_period_end: z.string().optional(),
-  current_period_start: z.string().optional(),
-  id: z.string().optional(),
-  plan_id: z.string().optional(),
+  archived_at: z.string().optional().describe(
+    "archived_at timestamp (for old subscriptions)",
+  ),
+  billing_anchor: z.string().optional().describe(
+    "billing_anchor of the subscription",
+  ),
+  created_at: z.string().optional().describe("created_at timestamp"),
+  current_period_end: z.string().optional().describe(
+    "current_period_end of the subscription",
+  ),
+  current_period_start: z.string().optional().describe(
+    "current_period_start of the subscription",
+  ),
+  id: z.string().optional().describe("id of the subscription"),
+  plan_id: z.string().optional().describe("plan_id of the subscription"),
   status: SubscriptionStatus$zodSchema.optional(),
 });

package/src/models/dtosubscriptionusagebymetersresponse.ts

@@ -26,11 +26,17 @@ export const DtoSubscriptionUsageByMetersResponse$zodSchema: z.ZodType<
   currency: z.string().optional(),
   display_amount: z.string().optional(),
   filter_values: z.record(z.string(), z.array(z.string())).optional(),
-  is_overage: z.boolean().optional(),
+  is_overage: z.boolean().optional().describe(
+    "Whether this charge is at overage rate",
+  ),
   meter_display_name: z.string().optional(),
   meter_id: z.string().optional(),
-  overage_factor: z.number().optional(),
+  overage_factor: z.number().optional().describe(
+    "Factor applied to this charge if in overage",
+  ),
   price: PricePrice$zodSchema.optional(),
   quantity: z.number().optional(),
-  subscription_line_item_id: z.string().optional(),
+  subscription_line_item_id: z.string().optional().describe(
+    "For feature_usage: direct match by sub_line_item_id",
+  ),
 });

package/src/models/dtoupdatecustomerrequest.ts

@@ -30,20 +30,46 @@ export type DtoUpdateCustomerRequest = {
 export const DtoUpdateCustomerRequest$zodSchema: z.ZodType<
   DtoUpdateCustomerRequest
 > = 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(),
-  email: z.string().optional(),
-  external_id: z.string().optional(),
+  address_city: z.string().optional().describe(
+    "address_city is the updated city name with maximum 100 characters",
+  ),
+  address_country: z.string().optional().describe(
+    "address_country is the updated two-letter ISO 3166-1 alpha-2 country code",
+  ),
+  address_line1: z.string().optional().describe(
+    "address_line1 is the updated primary address line with maximum 255 characters",
+  ),
+  address_line2: z.string().optional().describe(
+    "address_line2 is the updated secondary address line with maximum 255 characters",
+  ),
+  address_postal_code: z.string().optional().describe(
+    "address_postal_code is the updated postal code with maximum 20 characters",
+  ),
+  address_state: z.string().optional().describe(
+    "address_state is the updated state, province, or region name with maximum 100 characters",
+  ),
+  email: z.string().optional().describe(
+    "email is the updated email address and must be a valid email format if provided",
+  ),
+  external_id: z.string().optional().describe(
+    "external_id is the updated external identifier for the customer",
+  ),
   integration_entity_mapping: z.array(DtoIntegrationEntityMapping$zodSchema)
-    .optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
-  name: z.string().optional(),
-  parent_customer_external_id: z.string().optional(),
-  parent_customer_id: z.string().optional(),
+    .optional().describe(
+      "integration_entity_mapping contains provider integration mappings for this customer",
+    ),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "metadata contains updated key-value pairs that will replace existing metadata",
+  ),
+  name: z.string().optional().describe(
+    "name is the updated name or company name for the customer",
+  ),
+  parent_customer_external_id: z.string().optional().describe(
+    "Deprecated: See ParentCustomerID.\nparent_customer_external_id is the external ID of the parent customer from your system.\nExactly one of parent_customer_id or parent_customer_external_id may be provided.\nIf you provide the external ID, the parent customer value will be ignored.",
+  ),
+  parent_customer_id: z.string().optional().describe(
+    "Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.\nThis field is accepted for backward compatibility but no hierarchy validations are enforced.\nparent_customer_id is the internal FlexPrice ID of the parent customer.",
+  ),
 }).describe(
   "Request object for updating an existing customer. All fields are optional - only provided fields will be updated",
 );

package/src/models/dtoupdateinvoicerequest.ts

@@ -14,6 +14,8 @@ export const DtoUpdateInvoiceRequest$zodSchema: z.ZodType<
   DtoUpdateInvoiceRequest
 > = z.object({
   due_date: z.string().optional(),
-  invoice_pdf_url: z.string().optional(),
+  invoice_pdf_url: z.string().optional().describe(
+    "invoice_pdf_url is the URL where customers can download the PDF version of this invoice",
+  ),
   metadata: z.record(z.string(), z.string()).optional(),
 });

package/src/models/dtoupdatepaymentstatusrequest.ts

@@ -13,6 +13,8 @@ export type DtoUpdatePaymentStatusRequest = {
 export const DtoUpdatePaymentStatusRequest$zodSchema: z.ZodType<
   DtoUpdatePaymentStatusRequest
 > = z.object({
-  amount: z.string().optional(),
+  amount: z.string().optional().describe(
+    "amount is the optional payment amount to record",
+  ),
   payment_status: PaymentStatus$zodSchema,
 });

package/src/models/dtoupdatepricerequest.ts

@@ -32,17 +32,29 @@ export type DtoUpdatePriceRequest = {
 
 export const DtoUpdatePriceRequest$zodSchema: z.ZodType<DtoUpdatePriceRequest> =
   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(),
     description: z.string().optional(),
     display_name: z.string().optional(),
     effective_from: z.string().optional(),
-    group_id: z.string().optional(),
-    lookup_key: z.string().optional(),
+    group_id: z.string().optional().describe(
+      "GroupID is the id of the group to update the price in.\nIf not provided (nil), the group will not be changed\nIf provided as empty string (\"\"), the group will be removed (price will be ungrouped)\nIf provided as a group ID, the price will be assigned to that group (must exist and be published)",
+    ),
+    lookup_key: z.string().optional().describe(
+      "All price fields that can be updated\nNon-critical fields (can be updated directly)",
+    ),
     metadata: z.record(z.string(), z.string()).optional(),
-    price_unit_amount: z.string().optional(),
-    price_unit_tiers: z.array(DtoCreatePriceTier$zodSchema).optional(),
+    price_unit_amount: z.string().optional().describe(
+      "PriceUnitAmount is the price unit amount (for CUSTOM price unit type, FLAT_FEE/PACKAGE billing models)",
+    ),
+    price_unit_tiers: z.array(DtoCreatePriceTier$zodSchema).optional().describe(
+      "PriceUnitTiers are the price unit tiers (for CUSTOM price unit type, TIERED billing model)",
+    ),
     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/dtoupdatesubscriptionlineitemrequest.ts

@@ -36,18 +36,26 @@ export type DtoUpdateSubscriptionLineItemRequest = {
 export const DtoUpdateSubscriptionLineItemRequest$zodSchema: z.ZodType<
   DtoUpdateSubscriptionLineItemRequest
 > = z.object({
-  amount: z.string().optional(),
+  amount: z.string().optional().describe(
+    "Amount is the new price amount that overrides the original price",
+  ),
   billing_model: BillingModel$zodSchema.optional(),
-  commitment_amount: z.number().optional(),
+  commitment_amount: z.number().optional().describe("Commitment fields"),
   commitment_duration: BillingPeriod$zodSchema.optional(),
   commitment_overage_factor: z.number().optional(),
   commitment_quantity: z.number().optional(),
   commitment_true_up_enabled: z.boolean().optional(),
   commitment_type: CommitmentType$zodSchema.optional(),
   commitment_windowed: z.boolean().optional(),
-  effective_from: z.string().optional(),
-  metadata: z.record(z.string(), z.string()).optional(),
+  effective_from: z.string().optional().describe(
+    "EffectiveFrom for the existing line item (if not provided, defaults to now)",
+  ),
+  metadata: z.record(z.string(), z.string()).optional().describe(
+    "Metadata for the new line item",
+  ),
   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/dtoupdatesubscriptionrequest.ts

@@ -20,6 +20,8 @@ export const DtoUpdateSubscriptionRequest$zodSchema: z.ZodType<
 > = z.object({
   cancel_at: z.string().optional(),
   cancel_at_period_end: z.boolean().optional(),
-  parent_subscription_id: z.string().optional(),
+  parent_subscription_id: z.string().optional().describe(
+    "ParentSubscriptionID sets or clears the parent subscription. Omit to leave unchanged; send \"\" to clear.",
+  ),
   status: SubscriptionStatus$zodSchema.optional(),
 });

package/src/models/dtousageanalyticitem.ts

@@ -79,32 +79,42 @@ export const DtoUsageAnalyticItem$zodSchema: z.ZodType<DtoUsageAnalyticItem> = z
     aggregation_type: AggregationType$zodSchema.optional(),
     commitment_info: CommitmentInfo$zodSchema.optional(),
     currency: z.string().optional(),
-    event_count: z.int().optional(),
+    event_count: z.int().optional().describe(
+      "Number of events that contributed to this aggregation",
+    ),
     event_name: z.string().optional(),
     feature: GithubComFlexpriceFlexpriceInternalDomainFeatureFeature$zodSchema
       .optional(),
     feature_id: z.string().optional(),
     group: GroupGroup$zodSchema.optional(),
     meter: MeterMeter$zodSchema.optional(),
-    meter_id: z.string().optional(),
+    meter_id: z.string().optional().describe("Meter ID"),
     name: z.string().optional(),
     plan: GithubComFlexpriceFlexpriceInternalDomainPlanPlan$zodSchema
       .optional(),
     plan_id: z.string().optional(),
     points: z.array(DtoUsageAnalyticPoint$zodSchema).optional(),
     price: DtoPriceResponse$zodSchema.optional(),
-    price_id: z.string().optional(),
-    properties: z.record(z.string(), z.string()).optional(),
+    price_id: z.string().optional().describe("Price ID used for this usage"),
+    properties: z.record(z.string(), z.string()).optional().describe(
+      "Stores property values for flexible grouping (e.g., org_id -> \"org123\")",
+    ),
     reporting_unit: ReportingUnit$zodSchema.optional(),
     source: z.string().optional(),
-    sources: z.array(z.string()).optional(),
-    sub_line_item_id: z.string().optional(),
-    subscription_id: z.string().optional(),
+    sources: z.array(z.string()).optional().describe(
+      "List of sources when not grouping by source",
+    ),
+    sub_line_item_id: z.string().optional().describe(
+      "Subscription line item ID",
+    ),
+    subscription_id: z.string().optional().describe("Subscription ID"),
     subscription_line_item: SubscriptionSubscriptionLineItem$zodSchema
       .optional(),
     total_cost: z.string().optional(),
     total_usage: z.string().optional(),
-    total_usage_display: z.string().optional(),
+    total_usage_display: z.string().optional().describe(
+      "Empty string when feature has no reporting unit; otherwise the value in reporting units",
+    ),
     unit: z.string().optional(),
     unit_plural: z.string().optional(),
     window_size: WindowSize$zodSchema.optional(),

package/src/models/dtousageanalyticpoint.ts

@@ -16,11 +16,15 @@ export type DtoUsageAnalyticPoint = {
 
 export const DtoUsageAnalyticPoint$zodSchema: z.ZodType<DtoUsageAnalyticPoint> =
   z.object({
-    computed_commitment_utilized_amount: z.string().optional(),
+    computed_commitment_utilized_amount: z.string().optional().describe(
+      "Commitment breakdown (only populated for windowed commitments)",
+    ),
     computed_overage_amount: z.string().optional(),
     computed_true_up_amount: z.string().optional(),
     cost: z.string().optional(),
-    event_count: z.int().optional(),
+    event_count: z.int().optional().describe(
+      "Number of events in this time window",
+    ),
     timestamp: z.string().optional(),
     usage: z.string().optional(),
   });