@openmeter/client 1.0.0-beta-fd561cd8ec89 → 1.0.0-beta-622df7843cd1

package/dist/models/schemas.js

@@ -397,6 +397,9 @@ export const creditPurchasePaymentSettlementStatus = z
 export const creditGrantStatus = z
     .enum(['pending', 'active', 'expired', 'voided'])
     .describe('Credit grant lifecycle status. - `pending`: The credit block has been created but is not yet valid. (`effective_at` is in the future or availability_policy is not met) - `active`: The credit block is currently valid and eligible for consumption. (`effective_at` is in the past, `expires_at` is in the future and availability_policy is met) - `expired`: The credit block expired with remaining unused balance, `expires_at` time has passed. - `voided`: The credit block was voided. Remaining balance is forfeited.');
+export const validationIssueSeverity = z
+    .enum(['critical', 'warning'])
+    .describe('Severity level of a billing validation issue.');
 export const stringFieldFilterExact = z
     .union([
     z.string(),
@@ -506,9 +509,6 @@ export const taxIdentificationCode = z
     .min(1)
     .max(32)
     .describe('Tax identifier code is a normalized tax code shown on the original identity document.');
-export const invoiceValidationIssueSeverity = z
-    .enum(['critical', 'warning'])
-    .describe('Severity level of an invoice validation issue.');
 export const invoiceExternalReferences = z
     .object({
     invoicingId: z
@@ -2203,6 +2203,25 @@ export const listCreditGrantsParamsFilter = z
     key: stringFieldFilter.optional(),
 })
     .describe('Filter options for listing credit grants.');
+export const validationIssue = 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: validationIssueSeverity,
+    field: z
+        .string()
+        .optional()
+        .describe('JSON path to the field that caused the validation issue, if applicable.'),
+    component: z
+        .string()
+        .optional()
+        .describe('Component that reported the validation issue, if applicable.'),
+})
+    .describe('A validation issue found while processing a billing resource.');
 export const getCreditBalanceParamsFilter = z
     .object({
     currency: stringFieldFilterExact.optional(),
@@ -2262,21 +2281,6 @@ export const updateBillingPartyTaxIdentity = z
     code: taxIdentificationCode.optional(),
 })
     .describe('Identity stores the details required to identify an entity for tax purposes in a specific country.');
-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(),
@@ -2534,6 +2538,7 @@ export const creditAdjustment = z
 export const creditBalance = z
     .object({
     currency: billingCurrencyCode,
+    customCurrencyId: ulid.optional(),
     live: numeric,
     settled: numeric,
     pending: numeric,
@@ -2581,6 +2586,7 @@ export const creditTransaction = z
     bookedAt: dateTime,
     type: creditTransactionType,
     currency: billingCurrencyCode,
+    customCurrencyId: ulid.optional(),
     amount: numeric,
     availableBalance: z
         .object({
@@ -4008,6 +4014,10 @@ export const creditGrant = z
     expiresAt: dateTime.optional(),
     voidedAt: dateTime.optional(),
     status: creditGrantStatus,
+    validationIssues: z
+        .array(validationIssue)
+        .optional()
+        .describe('Validation issues found while processing the credit grant. Present only when there are one or more validation findings. An empty list is omitted.'),
 })
     .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 currencyPagePaginatedResponse = z
@@ -4040,7 +4050,7 @@ export const invoiceBase = z
     totals: totals,
     servicePeriod: closedPeriod,
     validationIssues: z
-        .array(invoiceValidationIssue)
+        .array(validationIssue)
         .optional()
         .describe('Validation issues found during invoice processing. Present only when there are one or more validation findings. An empty list is omitted.'),
     externalReferences: invoiceExternalReferences.optional(),
@@ -4081,7 +4091,7 @@ export const chargeRealizationInvoice = z
     totals: totals,
     servicePeriod: closedPeriod,
     validationIssues: z
-        .array(invoiceValidationIssue)
+        .array(validationIssue)
         .optional()
         .describe('Validation issues found during invoice processing. Present only when there are one or more validation findings. An empty list is omitted.'),
     externalReferences: invoiceExternalReferences.optional(),
@@ -4861,7 +4871,7 @@ export const invoiceStandard = z
     totals: totals,
     servicePeriod: closedPeriod,
     validationIssues: z
-        .array(invoiceValidationIssue)
+        .array(validationIssue)
         .optional()
         .describe('Validation issues found during invoice processing. Present only when there are one or more validation findings. An empty list is omitted.'),
     externalReferences: invoiceExternalReferences.optional(),
@@ -4948,6 +4958,10 @@ export const chargeFlatFee = z
     currency: billingCurrencyCode,
     resolvedCostBasis: chargeResolvedCostBasis.optional(),
     status: chargeStatus,
+    validationIssues: z
+        .array(validationIssue)
+        .optional()
+        .describe('Validation issues found while processing the charge. Present only when there are one or more validation findings. An empty list is omitted.'),
     invoiceAt: dateTime,
     servicePeriod: closedPeriod,
     fullServicePeriod: closedPeriod,
@@ -4995,6 +5009,10 @@ export const chargeUsageBased = z
     currency: billingCurrencyCode,
     resolvedCostBasis: chargeResolvedCostBasis.optional(),
     status: chargeStatus,
+    validationIssues: z
+        .array(validationIssue)
+        .optional()
+        .describe('Validation issues found while processing the charge. Present only when there are one or more validation findings. An empty list is omitted.'),
     invoiceAt: dateTime,
     servicePeriod: closedPeriod,
     fullServicePeriod: closedPeriod,
@@ -6153,6 +6171,9 @@ export const creditPurchasePaymentSettlementStatusWire = z
 export const creditGrantStatusWire = z
     .enum(['pending', 'active', 'expired', 'voided'])
     .describe('Credit grant lifecycle status. - `pending`: The credit block has been created but is not yet valid. (`effective_at` is in the future or availability_policy is not met) - `active`: The credit block is currently valid and eligible for consumption. (`effective_at` is in the past, `expires_at` is in the future and availability_policy is met) - `expired`: The credit block expired with remaining unused balance, `expires_at` time has passed. - `voided`: The credit block was voided. Remaining balance is forfeited.');
+export const validationIssueSeverityWire = z
+    .enum(['critical', 'warning'])
+    .describe('Severity level of a billing validation issue.');
 export const stringFieldFilterExactWire = z
     .union([
     z.string(),
@@ -6262,9 +6283,6 @@ export const taxIdentificationCodeWire = z
     .min(1)
     .max(32)
     .describe('Tax identifier code is a normalized tax code shown on the original identity document.');
-export const invoiceValidationIssueSeverityWire = z
-    .enum(['critical', 'warning'])
-    .describe('Severity level of an invoice validation issue.');
 export const invoiceExternalReferencesWire = z
     .strictObject({
     invoicing_id: z
@@ -7942,6 +7960,25 @@ export const listCreditGrantsParamsFilterWire = z
     key: stringFieldFilterWire.optional(),
 })
     .describe('Filter options for listing credit grants.');
+export const validationIssueWire = z
+    .strictObject({
+    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: validationIssueSeverityWire,
+    field: z
+        .string()
+        .optional()
+        .describe('JSON path to the field that caused the validation issue, if applicable.'),
+    component: z
+        .string()
+        .optional()
+        .describe('Component that reported the validation issue, if applicable.'),
+})
+    .describe('A validation issue found while processing a billing resource.');
 export const getCreditBalanceParamsFilterWire = z
     .strictObject({
     currency: stringFieldFilterExactWire.optional(),
@@ -7998,21 +8035,6 @@ export const updateBillingPartyTaxIdentityWire = z
     code: taxIdentificationCodeWire.optional(),
 })
     .describe('Identity stores the details required to identify an entity for tax purposes in a specific country.');
-export const invoiceValidationIssueWire = z
-    .strictObject({
-    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: invoiceValidationIssueSeverityWire,
-    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 invoiceAvailableActionsWire = z
     .strictObject({
     advance: invoiceAvailableActionDetailsWire.optional(),
@@ -8264,6 +8286,7 @@ export const creditAdjustmentWire = z
 export const creditBalanceWire = z
     .strictObject({
     currency: billingCurrencyCodeWire,
+    custom_currency_id: ulidWire.optional(),
     live: numericWire,
     settled: numericWire,
     pending: numericWire,
@@ -8311,6 +8334,7 @@ export const creditTransactionWire = z
     booked_at: dateTimeWire,
     type: creditTransactionTypeWire,
     currency: billingCurrencyCodeWire,
+    custom_currency_id: ulidWire.optional(),
     amount: numericWire,
     available_balance: z
         .strictObject({
@@ -9738,6 +9762,10 @@ export const creditGrantWire = z
     expires_at: dateTimeWire.optional(),
     voided_at: dateTimeWire.optional(),
     status: creditGrantStatusWire,
+    validation_issues: z
+        .array(validationIssueWire)
+        .optional()
+        .describe('Validation issues found while processing the credit grant. Present only when there are one or more validation findings. An empty list is omitted.'),
 })
     .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 currencyPagePaginatedResponseWire = z
@@ -9770,7 +9798,7 @@ export const invoiceBaseWire = z
     totals: totalsWire,
     service_period: closedPeriodWire,
     validation_issues: z
-        .array(invoiceValidationIssueWire)
+        .array(validationIssueWire)
         .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: invoiceExternalReferencesWire.optional(),
@@ -9808,7 +9836,7 @@ export const chargeRealizationInvoiceWire = z
     totals: totalsWire,
     service_period: closedPeriodWire,
     validation_issues: z
-        .array(invoiceValidationIssueWire)
+        .array(validationIssueWire)
         .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: invoiceExternalReferencesWire.optional(),
@@ -10586,7 +10614,7 @@ export const invoiceStandardWire = z
     totals: totalsWire,
     service_period: closedPeriodWire,
     validation_issues: z
-        .array(invoiceValidationIssueWire)
+        .array(validationIssueWire)
         .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: invoiceExternalReferencesWire.optional(),
@@ -10673,6 +10701,10 @@ export const chargeFlatFeeWire = z
     currency: billingCurrencyCodeWire,
     resolved_cost_basis: chargeResolvedCostBasisWire.optional(),
     status: chargeStatusWire,
+    validation_issues: z
+        .array(validationIssueWire)
+        .optional()
+        .describe('Validation issues found while processing the charge. Present only when there are one or more validation findings. An empty list is omitted.'),
     invoice_at: dateTimeWire,
     service_period: closedPeriodWire,
     full_service_period: closedPeriodWire,
@@ -10720,6 +10752,10 @@ export const chargeUsageBasedWire = z
     currency: billingCurrencyCodeWire,
     resolved_cost_basis: chargeResolvedCostBasisWire.optional(),
     status: chargeStatusWire,
+    validation_issues: z
+        .array(validationIssueWire)
+        .optional()
+        .describe('Validation issues found while processing the charge. Present only when there are one or more validation findings. An empty list is omitted.'),
     invoice_at: dateTimeWire,
     service_period: closedPeriodWire,
     full_service_period: closedPeriodWire,

package/dist/models/types.d.ts

@@ -1854,9 +1854,27 @@ export interface ListCreditGrantsParamsFilter {
     /** Filter credit grants by key. */
     key?: StringFieldFilter;
 }
+/** A validation issue found while processing a billing resource. */
+export interface ValidationIssue {
+    /** Machine-readable error code. */
+    code: string;
+    /** Human-readable description of the error. */
+    message: string;
+    /** Additional structured context. */
+    attributes?: Record<string, unknown>;
+    /** Severity of the validation issue. */
+    severity: 'critical' | 'warning';
+    /** JSON path to the field that caused the validation issue, if applicable. */
+    field?: string;
+    /** Component that reported the validation issue, if applicable. */
+    component?: string;
+}
 /** Filter options for getting a credit balance. */
 export interface GetCreditBalanceParamsFilter {
-    /** Filter credit balance by currency. */
+    /**
+     * Filter credit balance by currency code. When historical custom currencies reuse
+     * a code, each managed currency is returned as a separate balance row.
+     */
     currency?: StringFieldFilterExact;
     /**
      * Filter credit balance by feature key. Omit to return the total portfolio value.
@@ -1968,29 +1986,6 @@ export interface UpdateBillingPartyTaxIdentity {
     /** Normalized tax identification code shown on the original identity document. */
     code?: string;
 }
-/**
- * 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 interface InvoiceValidationIssue {
-    /** Machine-readable error code. */
-    code: string;
-    /** Human-readable description of the error. */
-    message: string;
-    /** Additional structured context. */
-    attributes?: Record<string, unknown>;
-    /** Severity of the validation issue. */
-    severity: 'critical' | 'warning';
-    /**
-     * JSON path to the field that caused this validation issue, if applicable.
-     *
-     * For example: `lines/0/rate_card/price`.
-     */
-    field?: string;
-}
 /**
  * The set of state-transition actions available for an invoice in its current
  * status.
@@ -2266,6 +2261,8 @@ export interface CreditAdjustment {
 /** The credit balance by currency. */
 export interface CreditBalance {
     currency: BillingCurrencyCode;
+    /** Immutable managed currency identifier. Present only for custom currencies. */
+    customCurrencyId?: string;
     /**
      * Credits available after applying currently live charge impacts.
      *
@@ -2305,7 +2302,10 @@ export interface CreateCreditAdjustmentRequest {
 export interface ListCreditTransactionsParamsFilter {
     /** Filter credit transactions by type. */
     type?: 'funded' | 'consumed' | 'expired' | 'voided';
-    /** Filter credit transactions by currency. */
+    /**
+     * Filter credit transactions by currency code. Custom-currency rows retain their
+     * managed currency identifier.
+     */
     currency?: BillingCurrencyCode;
     /**
      * Filter credit transactions by feature key. Omit to return all credit
@@ -2343,6 +2343,8 @@ export interface CreditTransaction {
     type: 'funded' | 'consumed' | 'expired' | 'voided';
     /** Currency of the balance affected by the transaction. */
     currency: BillingCurrencyCode;
+    /** Immutable managed currency identifier. Present only for custom currencies. */
+    customCurrencyId?: string;
     /**
      * Signed amount of the credit movement. Positive values add balance, negative
      * values reduce balance.
@@ -4357,6 +4359,13 @@ export interface CreditGrant {
     voidedAt?: Date;
     /** Current lifecycle status of the grant. */
     status: 'pending' | 'active' | 'expired' | 'voided';
+    /**
+     * Validation issues found while processing the credit grant.
+     *
+     * Present only when there are one or more validation findings. An empty list is
+     * omitted.
+     */
+    validationIssues?: ValidationIssue[];
 }
 /** Page paginated response. */
 export interface CurrencyPagePaginatedResponse {
@@ -4415,7 +4424,7 @@ export interface InvoiceBase {
      * Present only when there are one or more validation findings. An empty list is
      * omitted.
      */
-    validationIssues?: InvoiceValidationIssue[];
+    validationIssues?: ValidationIssue[];
     /** External identifiers assigned to this invoice by third-party systems. */
     externalReferences?: InvoiceExternalReferences;
 }
@@ -4500,7 +4509,7 @@ export interface ChargeRealizationInvoice {
      * Present only when there are one or more validation findings. An empty list is
      * omitted.
      */
-    validationIssues?: InvoiceValidationIssue[];
+    validationIssues?: ValidationIssue[];
     /** External identifiers assigned to this invoice by third-party systems. */
     externalReferences?: InvoiceExternalReferences;
     /** Discriminator field identifying this as a standard invoice. */
@@ -5739,7 +5748,7 @@ export interface InvoiceStandard {
      * Present only when there are one or more validation findings. An empty list is
      * omitted.
      */
-    validationIssues?: InvoiceValidationIssue[];
+    validationIssues?: ValidationIssue[];
     /** External identifiers assigned to this invoice by third-party systems. */
     externalReferences?: InvoiceExternalReferences;
     /** Discriminator field identifying this as a standard invoice. */
@@ -5874,6 +5883,13 @@ export interface ChargeFlatFee {
     resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
+    /**
+     * Validation issues found while processing the charge.
+     *
+     * Present only when there are one or more validation findings. An empty list is
+     * omitted.
+     */
+    validationIssues?: ValidationIssue[];
     /** The timestamp when the charge is intended to be invoiced. */
     invoiceAt: Date;
     /** The effective service period covered by the charge. */
@@ -5968,6 +5984,13 @@ export interface ChargeUsageBased {
     resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
+    /**
+     * Validation issues found while processing the charge.
+     *
+     * Present only when there are one or more validation findings. An empty list is
+     * omitted.
+     */
+    validationIssues?: ValidationIssue[];
     /** The timestamp when the charge is intended to be invoiced. */
     invoiceAt: Date;
     /** The effective service period covered by the charge. */
@@ -6989,6 +7012,13 @@ export interface CreditGrantInput {
     voidedAt?: Date;
     /** Current lifecycle status of the grant. */
     status: 'pending' | 'active' | 'expired' | 'voided';
+    /**
+     * Validation issues found while processing the credit grant.
+     *
+     * Present only when there are one or more validation findings. An empty list is
+     * omitted.
+     */
+    validationIssues?: ValidationIssue[];
 }
 /** Bad Request. */
 export interface BadRequestInput extends BaseErrorInput {
@@ -7076,7 +7106,7 @@ export interface ChargeRealizationInvoiceInput {
      * Present only when there are one or more validation findings. An empty list is
      * omitted.
      */
-    validationIssues?: InvoiceValidationIssue[];
+    validationIssues?: ValidationIssue[];
     /** External identifiers assigned to this invoice by third-party systems. */
     externalReferences?: InvoiceExternalReferences;
     /** Discriminator field identifying this as a standard invoice. */
@@ -8231,7 +8261,7 @@ export interface InvoiceStandardInput {
      * Present only when there are one or more validation findings. An empty list is
      * omitted.
      */
-    validationIssues?: InvoiceValidationIssue[];
+    validationIssues?: ValidationIssue[];
     /** External identifiers assigned to this invoice by third-party systems. */
     externalReferences?: InvoiceExternalReferences;
     /** Discriminator field identifying this as a standard invoice. */
@@ -8366,6 +8396,13 @@ export interface ChargeFlatFeeInput {
     resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
+    /**
+     * Validation issues found while processing the charge.
+     *
+     * Present only when there are one or more validation findings. An empty list is
+     * omitted.
+     */
+    validationIssues?: ValidationIssue[];
     /** The timestamp when the charge is intended to be invoiced. */
     invoiceAt: Date;
     /** The effective service period covered by the charge. */
@@ -8460,6 +8497,13 @@ export interface ChargeUsageBasedInput {
     resolvedCostBasis?: ChargeResolvedCostBasis;
     /** The lifecycle status of the charge. */
     status: 'created' | 'active' | 'final' | 'deleted';
+    /**
+     * Validation issues found while processing the charge.
+     *
+     * Present only when there are one or more validation findings. An empty list is
+     * omitted.
+     */
+    validationIssues?: ValidationIssue[];
     /** The timestamp when the charge is intended to be invoiced. */
     invoiceAt: Date;
     /** The effective service period covered by the charge. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-fd561cd8ec89",
+  "version": "1.0.0-beta-622df7843cd1",
   "description": "Official TypeScript SDK for the OpenMeter API — usage metering and billing",
   "keywords": [
     "openmeter",