@openmeter/client 1.0.0-beta-c16cbe1e4650 → 1.0.0-beta-d30d21dce71a

package/dist/models/schemas.js

@@ -417,9 +417,9 @@ export const creditTransactionType = z
 export const chargesExpand = z
     .enum(['real_time_usage'])
     .describe("Expands for customer charges. Values: - `real_time_usage`: The charge's real-time usage.");
-export const resourceManagedBy = z
-    .enum(['manual', 'system', 'subscription'])
-    .describe('Identifies which system manages a resource. Values: - `manual`: The resource is managed manually (overridden by our API users). - `system`: The resource is managed by the system. - `subscription`: The resource is managed by the subscription.');
+export const lifecycleController = z
+    .enum(['system', 'manual'])
+    .describe('Identifies whether a resource lifecycle is controlled by OpenMeter or manually overridden by the API user. Values: - `system`: The resource lifecycle is controlled by OpenMeter. - `manual`: The resource lifecycle was manually overridden by the API user.');
 export const chargeStatus = z
     .enum(['created', 'active', 'final', 'deleted'])
     .describe('Lifecycle status of a charge. Values: - `created`: The charge has been created but is not active yet. - `active`: The charge is active. - `final`: The charge is fully finalized and no further changes are expected. - `deleted`: The charge has been deleted.');
@@ -445,7 +445,7 @@ export const taxConfigExternalInvoicing = z
 export const pricePaymentTerm = z
     .union([z.literal('in_advance'), z.literal('in_arrears')])
     .describe('The payment term of a flat price.');
-export const flatFeeDiscounts = z
+export const chargeFlatFeeDiscounts = z
     .object({
     percentage: z
         .number()
@@ -507,6 +507,73 @@ export const workflowPaymentSendInvoiceSettings = z
         .describe("The period after which the invoice is due. With some payment solutions it's only applicable for manual collection method."),
 })
     .describe('Payment settings for a billing workflow when the collection method is send invoice.');
+export const invoiceNumber = z
+    .string()
+    .min(1)
+    .max(256)
+    .describe('InvoiceNumber is a unique identifier for the invoice, generated by the invoicing app. The uniqueness depends on a lot of factors: - app setting (unique per app or unique per customer) - multiple app scenarios (multiple apps generating invoices with the same prefix)');
+export const invoiceValidationIssueSeverity = z
+    .enum(['critical', 'warning'])
+    .describe('Severity level of an invoice validation issue.');
+export const invoiceExternalReferences = z
+    .object({
+    invoicing_id: z
+        .string()
+        .optional()
+        .describe('The ID assigned by the external invoicing app (e.g. Stripe invoice ID).'),
+    payment_id: z
+        .string()
+        .optional()
+        .describe('The ID assigned by the external payment app (e.g. Stripe payment intent ID).'),
+})
+    .describe('External identifiers assigned to an invoice by third-party systems.');
+export const invoiceStandardStatus = z
+    .enum([
+    'draft',
+    'issuing',
+    'issued',
+    'payment_processing',
+    'overdue',
+    'paid',
+    'uncollectible',
+    'voided',
+])
+    .describe('Lifecycle status of a standard invoice.');
+export const invoiceAvailableActionDetails = z
+    .object({
+    resulting_state: z
+        .string()
+        .describe('The extended status the invoice will transition to after performing this action.'),
+})
+    .describe('Details about an available invoice action including the resulting state.');
+export const invoiceWorkflowInvoicingSettings = z
+    .object({
+    auto_advance: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('Whether to automatically issue the invoice after the draft_period has passed.'),
+    draft_period: z
+        .string()
+        .optional()
+        .default('P0D')
+        .describe('The period for the invoice to be kept in draft status for manual reviews.'),
+})
+    .describe('Invoice-level invoicing settings. A subset of BillingWorkflowInvoicingSettings limited to fields that are meaningful per-invoice. progressive_billing is omitted as it is a gather-time / profile-level decision.');
+export const invoiceDiscountReason = z
+    .enum(['maximum_spend', 'ratecard_percentage', 'ratecard_usage'])
+    .describe('The reason a discount was applied to an invoice line.');
+export const invoiceLineExternalReferences = z
+    .object({
+    invoicing_id: z
+        .string()
+        .optional()
+        .describe('The ID assigned by the external invoicing app.'),
+})
+    .describe('External identifiers for an invoice line item assigned by third-party systems.');
+export const invoiceDetailedLineCostCategory = z
+    .enum(['regular', 'commitment'])
+    .describe('Cost category of a detailed invoice line item.');
 export const currencyType = z
     .enum(['fiat', 'custom'])
     .describe('Currency type for custom currencies. It should be a unique code but not conflicting with any existing standard currency codes.');
@@ -792,20 +859,21 @@ export const numericFieldFilter = z
 export const chargeType = z
     .enum(['flat_fee', 'usage_based'])
     .describe('Type of a charge. Values: - `flat_fee`: A fixed-amount charge. - `usage_based`: A usage-priced charge.');
-export const invoiceNumber = z
-    .string()
-    .min(1)
-    .max(256)
-    .describe('InvoiceNumber is a unique identifier for the invoice, generated by the invoicing app. The uniqueness depends on a lot of factors: - app setting (unique per app or unique per customer) - multiple app scenarios (multiple apps generating invoices with the same prefix)');
+export const invoiceType = z
+    .enum(['standard'])
+    .describe('The type of a billing invoice.');
+export const invoiceLineType = z
+    .enum(['standard_line'])
+    .describe('Line item type discriminator.');
+export const priceType = z
+    .enum(['free', 'flat', 'unit', 'graduated', 'volume'])
+    .describe("The type of the price. - `free`: No charge, the rate card is included at no cost. - `flat`: A fixed amount charged once per billing period, regardless of usage. - `unit`: A fixed rate charged per billing unit consumed. - `graduated`: Tiered pricing where each tier's rate applies only to usage within that tier. - `volume`: Tiered pricing where the rate for the highest tier reached applies to all units in the period.");
 export const collectionAlignment = z
     .enum(['subscription', 'anchored'])
     .describe('BillingCollectionAlignment specifies when the pending line items should be collected into an invoice.');
 export const collectionMethod = z
     .enum(['charge_automatically', 'send_invoice'])
     .describe('Collection method specifies how the invoice should be collected (automatic or manual).');
-export const priceType = z
-    .enum(['free', 'flat', 'unit', 'graduated', 'volume'])
-    .describe("The type of the price. - `free`: No charge, the rate card is included at no cost. - `flat`: A fixed amount charged once per billing period, regardless of usage. - `unit`: A fixed rate charged per billing unit consumed. - `graduated`: Tiered pricing where each tier's rate applies only to usage within that tier. - `volume`: Tiered pricing where the rate for the highest tier reached applies to all units in the period.");
 export const featureUnitCostType = z
     .enum(['llm', 'manual'])
     .describe('The type of unit cost.');
@@ -914,6 +982,15 @@ export const totals = z
     total: numeric,
 })
     .describe('Totals contains the summaries of all calculations for a billing resource.');
+export const invoiceLineCreditsApplied = z
+    .object({
+    amount: numeric,
+    description: z
+        .string()
+        .optional()
+        .describe('Optional human-readable description of the credit allocation.'),
+})
+    .describe('A credit allocation applied to an invoice line item.');
 export const featureManualUnitCost = z
     .object({
     type: z
@@ -1067,6 +1144,11 @@ export const appReference = z
     id: ulid,
 })
     .describe('App reference.');
+export const chargeReference = z
+    .object({
+    id: ulid,
+})
+    .describe('Reference to a charge associated with an invoice line.');
 export const currencyFiat = z
     .object({
     id: ulid,
@@ -1562,17 +1644,6 @@ export const customerUsageAttribution = z
         .describe('The subjects that are attributed to the customer. Can be empty when no usage event subjects are associated with the customer.'),
 })
     .describe('Mapping to attribute metered usage to the customer. One customer can have zero or more subjects, but one subject can only belong to one customer.');
-export const billingAddress = z
-    .object({
-    country: countryCode.optional(),
-    postal_code: z.string().optional().describe('Postal code.'),
-    state: z.string().optional().describe('State or province.'),
-    city: z.string().optional().describe('City.'),
-    line1: z.string().optional().describe('First line of the address.'),
-    line2: z.string().optional().describe('Second line of the address.'),
-    phone_number: z.string().optional().describe('Phone number.'),
-})
-    .describe('Address');
 export const address = z
     .object({
     country: countryCode.optional(),
@@ -1848,6 +1919,65 @@ export const workflowPaymentSettings = z
     workflowPaymentSendInvoiceSettings,
 ])
     .describe('Payment settings for a billing workflow.');
+export const invoiceValidationIssue = z
+    .object({
+    code: z.string().describe('Machine-readable error code.'),
+    message: z.string().describe('Human-readable description of the error.'),
+    attributes: z
+        .record(z.string(), z.unknown())
+        .optional()
+        .describe('Additional structured context.'),
+    severity: invoiceValidationIssueSeverity,
+    field: z
+        .string()
+        .optional()
+        .describe('JSON path to the field that caused this validation issue, if applicable. For example: `lines/0/rate_card/price`.'),
+})
+    .describe('A validation issue found during invoice processing. Converges on the same structure used by plan and subscription validation errors: a machine-readable `code`, a human-readable `message`, optional structured `attributes`, plus a `severity` and optional `field` path.');
+export const invoiceAvailableActions = z
+    .object({
+    advance: invoiceAvailableActionDetails.optional(),
+    approve: invoiceAvailableActionDetails.optional(),
+    delete: invoiceAvailableActionDetails.optional(),
+    retry: invoiceAvailableActionDetails.optional(),
+    snapshot_quantities: invoiceAvailableActionDetails.optional(),
+})
+    .describe('The set of state-transition actions available for an invoice in its current status. A field is present only when that action is permitted from the current state.');
+export const invoiceLineAmountDiscount = z
+    .object({
+    id: ulid,
+    reason: invoiceDiscountReason,
+    description: z
+        .string()
+        .optional()
+        .describe('Optional human-readable description of the discount.'),
+    external_references: invoiceLineExternalReferences.optional(),
+    amount: numeric,
+})
+    .describe('A monetary amount discount applied to an invoice line item.');
+export const invoiceLineUsageDiscount = z
+    .object({
+    id: ulid,
+    reason: invoiceDiscountReason,
+    description: z
+        .string()
+        .optional()
+        .describe('Optional human-readable description of the discount.'),
+    external_references: invoiceLineExternalReferences.optional(),
+    quantity: numeric,
+})
+    .describe('A usage quantity discount applied to an invoice line item.');
+export const invoiceLineBaseDiscount = z
+    .object({
+    id: ulid,
+    reason: invoiceDiscountReason,
+    description: z
+        .string()
+        .optional()
+        .describe('Optional human-readable description of the discount.'),
+    external_references: invoiceLineExternalReferences.optional(),
+})
+    .describe('Base fields shared by all invoice line item discounts.');
 export const listCurrenciesParamsFilter = z
     .object({
     type: currencyType.optional(),
@@ -2270,6 +2400,13 @@ export const profileAppReferences = z
     payment: appReference,
 })
     .describe('References to the applications used by a billing profile.');
+export const invoiceWorkflowAppsReferences = z
+    .object({
+    tax: appReference,
+    invoicing: appReference,
+    payment: appReference,
+})
+    .describe('BillingInvoiceWorkflowAppsReferences represents the references (id) to the apps used by a billing profile');
 export const listEventsParamsFilter = z
     .object({
     id: stringFieldFilter.optional(),
@@ -2389,7 +2526,7 @@ export const createCustomerRequest = z
         .optional()
         .describe('The primary email address of the customer.'),
     currency: currencyCode.optional(),
-    billing_address: billingAddress.optional(),
+    billing_address: address.optional(),
 })
     .describe('Customer create request.');
 export const customer = z
@@ -2416,7 +2553,7 @@ export const customer = z
         .optional()
         .describe('The primary email address of the customer.'),
     currency: currencyCode.optional(),
-    billing_address: billingAddress.optional(),
+    billing_address: address.optional(),
 })
     .describe('Customers can be individuals or organizations that can subscribe to plans and have access to features.');
 export const upsertCustomerRequest = z
@@ -2438,7 +2575,7 @@ export const upsertCustomerRequest = z
         .optional()
         .describe('The primary email address of the customer.'),
     currency: currencyCode.optional(),
-    billing_address: billingAddress.optional(),
+    billing_address: address.optional(),
 })
     .describe('Customer upsert request.');
 export const partyAddresses = z
@@ -2446,6 +2583,19 @@ export const partyAddresses = z
     billing_address: address,
 })
     .describe('A collection of addresses for the party.');
+export const invoiceCustomer = z
+    .object({
+    id: ulid,
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('Display name of the resource. Between 1 and 256 characters.'),
+    usage_attribution: customerUsageAttribution.optional(),
+    billing_address: address.optional(),
+    key: externalResourceKey.optional(),
+})
+    .describe("Snapshot of the customer's information at the time the invoice was issued.");
 export const appStripeCreateCheckoutSessionConsentCollection = z
     .object({
     payment_method_reuse_agreement: appStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement.optional(),
@@ -2660,6 +2810,36 @@ export const upsertTaxCodeRequest = z
         .describe('Mapping of app types to tax codes.'),
 })
     .describe('TaxCode upsert request.');
+export const invoiceWorkflow = z
+    .object({
+    invoicing: invoiceWorkflowInvoicingSettings.optional(),
+    payment: workflowPaymentSettings.optional(),
+})
+    .describe('Invoice-level snapshot of the workflow configuration. Contains only the settings that are meaningful for an already-created invoice: invoicing behaviour and payment settings. Collection alignment and tax policy are gather-time / profile-wide concerns and are not included.');
+export const invoiceStatusDetails = z
+    .object({
+    immutable: z
+        .boolean()
+        .describe('Whether the invoice is immutable (i.e. cannot be modified or deleted).'),
+    failed: z.boolean().describe('Whether the invoice is in a failed state.'),
+    extended_status: z
+        .string()
+        .describe('Fine-grained internal status string providing additional workflow detail beyond the top-level status enum.'),
+    available_actions: invoiceAvailableActions,
+})
+    .describe('Detailed status information for a standard invoice.');
+export const invoiceLineDiscounts = z
+    .object({
+    amount: z
+        .array(invoiceLineAmountDiscount)
+        .optional()
+        .describe('Monetary amount discounts (e.g. from maximum spend commitments).'),
+    usage: z
+        .array(invoiceLineUsageDiscount)
+        .optional()
+        .describe('Usage quantity discounts (e.g. free tier usage allowances).'),
+})
+    .describe('Discounts applied to an invoice line item.');
 export const currency = z
     .discriminatedUnion('type', [currencyFiat, currencyCustom])
     .describe('Fiat or custom currency.');
@@ -2802,7 +2982,7 @@ export const creditGrant = z
     status: creditGrantStatus,
 })
     .describe('A credit grant allocates credits to a customer. Credits are drawn down against charges according to the settlement mode configured on the rate card.');
-export const createFlatFeeChargeRequest = z
+export const createChargeFlatFeeRequest = z
     .object({
     name: z
         .string()
@@ -2826,7 +3006,7 @@ export const createFlatFeeChargeRequest = z
     settlement_mode: settlementMode,
     tax_config: taxConfig.optional(),
     payment_term: pricePaymentTerm,
-    discounts: flatFeeDiscounts.optional(),
+    discounts: chargeFlatFeeDiscounts.optional(),
     feature_key: z
         .string()
         .optional()
@@ -2910,6 +3090,17 @@ export const party = z
     addresses: partyAddresses.optional(),
 })
     .describe('Party represents a person or business entity.');
+export const supplier = z
+    .object({
+    id: z.string().optional().describe('Unique identifier for the party.'),
+    name: z
+        .string()
+        .optional()
+        .describe('Legal name or representation of the party.'),
+    tax_id: partyTaxIdentity.optional(),
+    addresses: partyAddresses.optional(),
+})
+    .describe("Snapshot of the supplier's information at the time the invoice was issued. Structurally a read-only subset of `BillingParty` (the type configured on the billing profile), so the snapshot stays aligned with the source. `key` is omitted because it is not part of the snapshotted supplier data.");
 export const appStripeCreateCheckoutSessionRequestOptions = z
     .object({
     billing_address_collection: appStripeCreateCheckoutSessionBillingAddressCollection
@@ -2973,6 +3164,43 @@ export const taxCodePagePaginatedResponse = z
     meta: paginatedMeta,
 })
     .describe('Page paginated response.');
+export const invoiceWorkflowSettings = z
+    .object({
+    apps: invoiceWorkflowAppsReferences.optional(),
+    source_billing_profile: profileReference,
+    workflow: invoiceWorkflow,
+})
+    .describe('Snapshot of the billing workflow configuration captured at invoice creation.');
+export const invoiceDetailedLine = z
+    .object({
+    id: ulid,
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('Display name of the resource. Between 1 and 256 characters.'),
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    labels: labels.optional(),
+    created_at: dateTime,
+    updated_at: dateTime,
+    deleted_at: dateTime.optional(),
+    service_period: closedPeriod,
+    totals: totals,
+    category: invoiceDetailedLineCostCategory.default('regular'),
+    discounts: invoiceLineDiscounts.optional(),
+    credits_applied: z
+        .array(invoiceLineCreditsApplied)
+        .optional()
+        .describe('Credit applied to this detailed line.'),
+    external_references: invoiceLineExternalReferences.optional(),
+    quantity: numeric,
+    unit_price: numeric,
+})
+    .describe('A detailed (child) sub-line belonging to a parent invoice line. Detailed lines represent the individual flat-fee components that make up a usage-based parent line after quantity snapshotting.');
 export const currencyPagePaginatedResponse = z
     .object({
     data: z.array(currency),
@@ -3062,6 +3290,31 @@ export const badRequest = z
     invalid_parameters: invalidParameters,
 }))
     .describe('Bad Request.');
+export const invoiceBase = z
+    .object({
+    id: ulid,
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    labels: labels.optional(),
+    created_at: dateTime,
+    updated_at: dateTime,
+    deleted_at: dateTime.optional(),
+    number: invoiceNumber,
+    currency: currencyCode,
+    supplier: supplier,
+    customer: invoiceCustomer,
+    totals: totals,
+    service_period: closedPeriod,
+    validation_issues: z
+        .array(invoiceValidationIssue)
+        .optional()
+        .describe('Validation issues found during invoice processing. Present only when there are one or more validation findings. An empty list is omitted.'),
+    external_references: invoiceExternalReferences.optional(),
+})
+    .describe('Base fields shared by all invoice types. Spread this model into each concrete invoice variant.');
 export const customerStripeCreateCheckoutSessionRequest = z
     .object({
     stripe_options: appStripeCreateCheckoutSessionRequestOptions,
@@ -3103,7 +3356,7 @@ export const governanceQueryResponse = z
     meta: cursorMeta,
 })
     .describe('Response of the governance query.');
-export const flatFeeCharge = z
+export const chargeFlatFee = z
     .object({
     id: ulid,
     name: z
@@ -3122,7 +3375,7 @@ export const flatFeeCharge = z
     deleted_at: dateTime.optional(),
     type: z.literal('flat_fee').describe('The type of the charge.'),
     customer: billingCustomerReference,
-    managed_by: resourceManagedBy,
+    lifecycle_controller: lifecycleController,
     subscription: subscriptionReference.optional(),
     currency: currencyCode,
     status: chargeStatus,
@@ -3138,7 +3391,7 @@ export const flatFeeCharge = z
     settlement_mode: settlementMode,
     tax_config: taxConfig.optional(),
     payment_term: pricePaymentTerm,
-    discounts: flatFeeDiscounts.optional(),
+    discounts: chargeFlatFeeDiscounts.optional(),
     feature_key: z
         .string()
         .optional()
@@ -3149,7 +3402,7 @@ export const flatFeeCharge = z
     price: price,
 })
     .describe('A flat fee charge for a customer.');
-export const usageBasedCharge = z
+export const chargeUsageBased = z
     .object({
     id: ulid,
     name: z
@@ -3168,7 +3421,7 @@ export const usageBasedCharge = z
     deleted_at: dateTime.optional(),
     type: z.literal('usage_based').describe('The type of the charge.'),
     customer: billingCustomerReference,
-    managed_by: resourceManagedBy,
+    lifecycle_controller: lifecycleController,
     subscription: subscriptionReference.optional(),
     currency: currencyCode,
     status: chargeStatus,
@@ -3189,7 +3442,7 @@ export const usageBasedCharge = z
     price: price,
 })
     .describe('A usage-based charge for a customer.');
-export const createUsageBasedChargeRequest = z
+export const createChargeUsageBasedRequest = z
     .object({
     name: z
         .string()
@@ -3219,6 +3472,14 @@ export const createUsageBasedChargeRequest = z
     billing_period: closedPeriod.optional(),
 })
     .describe('Usage-based charge create request.');
+export const invoiceLineRateCard = z
+    .object({
+    price: price,
+    tax_config: rateCardTaxConfig.optional(),
+    feature_key: resourceKey.optional(),
+    discounts: rateCardDiscounts.optional(),
+})
+    .describe('Rate card configuration snapshot for a usage-based invoice line.');
 export const rateCard = z
     .object({
     name: z
@@ -3259,14 +3520,51 @@ export const workflow = z
 })
     .describe('Billing workflow settings.');
 export const charge = z
-    .discriminatedUnion('type', [flatFeeCharge, usageBasedCharge])
+    .discriminatedUnion('type', [chargeFlatFee, chargeUsageBased])
     .describe('Customer charge.');
 export const createChargeRequest = z
     .discriminatedUnion('type', [
-    createFlatFeeChargeRequest,
-    createUsageBasedChargeRequest,
+    createChargeFlatFeeRequest,
+    createChargeUsageBasedRequest,
 ])
     .describe('Customer charge.');
+export const invoiceStandardLine = z
+    .object({
+    id: ulid,
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('Display name of the resource. Between 1 and 256 characters.'),
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    labels: labels.optional(),
+    created_at: dateTime,
+    updated_at: dateTime,
+    deleted_at: dateTime.optional(),
+    type: z
+        .literal('standard_line')
+        .describe('The type of charge this line item represents.'),
+    lifecycle_controller: lifecycleController,
+    service_period: closedPeriod,
+    totals: totals,
+    discounts: invoiceLineDiscounts.optional(),
+    credits_applied: z
+        .array(invoiceLineCreditsApplied)
+        .optional()
+        .describe('Credit applied to this line item.'),
+    external_references: invoiceLineExternalReferences.optional(),
+    subscription: subscriptionReference.optional(),
+    rate_card: invoiceLineRateCard,
+    detailed_lines: z
+        .array(invoiceDetailedLine)
+        .describe('Detailed sub-lines that this line has been broken down into. Present when line has individual details.'),
+    charge: chargeReference.optional(),
+})
+    .describe('A top-level line item on an invoice. Each line represents a single charge, typically associated with a rate card from a subscription. Detailed (child) lines are nested under `detailed_lines` when present.');
 export const planPhase = z
     .object({
     name: z
@@ -3423,6 +3721,9 @@ export const chargePagePaginatedResponse = z
     meta: paginatedMeta,
 })
     .describe('Page paginated response.');
+export const invoiceLine = z
+    .discriminatedUnion('type', [invoiceStandardLine])
+    .describe('A top-level line item on an invoice. Each line represents a single charge, typically associated with a rate card from a subscription. Detailed (child) lines are nested under `detailed_lines` when present.');
 export const plan = z
     .object({
     id: ulid,
@@ -3531,12 +3832,56 @@ export const profilePagePaginatedResponse = z
     meta: paginatedMeta,
 })
     .describe('Page paginated response.');
+export const invoiceStandard = z
+    .object({
+    id: ulid,
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    labels: labels.optional(),
+    created_at: dateTime,
+    updated_at: dateTime,
+    deleted_at: dateTime.optional(),
+    number: invoiceNumber,
+    currency: currencyCode,
+    supplier: supplier,
+    customer: invoiceCustomer,
+    totals: totals,
+    service_period: closedPeriod,
+    validation_issues: z
+        .array(invoiceValidationIssue)
+        .optional()
+        .describe('Validation issues found during invoice processing. Present only when there are one or more validation findings. An empty list is omitted.'),
+    external_references: invoiceExternalReferences.optional(),
+    type: z
+        .literal('standard')
+        .describe('Discriminator field identifying this as a standard invoice.'),
+    status: invoiceStandardStatus,
+    status_details: invoiceStatusDetails,
+    issued_at: dateTime.optional(),
+    draft_until: dateTime.optional(),
+    quantity_snapshotted_at: dateTime.optional(),
+    collection_at: dateTime.optional(),
+    due_at: dateTime.optional(),
+    sent_to_customer_at: dateTime.optional(),
+    workflow: invoiceWorkflowSettings,
+    lines: z
+        .array(invoiceLine)
+        .optional()
+        .describe('Line items on this invoice. Always returned on single-resource GET; omitted on list endpoints unless explicitly expanded.'),
+})
+    .describe('A standard invoice for charges owed by the customer.');
 export const planPagePaginatedResponse = z
     .object({
     data: z.array(plan),
     meta: paginatedMeta,
 })
     .describe('Page paginated response.');
+export const invoice = z
+    .discriminatedUnion('type', [invoiceStandard])
+    .describe('An invoice issued to a customer. The `type` field determines the concrete variant: - `standard`: a standard invoice for charges owed.');
 export const listMeteringEventsQueryParams = z.object({
     page: cursorPaginationQueryPage.optional(),
     filter: listEventsParamsFilter.optional(),
@@ -3859,6 +4204,10 @@ export const updateBillingProfileResponse = profile;
 export const deleteBillingProfilePathParams = z.object({
     id: ulid,
 });
+export const getInvoicePathParams = z.object({
+    invoiceId: ulid,
+});
+export const getInvoiceResponse = invoice;
 export const createTaxCodeBody = createTaxCodeRequest;
 export const createTaxCodeResponse = taxCode;
 export const getTaxCodePathParams = z.object({