@openmeter/client 1.0.0-beta-8f93b11ab8cd → 1.0.0-beta-52bb0a888f9a

package/dist/models/schemas.js

@@ -970,6 +970,9 @@ 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 chargeCostBasisType = z
+    .enum(['dynamic', 'pinned', 'manual'])
+    .describe('Cost basis resolution mode of a charge.');
 export const invoiceType = z
     .enum(['standard'])
     .describe('The type of a billing invoice.');
@@ -1041,6 +1044,14 @@ export const appCustomerDataExternalInvoicing = z
     labels: labels.optional(),
 })
     .describe('External invoicing customer data.');
+export const chargeCostBasisDynamic = z
+    .object({
+    type: z
+        .literal('dynamic')
+        .describe('Discriminator selecting the cost basis mode.'),
+    fiatCurrency: currencyCode,
+})
+    .describe("Cost basis resolved at the charge's full service period start.");
 export const currencyFiat = z
     .object({
     type: z.literal('fiat').describe('The type of the currency.'),
@@ -1144,6 +1155,15 @@ export const rateCardDiscounts = z
     usage: numeric.optional(),
 })
     .describe('Discount configuration for a rate card.');
+export const chargeCostBasisManual = z
+    .object({
+    type: z
+        .literal('manual')
+        .describe('Discriminator selecting the cost basis mode.'),
+    fiatCurrency: currencyCode,
+    rate: numeric,
+})
+    .describe('Cost basis with an explicit conversion rate supplied with the charge.');
 export const totals = z
     .object({
     amount: numeric,
@@ -1201,12 +1221,6 @@ export const featureLlmUnitCostPricing = z
     cacheWritePerToken: numeric.optional(),
 })
     .describe('Resolved per-token pricing from the LLM cost database.');
-export const currencyAmount = z
-    .object({
-    amount: numeric,
-    currency: currencyCode,
-})
-    .describe('Monetary amount in a specific currency.');
 export const invoiceLineCreditsApplied = z
     .object({
     amount: numeric,
@@ -1258,6 +1272,12 @@ export const llmCostModelPricing = z
     reasoningPerToken: numeric.optional(),
 })
     .describe('Token pricing for an LLM model, denominated per token.');
+export const fiatCurrencyAmount = z
+    .object({
+    amount: numeric,
+    currency: currencyCode,
+})
+    .describe('Monetary amount in a specific fiat currency.');
 export const queryFilterNumeric = z
     .object({
     gt: numeric.optional(),
@@ -1380,6 +1400,15 @@ export const subscriptionReference = z
         .describe('The phase of the subscription.'),
 })
     .describe('Subscription reference represents a reference to the specific subscription item this entity represents.');
+export const chargeCostBasisPinned = z
+    .object({
+    type: z
+        .literal('pinned')
+        .describe('Discriminator selecting the cost basis mode.'),
+    fiatCurrency: currencyCode,
+    costBasisId: ulid,
+})
+    .describe('Cost basis pinned to a specific cost basis resource of the custom currency.');
 export const appReference = z
     .object({
     id: ulid,
@@ -1520,6 +1549,14 @@ export const closedPeriod = z
     to: dateTime,
 })
     .describe('A period with defined start and end dates. The period is always inclusive at the start and exclusive at the end.');
+export const chargeResolvedCostBasis = z
+    .object({
+    fiatCurrency: currencyCode,
+    rate: numeric,
+    costBasisId: ulid.optional(),
+    resolvedAt: dateTime,
+})
+    .describe('Fiat conversion rate a custom-currency charge is invoiced at. Present once the cost basis is resolved; dynamic cost bases are exposed only after the service period has started.');
 export const subscriptionAddonTimelineSegment = z
     .object({
     activeFrom: dateTime,
@@ -2497,6 +2534,12 @@ export const creditTransaction = z
         .describe('The available balance before and after the transaction.'),
 })
     .describe("A credit transaction represents a single credit movement on the customer's balance. Credit transactions are immutable.");
+export const currencyAmount = z
+    .object({
+    amount: numeric,
+    currency: billingCurrencyCode,
+})
+    .describe('Monetary amount in a fiat or custom currency.');
 export const priceTier = z
     .object({
     upToAmount: numeric.optional(),
@@ -2657,6 +2700,13 @@ export const updateOrganizationDefaultTaxCodesRequest = z
     creditGrantTaxCode: taxCodeReference.optional(),
 })
     .describe('OrganizationDefaultTaxCodes update request.');
+export const chargeCostBasis = z
+    .discriminatedUnion('type', [
+    chargeCostBasisDynamic,
+    chargeCostBasisPinned,
+    chargeCostBasisManual,
+])
+    .describe('Cost basis selection for a custom-currency charge. The variant chosen fixes when and how the conversion rate is determined.');
 export const invoiceWorkflowAppsReferences = z
     .object({
     tax: appReference,
@@ -3070,30 +3120,6 @@ export const workflowCollectionAlignmentAnchored = z
     recurringPeriod: recurringPeriod,
 })
     .describe('BillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items into an invoice.');
-export const chargeFlatFeeSystemIntent = z
-    .object({
-    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(),
-    invoiceAt: dateTime,
-    servicePeriod: closedPeriod,
-    fullServicePeriod: closedPeriod,
-    billingPeriod: closedPeriod,
-    paymentTerm: pricePaymentTerm,
-    discounts: chargeFlatFeeDiscounts.optional(),
-    prorationConfiguration: rateCardProrationConfiguration,
-    amountBeforeProration: currencyAmount,
-    deletedAt: dateTime.optional(),
-})
-    .describe('Flat fee intent fields from the system lifecycle controller shadowed by a manual override.');
 export const invoiceStatusDetails = z
     .object({
     immutable: z
@@ -3283,6 +3309,30 @@ export const creditTransactionPaginatedResponse = z
     meta: cursorMeta,
 })
     .describe('Cursor paginated response.');
+export const chargeFlatFeeSystemIntent = z
+    .object({
+    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(),
+    invoiceAt: dateTime,
+    servicePeriod: closedPeriod,
+    fullServicePeriod: closedPeriod,
+    billingPeriod: closedPeriod,
+    paymentTerm: pricePaymentTerm,
+    discounts: chargeFlatFeeDiscounts.optional(),
+    prorationConfiguration: rateCardProrationConfiguration,
+    amountBeforeProration: currencyAmount,
+    deletedAt: dateTime.optional(),
+})
+    .describe('Flat fee intent fields from the system lifecycle controller shadowed by a manual override.');
 export const priceGraduated = z
     .object({
     type: z.literal('graduated').describe('The type of the price.'),
@@ -3399,6 +3449,21 @@ 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 workflowTaxSettings = z
+    .object({
+    enabled: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('Enable automatic tax calculation when tax is supported by the app. For example, with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.'),
+    enforced: z
+        .boolean()
+        .optional()
+        .default(false)
+        .describe('Enforce tax calculation when tax is supported by the app. When enabled, the billing system will not allow to create an invoice without tax calculation. Enforcement is different per apps, for example, Stripe app requires customer to have a tax location when starting a paid subscription.'),
+    defaultTaxConfig: taxConfig.optional(),
+})
+    .describe('Tax settings for a billing workflow.');
 export const createChargeFlatFeeRequest = z
     .object({
     name: z
@@ -3413,7 +3478,8 @@ export const createChargeFlatFeeRequest = z
         .describe('Optional description of the resource. Maximum 1024 characters.'),
     labels: labels.optional(),
     type: z.literal('flat_fee').describe('The type of the charge.'),
-    currency: currencyCode,
+    currency: billingCurrencyCode,
+    costBasis: chargeCostBasis.optional(),
     invoiceAt: dateTime,
     servicePeriod: closedPeriod,
     uniqueReferenceId: z
@@ -3431,21 +3497,6 @@ export const createChargeFlatFeeRequest = z
     billingPeriod: closedPeriod.optional(),
 })
     .describe('Flat fee charge create request.');
-export const workflowTaxSettings = z
-    .object({
-    enabled: z
-        .boolean()
-        .optional()
-        .default(true)
-        .describe('Enable automatic tax calculation when tax is supported by the app. For example, with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.'),
-    enforced: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe('Enforce tax calculation when tax is supported by the app. When enabled, the billing system will not allow to create an invoice without tax calculation. Enforcement is different per apps, for example, Stripe app requires customer to have a tax location when starting a paid subscription.'),
-    defaultTaxConfig: taxConfig.optional(),
-})
-    .describe('Tax settings for a billing workflow.');
 export const planAddonPagePaginatedResponse = z
     .object({
     data: z.array(planAddon),
@@ -4081,7 +4132,8 @@ export const createChargeUsageBasedRequest = z
         .describe('Optional description of the resource. Maximum 1024 characters.'),
     labels: labels.optional(),
     type: z.literal('usage_based').describe('The type of the charge.'),
-    currency: currencyCode,
+    currency: billingCurrencyCode,
+    costBasis: chargeCostBasis.optional(),
     invoiceAt: dateTime,
     servicePeriod: closedPeriod,
     uniqueReferenceId: z
@@ -4719,7 +4771,8 @@ export const chargeFlatFee = z
     customer: customerOrReference,
     lifecycleController: lifecycleController,
     subscription: subscriptionOrReference.optional(),
-    currency: currencyCode,
+    currency: billingCurrencyCode,
+    resolvedCostBasis: chargeResolvedCostBasis.optional(),
     status: chargeStatus,
     invoiceAt: dateTime,
     servicePeriod: closedPeriod,
@@ -4765,7 +4818,8 @@ export const chargeUsageBased = z
     customer: customerOrReference,
     lifecycleController: lifecycleController,
     subscription: subscriptionOrReference.optional(),
-    currency: currencyCode,
+    currency: billingCurrencyCode,
+    resolvedCostBasis: chargeResolvedCostBasis.optional(),
     status: chargeStatus,
     invoiceAt: dateTime,
     servicePeriod: closedPeriod,
@@ -6487,6 +6541,9 @@ export const numericFieldFilterWire = z
 export const chargeTypeWire = 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 chargeCostBasisTypeWire = z
+    .enum(['dynamic', 'pinned', 'manual'])
+    .describe('Cost basis resolution mode of a charge.');
 export const invoiceTypeWire = z
     .enum(['standard'])
     .describe('The type of a billing invoice.');
@@ -6558,6 +6615,14 @@ export const appCustomerDataExternalInvoicingWire = z
     labels: labelsWire.optional(),
 })
     .describe('External invoicing customer data.');
+export const chargeCostBasisDynamicWire = z
+    .strictObject({
+    type: z
+        .literal('dynamic')
+        .describe('Discriminator selecting the cost basis mode.'),
+    fiat_currency: currencyCodeWire,
+})
+    .describe("Cost basis resolved at the charge's full service period start.");
 export const currencyFiatWire = z
     .strictObject({
     type: z.literal('fiat').describe('The type of the currency.'),
@@ -6661,6 +6726,15 @@ export const rateCardDiscountsWire = z
     usage: numericWire.optional(),
 })
     .describe('Discount configuration for a rate card.');
+export const chargeCostBasisManualWire = z
+    .strictObject({
+    type: z
+        .literal('manual')
+        .describe('Discriminator selecting the cost basis mode.'),
+    fiat_currency: currencyCodeWire,
+    rate: numericWire,
+})
+    .describe('Cost basis with an explicit conversion rate supplied with the charge.');
 export const totalsWire = z
     .strictObject({
     amount: numericWire,
@@ -6718,12 +6792,6 @@ export const featureLlmUnitCostPricingWire = z
     cache_write_per_token: numericWire.optional(),
 })
     .describe('Resolved per-token pricing from the LLM cost database.');
-export const currencyAmountWire = z
-    .strictObject({
-    amount: numericWire,
-    currency: currencyCodeWire,
-})
-    .describe('Monetary amount in a specific currency.');
 export const invoiceLineCreditsAppliedWire = z
     .strictObject({
     amount: numericWire,
@@ -6775,6 +6843,12 @@ export const llmCostModelPricingWire = z
     reasoning_per_token: numericWire.optional(),
 })
     .describe('Token pricing for an LLM model, denominated per token.');
+export const fiatCurrencyAmountWire = z
+    .strictObject({
+    amount: numericWire,
+    currency: currencyCodeWire,
+})
+    .describe('Monetary amount in a specific fiat currency.');
 export const queryFilterNumericWire = z
     .strictObject({
     gt: numericWire.optional(),
@@ -6897,6 +6971,15 @@ export const subscriptionReferenceWire = z
         .describe('The phase of the subscription.'),
 })
     .describe('Subscription reference represents a reference to the specific subscription item this entity represents.');
+export const chargeCostBasisPinnedWire = z
+    .strictObject({
+    type: z
+        .literal('pinned')
+        .describe('Discriminator selecting the cost basis mode.'),
+    fiat_currency: currencyCodeWire,
+    cost_basis_id: ulidWire,
+})
+    .describe('Cost basis pinned to a specific cost basis resource of the custom currency.');
 export const appReferenceWire = z
     .strictObject({
     id: ulidWire,
@@ -7036,6 +7119,14 @@ export const closedPeriodWire = z
     to: dateTimeWire,
 })
     .describe('A period with defined start and end dates. The period is always inclusive at the start and exclusive at the end.');
+export const chargeResolvedCostBasisWire = z
+    .strictObject({
+    fiat_currency: currencyCodeWire,
+    rate: numericWire,
+    cost_basis_id: ulidWire.optional(),
+    resolved_at: dateTimeWire,
+})
+    .describe('Fiat conversion rate a custom-currency charge is invoiced at. Present once the cost basis is resolved; dynamic cost bases are exposed only after the service period has started.');
 export const subscriptionAddonTimelineSegmentWire = z
     .strictObject({
     active_from: dateTimeWire,
@@ -7990,6 +8081,12 @@ export const creditTransactionWire = z
         .describe('The available balance before and after the transaction.'),
 })
     .describe("A credit transaction represents a single credit movement on the customer's balance. Credit transactions are immutable.");
+export const currencyAmountWire = z
+    .strictObject({
+    amount: numericWire,
+    currency: billingCurrencyCodeWire,
+})
+    .describe('Monetary amount in a fiat or custom currency.');
 export const priceTierWire = z
     .strictObject({
     up_to_amount: numericWire.optional(),
@@ -8150,6 +8247,13 @@ export const updateOrganizationDefaultTaxCodesRequestWire = z
     credit_grant_tax_code: taxCodeReferenceWire.optional(),
 })
     .describe('OrganizationDefaultTaxCodes update request.');
+export const chargeCostBasisWire = z
+    .discriminatedUnion('type', [
+    chargeCostBasisDynamicWire,
+    chargeCostBasisPinnedWire,
+    chargeCostBasisManualWire,
+])
+    .describe('Cost basis selection for a custom-currency charge. The variant chosen fixes when and how the conversion rate is determined.');
 export const invoiceWorkflowAppsReferencesWire = z
     .strictObject({
     tax: appReferenceWire,
@@ -8563,30 +8667,6 @@ export const workflowCollectionAlignmentAnchoredWire = z
     recurring_period: recurringPeriodWire,
 })
     .describe('BillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items into an invoice.');
-export const chargeFlatFeeSystemIntentWire = z
-    .strictObject({
-    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: labelsWire.optional(),
-    invoice_at: dateTimeWire,
-    service_period: closedPeriodWire,
-    full_service_period: closedPeriodWire,
-    billing_period: closedPeriodWire,
-    payment_term: pricePaymentTermWire,
-    discounts: chargeFlatFeeDiscountsWire.optional(),
-    proration_configuration: rateCardProrationConfigurationWire,
-    amount_before_proration: currencyAmountWire,
-    deleted_at: dateTimeWire.optional(),
-})
-    .describe('Flat fee intent fields from the system lifecycle controller shadowed by a manual override.');
 export const invoiceStatusDetailsWire = z
     .strictObject({
     immutable: z
@@ -8780,6 +8860,30 @@ export const creditTransactionPaginatedResponseWire = z
     meta: cursorMetaWire,
 })
     .describe('Cursor paginated response.');
+export const chargeFlatFeeSystemIntentWire = z
+    .strictObject({
+    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: labelsWire.optional(),
+    invoice_at: dateTimeWire,
+    service_period: closedPeriodWire,
+    full_service_period: closedPeriodWire,
+    billing_period: closedPeriodWire,
+    payment_term: pricePaymentTermWire,
+    discounts: chargeFlatFeeDiscountsWire.optional(),
+    proration_configuration: rateCardProrationConfigurationWire,
+    amount_before_proration: currencyAmountWire,
+    deleted_at: dateTimeWire.optional(),
+})
+    .describe('Flat fee intent fields from the system lifecycle controller shadowed by a manual override.');
 export const priceGraduatedWire = z
     .strictObject({
     type: z.literal('graduated').describe('The type of the price.'),
@@ -8897,6 +9001,19 @@ export const creditGrantWire = z
     status: creditGrantStatusWire,
 })
     .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 workflowTaxSettingsWire = z
+    .strictObject({
+    enabled: z
+        .boolean()
+        .optional()
+        .describe('Enable automatic tax calculation when tax is supported by the app. For example, with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.'),
+    enforced: z
+        .boolean()
+        .optional()
+        .describe('Enforce tax calculation when tax is supported by the app. When enabled, the billing system will not allow to create an invoice without tax calculation. Enforcement is different per apps, for example, Stripe app requires customer to have a tax location when starting a paid subscription.'),
+    default_tax_config: taxConfigWire.optional(),
+})
+    .describe('Tax settings for a billing workflow.');
 export const createChargeFlatFeeRequestWire = z
     .strictObject({
     name: z
@@ -8911,7 +9028,8 @@ export const createChargeFlatFeeRequestWire = z
         .describe('Optional description of the resource. Maximum 1024 characters.'),
     labels: labelsWire.optional(),
     type: z.literal('flat_fee').describe('The type of the charge.'),
-    currency: currencyCodeWire,
+    currency: billingCurrencyCodeWire,
+    cost_basis: chargeCostBasisWire.optional(),
     invoice_at: dateTimeWire,
     service_period: closedPeriodWire,
     unique_reference_id: z
@@ -8929,19 +9047,6 @@ export const createChargeFlatFeeRequestWire = z
     billing_period: closedPeriodWire.optional(),
 })
     .describe('Flat fee charge create request.');
-export const workflowTaxSettingsWire = z
-    .strictObject({
-    enabled: z
-        .boolean()
-        .optional()
-        .describe('Enable automatic tax calculation when tax is supported by the app. For example, with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.'),
-    enforced: z
-        .boolean()
-        .optional()
-        .describe('Enforce tax calculation when tax is supported by the app. When enabled, the billing system will not allow to create an invoice without tax calculation. Enforcement is different per apps, for example, Stripe app requires customer to have a tax location when starting a paid subscription.'),
-    default_tax_config: taxConfigWire.optional(),
-})
-    .describe('Tax settings for a billing workflow.');
 export const planAddonPagePaginatedResponseWire = z
     .strictObject({
     data: z.array(planAddonWire),
@@ -9579,7 +9684,8 @@ export const createChargeUsageBasedRequestWire = z
         .describe('Optional description of the resource. Maximum 1024 characters.'),
     labels: labelsWire.optional(),
     type: z.literal('usage_based').describe('The type of the charge.'),
-    currency: currencyCodeWire,
+    currency: billingCurrencyCodeWire,
+    cost_basis: chargeCostBasisWire.optional(),
     invoice_at: dateTimeWire,
     service_period: closedPeriodWire,
     unique_reference_id: z
@@ -10212,7 +10318,8 @@ export const chargeFlatFeeWire = z
     customer: customerOrReferenceWire,
     lifecycle_controller: lifecycleControllerWire,
     subscription: subscriptionOrReferenceWire.optional(),
-    currency: currencyCodeWire,
+    currency: billingCurrencyCodeWire,
+    resolved_cost_basis: chargeResolvedCostBasisWire.optional(),
     status: chargeStatusWire,
     invoice_at: dateTimeWire,
     service_period: closedPeriodWire,
@@ -10258,7 +10365,8 @@ export const chargeUsageBasedWire = z
     customer: customerOrReferenceWire,
     lifecycle_controller: lifecycleControllerWire,
     subscription: subscriptionOrReferenceWire.optional(),
-    currency: currencyCodeWire,
+    currency: billingCurrencyCodeWire,
+    resolved_cost_basis: chargeResolvedCostBasisWire.optional(),
     status: chargeStatusWire,
     invoice_at: dateTimeWire,
     service_period: closedPeriodWire,