@openmeter/client 1.0.0-beta-19b4fd5a13eb → 1.0.0-beta-e0f66967ddb0

package/dist/models/schemas.js

@@ -9,6 +9,11 @@ export const currencyCode = z
     .max(3)
     .regex(new RegExp('^[A-Z]{3}$'))
     .describe('Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience.');
+export const currencyCodeCustom = z
+    .string()
+    .min(4)
+    .max(24)
+    .describe('Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes.');
 export const numeric = z
     .string()
     .regex(new RegExp('^\\-?[0-9]+(\\.[0-9]+)?$'))
@@ -689,11 +694,6 @@ export const currencyType = z
 export const currencyExpand = z
     .enum(['cost_basis'])
     .describe("Expands for currencies. Values: - `cost_basis`: The currency's currently-active cost basis.");
-export const currencyCodeCustom = z
-    .string()
-    .min(4)
-    .max(24)
-    .describe('Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes.');
 export const featureLlmTokenType = z
     .enum([
     'input',
@@ -1021,12 +1021,6 @@ export const appCustomerDataExternalInvoicing = z
     labels: labels.optional(),
 })
     .describe('External invoicing customer data.');
-export const billingCurrencyCode = z
-    .union([currencyCode])
-    .describe('Fiat or custom currency code.');
-export const createCurrencyCode = z
-    .union([currencyCode])
-    .describe('Fiat or custom currency code.');
 export const currencyFiat = z
     .object({
     type: z.literal('fiat').describe('The type of the currency.'),
@@ -1064,6 +1058,43 @@ export const listCostBasesParamsFilter = z
     fiatCode: currencyCode.optional(),
 })
     .describe('Filter options for listing cost bases.');
+export const billingCurrencyCode = z
+    .union([currencyCode, currencyCodeCustom])
+    .describe('Fiat or custom currency code.');
+export const createCurrencyCode = z
+    .union([currencyCode, currencyCodeCustom])
+    .describe('Fiat or custom currency code.');
+export const createCurrencyCustomRequest = z
+    .object({
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('The name of the currency. It should be a human-readable string that represents the name of the currency, such as "US Dollar" or "Euro".'),
+    symbol: z
+        .string()
+        .min(1)
+        .optional()
+        .describe('The symbol of the currency. It should be a string that represents the symbol of the currency, such as "$" for US Dollar or "€" for Euro.'),
+    precision: z
+        .number()
+        .int()
+        .nonnegative()
+        .lte(4294967295)
+        .describe('The precision of the currency. It should be a number that represents the number of decimal places used for the currency, such as 2 for US Dollar or Euro.'),
+    decimalMark: z
+        .string()
+        .min(1)
+        .max(1)
+        .describe('The decimal mark for the currency. It should be a string that represents the decimal mark of the currency, such as "." for US Dollar or "," for Euro.'),
+    thousandSeparator: z
+        .string()
+        .min(1)
+        .max(1)
+        .describe('The thousand separator for the currency. It should be a string that represents the thousand separator of the currency, such as "," for US Dollar or "." for Euro.'),
+    code: currencyCodeCustom,
+})
+    .describe('CurrencyCustom create request.');
 export const currencyAmount = z
     .object({
     amount: numeric,
@@ -2254,37 +2285,6 @@ export const listCurrenciesParamsFilter = z
     code: stringFieldFilter.optional(),
 })
     .describe('Filter options for listing currencies.');
-export const createCurrencyCustomRequest = z
-    .object({
-    name: z
-        .string()
-        .min(1)
-        .max(256)
-        .describe('The name of the currency. It should be a human-readable string that represents the name of the currency, such as "US Dollar" or "Euro".'),
-    symbol: z
-        .string()
-        .min(1)
-        .optional()
-        .describe('The symbol of the currency. It should be a string that represents the symbol of the currency, such as "$" for US Dollar or "€" for Euro.'),
-    precision: z
-        .number()
-        .int()
-        .nonnegative()
-        .lte(4294967295)
-        .describe('The precision of the currency. It should be a number that represents the number of decimal places used for the currency, such as 2 for US Dollar or Euro.'),
-    decimalMark: z
-        .string()
-        .min(1)
-        .max(1)
-        .describe('The decimal mark for the currency. It should be a string that represents the decimal mark of the currency, such as "." for US Dollar or "," for Euro.'),
-    thousandSeparator: z
-        .string()
-        .min(1)
-        .max(1)
-        .describe('The thousand separator for the currency. It should be a string that represents the thousand separator of the currency, such as "," for US Dollar or "." for Euro.'),
-    code: currencyCodeCustom,
-})
-    .describe('CurrencyCustom create request.');
 export const governanceQueryRequest = z
     .object({
     includeCredits: z
@@ -3846,6 +3846,7 @@ export const rateCard = z
     labels: labels.optional(),
     key: resourceKey,
     feature: featureReference.optional(),
+    currency: billingCurrencyCode.optional(),
     billingCadence: iso8601Duration.optional(),
     price: price,
     unitConfig: unitConfig.optional(),
@@ -4230,7 +4231,7 @@ export const plan = z
         .gte(1)
         .default(1)
         .describe('Plans are versioned to allow you to make changes without affecting running subscriptions.'),
-    currency: currencyCode,
+    currency: billingCurrencyCode,
     billingCadence: iso8601Duration,
     proRatingEnabled: z
         .boolean()
@@ -4265,7 +4266,7 @@ export const createPlanRequest = z
         .describe('Optional description of the resource. Maximum 1024 characters.'),
     labels: labels.optional(),
     key: resourceKey,
-    currency: currencyCode,
+    currency: billingCurrencyCode,
     billingCadence: iso8601Duration,
     proRatingEnabled: z
         .boolean()
@@ -5136,6 +5137,11 @@ export const currencyCodeWire = z
     .max(3)
     .regex(new RegExp('^[A-Z]{3}$'))
     .describe('Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience.');
+export const currencyCodeCustomWire = z
+    .string()
+    .min(4)
+    .max(24)
+    .describe('Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes.');
 export const numericWire = z
     .string()
     .regex(new RegExp('^\\-?[0-9]+(\\.[0-9]+)?$'))
@@ -5809,11 +5815,6 @@ export const currencyTypeWire = z
 export const currencyExpandWire = z
     .enum(['cost_basis'])
     .describe("Expands for currencies. Values: - `cost_basis`: The currency's currently-active cost basis.");
-export const currencyCodeCustomWire = z
-    .string()
-    .min(4)
-    .max(24)
-    .describe('Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes.');
 export const featureLlmTokenTypeWire = z
     .enum([
     'input',
@@ -6141,12 +6142,6 @@ export const appCustomerDataExternalInvoicingWire = z
     labels: labelsWire.optional(),
 })
     .describe('External invoicing customer data.');
-export const billingCurrencyCodeWire = z
-    .union([currencyCodeWire])
-    .describe('Fiat or custom currency code.');
-export const createCurrencyCodeWire = z
-    .union([currencyCodeWire])
-    .describe('Fiat or custom currency code.');
 export const currencyFiatWire = z
     .strictObject({
     type: z.literal('fiat').describe('The type of the currency.'),
@@ -6184,6 +6179,43 @@ export const listCostBasesParamsFilterWire = z
     fiat_code: currencyCodeWire.optional(),
 })
     .describe('Filter options for listing cost bases.');
+export const billingCurrencyCodeWire = z
+    .union([currencyCodeWire, currencyCodeCustomWire])
+    .describe('Fiat or custom currency code.');
+export const createCurrencyCodeWire = z
+    .union([currencyCodeWire, currencyCodeCustomWire])
+    .describe('Fiat or custom currency code.');
+export const createCurrencyCustomRequestWire = z
+    .strictObject({
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('The name of the currency. It should be a human-readable string that represents the name of the currency, such as "US Dollar" or "Euro".'),
+    symbol: z
+        .string()
+        .min(1)
+        .optional()
+        .describe('The symbol of the currency. It should be a string that represents the symbol of the currency, such as "$" for US Dollar or "€" for Euro.'),
+    precision: z
+        .number()
+        .int()
+        .nonnegative()
+        .lte(4294967295)
+        .describe('The precision of the currency. It should be a number that represents the number of decimal places used for the currency, such as 2 for US Dollar or Euro.'),
+    decimal_mark: z
+        .string()
+        .min(1)
+        .max(1)
+        .describe('The decimal mark for the currency. It should be a string that represents the decimal mark of the currency, such as "." for US Dollar or "," for Euro.'),
+    thousand_separator: z
+        .string()
+        .min(1)
+        .max(1)
+        .describe('The thousand separator for the currency. It should be a string that represents the thousand separator of the currency, such as "," for US Dollar or "." for Euro.'),
+    code: currencyCodeCustomWire,
+})
+    .describe('CurrencyCustom create request.');
 export const currencyAmountWire = z
     .strictObject({
     amount: numericWire,
@@ -7351,37 +7383,6 @@ export const listCurrenciesParamsFilterWire = z
     code: stringFieldFilterWire.optional(),
 })
     .describe('Filter options for listing currencies.');
-export const createCurrencyCustomRequestWire = z
-    .strictObject({
-    name: z
-        .string()
-        .min(1)
-        .max(256)
-        .describe('The name of the currency. It should be a human-readable string that represents the name of the currency, such as "US Dollar" or "Euro".'),
-    symbol: z
-        .string()
-        .min(1)
-        .optional()
-        .describe('The symbol of the currency. It should be a string that represents the symbol of the currency, such as "$" for US Dollar or "€" for Euro.'),
-    precision: z
-        .number()
-        .int()
-        .nonnegative()
-        .lte(4294967295)
-        .describe('The precision of the currency. It should be a number that represents the number of decimal places used for the currency, such as 2 for US Dollar or Euro.'),
-    decimal_mark: z
-        .string()
-        .min(1)
-        .max(1)
-        .describe('The decimal mark for the currency. It should be a string that represents the decimal mark of the currency, such as "." for US Dollar or "," for Euro.'),
-    thousand_separator: z
-        .string()
-        .min(1)
-        .max(1)
-        .describe('The thousand separator for the currency. It should be a string that represents the thousand separator of the currency, such as "," for US Dollar or "." for Euro.'),
-    code: currencyCodeCustomWire,
-})
-    .describe('CurrencyCustom create request.');
 export const governanceQueryRequestWire = z
     .strictObject({
     include_credits: z
@@ -8947,6 +8948,7 @@ export const rateCardWire = z
     labels: labelsWire.optional(),
     key: resourceKeyWire,
     feature: featureReferenceWire.optional(),
+    currency: billingCurrencyCodeWire.optional(),
     billing_cadence: iso8601DurationWire.optional(),
     price: priceWire,
     unit_config: unitConfigWire.optional(),
@@ -9329,7 +9331,7 @@ export const planWire = z
         .int()
         .gte(1)
         .describe('Plans are versioned to allow you to make changes without affecting running subscriptions.'),
-    currency: currencyCodeWire,
+    currency: billingCurrencyCodeWire,
     billing_cadence: iso8601DurationWire,
     pro_rating_enabled: z
         .boolean()
@@ -9363,7 +9365,7 @@ export const createPlanRequestWire = z
         .describe('Optional description of the resource. Maximum 1024 characters.'),
     labels: labelsWire.optional(),
     key: resourceKeyWire,
-    currency: currencyCodeWire,
+    currency: billingCurrencyCodeWire,
     billing_cadence: iso8601DurationWire,
     pro_rating_enabled: z
         .boolean()

package/dist/models/types.d.ts

@@ -545,6 +545,36 @@ export interface ListCostBasesParamsFilter {
     /** Filter cost bases by fiat currency code. */
     fiatCode?: string;
 }
+/** CurrencyCustom create request. */
+export interface CreateCurrencyCustomRequest {
+    /**
+     * The name of the currency. It should be a human-readable string that represents
+     * the name of the currency, such as "US Dollar" or "Euro".
+     */
+    name: string;
+    /**
+     * The symbol of the currency. It should be a string that represents the symbol of
+     * the currency, such as "$" for US Dollar or "€" for Euro.
+     */
+    symbol?: string;
+    /**
+     * The precision of the currency. It should be a number that represents the number
+     * of decimal places used for the currency, such as 2 for US Dollar or Euro.
+     */
+    precision: number;
+    /**
+     * The decimal mark for the currency. It should be a string that represents the
+     * decimal mark of the currency, such as "." for US Dollar or "," for Euro.
+     */
+    decimalMark: string;
+    /**
+     * The thousand separator for the currency. It should be a string that represents
+     * the thousand separator of the currency, such as "," for US Dollar or "." for
+     * Euro.
+     */
+    thousandSeparator: string;
+    code: string;
+}
 /** Monetary amount in a specific currency. */
 export interface CurrencyAmount {
     amount: string;
@@ -2045,36 +2075,6 @@ export interface ListCurrenciesParamsFilter {
     type?: 'fiat' | 'custom';
     code?: StringFieldFilter;
 }
-/** CurrencyCustom create request. */
-export interface CreateCurrencyCustomRequest {
-    /**
-     * The name of the currency. It should be a human-readable string that represents
-     * the name of the currency, such as "US Dollar" or "Euro".
-     */
-    name: string;
-    /**
-     * The symbol of the currency. It should be a string that represents the symbol of
-     * the currency, such as "$" for US Dollar or "€" for Euro.
-     */
-    symbol?: string;
-    /**
-     * The precision of the currency. It should be a number that represents the number
-     * of decimal places used for the currency, such as 2 for US Dollar or Euro.
-     */
-    precision: number;
-    /**
-     * The decimal mark for the currency. It should be a string that represents the
-     * decimal mark of the currency, such as "." for US Dollar or "," for Euro.
-     */
-    decimalMark: string;
-    /**
-     * The thousand separator for the currency. It should be a string that represents
-     * the thousand separator of the currency, such as "," for US Dollar or "." for
-     * Euro.
-     */
-    thousandSeparator: string;
-    code: string;
-}
 /** Query to evaluate feature access for a list of customers. */
 export interface GovernanceQueryRequest {
     /**
@@ -4269,6 +4269,11 @@ export interface RateCard {
     key: string;
     /** The feature associated with the rate card. */
     feature?: FeatureReference;
+    /**
+     * Overrides the containing plan or add-on currency for this rate card. When
+     * omitted, the containing resource currency applies.
+     */
+    currency?: BillingCurrencyCode;
     /**
      * The billing cadence of the rate card. When null, the charge is one-time
      * (non-recurring). Only valid for flat prices.
@@ -4862,7 +4867,7 @@ export interface Plan {
      */
     version: number;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */
@@ -4930,7 +4935,7 @@ export interface CreatePlanRequest {
      */
     key: string;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */
@@ -5141,9 +5146,9 @@ export type StringFieldFilterExact = string | {
 /** The payment term of a flat price. */
 export type PricePaymentTerm = 'in_advance' | 'in_arrears';
 /** Fiat or custom currency code. */
-export type BillingCurrencyCode = string;
+export type BillingCurrencyCode = string | string;
 /** Fiat or custom currency code. */
-export type CreateCurrencyCode = string;
+export type CreateCurrencyCode = string | string;
 /**
  * Filters on the given ULID field value by exact match. All properties are
  * optional; provide exactly one to specify the comparison.
@@ -6056,6 +6061,11 @@ export interface RateCardInput {
     key: string;
     /** The feature associated with the rate card. */
     feature?: FeatureReference;
+    /**
+     * Overrides the containing plan or add-on currency for this rate card. When
+     * omitted, the containing resource currency applies.
+     */
+    currency?: BillingCurrencyCode;
     /**
      * The billing cadence of the rate card. When null, the charge is one-time
      * (non-recurring). Only valid for flat prices.
@@ -6498,7 +6508,7 @@ export interface PlanInput {
      */
     version?: number;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */
@@ -6566,7 +6576,7 @@ export interface CreatePlanRequestInput {
      */
     key: string;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */

package/package.json

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